[Live Now] Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Join for FREE! Join TestMu Conference

How to use compareImagesCommand method of io.appium.java_client.MobileCommand class

Best io.appium code snippet using io.appium.java_client.MobileCommand.compareImagesCommand

MobileCommand.java

Source:MobileCommand.java

...459     * @param img2Data base64-encoded data of the second image460     * @param options comparison options461     * @return key-value pairs462     */463    public static Map.Entry<String, Map<String, ?>> compareImagesCommand(ComparisonMode mode,464                                                                         byte[] img1Data, byte[] img2Data,465                                                                         @Nullable BaseComparisonOptions options) {466        String[] parameters = options == null467                ? new String[]{"mode", "firstImage", "secondImage"}468                : new String[]{"mode", "firstImage", "secondImage", "options"};469        Object[] values = options == null470                ? new Object[]{mode.toString(), new String(img1Data, StandardCharsets.UTF_8),471                               new String(img2Data, StandardCharsets.UTF_8)}472                : new Object[]{mode.toString(), new String(img1Data, StandardCharsets.UTF_8),473                               new String(img2Data, StandardCharsets.UTF_8), options.build()};474        return new AbstractMap.SimpleEntry<>(COMPARE_IMAGES, prepareArguments(parameters, values));475    }476    /**477     * This method forms a {@link Map} of parameters for the checking of the keyboard state (is it shown or not)....

ComparesImages.java

Source:ComparesImages.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client;17import static io.appium.java_client.MobileCommand.compareImagesCommand;18import io.appium.java_client.imagecomparison.ComparisonMode;19import io.appium.java_client.imagecomparison.FeaturesMatchingOptions;20import io.appium.java_client.imagecomparison.FeaturesMatchingResult;21import io.appium.java_client.imagecomparison.OccurrenceMatchingOptions;22import io.appium.java_client.imagecomparison.OccurrenceMatchingResult;23import io.appium.java_client.imagecomparison.SimilarityMatchingOptions;24import io.appium.java_client.imagecomparison.SimilarityMatchingResult;25import org.apache.commons.codec.binary.Base64;26import org.apache.commons.io.FileUtils;27import java.io.File;28import java.io.IOException;29import java.util.Map;30import javax.annotation.Nullable;31public interface ComparesImages extends ExecutesMethod {32    /**33     * Performs images matching by features with default options. Read34     * https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html35     * for more details on this topic.36     *37     * @param base64image1 base64-encoded representation of the first image38     * @param base64Image2 base64-encoded representation of the second image39     * @return The matching result.40     */41    default FeaturesMatchingResult matchImagesFeatures(byte[] base64image1, byte[] base64Image2) {42        return matchImagesFeatures(base64image1, base64Image2, null);43    }44    /**45     * Performs images matching by features. Read46     * https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html47     * for more details on this topic.48     *49     * @param base64image1 base64-encoded representation of the first image50     * @param base64Image2 base64-encoded representation of the second image51     * @param options comparison options52     * @return The matching result. The configuration of fields in the result depends on comparison options.53     */54    default FeaturesMatchingResult matchImagesFeatures(byte[] base64image1, byte[] base64Image2,55                                                       @Nullable FeaturesMatchingOptions options) {56        Object response = CommandExecutionHelper.execute(this,57                compareImagesCommand(ComparisonMode.MATCH_FEATURES, base64image1, base64Image2, options));58        //noinspection unchecked59        return new FeaturesMatchingResult((Map<String, Object>) response);60    }61    /**62     * Performs images matching by features with default options. Read63     * https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html64     * for more details on this topic.65     *66     * @param image1 The location of the first image67     * @param image2 The location of the second image68     * @return The matching result.69     */70    default FeaturesMatchingResult matchImagesFeatures(File image1, File image2) throws IOException {71        return matchImagesFeatures(image1, image2, null);72    }73    /**74     * Performs images matching by features. Read75     * https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html76     * for more details on this topic.77     *78     * @param image1 The location of the first image79     * @param image2 The location of the second image80     * @param options comparison options81     * @return The matching result. The configuration of fields in the result depends on comparison options.82     */83    default FeaturesMatchingResult matchImagesFeatures(File image1, File image2,84                                                       @Nullable FeaturesMatchingOptions options) throws IOException {85        return matchImagesFeatures(Base64.encodeBase64(FileUtils.readFileToByteArray(image1)),86                Base64.encodeBase64(FileUtils.readFileToByteArray(image2)), options);87    }88    /**89     * Performs images matching by template to find possible occurrence of the partial image90     * in the full image with default options. Read91     * https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html92     * for more details on this topic.93     *94     * @param fullImage base64-encoded representation of the full image95     * @param partialImage base64-encoded representation of the partial image96     * @return The matching result.97     */98    default OccurrenceMatchingResult findImageOccurrence(byte[] fullImage, byte[] partialImage) {99        return findImageOccurrence(fullImage, partialImage, null);100    }101    /**102     * Performs images matching by template to find possible occurrence of the partial image103     * in the full image. Read104     * https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html105     * for more details on this topic.106     *107     * @param fullImage base64-encoded representation of the full image108     * @param partialImage base64-encoded representation of the partial image109     * @param options comparison options110     * @return The matching result. The configuration of fields in the result depends on comparison options.111     */112    default OccurrenceMatchingResult findImageOccurrence(byte[] fullImage, byte[] partialImage,113                                                         @Nullable OccurrenceMatchingOptions options) {114        Object response = CommandExecutionHelper.execute(this,115                compareImagesCommand(ComparisonMode.MATCH_TEMPLATE, fullImage, partialImage, options));116        //noinspection unchecked117        return new OccurrenceMatchingResult((Map<String, Object>) response);118    }119    /**120     * Performs images matching by template to find possible occurrence of the partial image121     * in the full image with default options. Read122     * https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html123     * for more details on this topic.124     *125     * @param fullImage The location of the full image126     * @param partialImage The location of the partial image127     * @return The matching result. The configuration of fields in the result depends on comparison options.128     */129    default OccurrenceMatchingResult findImageOccurrence(File fullImage, File partialImage) throws IOException {130        return findImageOccurrence(fullImage, partialImage, null);131    }132    /**133     * Performs images matching by template to find possible occurrence of the partial image134     * in the full image. Read135     * https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html136     * for more details on this topic.137     *138     * @param fullImage The location of the full image139     * @param partialImage The location of the partial image140     * @param options comparison options141     * @return The matching result. The configuration of fields in the result depends on comparison options.142     */143    default OccurrenceMatchingResult findImageOccurrence(File fullImage, File partialImage,144                                                         @Nullable OccurrenceMatchingOptions options)145            throws IOException {146        return findImageOccurrence(Base64.encodeBase64(FileUtils.readFileToByteArray(fullImage)),147                Base64.encodeBase64(FileUtils.readFileToByteArray(partialImage)), options);148    }149    /**150     * Performs images matching to calculate the similarity score between them151     * with default options. The flow there is similar to the one used in152     * {@link #findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions)},153     * but it is mandatory that both images are of equal size.154     *155     * @param base64image1 base64-encoded representation of the first image156     * @param base64Image2 base64-encoded representation of the second image157     * @return Matching result. The configuration of fields in the result depends on comparison options.158     */159    default SimilarityMatchingResult getImagesSimilarity(byte[] base64image1, byte[] base64Image2) {160        return getImagesSimilarity(base64image1, base64Image2, null);161    }162    /**163     * Performs images matching to calculate the similarity score between them.164     * The flow there is similar to the one used in165     * {@link #findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions)},166     * but it is mandatory that both images are of equal size.167     *168     * @param base64image1 base64-encoded representation of the first image169     * @param base64Image2 base64-encoded representation of the second image170     * @param options comparison options171     * @return Matching result. The configuration of fields in the result depends on comparison options.172     */173    default SimilarityMatchingResult getImagesSimilarity(byte[] base64image1, byte[] base64Image2,174                                                         @Nullable SimilarityMatchingOptions options) {175        Object response = CommandExecutionHelper.execute(this,176                compareImagesCommand(ComparisonMode.GET_SIMILARITY, base64image1, base64Image2, options));177        //noinspection unchecked178        return new SimilarityMatchingResult((Map<String, Object>) response);179    }180    /**181     * Performs images matching to calculate the similarity score between them182     * with default options. The flow there is similar to the one used in183     * {@link #findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions)},184     * but it is mandatory that both images are of equal size.185     *186     * @param image1 The location of the full image187     * @param image2 The location of the partial image188     * @return Matching result. The configuration of fields in the result depends on comparison options.189     */190    default SimilarityMatchingResult getImagesSimilarity(File image1, File image2) throws IOException {...

compareImagesCommand

Using AI Code Generation

1MobileCommand command = new MobileCommand("compareImagesCommand");2command.addParameter("firstImage", firstImage);3command.addParameter("secondImage", secondImage);4command.addParameter("threshold", threshold);5command.addParameter("outputImage", outputImage);6command.addParameter("outputMask", outputMask);7command.addParameter("outputResult", outputResult);8Response response = driver.execute(command);9String actualResult = response.getValue().toString();10Assert.assertEquals(actualResult, "True");11driver.quit();12}

