Implementation of Selenium Manager

.github/workflows/ci-python.yml

@@ -134,12 +134,8 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.7.10
-      - name: Setup Java
-        uses: actions/setup-java@v1
-        with:
-          java-version: '11'
-      - name: Setup Chrome and ChromeDriver
-        uses: ./.github/actions/setup-chrome
+      - name: Setup Chrome
+        uses: browser-actions/setup-chrome@latest
       - name: Start XVFB
         run: Xvfb :99 &
       - name: Start Fluxbox
@@ -179,8 +175,11 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: '11'
-      - name: Setup Firefox and GeckoDriver
-        uses: ./.github/actions/setup-firefox
+      - name: Setup Firefox
+        uses: abhi1693/setup-browser@v0.3.4
+        with:
+          browser: firefox
+          version: latest
       - name: Start XVFB
         run: Xvfb :99 &
       - name: Start Fluxbox
@@ -219,8 +218,11 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: '11'
-      - name: Setup Firefox and GeckoDriver
-        uses: ./.github/actions/setup-firefox
+      - name: Setup Firefox
+        uses: abhi1693/setup-browser@v0.3.4
+        with:
+          browser: firefox
+          version: latest
       - name: Start Xvfb
         run: Xvfb :99 &
       - name: Start Fluxbox

.github/workflows/ci-ruby.yml

@@ -208,7 +208,7 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: ${{ matrix.ruby }}
       - name: Cache Bazel artifacts
         uses: actions/cache@v2
         with:

Rakefile

