fix: introduce MobileBy.className

The change made in Selenium 4 (SeleniumHQ/selenium@0aaa401#r58091435)
broke Appium `class name` selector strategy. The workaround was implemented: `MobileBy#className`.

Author: valfirst

src/main/java/io/appium/java_client/MobileBy.java

@@ -162,6 +162,15 @@ public static By custom(final String selector) {
         return new ByCustom(selector);
     }
 
+    /**
+     * For IOS it is the full name of the XCUI element and begins with XCUIElementType.
+     * For Android it is the full name of the UIAutomator2 class (e.g.: android.widget.TextView)
+     * @param selector the class name of the element
+     * @return an instance of {@link ByClassName}
+     */
+    public static By className(final String selector) {
+        return new ByClassName(selector);
+    }
 
     public static class ByAndroidUIAutomator extends MobileBy implements Serializable {
 
@@ -270,6 +279,17 @@ public ByAndroidViewTag(String tag) {
             return "By.AndroidViewTag: " + getLocatorString();
         }
     }
+
+    public static class ByClassName extends MobileBy implements Serializable {
+
+        protected ByClassName(String selector) {
+            super("class name", selector);
+        }
+
+        @Override public String toString() {
+            return "By.className: " + getLocatorString();
+        }
+    }
 }
 
 

src/main/java/io/appium/java_client/pagefactory/bys/builder/Strategies.java

@@ -46,7 +46,7 @@ enum Strategies {
     },
     BYCLASSNAME("className") {
         @Override By getBy(Annotation annotation) {
-            return By.className(getValue(annotation, this));
+            return MobileBy.className(getValue(annotation, this));
         }
     },
     BYID("id") {

src/test/java/io/appium/java_client/android/AndroidAbilityToUseSupplierTest.java

@@ -21,7 +21,7 @@ public class AndroidAbilityToUseSupplierTest extends BaseAndroidTest {
         driver.findElement(By.id("io.appium.android.apis:id/gallery"));
 
         AndroidElement gallery = driver.findElement(By.id("io.appium.android.apis:id/gallery"));
-        List<MobileElement> images = gallery.findElements(By.className("android.widget.ImageView"));
+        List<MobileElement> images = gallery.findElements(MobileBy.className("android.widget.ImageView"));
         Point location = gallery.getLocation();
         Point center = gallery.getCenter();
 
@@ -48,12 +48,13 @@ public class AndroidAbilityToUseSupplierTest extends BaseAndroidTest {
         Activity activity = new Activity("io.appium.android.apis", ".view.Gallery1");
         driver.startActivity(activity);
         AndroidElement gallery = driver.findElement(By.id("io.appium.android.apis:id/gallery"));
-        List<MobileElement> images = gallery.findElements(By.className("android.widget.ImageView"));
+        List<MobileElement> images = gallery.findElements(MobileBy.className("android.widget.ImageView"));
         int originalImageCount = images.size();
 
         horizontalSwipe.get().perform();
 
-        assertNotEquals(originalImageCount, gallery.findElements(By.className("android.widget.ImageView")).size());
+        assertNotEquals(originalImageCount,
+                gallery.findElements(MobileBy.className("android.widget.ImageView")).size());
     }
 
     @Test public void verticalSwipingWithSupplier() throws Exception {

src/test/java/io/appium/java_client/android/AndroidTouchTest.java

@@ -9,9 +9,11 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotEquals;
 
+import io.appium.java_client.MobileBy;
 import io.appium.java_client.MobileElement;
 import io.appium.java_client.MultiTouchAction;
 import io.appium.java_client.TouchAction;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.openqa.selenium.By;
@@ -169,7 +171,7 @@ public void setUp() {
         driver.startActivity(activity);
 
         AndroidElement gallery = driver.findElement(By.id("io.appium.android.apis:id/gallery"));
-        List<MobileElement> images = gallery.findElements(By.className("android.widget.ImageView"));
+        List<MobileElement> images = gallery.findElements(MobileBy.className("android.widget.ImageView"));
         int originalImageCount = images.size();
         Point location = gallery.getLocation();
         Point center = gallery.getCenter();
@@ -180,7 +182,8 @@ public void setUp() {
                 .moveTo(element(gallery,10,center.y - location.y))
                 .release();
         swipe.perform();
-        assertNotEquals(originalImageCount, gallery.findElements(By.className("android.widget.ImageView")).size());
+        assertNotEquals(originalImageCount,
+                gallery.findElements(MobileBy.className("android.widget.ImageView")).size());
     }
 
     @Test public void multiTouchTest() {

src/test/java/io/appium/java_client/events/BaseListenerTest.java

@@ -39,7 +39,7 @@ protected boolean assertThatSearchListenerWorks(EmptyWebDriver driver, TestListe
                             prefix + "The searching for something using By.id: someId2 has beed finished. "
                                     + "The root element was null"));
 
-            driver.findElement(By.id("someId")).findElement(By.className("someClazz"));
+            driver.findElement(By.id("someId")).findElement(MobileBy.className("someClazz"));
 
             assertThat(listener.messages,
                     contains(prefix + "Attempt to find something using By.id: someId. The root element is null",
@@ -57,7 +57,7 @@ protected boolean assertThatSearchListenerWorks(EmptyWebDriver driver, TestListe
                             prefix + "The searching for something using By.className: someClazz has beed finished. "
                                     + "The root element was io.appium.java_client.events.StubWebElement"));
 
-            driver.findElements(By.id("someId2")).get(0).findElements(By.className("someClazz2"));
+            driver.findElements(By.id("someId2")).get(0).findElements(MobileBy.className("someClazz2"));
             assertThat(listener.messages,
                     contains(prefix + "Attempt to find something using By.id: someId. The root element is null",
                              prefix + "The searching for something using By.id: someId has beed finished. "

src/test/java/io/appium/java_client/ios/IOSElementTest.java

@@ -29,7 +29,7 @@ public void setValueTest() {
         WebDriverWait wait = new WebDriverWait(driver, 20);
 
         IOSElement slider = wait.until(
-                driver1 -> driver1.findElement(By.className("XCUIElementTypeSlider")));
+                driver1 -> driver1.findElement(MobileBy.className("XCUIElementTypeSlider")));
         slider.setValue("0%");
         assertEquals("0%", slider.getAttribute("value"));
     }

src/test/java/io/appium/java_client/ios/IOSTouchTest.java

@@ -75,7 +75,7 @@ public void touchWithPressureTest() {
 
         IOSTouchAction iosTouchAction = new IOSTouchAction(driver);
         iosTouchAction.doubleTap(element(firstField));
-        IOSElement editingMenu = driver.findElement(By.className("XCUIElementTypeTextField"));
+        IOSElement editingMenu = driver.findElement(MobileBy.className("XCUIElementTypeTextField"));
         assertNotNull(editingMenu);
     }
 }