[+] Add support for selendroid locators in page object annotations

Author: clicman

src/main/java/io/appium/java_client/pagefactory/AppiumAnnotations.java

@@ -137,12 +137,14 @@ By getBy(Annotation annotation) {
 
 private final Field mobileField;
 private final String platform;
+private final String automation;
 
-AppiumAnnotations(Field field, String platform) {
+AppiumAnnotations(Field field, String platform, String automation) {
 super(field);
 mobileField = field;
 this.platform = String.valueOf(platform).
 toUpperCase().trim();
+this.automation = String.valueOf(automation);
 }
 
 private static void checkDisallowedAnnotationPairs(Annotation a1,
@@ -161,14 +163,31 @@ private void assertValidAnnotations() {
 .getAnnotation(AndroidFindBys.class);
 AndroidFindAll androidFindAll = mobileField.
 getAnnotation(AndroidFindAll.class);
-
+ 
+ SelendroidFindBy selendroidBy = mobileField
+.getAnnotation(SelendroidFindBy.class);
+SelendroidFindBys selendroidBys = mobileField
+.getAnnotation(SelendroidFindBys.class);
+SelendroidFindAll selendroidFindAll = mobileField.
+getAnnotation(SelendroidFindAll.class);
+
 iOSFindBy iOSBy = mobileField.getAnnotation(iOSFindBy.class);
 iOSFindBys iOSBys = mobileField.getAnnotation(iOSFindBys.class);
 iOSFindAll iOSFindAll = mobileField.getAnnotation(iOSFindAll.class);
 
 checkDisallowedAnnotationPairs(androidBy, androidBys);
+ checkDisallowedAnnotationPairs(androidBy, selendroidBys);
 checkDisallowedAnnotationPairs(androidBy, androidFindAll);
+checkDisallowedAnnotationPairs(androidBy, selendroidFindAll);
 checkDisallowedAnnotationPairs(androidBys, androidFindAll);
+checkDisallowedAnnotationPairs(androidBys, selendroidFindAll);
+
+checkDisallowedAnnotationPairs(selendroidBy, androidBys);
+ checkDisallowedAnnotationPairs(selendroidBy, selendroidBys);
+checkDisallowedAnnotationPairs(selendroidBy, androidFindAll);
+checkDisallowedAnnotationPairs(selendroidBy, selendroidFindAll);
+checkDisallowedAnnotationPairs(selendroidBys, androidFindAll);
+checkDisallowedAnnotationPairs(selendroidBys, selendroidFindAll);
 
 checkDisallowedAnnotationPairs(iOSBy, iOSBys);
 checkDisallowedAnnotationPairs(iOSBy, iOSFindAll);
@@ -248,12 +267,34 @@ private <T extends By> T getComplexMobileBy(Annotation[] annotations, Class<T> r
 public By buildBy() {
 assertValidAnnotations();
 
+ SelendroidFindBy selendroidBy = mobileField
+.getAnnotation(SelendroidFindBy.class);
+if (selendroidBy != null && ANDROID.toUpperCase().equals(platform) &&
+ "Selendroid".equals(automation)) {
+return getMobileBy(selendroidBy, getFilledValue(selendroidBy));
+}
+ 
+ SelendroidFindBys selendroidBys = mobileField
+.getAnnotation(SelendroidFindBys.class);
+if (selendroidBy != null && ANDROID.toUpperCase().equals(platform) &&
+ "Selendroid".equals(automation)) {
+return getMobileBy(selendroidBys, getFilledValue(selendroidBys));
+}
+ 
+ SelendroidFindAll selendroidAll = mobileField
+.getAnnotation(SelendroidFindAll.class);
+if (selendroidBy != null && ANDROID.toUpperCase().equals(platform) &&
+ "Selendroid".equals(automation)) {
+return getMobileBy(selendroidAll, getFilledValue(selendroidAll));
+}
+ 
+ 
 AndroidFindBy androidBy = mobileField
 .getAnnotation(AndroidFindBy.class);
 if (androidBy != null && ANDROID.toUpperCase().equals(platform)) {
 return getMobileBy(androidBy, getFilledValue(androidBy));
 }
-
+ 
 AndroidFindBys androidBys = mobileField
 .getAnnotation(AndroidFindBys.class);
 if (androidBys != null && ANDROID.toUpperCase().equals(platform)) {
@@ -265,6 +306,7 @@ public By buildBy() {
 return getComplexMobileBy(androidFindAll.value(), ByAll.class);
 }
 
+ 
 iOSFindBy iOSBy = mobileField.getAnnotation(iOSFindBy.class);
 if (iOSBy != null && IOS.toUpperCase().equals(platform)) {
 return getMobileBy(iOSBy, getFilledValue(iOSBy));

src/main/java/io/appium/java_client/pagefactory/AppiumElementLocator.java

@@ -71,7 +71,12 @@ public List<WebElement> apply(By by) {
 .valueOf(((HasCapabilities) unpackWebDriverFromSearchContext())
 .getCapabilities().getCapability(
 MobileCapabilityType.PLATFORM_NAME));
-AppiumAnnotations annotations = new AppiumAnnotations(field, platform);
+String automation = String
+.valueOf(((HasCapabilities) unpackWebDriverFromSearchContext())
+.getCapabilities().getCapability(
+MobileCapabilityType.AUTOMATION_NAME));
+ 
+AppiumAnnotations annotations = new AppiumAnnotations(field, platform, automation);
 this.timeOutContainer = timeOutContainer;
 shouldCache = annotations.isLookupCached();
 by = annotations.buildBy();

src/main/java/io/appium/java_client/pagefactory/SelendroidFindAll.java

@@ -0,0 +1,17 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Used to mark a field on a Page/Screen Object to indicate that lookup should use a series of {@link SelendroidFindBy} tags
+ * It will then search for all elements that match any criteria. Note that elements
+ * are not guaranteed to be in document order.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.TYPE})
+public @interface SelendroidFindAll {
+SelendroidFindBy[] value();
+}

src/main/java/io/appium/java_client/pagefactory/SelendroidFindBy.java

@@ -0,0 +1,26 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+
+/**
+ * Used to mark a field on a Page Object to indicate an alternative mechanism for locating the
+ * element or a list of elements. Used in conjunction with
+ * {@link org.openqa.selenium.support.PageFactory}
+ * this allows users to quickly and easily create PageObjects.
+ * using Android UI selectors, accessibility, id, name, class name, tag and xpath
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.TYPE})
+public @interface SelendroidFindBy {
+String uiAutomator() default "";
+String accessibility() default "";
+String id() default "";
+String name() default "";
+String className() default "";
+String tagName() default "";
+String xpath() default "";
+}

src/main/java/io/appium/java_client/pagefactory/SelendroidFindBys.java

@@ -0,0 +1,15 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Used to mark a field on a Page Object to indicate that lookup should use a series of @SelendroidFindBy tags
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.TYPE})
+public @interface SelendroidFindBys {
+SelendroidFindBy[] value();
+}