updated README and made example code more simplistic

Author: Severi Haverila

README.md

@@ -1,3 +1,11 @@
+# Overview
+This is an image recognition library that can be used for mobile application testing.
+
+This library has been extracted and refactored from the following project: 
+<https://github.com/bitbar/testdroid-samples/tree/master/image-recognition>
+
+As this README is currently rather simplistic, more information can be found from the original project's readme or from this blog post: <http://bitbar.com/appium-tip-27-using-appium-for-mobile-game-testing>
+
 # Prerequisites
 ## General
 
@@ -35,6 +43,9 @@ cd library
 mvn package
 cp target/image-recognition-library-2.0-SNAPSHOT.jar ../example/lib/image_recognition_library_test.jar
 cd ../example
+
+# Install OpenCV (change path according to your platform)
+mvn install:install-file -Dfile=lib/linux/opencv/java7/opencv-2413.jar -DgroupId=opencv -DartifactId=opencv -Dversion=2.4.13 -Dpackaging=jar
 	
 # Download the example Android application
 wget https://github.com/bitbar/testdroid-samples/blob/master/apps/builds/BitbarSampleApp.apk -O application.apk

example/src/main/java/AbstractAppiumTest.java

@@ -9,27 +9,15 @@
 import objects.PlatformType;
 
 import java.io.File;
-import java.io.IOException;
 import java.net.URL;
 import java.util.concurrent.TimeUnit;
 
