Drive Opera browser with 'chromedriver' (#293)

sbabcoc · web-flow · commit 018533d900f1 · 2025-06-02T19:28:09.000-07:00
diff --git a/build.gradle b/build.gradle
@@ -151,10 +151,10 @@ test {
 
 scmVersion {
   hooks {
-        pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(&lt;version&gt;)\d+\.\d+\.\d+(-s[34]&lt;\/version&gt;)/}, replacement: {v, p -> "\$1$v\$2"}]
-        pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(selenium-foundation:)\d+\.\d+\.\d+(-s[34])/}, replacement: {v, p -> "\$1$v\$2"}]
-        pre 'commit'
-        post 'push'
+    pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(&lt;version&gt;)\d+\.\d+\.\d+(-s[34]&lt;\/version&gt;)/}, replacement: {v, p -> "\$1$v\$2"}]
+    pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(selenium-foundation:)\d+\.\d+\.\d+(-s[34])/}, replacement: {v, p -> "\$1$v\$2"}]
+    pre 'commit'
+    post 'push'
   }
 }
 
diff --git a/src/main/java/com/nordstrom/automation/selenium/core/GridUtility.java b/src/main/java/com/nordstrom/automation/selenium/core/GridUtility.java
@@ -22,6 +22,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.ServiceConfigurationError;
 import java.util.ServiceLoader;
 import java.util.concurrent.TimeoutException;
@@ -209,6 +210,17 @@ public static String readAvailable(InputStream inputStream) throws IOException {
         return result.toString(StandardCharsets.UTF_8.name());
     }
 
+    /**
+     * Get the 'driverPath' value from the specified capabilities map.
+     * 
+     * @param capabilities map of capabilities
+     * @return 'driverPath' value; {@code null} if no 'driverPath' value is found
+     */
+    public static String getDriverPath(Capabilities capabilities) {
+        Map<String, Object> options = getNordOptions(capabilities);
+        return (String) Optional.ofNullable(options.get("driverPath")).orElse(null);
+    }
+    
     /**
      * Get the 'personality' value from the specified capabilities map.
      * <p>
diff --git a/src/main/java/com/nordstrom/automation/selenium/plugins/ChromeCaps.java b/src/main/java/com/nordstrom/automation/selenium/plugins/ChromeCaps.java
@@ -36,7 +36,7 @@ private ChromeCaps() {
     /** extension capability name for <b>ChromeOptions</b> */
     public static final String OPTIONS_KEY = "goog:chromeOptions";
     
-    private static final String[] PROPERTY_NAMES = 
+    static final String[] PROPERTY_NAMES = 
         { DRIVER_PATH, BINARY_PATH, LOGFILE_PATH, VERBOSE_LOG, SILENT_MODE, WHITELISTED };
     
     private static final String CAPABILITIES =
diff --git a/src/main/resources/operaChromiumVersions.json b/src/main/resources/operaChromiumVersions.json
@@ -0,0 +1,13 @@
+{
+  "109": "123",
+  "110": "124",
+  "111": "125",
+  "112": "126",
+  "113": "127",
+  "114": "128",
+  "115": "130",
+  "116": "131",
+  "117": "132",
+  "118": "133",
+  "119": "134"
+}
diff --git a/src/selenium4/java/com/nordstrom/automation/selenium/SeleniumConfig.java b/src/selenium4/java/com/nordstrom/automation/selenium/SeleniumConfig.java
@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 import org.apache.commons.configuration2.ex.ConfigurationException;
@@ -496,6 +497,8 @@ public Path createNodeConfig(String capabilities, URL hubUrl) throws IOException
                     Map<String, Object> thisConfig = new HashMap<>();
                     thisConfig.put("stereotype", theseCaps);
                     thisConfig.put("display-name", GridUtility.getPersonality(theseCaps));
+                    Optional.ofNullable(GridUtility.getDriverPath(theseCaps))
+                            .ifPresent(value -> thisConfig.put("webdriver-executable", value));
                     driverConfiguration.add(thisConfig);
                 });
             }