@@ -110,6 +110,7 @@ JAVA_RELEASE_TARGETS = %w[
   //java/src/org/openqa/selenium/ie:ie.publish
   //java/src/org/openqa/selenium/json:json.publish
   //java/src/org/openqa/selenium/lift:lift.publish
+  //java/src/org/openqa/selenium/manager:manager.publish
   //java/src/org/openqa/selenium/remote/http/jdk:jdk.publish
   //java/src/org/openqa/selenium/remote/http:http.publish
   //java/src/org/openqa/selenium/remote:remote.publish

common/manager/BUILD.bazel

@@ -0,0 +1,30 @@
+filegroup(
+    name = "manager",
+    srcs = glob([
+        "*",
+        "**/*",
+    ]),
+    visibility = [
+        "//java/test/org/openqa/selenium/chrome:__pkg__",
+        "//java/test/org/openqa/selenium/edge:__pkg__",
+        "//java/test/org/openqa/selenium/firefox:__pkg__",
+        "//py:__pkg__",
+        "//rb:__pkg__",
+    ],
+)
+
+exports_files(
+    [
+        "linux/selenium-manager",
+        "macos/selenium-manager",
+        "windows/selenium-manager.exe",
+    ],
+    visibility = [
+        "//java/src/org/openqa/selenium/manager:__pkg__",
+        "//java/test/org/openqa/selenium/chrome:__pkg__",
+        "//java/test/org/openqa/selenium/edge:__pkg__",
+        "//java/test/org/openqa/selenium/firefox:__pkg__",
+        "//py:__pkg__",
+        "//rb:__pkg__",
+    ],
+)

dotnet/src/webdriver/DriverService.cs

@@ -65,7 +65,23 @@ protected DriverService(string servicePath, int port, string driverServiceExecut
             string executablePath = Path.Combine(servicePath, driverServiceExecutableName);
             if (!File.Exists(executablePath))
             {
-                throw new DriverServiceNotFoundException(string.Format(CultureInfo.InvariantCulture, "The file {0} does not exist. The driver can be downloaded at {1}", executablePath, driverServiceDownloadUrl));
+                try
+                {
+                    executablePath = SeleniumManager.DriverPath(driverServiceExecutableName);
+                }
+                catch (Exception e)
+                {
+                  // No-op; entirely a fall-back feature
+                }
+
+                if (File.Exists(executablePath))
+                {
+                    servicePath = Path.GetDirectoryName(executablePath);
+                }
+                else
+                {
+                    throw new DriverServiceNotFoundException(string.Format(CultureInfo.InvariantCulture, "The file {0} does not exist. The driver can be downloaded at {1}", executablePath, driverServiceDownloadUrl));
+                }
             }
 
             this.driverServicePath = servicePath;
@@ -74,12 +90,12 @@ protected DriverService(string servicePath, int port, string driverServiceExecut
         }
 
         /// <summary>
-        /// Occurs when the driver process is starting. 
+        /// Occurs when the driver process is starting.
         /// </summary>
         public event EventHandler<DriverProcessStartingEventArgs> DriverProcessStarting;
 
         /// <summary>
-        /// Occurs when the driver process has completely started. 
+        /// Occurs when the driver process has completely started.
         /// </summary>
         public event EventHandler<DriverProcessStartedEventArgs> DriverProcessStarted;
 

dotnet/src/webdriver/SeleniumManager.cs

@@ -0,0 +1,146 @@
+// <copyright file="SeleniumManager.cs" company="WebDriver Committers">
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// 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.
+// </copyright>
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Globalization;
+using System.IO;
+using System.Text;
+using System.Threading;
+using OpenQA.Selenium.Internal;
+
+namespace OpenQA.Selenium
+{
+    /// <summary>
+    /// Wrapper for the Selenium Manager binary.
+    /// </summary>
+    public static class SeleniumManager
+    {
+        private static string binary;
+        private static readonly List<string> KnownDrivers = new List<string>() {
+            "geckodriver.exe",
+            "chromedriver.exe"
+        };
+
+        /// <summary>
+        /// Determines the location of the correct driver.
+        /// </summary>
+        /// <param name="driverName">Which driver the service needs.</param>
+        /// <returns>
+        /// The location of the driver.
+        /// </returns>
+        public static string DriverPath(string driverName)
+        {
+            if (!KnownDrivers.Contains(driverName))
+            {
+                throw new WebDriverException("Unable to locate driver with name: " + driverName);
+            }
+            var binaryFile = Binary;
+            if (binaryFile == null) return null;
+
+            var arguments = "--driver " + driverName.Replace(".exe", "");
+            var output = RunCommand(binaryFile, arguments);
+            return output.Replace("INFO\t", "").TrimEnd();
+        }
+
+        /// <summary>
+        /// Gets the location of the correct Selenium Manager binary.
+        /// </summary>
+        private static string Binary
+        {
+            get
+            {
+                if (string.IsNullOrEmpty(binary))
+                {
+                    string folder = "windows";
+                    string extension = ".exe";
+
+                    if (!Environment.OSVersion.Platform.ToString().StartsWith("Win"))
+                    {
+                        throw new WebDriverException("Selenium Manager only supports Windows in .NET at this time");
+                    }
+
+                    try
+                    {
+                        string name = "selenium-manager-" + folder;
+                        using (Stream fileStream = ResourceUtilities.GetResourceStream(name, name))
+                        {
+                            using (BinaryReader binReader = new BinaryReader(fileStream, Encoding.ASCII))
+                            {
+                                byte[] fileBytes = binReader.ReadBytes((int)fileStream.Length);
+                                string directoryName = string.Format(CultureInfo.InvariantCulture, "webdriver.{0}",
+                                    Guid.NewGuid().ToString("N"));
+                                var path = Path.Combine(Path.GetTempPath(), directoryName + "/" + folder);
+                                Directory.CreateDirectory(path);
+                                var filePath = Path.Combine(path, "selenium-manager" + extension);
+
+                                using (BinaryWriter binWriter = new BinaryWriter(File.Open(filePath, FileMode.Create)))
+                                {
+                                    binWriter.Flush();
+                                    binWriter.Write(fileBytes);
+                                }
+                                binary = filePath;
+                            }
+                        }
+                    }
+                    catch (Exception ex)
+                    {
+                        throw new WebDriverException("Unable to obtain Selenium Manager", ex);
+                    }
+                }
+
+                return binary;
+            }
+        }
+
+        /// <summary>
+        /// Executes a process with the given arguments.
+        /// </summary>
+        /// <param name="fileName">The path to the Selenium Manager.</param>
+        /// <param name="arguments">The switches to be used by Selenium Manager.</param>
+        /// <returns>
+        /// the standard output of the execution.
+        /// </returns>
+        private static string RunCommand(string fileName, string arguments)
+        {
+            Process process = new Process();
+            process.StartInfo.FileName = fileName;
+            process.StartInfo.Arguments = arguments;
+            process.StartInfo.UseShellExecute = false;
+            process.StartInfo.RedirectStandardOutput = true;
+
+            try
+            {
+                process.Start();
+            }
+            catch (Exception ex)
+            {
+                throw new WebDriverException("Error starting process: " + process, ex);
+            }
+
+            String output = process.StandardOutput.ReadToEnd();
+
+            if (!output.StartsWith("INFO")) {
+                throw new WebDriverException("Invalid response from process: " + process);
+            }
+
+            return output;
+        }
+    }
+}

dotnet/src/webdriver/WebDriver.csproj

@@ -117,6 +117,10 @@
       <Visible>False</Visible>
       <LogicalName>webdriver_prefs.json</LogicalName>
     </EmbeddedResource>
+    <EmbeddedResource Include="$(ProjectDir)..\..\..\common\manager\windows\selenium-manager.exe">
+      <Visible>False</Visible>
+      <LogicalName>selenium-manager-windows</LogicalName>
+    </EmbeddedResource>
     <EmbeddedResource Include="$(ProjectDir)..\..\..\bazel-bin\javascript\webdriver\atoms\get-attribute.js">
       <Visible>False</Visible>
       <LogicalName>get-attribute.js</LogicalName>
@@ -140,6 +144,10 @@
       <Visible>False</Visible>
       <LogicalName>webdriver_prefs.json</LogicalName>
     </EmbeddedResource>
+    <EmbeddedResource Include="$(ProjectDir)../../../common/manager/windows/selenium-manager.exe">
+      <Visible>False</Visible>
+      <LogicalName>selenium-manager-windows</LogicalName>
+    </EmbeddedResource>
     <EmbeddedResource Include="$(ProjectDir)../../../bazel-bin/javascript/webdriver/atoms/get-attribute.js">
       <Visible>False</Visible>
       <LogicalName>get-attribute.js</LogicalName>

java/src/org/openqa/selenium/manager/BUILD.bazel

@@ -0,0 +1,41 @@
+load("@rules_jvm_external//:defs.bzl", "artifact")
+load("//common:defs.bzl", "copy_file")
+load("//java:defs.bzl", "java_export")
+load("//java:version.bzl", "SE_VERSION")
+
+java_export(
+    name = "manager",
+    srcs = glob(["*.java"]),
+    maven_coordinates = "org.seleniumhq.selenium:selenium-manager:%s" % SE_VERSION,
+    pom_template = "//java/src/org/openqa/selenium:template-pom",
+    resources = [
+        ":manager-linux",
+        ":manager-macos",
+        ":manager-windows",
+    ],
+    visibility = [
+        "//visibility:public",
+    ],
+    deps = [
+        "//java/src/org/openqa/selenium:core",
+        artifact("com.google.guava:guava"),
+    ],
+)
+
+copy_file(
+    name = "manager-linux",
+    src = "//common/manager:linux/selenium-manager",
+    out = "linux/selenium-manager",
+)
+
+copy_file(
+    name = "manager-windows",
+    src = "//common/manager:windows/selenium-manager.exe",
+    out = "windows/selenium-manager.exe",
+)
+
+copy_file(
+    name = "manager-macos",
+    src = "//common/manager:macos/selenium-manager",
+    out = "macos/selenium-manager",
+)