compareImagesCommand

Using AI Code Generation

1MobileCommand command = new MobileCommand("compareImagesCommand");2command.addParameter("firstImage", firstImage);3command.addParameter("secondImage", secondImage);4command.addParameter("threshold", threshold);5command.addParameter("outputImage", outputImage);6command.addParameter("outputMask", outputMask);7command.addParameter("outputResult", outputResult);8command.addParameter("outputResultJson", outputResultJson);9command.addParameter("outputResultXml", outputResultXml);10command.addParameter("outputResultHtml", outputResultHtml);11command.addParameter("outputResultCsv", outputResultCsv);12command.addParameter("outputResultXlsx", outputResultXlsx);13command.addParameter("outputResultPng", outputResultPng);14command.addParameter("outputResultTsv", outputResultTsv);15command.addParameter("outputResultTxt", outputResultTxt);16command.addParameter("outputResultJsonSummary", outputResultJsonSummary);17command.addParameter("outputResultHtmlSummary", outputResultHtmlSummary);18command.addParameter("outputResultCsvSummary", outputResultCsvSummary);19command.addParameter("outputResultXlsxSummary", outputResultXlsxSummary);20command.addParameter("outputResultPngSummary", outputResultPngSummary);21command.addParameter("outputResultTsvSummary", outputResultTsvSummary);22command.addParameter("outputResultTxtSummary", outputResultTxtSummary);23command.addParameter("outputResultJsonDifferences", outputResultJsonDifferences);24command.addParameter("outputResultHtmlDifferences", outputResultHtmlDifferences);25command.addParameter("outputResultCsvDifferences", outputResultCsvDifferences);26command.addParameter("outputResultXlsxDifferences", outputResultXlsxDifferences);27command.addParameter("outputResultPngDifferences", outputResultPngDifferences);28command.addParameter("outputResultTsvDifferences", outputResultTsvDifferences);29command.addParameter("outputResultTxtDifferences", outputResultTxtDifferences);30command.addParameter("outputResultJsonDetails", outputResultJsonDetails);31command.addParameter("outputResultHtmlDetails", outputResultHtmlDetails);32command.addParameter("outputResultCsvDetails", outputResultCsvDetails);33command.addParameter("outputResultXlsxDetails", outputResultXlsxDetails);34command.addParameter("outputResultPngDetails", outputResultPngDetails);35command.addParameter("outputResultTsvDetails", outputResultTsvDetails);36command.addParameter("outputResultTxtDetails", outputResultTxtDetails);