diff --git a/src/selenium4/java/com/nordstrom/automation/selenium/plugins/ChromePlugin.java b/src/selenium4/java/com/nordstrom/automation/selenium/plugins/ChromePlugin.java
@@ -16,6 +16,15 @@ public ChromePlugin() {
         super(ChromeCaps.DRIVER_NAME);
     }
     
+    /**
+     * Extension constructor for <b>ChromeDriver</b> subclass objects.
+     * 
+     * @param browserName browser name
+     */
+    protected ChromePlugin(String browserName) {
+        super(browserName);
+    }
+    
     /**
      * <b>org.openqa.selenium.chrome.ChromeDriver</b>
      * 
diff --git a/src/selenium4/java/com/nordstrom/automation/selenium/plugins/OperaPlugin.java b/src/selenium4/java/com/nordstrom/automation/selenium/plugins/OperaPlugin.java
@@ -1,13 +1,68 @@
 package com.nordstrom.automation.selenium.plugins;
 
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import java.lang.reflect.Type;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.List;
 import java.util.Map;
+import java.util.Objects;
+
+import org.openqa.selenium.json.Json;
+import org.openqa.selenium.json.TypeToken;
+import org.openqa.selenium.manager.SeleniumManager;
+import org.openqa.selenium.manager.SeleniumManagerOutput.Result;
 
 import com.nordstrom.automation.selenium.SeleniumConfig;
+import com.nordstrom.automation.selenium.core.JsUtility;
+import com.nordstrom.automation.selenium.exceptions.DriverExecutableNotFoundException;
+import com.nordstrom.common.file.OSInfo;
+import com.nordstrom.common.file.OSInfo.OSType;
 
 /**
  * This class is the plug-in for <b>OperaDriver</b>.
  */