-/**
- * Created by testdroid on 22/07/16.
- */
 public abstract class AbstractAppiumTest {
 
-    public static final int SHORT_SLEEP = 1;
-    public static final int MEDIUM_SLEEP = 5;
-    public static final int LONG_SLEEP = 10;
-
     protected static Logger logger = LoggerFactory.getLogger(AbstractAppiumTest.class);
-
-
-
     protected static AppiumDriver<MobileElement> driver;
     protected static int defaultWaitTime = 120;
 
-    public static String screenshotsFolder = "";
     public static String appFile = System.getenv("APP_FILE");
     public static PlatformType platform;
     public static String automationName = System.getenv("AUTOMATION_NAME");
@@ -38,10 +26,8 @@ public abstract class AbstractAppiumTest {
     public static String platformVersion = System.getenv("PLATFORM_VERSION");
     // Set to false to autoDismiss
     public static boolean autoAccept = true;
-    public static boolean idevicescreenshotExists = false;
-
 
-    public static AppiumDriver getIOSDriver() throws Exception {
+    public static AppiumDriver<MobileElement> getIOSDriver() throws Exception {
         if (appFile == null) {
             appFile = "application.ipa";
         }
@@ -57,10 +43,6 @@ public static AppiumDriver getIOSDriver() throws Exception {
         // Use default "appium" automation for iOS
         automationName = "appium";
 
-        screenshotsFolder = "target/reports/screenshots/ios/";
-        File dir = new File(screenshotsFolder);
-        dir.mkdirs();
-
         DesiredCapabilities capabilities = new DesiredCapabilities();
         capabilities.setCapability("platformName", platform.getPlatformName());
         capabilities.setCapability("deviceName", deviceName);
@@ -80,15 +62,13 @@ public static AppiumDriver getIOSDriver() throws Exception {
             capabilities.setCapability("autoDismissAlerts", true);
         }
 
-        idevicescreenshotCheck();
-
         log("Creating Appium session, this may take couple minutes..");
         driver = new IOSDriver<MobileElement>(new URL("http://localhost:4723/wd/hub"), capabilities);
         driver.manage().timeouts().implicitlyWait(defaultWaitTime, TimeUnit.SECONDS);
         return driver;
     }
 
-    public static AppiumDriver getAndroidDriver() throws Exception {
+    public static AppiumDriver<MobileElement> getAndroidDriver() throws Exception {
         if (appFile == null) {
             appFile = "application.apk";
         }
@@ -101,9 +81,6 @@ public static AppiumDriver getAndroidDriver() throws Exception {
         if (automationName == null){
             automationName = "appium";
         }
-        screenshotsFolder = "target/reports/screenshots/android/";
-        File dir = new File(screenshotsFolder);
-        dir.mkdirs();
 
         DesiredCapabilities capabilities = new DesiredCapabilities();
         capabilities.setCapability("automationName", automationName);
@@ -124,51 +101,8 @@ public static AppiumDriver getAndroidDriver() throws Exception {
         return driver;
     }
 
-
-
-    //On a test run on the local machine this method will save the Reports folder in different folders on every test run.
-    public static void savePreviousRunReports() {
-        long millis = System.currentTimeMillis();
-        File dir = new File("./target/reports");
-        File newName = new File("./target/reports" + millis);
-        if (dir.isDirectory()) {
-            dir.renameTo(newName);
-        } else {
-            dir.mkdir();
-            dir.renameTo(newName);
-        }
-    }
-
-    public static boolean idevicescreenshotCheck() throws IOException, InterruptedException {
-        String[] cmd = new String[]{"idevicescreenshot", "--help"};
-        int exitVal = -1;
-        try {
-            Process p = Runtime.getRuntime().exec(cmd);
-            exitVal = p.waitFor();
-        } catch (IOException e) {
-            log(e.toString());
-        }
-        if (exitVal == 0) {
-            log("idevicescreenshot exited with value: " + exitVal + ". Using it for screenshots.");
-            idevicescreenshotExists = true;
-        } else {
-            log("idevicescreenshot process exited with value: " + exitVal + ". Won't be using it for screenshots.");
-            idevicescreenshotExists = false;
-        }
-        return idevicescreenshotExists;
-    }
-
-    //Stops the script for the given amount of seconds.
-    public static void sleep(double seconds) throws Exception {
-        log("Waiting for " + seconds + " sec");
-        seconds = seconds * 1000;
-        Thread.sleep((int) seconds);
-    }
-
     public static void log(String message) {
         logger.info(message);
     }
 
-
-
 }

example/src/main/java/AppiumCommons.java

@@ -1,51 +1,41 @@
 import imagerecognition.ImageRecognition;
 
-import org.openqa.selenium.Dimension;
+import java.io.File;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import objects.ImageLocation;
 import objects.ImageRecognitionSettings;
 import objects.ImageSearchResult;
 
-
-/**
- * Created by testdroid on 22/07/16.
- */
 public class TestdroidImageRecognition extends AbstractAppiumTest {
 
     public Logger logger = LoggerFactory.getLogger(TestdroidImageRecognition.class);
-    private String queryImageSubFolder = "";
-
-
-    //If this method is called inside a test the script will check if the device has a resolution lower than 500x500 and if so will use
-    // a different set of images when trying to find a image. These images are located in /queryimages/low_res
-    public void setQueryImageFolder() {
-        Dimension size = driver.manage().window().getSize();
-        log("Screen size: " + size.toString());
-        if ((size.getHeight() <= 500) || (size.getWidth() <= 500)) {
-            queryImageSubFolder = "low_res/";
-        }
+    String screenshotsFolder;
+    String queryImageFolder;
+    
+    public TestdroidImageRecognition(){
+        super();
+        screenshotsFolder = "target/reports/screenshots/";
+        queryImageFolder = "queryimages/";
+        File dir = new File(screenshotsFolder);
+        dir.mkdirs();
     }
 
     public ImageLocation findImageOnScreen(String image) throws Exception {
         ImageRecognitionSettings defaultSettings = new ImageRecognitionSettings();
         return findImageOnScreen(image, defaultSettings).getImageLocation();
     }
 
-    public ImageSearchResult findImageOnScreen(String imageName, ImageRecognitionSettings settings) throws Exception { 
-        // queryImageFolder is "", unless set by setQueryImageFolder()
-        String queryImageFolder = "queryimages/" + queryImageSubFolder;
-        String screenshotsFolder = "target/reports/screenshots/";
+    public ImageSearchResult findImageOnScreen(String imageName, ImageRecognitionSettings settings) throws Exception {
         String imageFile = queryImageFolder+imageName;
         log("Searching for: "+imageFile);
         ImageSearchResult foundImage = ImageRecognition.findImageOnScreen(imageFile, screenshotsFolder, settings, platform);
         return foundImage;
     }
 
     public void waitForImageToDisappearFromScreen(String image) throws Exception {
-        String queryImageFolder = "queryimages/" + queryImageSubFolder;
-        String screenshotsFolder = "target/reports/screenshots/";
         String imageFile = queryImageFolder+image;
         boolean hasImageDisappeared = ImageRecognition.hasImageDissappearedFromScreenBeforeTimeout(imageFile, screenshotsFolder, platform);
         assert(hasImageDisappeared);