Add examples for Drivers HTTP Client in Java and Python (SeleniumHQ#2041

) * Add examples for http_client java and python * Updated for other languages * Fix flaky test in examples python (SeleniumHQ#2042) [deploy site] --------- Signed-off-by: Viet Nguyen Duc <[email protected]>
pallavigitwork · Nov 5, 2024 · 2ce6752 · 2ce6752
1 parent e2defad
commit 2ce6752
Show file tree

Hide file tree

Showing 28 changed files with 476 additions and 97 deletions.
diff --git a/.github/workflows/java-examples.yml b/.github/workflows/java-examples.yml
@@ -45,43 +45,50 @@ jobs:
       if: matrix.os == 'ubuntu'
       run: Xvfb :99 &
     - name: Set up Java
+      id: java
       uses: actions/setup-java@v4
       with:
         distribution: 'temurin'
         java-version: 17
+    - name: Import test cert non-Windows
+      if: matrix.os != 'windows'
+      run: sudo keytool -import -noprompt -trustcacerts -alias SeleniumHQ -file examples/java/src/test/resources/tls.crt -keystore ${{ steps.java.outputs.path }}/lib/security/cacerts -storepass changeit
+    - name: Import test cert Windows
+      if: matrix.os == 'windows'
+      run: keytool -import -noprompt -trustcacerts -alias SeleniumHQ -file examples/java/src/test/resources/tls.crt -keystore ${{ steps.java.outputs.path }}/lib/security/cacerts -storepass changeit
     - name: Run Tests Stable
       if: matrix.release == 'stable'
       uses: nick-invision/[email protected]
       with:
-        timeout_minutes: 20
+        timeout_minutes: 40
         max_attempts: 3
         command: |
           cd examples/java
-          mvn -B test
+          mvn -B test -D"jdk.internal.httpclient.disableHostnameVerification=true"
     - name: Run Tests Nightly Linux/macOS
       if: matrix.release == 'nightly' && matrix.os != 'windows'
       uses: nick-invision/[email protected]
       with:
-        timeout_minutes: 20
+        timeout_minutes: 40
         max_attempts: 3
         command: |
           pip install yq
           xml_content=$(curl -sf https://oss.sonatype.org/service/local/repositories/snapshots/content/org/seleniumhq/selenium/selenium-java/)
           latest_snapshot=$(echo "$xml_content" | xq '.content.data."content-item"' | jq -r 'sort_by(.lastModified) | last | .text')
           echo "Latest Selenium Snapshot: $latest_snapshot"
           cd examples/java
-          mvn -B -U test -Dselenium.version="$latest_snapshot"
+          mvn -B -U test -D"jdk.internal.httpclient.disableHostnameVerification=true"
 
     - name: Run Tests Nightly Windows
       if: matrix.release == 'nightly' && matrix.os == 'windows'
       uses: nick-invision/[email protected]
       with:
-        timeout_minutes: 20
+        timeout_minutes: 40
         max_attempts: 3
         command: |
           pip install yq          
           $xml_content = Invoke-WebRequest -Uri "https://oss.sonatype.org/service/local/repositories/snapshots/content/org/seleniumhq/selenium/selenium-java/"
           $latest_snapshot = $xml_content.Content | xq '.content.data.\"content-item\"' | jq -r 'sort_by(.lastModified) | last | .text'
           Write-Output "Latest Selenium Snapshot: $latest_snapshot"
           cd examples/java
-          mvn -B -U test "-Dselenium.version=$latest_snapshot"
+          mvn -B -U test -D"jdk.internal.httpclient.disableHostnameVerification=true"
diff --git a/.github/workflows/python-examples.yml b/.github/workflows/python-examples.yml
@@ -80,7 +80,7 @@ jobs:
     - name: Run tests
       uses: nick-invision/[email protected]
       with:
-        timeout_minutes: 20
+        timeout_minutes: 40
         max_attempts: 3
         command: |
           cd examples/python

diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,5 @@ website_and_docs/resources
 .settings
 .gitignore
 .pydevproject
+**/*.iml
+**/.gradle
diff --git a/examples/java/src/test/java/dev/selenium/BaseTest.java b/examples/java/src/test/java/dev/selenium/BaseTest.java
@@ -4,6 +4,7 @@
 import java.io.IOException;
 import java.net.URL;
 import java.nio.file.Files;
+import java.nio.file.Path;
 import java.time.Duration;
 import java.util.Arrays;
 import java.util.logging.Level;
@@ -26,6 +27,9 @@ public class BaseTest {
   protected WebDriverWait wait;
   protected File driverPath;
   protected File browserPath;
+  protected String username = "admin";
+  protected String password = "myStrongPassword";
+  protected String trustStorePassword = "seleniumkeystore";
 
   public WebElement getLocatedElement(WebDriver driver, By by) {
     WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(5));
@@ -98,6 +102,38 @@ protected URL startStandaloneGrid() {
     }
   }
 
+  protected URL startStandaloneGridAdvanced() {
+    int port = PortProber.findFreePort();
+    try {
+      System.setProperty("javax.net.ssl.trustStore", Path.of("src/test/resources/server.jks").toAbsolutePath().toString());
+      System.setProperty("javax.net.ssl.trustStorePassword", trustStorePassword);
+      System.setProperty("jdk.internal.httpclient.disableHostnameVerification", "true");
+      Main.main(
+              new String[] {
+                      "standalone",
+                      "--port",
+                      String.valueOf(port),
+                      "--selenium-manager",
+                      "true",
+                      "--enable-managed-downloads",
+                      "true",
+                      "--log-level",
+                      "WARNING",
+                      "--username",
+                      username,
+                      "--password",
+                      password,
+                      "--https-certificate",
+                      Path.of("src/test/resources/tls.crt").toAbsolutePath().toString(),
+                      "--https-private-key",
+                      Path.of("src/test/resources/tls.key").toAbsolutePath().toString()
+              });
+      return new URL("https://localhost:" + port);
+    } catch (Exception e) {
+      throw new RuntimeException(e);
+    }
+  }
+
   protected void enableLogging() {
     Logger logger = Logger.getLogger("");
     logger.setLevel(Level.FINE);

diff --git a/examples/java/src/test/java/dev/selenium/drivers/HttpClientTest.java b/examples/java/src/test/java/dev/selenium/drivers/HttpClientTest.java
@@ -2,6 +2,104 @@
 
 import dev.selenium.BaseTest;
 
+import org.openqa.selenium.remote.http.ClientConfig;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.openqa.selenium.chrome.ChromeOptions;
+import org.openqa.selenium.remote.RemoteWebDriver;
+
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.TrustManagerFactory;
+import javax.net.ssl.X509TrustManager;
+import java.io.FileInputStream;
+import java.net.URL;
+import java.nio.file.Path;
+import java.security.KeyStore;
+import java.security.cert.CertificateFactory;
+import java.security.cert.X509Certificate;
+import java.time.Duration;
+
+import org.openqa.selenium.UsernameAndPassword;
+
+import static java.net.http.HttpClient.Version.HTTP_1_1;
+
 public class HttpClientTest extends BaseTest {
+    URL gridUrl;
+
+    @BeforeEach
+    public void startGrid() {
+        gridUrl = startStandaloneGridAdvanced();
+    }
+
+    @Test
+    public void remoteWebDriverWithClientConfig() throws Exception {
+        ClientConfig clientConfig = ClientConfig.defaultConfig()
+                .withRetries()
+                .sslContext(createSSLContextWithCA(Path.of("src/test/resources/tls.crt").toAbsolutePath().toString()))
+                .connectionTimeout(Duration.ofSeconds(300))
+                .readTimeout(Duration.ofSeconds(3600))
+                .authenticateAs(new UsernameAndPassword("admin", "myStrongPassword"))
+                .version(HTTP_1_1.toString());
+        ChromeOptions options = new ChromeOptions();
+        options.setEnableDownloads(true);
+        driver = RemoteWebDriver.builder()
+                .oneOf(options)
+                .address(gridUrl)
+                .config(clientConfig)
+                .build();
+        driver.quit();
+    }
+
+    @Test
+    public void remoteWebDriverIgnoreSSL() throws Exception {
+        ClientConfig clientConfig = ClientConfig.defaultConfig()
+                .withRetries()
+                .sslContext(createIgnoreSSLContext())
+                .connectionTimeout(Duration.ofSeconds(300))
+                .readTimeout(Duration.ofSeconds(3600))
+                .authenticateAs(new UsernameAndPassword("admin", "myStrongPassword"))
+                .version(HTTP_1_1.toString());
+        ChromeOptions options = new ChromeOptions();
+        options.setEnableDownloads(true);
+        driver = RemoteWebDriver.builder()
+                .oneOf(options)
+                .address(gridUrl)
+                .config(clientConfig)
+                .build();
+        driver.quit();
+    }
+
+    public static SSLContext createSSLContextWithCA(String caCertPath) throws Exception {
+        FileInputStream fis = new FileInputStream(caCertPath);
+        CertificateFactory cf = CertificateFactory.getInstance("X.509");
+        X509Certificate caCert = (X509Certificate) cf.generateCertificate(fis);
+        KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
+        keyStore.load(null, null);
+        keyStore.setCertificateEntry("caCert", caCert);
+        TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
+        tmf.init(keyStore);
+        SSLContext sslContext = SSLContext.getInstance("TLS");
+        sslContext.init(null, tmf.getTrustManagers(), null);
+        return sslContext;
+    }
+
+    public static SSLContext createIgnoreSSLContext() throws Exception {
+        TrustManager[] trustAllCerts = new TrustManager[]{
+                new X509TrustManager() {
+                    public X509Certificate[] getAcceptedIssuers() {
+                        return null;
+                    }
+
+                    public void checkClientTrusted(X509Certificate[] certs, String authType) {
+                    }
 
+                    public void checkServerTrusted(X509Certificate[] certs, String authType) {
+                    }
+                }
+        };
+        SSLContext sslContext = SSLContext.getInstance("TLS");
+        sslContext.init(null, trustAllCerts, new java.security.SecureRandom());
+        return sslContext;
+    }
 }
diff --git a/examples/java/src/test/resources/server.jks b/examples/java/src/test/resources/server.jks
diff --git a/examples/java/src/test/resources/tls.crt b/examples/java/src/test/resources/tls.crt
@@ -0,0 +1,24 @@
+-----BEGIN CERTIFICATE-----
+MIIEAzCCAuugAwIBAgIIPgWI/2ppJPowDQYJKoZIhvcNAQELBQAwgYcxEDAOBgNV
+BAYTB1Vua25vd24xEDAOBgNVBAgTB1Vua25vd24xEDAOBgNVBAcTB1Vua25vd24x
+EzARBgNVBAoTClNlbGVuaXVtSFExJTAjBgNVBAsTHFNvZnR3YXJlIEZyZWVkb20g
+Q29uc2VydmFuY3kxEzARBgNVBAMTClNlbGVuaXVtSFEwHhcNMjQxMTAzMDkwMDUz
+WhcNMzQxMTAxMDkwMDUzWjCBhzEQMA4GA1UEBhMHVW5rbm93bjEQMA4GA1UECBMH
+VW5rbm93bjEQMA4GA1UEBxMHVW5rbm93bjETMBEGA1UEChMKU2VsZW5pdW1IUTEl
+MCMGA1UECxMcU29mdHdhcmUgRnJlZWRvbSBDb25zZXJ2YW5jeTETMBEGA1UEAxMK
+U2VsZW5pdW1IUTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKVTx0e5
+6/75QgE5E6rTYPlTkIxDjZylOMT2YBNuB8vIFZkSaCtLEqto0XTVV6dQc8Ge41QV
+rkt7DID1oN40rvWZdla9/2bVhCsWsRiXlvrKDbjoUi5kiLcfKJW+erUWs28xnLOw
+bvGNLLAjEUitKKGpR1vsSMOuvMN9VnsSkn9smAHLT2y41CjKpvdkq+OCUdnqfYju
+vV6OthRPXFMsDb1fYqZfE7fZhLc806Rg31qLssNVPwxt6VeNYi1/e5cWYeKIJQoj
+sFkqIdvu7xHtR7Qu1tNdeQoiDhMS7VLdZDsnAAtQLHvyAVEBicBX95VrGnOTlKdk
++UDwyOP6djCISzUCAwEAAaNxMG8wHQYDVR0OBBYEFNrLCgZ7d2vfurWaJ4wa8O/T
+PfXPME4GA1UdEQEB/wREMEKCCWxvY2FsaG9zdIITc2VsZW5pdW0tZ3JpZC5sb2Nh
+bIISc2VsZW5pdW0tZ3JpZC5wcm9kggxzZWxlbml1bS5kZXYwDQYJKoZIhvcNAQEL
+BQADggEBABtxoPrVrPO5ELzUuSXbvYKHQG9YEuoAisXsiOWmldXRRvT/yTr3nzJn
+bC4dJywMW5unPdq1NoMxza0AF0KBFp1GzLDW5/KcA26R4IQi2xfQKVyRzb4vu0CY
+BDbnzF7Bisj50sSI4WThtF4xLEHVmzJ2GWNp6SgAScIrdGeB320aTqUIDO8YHH+y
+oeSu6qQfEcDiBWh3KD85vCIx0+L4AM3WKkP5nDq2FL6nwCdxqV7bo5/BZJEODMiW
+xv/hw0r1OBn2T2Z6o3pRI92zu9sjj6PzPP80DUPl7+fqAaRlLFglXd8b+Qxojm9o
+B0QN+gEM717L6WqmJGr1VC6HWQCvcCc=
+-----END CERTIFICATE-----
diff --git a/examples/java/src/test/resources/tls.key b/examples/java/src/test/resources/tls.key
@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQClU8dHuev++UIB
+OROq02D5U5CMQ42cpTjE9mATbgfLyBWZEmgrSxKraNF01VenUHPBnuNUFa5LewyA
+9aDeNK71mXZWvf9m1YQrFrEYl5b6yg246FIuZIi3HyiVvnq1FrNvMZyzsG7xjSyw
+IxFIrSihqUdb7EjDrrzDfVZ7EpJ/bJgBy09suNQoyqb3ZKvjglHZ6n2I7r1ejrYU
+T1xTLA29X2KmXxO32YS3PNOkYN9ai7LDVT8MbelXjWItf3uXFmHiiCUKI7BZKiHb
+7u8R7Ue0LtbTXXkKIg4TEu1S3WQ7JwALUCx78gFRAYnAV/eVaxpzk5SnZPlA8Mjj
++nYwiEs1AgMBAAECggEAA2D+tT3SGlmG9Tube2CLaRUW4shSVDBWmcSXn+teBUFv
+MDwdfRMGoZJdw4eaXWz0wgaItV7QZjJbMKXfK44ZQaOTtP/4QLuzkjuKE4tXloO7
+e5BjS5eaPrSIPGU9S0cDPvjH2oP22dYi4sJYt6ry+2ODC0Mn6o3p8Dc3Ja1HvrXA
+SNImimok7YemXVMbdPyaqbu2eXjPvWAA8W9/OW2L1n4U4neM0S5Nt3tVl5sMELj5
+iFC7Z+M3ZLon/54137h3xPmHYQMiPIX+PulaRLOJYSbR0dtMHhPMyWtR7GwEK4Aw
+EgtDLKfa6qMv5BYsI2E0bPHRDaj39UXGeWX5/2xzyQKBgQDcMUL3sEbRmeBKhYlT
+xv5ea2P4P247DDWObTDw5jLhwfmOycFcJVlaiXICpGR6hqWY8wI7kKxbQQVKFob6
+JVpIHmkkRqsV8JfXVAcaH1thlKAS4NVZsOJIVBHO3JdPaCUFq7HHbBA3436aJLtC
+HiINkuiNXd2dDMuDwOsfhsRFzQKBgQDANnK1P7sZSP7dJHinA2sPSbGAK8ZTbYWD
+8oe/lYlLkw6qM9i8vIKCfTpfi4vh4qfjQUczdy1w2zFbxriC2+uxhEqDN2tud3/P
+0CYrO0SGQKYCROrYUh0Pl1MswBeu8yT5AdrIBK3t92wfYqTWK7VUZQaUQ7YJWfXS
+usbz5qIzCQKBgH8ICHt+/gxUOtqjWYu0pPFyATWp2n1EWO13PyHrnHU0BDaFXQE9
+JuSdoOG3V6R8Y7Lul14n49etllCc2Hgd7ozmxn/AKVm5+M+oUYSXjI+qQANEJLHe
+410Y60EtcDnGen1gBWtog57KpzJkeIf3fGvaUkGkYoMFa6/yL3N7u2YNAoGADH29
+WKAKpasDvRVYrenf9D9ixKSTn+pXKesB/WZXZMzqwA7cf+90P8yplXn5HjXfmTot
+yV9uWY41F/TDGuX13DRvrzVTyvsDGFs7j8WrP1pGL5GQ/XvgnZnE8vyMzXbJqVEA
+ic0cDIHuyd9cPPrcLt7d3ZbE5ris7APtV/5d/hkCgYAMFCYoKcCh+9/2HOgwQ1b6
+16CS71TvDBCx7+D1V3WXrIOWkNzW2SIZtnhQwglU9L7PFw6ViJAY4sB2p9hDDtcZ
+e7Lotmnbrb75QQpWUyaoZMsw8l23MOGPzHKPqNiT57uOorjcFrePi9EOdERSG9+4
+lRKqCFhaNBUwQ4idzO0rWA==
+-----END PRIVATE KEY-----
diff --git a/examples/python/requirements.txt b/examples/python/requirements.txt
@@ -3,3 +3,4 @@ pytest
 trio
 pytest-trio
 flake8
+requests
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ pytest @@
     trio
     pytest-trio
     flake8
+    requests