use enum for platformType

Severi Haverila · Severi Haverila · commit 5f2485a78b35 · 2016-11-07T15:08:09.000-08:00
diff --git a/src/main/java/AbstractAppiumTest.java b/src/main/java/AbstractAppiumTest.java
@@ -10,6 +10,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import dtos.PlatformType;
+
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.IOException;
@@ -35,7 +37,7 @@ public abstract class AbstractAppiumTest {
 
     public static String screenshotsFolder = "";
     public static String appFile = System.getenv("APP_FILE");
-    public static String platformName = System.getenv("PLATFORM_NAME");
+    public static PlatformType platform;
     public static String automationName = System.getenv("AUTOMATION_NAME");
     public static String deviceName = System.getenv("DEVICE_NAME");
     public static String udid = System.getenv("UDID");
@@ -49,8 +51,8 @@ public static AppiumDriver getIOSDriver() throws Exception {
         if (appFile == null) {
             appFile = "application.ipa";
         }
-        if (platformName == null) {
-            platformName = "iOS";
+        if (platform == null) {
+        	platform = PlatformType.IOS;
         }
         if (deviceName == null){
         	deviceName = "device";
@@ -66,7 +68,7 @@ public static AppiumDriver getIOSDriver() throws Exception {
         dir.mkdirs();
 
         DesiredCapabilities capabilities = new DesiredCapabilities();
-        capabilities.setCapability("platformName", platformName);
+        capabilities.setCapability("platformName", platform.getPlatformName());
         capabilities.setCapability("deviceName", deviceName);
         if (udid != null)
             capabilities.setCapability("udid", udid);
@@ -96,8 +98,8 @@ public static AppiumDriver getAndroidDriver() throws Exception {
         if (appFile == null) {
             appFile = "application.apk";
         }
-        if (platformName == null) {
-            platformName = "Android";
+        if (platform == null) {
+        	platform = PlatformType.ANDROID;
         }
         if (deviceName == null){
             deviceName = "device";
@@ -111,7 +113,7 @@ public static AppiumDriver getAndroidDriver() throws Exception {
 
         DesiredCapabilities capabilities = new DesiredCapabilities();
         capabilities.setCapability("automationName", automationName);
-        capabilities.setCapability("platformName", platformName);
+        capabilities.setCapability("platformName", platform.getPlatformName());
         capabilities.setCapability("deviceName", "Android Device");
         if (udid != null)
             capabilities.setCapability("udid", udid);
diff --git a/src/main/java/TestdroidImageRecognition.java b/src/main/java/TestdroidImageRecognition.java
@@ -6,8 +6,9 @@
 import org.slf4j.LoggerFactory;
 
 import dtos.ImageLocation;
-import dtos.ImageRecognitionSettingsDTO;
-import dtos.ImageSearchDTO;
+import dtos.ImageRecognitionSettings;
+import dtos.ImageSearchResult;
+import dtos.PlatformType;
 
 import java.io.*;
 
@@ -32,17 +33,17 @@ public void setQueryImageFolder() {
     }
 
     public ImageLocation findImageOnScreen(String image) throws Exception {
-    	ImageRecognitionSettingsDTO defaultSettings = new ImageRecognitionSettingsDTO();
+    	ImageRecognitionSettings defaultSettings = new ImageRecognitionSettings();
     	return findImageOnScreen(image, defaultSettings).getImageLocation();
     }
     
-    public ImageSearchDTO findImageOnScreen(String imageName, ImageRecognitionSettingsDTO settings) throws Exception { 
+    public ImageSearchResult findImageOnScreen(String imageName, ImageRecognitionSettings settings) throws Exception { 
     	// queryImageFolder is "", unless set by setQueryImageFolder()
         String queryImageFolder = "queryimages/" + queryImageSubFolder;
         String screenshotsFolder = "target/reports/screenshots/"; //TODO Severi remove this
         String imageFile = queryImageFolder+imageName;
         log("Searching for: "+imageFile);
-    	ImageSearchDTO foundImage = ImageRecognition.findImageOnScreen(imageFile, screenshotsFolder, settings, getScreenSize(), platformName);
+    	ImageSearchResult foundImage = ImageRecognition.findImageOnScreen(imageFile, screenshotsFolder, settings, getScreenSize(), platform);
         return foundImage;
     }
 
@@ -51,14 +52,14 @@ public void waitForImageToDisappearFromScreen(String image) throws Exception {
         String screenshotsFolder = "target/reports/screenshots/"; //TODO Severi remove this
         Dimension screenSize = getScreenSize(); //TODO Severi remove this
         String imageFile = queryImageFolder+image;
-		boolean hasImageDisappeared = ImageRecognition.hasImageDissappearedFromScreenBeforeTimeout(imageFile, screenshotsFolder, screenSize, platformName);
+		boolean hasImageDisappeared = ImageRecognition.hasImageDissappearedFromScreenBeforeTimeout(imageFile, screenshotsFolder, screenSize, platform);
 		assert(hasImageDisappeared);
     }
 
     public Dimension getScreenSize() throws Exception {
         log("trying to get size from adb...");
         log("------------------------------");
-        if (platformName.equalsIgnoreCase("iOS")) {
+        if (platform.equals(PlatformType.IOS)) {
             return driver.manage().window().getSize();
         } else {
             return getAndroidScreenSize();
@@ -92,15 +93,15 @@ private Dimension getAndroidScreenSize() throws IOException, InterruptedExceptio
 
 
     public String grabTextFromImage(String image) throws Exception {
-    	ImageSearchDTO imageSearch = findAndCropImage(image);
+    	ImageSearchResult imageSearch = findAndCropImage(image);
         String text = ImageRecognition.getTextStringFromImage(imageSearch.getScreenshotFile());
 		return text;
     }
 
-	public ImageSearchDTO findAndCropImage(String image) throws Exception {
-		ImageRecognitionSettingsDTO settings = new ImageRecognitionSettingsDTO();
+	public ImageSearchResult findAndCropImage(String image) throws Exception {
+		ImageRecognitionSettings settings = new ImageRecognitionSettings();
     	settings.setCrop(true);
-    	ImageSearchDTO imageSearch = findImageOnScreen(image, settings);
+    	ImageSearchResult imageSearch = findImageOnScreen(image, settings);
 		return imageSearch;
 	}
 
diff --git a/src/main/java/dtos/ImageRecognitionSettings.java b/src/main/java/dtos/ImageRecognitionSettings.java
@@ -1,13 +1,13 @@
 package dtos;
 
-public class ImageRecognitionSettingsDTO {
+public class ImageRecognitionSettings {
     
 	private final int DEFAULT_RETRIES = 5;
     private final int DEFAULT_RETRY_WAIT = 0;
     private final double DEFAULT_TOLERANCE = 0.6;
     private final boolean DEFAULT_CROP = false;
 	
-	public ImageRecognitionSettingsDTO(){
+	public ImageRecognitionSettings(){
 		this.retries = DEFAULT_RETRIES;
 		this.retryWaitTime = DEFAULT_RETRY_WAIT;
 		this.tolerance = DEFAULT_TOLERANCE;
diff --git a/src/main/java/dtos/ImageSearchResult.java b/src/main/java/dtos/ImageSearchResult.java
@@ -1,13 +1,13 @@
 package dtos;
 
-public class ImageSearchDTO {
+public class ImageSearchResult {
 	
-	public ImageSearchDTO(){
+	public ImageSearchResult(){
 		this.screenshotFile = null;
 		this.imageLocation = null;
 	}
 	
-	public ImageSearchDTO(String screenshotFile, ImageLocation imageLocation){
+	public ImageSearchResult(String screenshotFile, ImageLocation imageLocation){
 		this.screenshotFile = screenshotFile;
 		this.imageLocation = imageLocation;
 	}
diff --git a/src/main/java/dtos/PlatformType.java b/src/main/java/dtos/PlatformType.java
@@ -0,0 +1,17 @@
+package dtos;
+
+public enum PlatformType {
+	ANDROID("Android"), 
+	IOS("iOS");
+	
+	PlatformType(String platformName){
+		this.platformName=platformName;
+	}
+	
+	public String getPlatformName(){
+		return this.platformName;
+	}
+	
+	private String platformName;
+	
+}
diff --git a/src/main/java/library/AkazeImageFinder.java b/src/main/java/library/AkazeImageFinder.java
@@ -10,7 +10,7 @@
 import org.slf4j.LoggerFactory;
 
 import dtos.ImageLocation;
-import dtos.ImageSearchDTO;
+import dtos.ImageSearchResult;
 
 import java.io.*;
 import java.lang.reflect.Field;
@@ -244,7 +244,7 @@ public ImageLocation findImage(String queryImageFile, String sceneFile, double t
         return location;
     }
 
-    public void cropImage(ImageSearchDTO imageDto) {
+    public void cropImage(ImageSearchResult imageDto) {
     	double x = imageDto.getImageLocation().getTopLeft().x;
     	double y = imageDto.getImageLocation().getTopLeft().y;
     	double width = imageDto.getImageLocation().getWidth();
diff --git a/src/main/java/library/ImageRecognition.java b/src/main/java/library/ImageRecognition.java
@@ -12,8 +12,9 @@
 import org.slf4j.LoggerFactory;
 
 import dtos.ImageLocation;
-import dtos.ImageRecognitionSettingsDTO;
-import dtos.ImageSearchDTO;
+import dtos.ImageRecognitionSettings;
+import dtos.ImageSearchResult;
+import dtos.PlatformType;
 
 public class ImageRecognition {
 
@@ -24,23 +25,23 @@ private static void log(String message) {
     }
 	
 	
-    public static ImageLocation findImage(String image, String scene, String platformName, Dimension screenSize) throws Exception {
-    	ImageRecognitionSettingsDTO setting = new ImageRecognitionSettingsDTO();
-    	return findImage(image, scene, setting, platformName, screenSize);
+    public static ImageLocation findImage(String image, String scene, PlatformType platform, Dimension screenSize) throws Exception {
+    	ImageRecognitionSettings setting = new ImageRecognitionSettings();
+    	return findImage(image, scene, setting, platform, screenSize);
     }
     
     
     //This method calls on the Akaze scripts to find the coordinates of a given image in another image.
     //The "image" parameter is the image that you are searching for
     //The "scene" parameter is the image in which we are looking for "image"
     // "tolerance" sets the required accuracy for the image recognition algorithm.
-    public static ImageLocation findImage(String image, String scene, ImageRecognitionSettingsDTO settings, String platformName, Dimension screenSize) throws Exception {
+    public static ImageLocation findImage(String image, String scene, ImageRecognitionSettings settings, PlatformType platform, Dimension screenSize) throws Exception {
         log("Searching for " + image);
         log("Searching in " + scene);
         ImageLocation imgLocation = findImageUsingAkaze(image, scene, settings);
 
         if (imgLocation != null) {
-            if (platformName.equalsIgnoreCase("iOS")) {
+            if (platform.equals(PlatformType.IOS)) {
             	imgLocation = scaleImageRectangleForIos(screenSize, imgLocation, scene);
             }
             Point center = imgLocation.getCenter();
@@ -55,7 +56,7 @@ public static ImageLocation findImage(String image, String scene, ImageRecogniti
 
 
 
-	private static ImageLocation findImageUsingAkaze(String image, String scene, ImageRecognitionSettingsDTO settings) {
+	private static ImageLocation findImageUsingAkaze(String image, String scene, ImageRecognitionSettings settings) {
 		ImageLocation location = imageFinder.findImage(image, scene, settings.getTolerance());
 		return location;
 	}
@@ -106,14 +107,14 @@ private static boolean isPointInsideScreenBounds(Point center, Dimension screenS
 	
 	
 	public static boolean hasImageDissappearedFromScreenBeforeTimeout(String imageFile,
-			String screenshotsFolder, Dimension screenSize, String platformName) throws Exception {
+			String screenshotsFolder, Dimension screenSize, PlatformType platform) throws Exception {
 		log("==> Trying to find image: " + imageFile);
         int retry_counter=0;
         long start = System.nanoTime();
         while (((System.nanoTime() - start) / 1e6 / 1000 < 300)) {
         	String screenshotName = parseFileName(imageFile) + "_screenshot_"+retry_counter;
-			String screenShotFile = ImageRecognition.takeScreenshot(screenshotName, screenshotsFolder, platformName);
-			if ((findImage(imageFile, screenShotFile, platformName, screenSize)) == null) {
+			String screenShotFile = ImageRecognition.takeScreenshot(screenshotName, screenshotsFolder, platform);
+			if ((findImage(imageFile, screenShotFile, platform, screenSize)) == null) {
         		log("Image has successfully disappeared from screen.");
         		return true;
         	}
@@ -153,22 +154,22 @@ public static String getTextStringFromImage(String imageInput) {
     
     
     
-    public static ImageSearchDTO findImageOnScreen(String imageFile, String screenshotsFolder, ImageRecognitionSettingsDTO settings, Dimension screenSize, String platformName) throws InterruptedException, IOException, Exception {
-    	ImageSearchDTO foundImageDto = findImageLoop(imageFile, screenshotsFolder, settings, screenSize, platformName);
+    public static ImageSearchResult findImageOnScreen(String imageFile, String screenshotsFolder, ImageRecognitionSettings settings, Dimension screenSize, PlatformType platform) throws InterruptedException, IOException, Exception {
+    	ImageSearchResult foundImageDto = findImageLoop(imageFile, screenshotsFolder, settings, screenSize, platform);
         if (foundImageDto.isFound() && settings.isCrop()) {
         	cropImage(foundImageDto);
         }
         return foundImageDto;
     }
     
-	private static ImageSearchDTO findImageLoop(String imageFile, String screenshotsFolder, ImageRecognitionSettingsDTO settings, Dimension screenSize, String platformName) throws InterruptedException, IOException, Exception {
+	private static ImageSearchResult findImageLoop(String imageFile, String screenshotsFolder, ImageRecognitionSettings settings, Dimension screenSize, PlatformType platform) throws InterruptedException, IOException, Exception {
 		long start_time = System.nanoTime();
-		ImageSearchDTO foundImageDto = new ImageSearchDTO();
+		ImageSearchResult foundImageDto = new ImageSearchResult();
 		String imageName = parseFileName(imageFile);
 		for (int i = 0; i < settings.getRetries(); i++) {
 			String screenshotName = imageName + "_screenshot_"+i;
-			String screenshotFile = takeScreenshot(screenshotName,screenshotsFolder, platformName);
-			ImageLocation imageLocation = ImageRecognition.findImage(imageFile, screenshotFile, settings, platformName, screenSize);
+			String screenshotFile = takeScreenshot(screenshotName,screenshotsFolder, platform);
+			ImageLocation imageLocation = ImageRecognition.findImage(imageFile, screenshotFile, settings, platform, screenSize);
             if (imageLocation!=null){
             	long end_time = System.nanoTime();
                 int difference = (int) ((end_time - start_time) / 1e6 / 1000);
@@ -183,13 +184,13 @@ private static ImageSearchDTO findImageLoop(String imageFile, String screenshots
 		return foundImageDto;
 	}
 	
-	private static void cropImage(ImageSearchDTO foundImage) {
+	private static void cropImage(ImageSearchResult foundImage) {
 		log("Cropping image..");
 		imageFinder.cropImage(foundImage);
 		log("Cropping image.. Succeeded!");
 	}
     
-	private static void retryWait(ImageRecognitionSettingsDTO settings) throws InterruptedException {
+	private static void retryWait(ImageRecognitionSettings settings) throws InterruptedException {
 		if (settings.getRetryWaitTime() > 0) {
 		    log("retryWait given, sleeping " + settings.getRetryWaitTime() + " seconds.");
 		    sleep(settings.getRetryWaitTime());
@@ -211,18 +212,18 @@ private static void sleep(int seconds) throws InterruptedException {
     	}
 
      */
-    public static String takeScreenshot(String screenshotName, String screenshotsFolder, String platformName) throws Exception {
+    public static String takeScreenshot(String screenshotName, String screenshotsFolder, PlatformType platform) throws Exception {
     	long start_time = System.nanoTime();
     	
     	String screenshotFile = screenshotsFolder + screenshotName + ".png";
 		String fullFileName = System.getProperty("user.dir") + "/" + screenshotFile;
 
-		if (platformName.equalsIgnoreCase("iOS")) {
+		if (platform.equals(PlatformType.IOS)) {
     		takeIDeviceScreenshot(fullFileName);
-    	} else if (platformName.equalsIgnoreCase("Android")) {
+    	} else if (platform.equals(PlatformType.ANDROID)) {
     		takeAndroidScreenshot(fullFileName);
     	} else{
-    		throw new Exception("Invalid platformName: "+platformName);
+    		throw new Exception("Invalid platformType: "+platform);
     	}
 		
     	long end_time = System.nanoTime();

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`package dtos;`
`2`	`2`
`3`		`-public class ImageSearchDTO {`
	`3`	`+public class ImageSearchResult {`
`4`	`4`
`5`		`- public ImageSearchDTO(){`
	`5`	`+ public ImageSearchResult(){`
`6`	`6`	`this.screenshotFile = null;`
`7`	`7`	`this.imageLocation = null;`
`8`	`8`	`}`
`9`	`9`
`10`		`- public ImageSearchDTO(String screenshotFile, ImageLocation imageLocation){`
	`10`	`+ public ImageSearchResult(String screenshotFile, ImageLocation imageLocation){`
`11`	`11`	`this.screenshotFile = screenshotFile;`
`12`	`12`	`this.imageLocation = imageLocation;`
`13`	`13`	`}`