feat: Implement HasBiDi interface support in AppiumDriver (#2250)

Author: mykola-mokhnach

.github/workflows/gradle.yml

@@ -19,6 +19,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
+  CI: true
   ANDROID_SDK_VERSION: "28"
   ANDROID_EMU_NAME: test
   ANDROID_EMU_TARGET: default

src/e2eAndroidTest/java/io/appium/java_client/android/AndroidContextTest.java

@@ -20,6 +20,7 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
+import static io.appium.java_client.HasBrowserCheck.NATIVE_CONTEXT;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
@@ -31,7 +32,7 @@ public class AndroidContextTest extends BaseAndroidTest {
     }
 
     @Test public void testGetContext() {
-        assertEquals("NATIVE_APP", driver.getContext());
+        assertEquals(NATIVE_CONTEXT, driver.getContext());
     }
 
     @Test public void testGetContextHandles() {
@@ -42,8 +43,8 @@ public class AndroidContextTest extends BaseAndroidTest {
         driver.getContextHandles();
         driver.context("WEBVIEW_io.appium.android.apis");
         assertEquals(driver.getContext(), "WEBVIEW_io.appium.android.apis");
-        driver.context("NATIVE_APP");
-        assertEquals(driver.getContext(), "NATIVE_APP");
+        driver.context(NATIVE_CONTEXT);
+        assertEquals(driver.getContext(), NATIVE_CONTEXT);
     }
 
     @Test public void testContextError() {

src/e2eAndroidTest/java/io/appium/java_client/android/AndroidFunctionTest.java

@@ -18,6 +18,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import static io.appium.java_client.HasBrowserCheck.NATIVE_CONTEXT;
 import static java.time.Duration.ofMillis;
 import static java.time.Duration.ofSeconds;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -75,7 +76,7 @@ public static void startWebViewActivity() {
     @BeforeEach
     public void setUp() {
 
-        driver.context("NATIVE_APP");
+        driver.context(NATIVE_CONTEXT);
     }
 
     @Test

src/e2eIosTest/java/io/appium/java_client/ios/AppIOSTest.java

@@ -21,6 +21,7 @@ public static void beforeClass() {
                 .setDeviceName(DEVICE_NAME)
                 .setCommandTimeouts(Duration.ofSeconds(240))
                 .setApp(TEST_APP_ZIP)
+                .enableBiDi()
                 .setWdaLaunchTimeout(WDA_LAUNCH_TIMEOUT);
         try {
             driver = new IOSDriver(service.getUrl(), options);

src/e2eIosTest/java/io/appium/java_client/ios/BaseIOSWebViewTest.java

@@ -39,7 +39,6 @@ public static void beforeClass() {
                 .setDeviceName(DEVICE_NAME)
                 .setWdaLaunchTimeout(WDA_LAUNCH_TIMEOUT)
                 .setCommandTimeouts(Duration.ofSeconds(240))
-                .setShowIosLog(true)
                 .setApp(VODQA_ZIP);
         Supplier<IOSDriver> createDriver = () -> new IOSDriver(service.getUrl(), options);
         try {

src/e2eIosTest/java/io/appium/java_client/ios/IOSBiDiTest.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.java_client.ios;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.openqa.selenium.bidi.log.LogEntry;
+import org.openqa.selenium.bidi.module.LogInspector;
+
+import java.util.concurrent.CopyOnWriteArrayList;
+
+import static io.appium.java_client.HasBrowserCheck.NATIVE_CONTEXT;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+
+public class IOSBiDiTest extends AppIOSTest {
+
+    @Test
+    @Disabled("Need to resolve compatibility issues")
+    public void listenForIosLogs() {
+        var logs = new CopyOnWriteArrayList<LogEntry>();
+        try (var logInspector = new LogInspector(NATIVE_CONTEXT, driver)) {
+            logInspector.onLog(logs::add);
+            driver.getPageSource();
+        }
+        assertFalse(logs.isEmpty());
+    }
+
+}

src/e2eIosTest/java/io/appium/java_client/ios/IOSContextTest.java

@@ -19,6 +19,7 @@
 import io.appium.java_client.NoSuchContextException;
 import org.junit.jupiter.api.Test;
 
+import static io.appium.java_client.HasBrowserCheck.NATIVE_CONTEXT;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.StringContains.containsString;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -27,7 +28,7 @@
 public class IOSContextTest extends BaseIOSWebViewTest {
 
     @Test public void testGetContext() {
-        assertEquals("NATIVE_APP", driver.getContext());
+        assertEquals(NATIVE_CONTEXT, driver.getContext());
     }
 
     @Test public void testGetContextHandles() {
@@ -38,7 +39,7 @@ public class IOSContextTest extends BaseIOSWebViewTest {
         driver.getContextHandles();
         findAndSwitchToWebView();
         assertThat(driver.getContext(), containsString("WEBVIEW"));
-        driver.context("NATIVE_APP");
+        driver.context(NATIVE_CONTEXT);
     }
 
     @Test public void testContextError() {

src/e2eIosTest/java/io/appium/java_client/ios/IOSWebViewTest.java

@@ -1,6 +1,8 @@
 package io.appium.java_client.ios;
 
 import io.appium.java_client.AppiumBy;
+import io.appium.java_client.TestUtils;
+import org.junit.jupiter.api.Assumptions;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.support.ui.ExpectedConditions;
@@ -15,6 +17,9 @@ public class IOSWebViewTest extends BaseIOSWebViewTest {
 
     @Test
     public void webViewPageTestCase() throws InterruptedException {
+        // this test is not stable in the CI env
+        Assumptions.assumeFalse(TestUtils.isCiEnv());
+
         new WebDriverWait(driver, LOOKUP_TIMEOUT)
                 .until(ExpectedConditions.presenceOfElementLocated(By.id("login")))
                 .click();