compareImagesCommand

Using AI Code Generation

1import io.appium.java_client.MobileBy;2import io.appium.java_client.MobileCommand;3import io.appium.java_client.MobileElement;4import io.appium.java_client.android.AndroidDriver;5import io.appium.java_client.android.AndroidElement;6import org.openqa.selenium.By;7import org.openqa.selenium.remote.DesiredCapabilities;8import org.openqa.selenium.support.ui.ExpectedConditions;9import org.openqa.selenium.support.ui.WebDriverWait;10import java.net.URL;11public class CompareImages {12    public static void main(String[] args) throws Exception {13        DesiredCapabilities caps = new DesiredCapabilities();14        caps.setCapability("deviceName", "Pixel 3");15        caps.setCapability("platformName", "Android");16        caps.setCapability("platformVersion", "9");17        caps.setCapability("automationName", "UiAutomator2");18        caps.setCapability("appPackage", "com.android.settings");19        caps.setCapability("appActivity", ".Settings");20        caps.setCapability("noReset", true);

compareImagesCommand

Using AI Code Generation

1package appium;2import java.io.File;3import java.net.URL;4import java.util.HashMap;5import java.util.Map;6import org.openqa.selenium.remote.DesiredCapabilities;7import io.appium.java_client.AppiumDriver;8import io.appium.java_client.MobileElement;9public class compareImages {10	public static void main(String[] args) throws Exception {11		DesiredCapabilities caps = new DesiredCapabilities();12		caps.setCapability("deviceName", "Pixel 2 API 28");13		caps.setCapability("platformName", "Android");14		caps.setCapability("platformVersion", "9");15		caps.setCapability("skipUnlock","true");16		caps.setCapability("appPackage", "com.android.vending");17		caps.setCapability("appActivity","com.android.vending.AssetBrowserActivity");18		caps.setCapability("noReset","true");

compareImagesCommand

Using AI Code Generation

1import java.util.HashMap;2import java.util.Map;3import java.io.File;4import org.openqa.selenium.remote.DesiredCapabilities;5import org.openqa.selenium.remote.RemoteWebElement;6import io.appium.java_client.AppiumDriver;7import io.appium.java_client.MobileCommand;8import io.appium.java_client.MobileElement;9import io.appium.java_client.android.AndroidDriver;10public class appium {11public static void main(String[] args) throws Exception {12	DesiredCapabilities caps = new DesiredCapabilities();13	caps.setCapability("deviceName", "Pixel_2_API_29");14	caps.setCapability("platformName", "Android");15	caps.setCapability("platformVersion", "10");16	caps.setCapability("appPackage", "com.android.calculator2");17	caps.setCapability("appActivity", "com.android.calculator2.Calculator");18	caps.setCapability("noReset", "true");

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.