-public class OperaPlugin extends RemoteWebDriverPlugin {
+public class OperaPlugin extends ChromePlugin {
+    
+    private static final String TEMPLATE = 
+            "{\"browserName\":\"chrome\"," +
+             "\"goog:chromeOptions\":{\"binary\":\"<binary-path>\"}," +
+             "\"nord:options\":{\"personality\":\"opera\"," +
+                               "\"driverPath\":\"<driver-path>\"}}";
+    
+    private static final String BASELINE =
+            "{\"browserName\":\"chrome\"," +
+             "\"goog:chromeOptions\":{\"args\":[\"--disable-infobars\",\"--disable-dev-shm-usage\"," +
+                                               "\"--remote-debugging-port=9222\",\"--no-sandbox\"," +
+                                               "\"--disable-gpu\",\"--disable-logging\"]," +
+                                     "\"prefs\":{\"credentials_enable_service\":false}}," +
+             "\"nord:options\":{\"personality\":\"opera\"," +
+                               "\"pluginClass\":\"com.nordstrom.automation.selenium.plugins.OperaPlugin\"}}";
+    
+    private static final OSType OS_TYPE;
+    private static final Map<String, String> OPERA_TO_CHROMIUM;
+    private static final String BINARY_PATH;
+    private static final String DRIVER_PATH;
+    private static final String CAPABILITIES;
+    private static final Map<String, String> PERSONALITIES;
+    
+    private static final String VERSION_MAPPINGS = "operaChromiumVersions.json";
+    private static final Type MAP_TYPE = new TypeToken<Map<String, String>>() {}.getType();
+    
+    static {
+        OS_TYPE = OSInfo.getDefault().getType();
+        String mappings = JsUtility.getScriptResource(VERSION_MAPPINGS);
+        OPERA_TO_CHROMIUM = new Json().toType(mappings, MAP_TYPE);
+        
+        BINARY_PATH = Objects.requireNonNull(findOperaBinary(), "Failed finding the Opera browser binary");
+        DRIVER_PATH = Objects.requireNonNull(findDriverBinary(), "Failed finding the 'chromedriver' binary");
+        
+        CAPABILITIES = TEMPLATE
+                .replace("<binary-path>", BINARY_PATH.replaceAll("\\\\", "/"))
+                .replace("<driver-path>", DRIVER_PATH.replaceAll("\\\\", "/"));
+        PERSONALITIES = Map.of(OperaCaps.DRIVER_NAME, BASELINE);
+    }
     
     /**
      * Constructor for <b>OperaPlugin</b> objects.
@@ -16,58 +71,146 @@ public OperaPlugin() {
         super(OperaCaps.DRIVER_NAME);
     }
     
-    /**
-     * <b>org.openqa.selenium.opera.OperaDriver</b>
-     * 
-     * <pre>&lt;dependency&gt;
-     *  &lt;groupId&gt;org.seleniumhq.selenium&lt;/groupId&gt;
-     *  &lt;artifactId&gt;selenium-opera-driver&lt;/artifactId&gt;
-     *  &lt;version&gt;4.30.0&lt;/version&gt;
-     *&lt;/dependency&gt;</pre>
-     *
-     * <b>net.bytebuddy.matcher.ElementMatcher</b>
-     * 
-     * <pre>&lt;dependency&gt;
-     *  &lt;groupId&gt;net.bytebuddy&lt;/groupId&gt;
-     *  &lt;artifactId&gt;byte-buddy&lt;/artifactId&gt;
-     *  &lt;version&gt;1.17.5&lt;/version&gt;
-     *&lt;/dependency&gt;</pre>
-     */
-    private static final String[] DEPENDENCY_CONTEXTS = {
-        "org.openqa.selenium.opera.OperaDriver",
-        "net.bytebuddy.matcher.ElementMatcher"
-    };
-    
     /**
      * {@inheritDoc}
      */
     @Override
-    public String[] getDependencyContexts() {
-        return DEPENDENCY_CONTEXTS;
+    public String getCapabilities(SeleniumConfig config) {
+        return CAPABILITIES;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
-    public String getCapabilities(SeleniumConfig config) {
-        return OperaCaps.getCapabilities();
+    public Map<String, String> getPersonalities() {
+        return PERSONALITIES;
     }
 
     /**
-     * {@inheritDoc}
+     * Get list of system property names recognized by the driver associated with this plug-in.
+     * 
+     * @param capabilities JSON {@link org.openqa.selenium.Capabilities Capabilities} object
+     * @return list of system property names
      */
-    @Override
-    public Map<String, String> getPersonalities() {
-        return OperaCaps.getPersonalities();
+    public String[] getPropertyNames(String capabilities) {
+        return ChromeCaps.PROPERTY_NAMES;
     }
 
     /**
-     * {@inheritDoc}
+     * Get path to installed <b>Opera</b> browser.
+     * 
+     * @return path to installed <b>Opera</b> browser; {@code null} if browser not found
      */
-    @Override
-    public String[] getPropertyNames(String capabilities) {
-        return OperaCaps.getPropertyNames(capabilities);
+    public static String findOperaBinary() {
+        switch (OS_TYPE) {
+        case MACINTOSH:
+            return findOnMac();
+        case UNIX:
+            return findOnLinux();
+        case WINDOWS:
+            return findOnWindows();
+        default:
+            return null;
+        }
     }
 
+    private static String findOnWindows() {
+        String[] possiblePaths = { "C:\\Program Files\\Opera\\opera.exe",
+                System.getenv("LOCALAPPDATA") + "\\Programs\\Opera\\opera.exe" };
+
+        return firstExistingPath(possiblePaths);
+    }
+
+    private static String findOnMac() {
+        String[] possiblePaths = { "/Applications/Opera.app/Contents/MacOS/Opera",
+                System.getProperty("user.home") + "/Applications/Opera.app/Contents/MacOS/Opera" };
+
+        return firstExistingPath(possiblePaths);
+    }
+
+    private static String findOnLinux() {
+        String[] possiblePaths = { "/usr/bin/opera", "/usr/local/bin/opera", "/opt/opera/opera" };
+
+        return firstExistingPath(possiblePaths);
+    }
+
+    private static String firstExistingPath(String[] paths) {
+        for (String path : paths) {
+            if (path != null && Files.exists(Paths.get(path))) {
+                return path;
+            }
+        }
+        return null;
+    }
+    
+    /**
+     * Detect version of installed <b>Opera</b> browser.
+     *  
+     * @return version of installed <b>Opera</b> browser; {@code null} if detection fails
+     */
+    public static String detectOperaVersion() {
+        try {
+            switch (OS_TYPE) {
+            case MACINTOSH:
+                return detectMac();
+            case UNIX:
+                return detectLinux();
+            case WINDOWS:
+                return detectWindows();
+            default:
+                return null;
+            }
+        } catch (Exception e) {
+            e.printStackTrace();
+            return null;
+        }
+    }
+
+    private static String detectWindows() throws Exception {
+        // Use PowerShell to get ProductVersion from file metadata
+        String[] cmd = { "powershell.exe", "-Command", "\"(Get-Item '" + BINARY_PATH + "').VersionInfo.ProductVersion\"" };
+        return runCommand(cmd).trim();
+    }
+
+    private static String detectMac() throws Exception {
+        String[] cmd = { "/usr/libexec/PlistBuddy", "-c", "Print :CFBundleShortVersionString", BINARY_PATH + "/Contents/Info.plist" };
+        return runCommand(cmd).trim();
+    }
+
+    private static String detectLinux() throws Exception {
+        String[] cmd = { "/bin/sh", "-c", "cat " + BINARY_PATH + "/resources/version" };
+        return runCommand(cmd).trim();
+    }
+
+    private static String runCommand(String[] command) throws Exception {
+        Process process = new ProcessBuilder(command).redirectErrorStream(true).start();
+        try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))) {
+            String line = reader.readLine();
+            return (line != null) ? line : null;
+        }
+    }
+    
+    /**
+     * Find 'chromedriver' binary that works with the active installation of Opera.
+     * 
+     * @return path to 'chromedriver' binary; {@code null} if driver not found
+     */
+    public static String findDriverBinary() {
+        String operaVersion = Objects.requireNonNull(detectOperaVersion(),
+                "Failed detecting Opera browser version");
+        String operaMajor = operaVersion.split("\\.")[0];
+        String chromiumMajor = Objects.requireNonNull(OPERA_TO_CHROMIUM.get(operaMajor),
+                "No Chromium version mapping found for Opera major version: " + operaMajor);
+        
+        try {
+            SeleniumManager manager = SeleniumManager.getInstance();
+            Result result = manager.getBinaryPaths(List.of(
+                    "--driver", "chromedriver",
+                    "--driver-version", chromiumMajor));
+            return result.getDriverPath();
+        } catch (IllegalStateException e) {
+            throw new DriverExecutableNotFoundException(ChromeCaps.DRIVER_PATH);
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -151,10 +151,10 @@ test {`
`151`	`151`
`152`	`152`	`scmVersion {`
`153`	`153`	`hooks {`
`154`		`- pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(<version>)\d+\.\d+\.\d+(-s[34]<\/version>)/}, replacement: {v, p -> "\$1$v\$2"}]`
`155`		`- pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(selenium-foundation:)\d+\.\d+\.\d+(-s[34])/}, replacement: {v, p -> "\$1$v\$2"}]`
`156`		`- pre 'commit'`
`157`		`- post 'push'`
	`154`	`+ pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(<version>)\d+\.\d+\.\d+(-s[34]<\/version>)/}, replacement: {v, p -> "\$1$v\$2"}]`
	`155`	`+ pre 'fileUpdate', [file: 'README.md', pattern: {v, p -> /(selenium-foundation:)\d+\.\d+\.\d+(-s[34])/}, replacement: {v, p -> "\$1$v\$2"}]`
	`156`	`+ pre 'commit'`
	`157`	`+ post 'push'`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`