Add environment variable support for driver executables in Chrome, Edge, Firefox, IE, and Safari

Author: iampopovich

javascript/selenium-webdriver/test/chrome/service_test.js

@@ -41,6 +41,51 @@ test.suite(
           assert.ok(url.endsWith('/foo/bar/baz'), 'unexpected url: ' + url)
         })
       })
+
+      describe('environment variable support', function () {
+        let originalEnvValue
+
+        beforeEach(function () {
+          originalEnvValue = process.env.SE_CHROMEDRIVER
+        })
+
+        afterEach(function () {
+          if (originalEnvValue) {
+            process.env.SE_CHROMEDRIVER = originalEnvValue
+          } else {
+            delete process.env.SE_CHROMEDRIVER
+          }
+        })
+
+        it('uses SE_CHROMEDRIVER environment variable when set', function () {
+          const testPath = '/custom/path/to/chromedriver'
+          process.env.SE_CHROMEDRIVER = testPath
+          
+          const serviceBuilder = new chrome.ServiceBuilder()
+          const service = serviceBuilder.build()
+          assert.strictEqual(service.getExecutable(), testPath)
+        })
+
+        it('explicit path overrides environment variable', function () {
+          const envPath = '/env/path/to/chromedriver'
+          const explicitPath = '/explicit/path/to/chromedriver'
+          
+          process.env.SE_CHROMEDRIVER = envPath
+          const serviceBuilder = new chrome.ServiceBuilder(explicitPath)
+          const service = serviceBuilder.build()
+          
+          assert.strictEqual(service.getExecutable(), explicitPath)
+        })
+
+        it('falls back to default behavior when environment variable is not set', function () {
+          delete process.env.SE_CHROMEDRIVER
+          
+          const serviceBuilder = new chrome.ServiceBuilder()
+          const service = serviceBuilder.build()
+          // Should be null/undefined when no explicit path and no env var
+          assert.ok(!service.getExecutable())
+        })
+      })
     })
   },
   { browsers: ['chrome'] },

javascript/selenium-webdriver/test/edge/service_test.js

@@ -39,6 +39,51 @@ test.suite(
         let url = await service.start()
         assert(/127\.0\.0\.1/.test(url), `unexpected url: ${url}`)
       })
+
+      describe('environment variable support', function () {
+        let originalEnvValue
+
+        beforeEach(function () {
+          originalEnvValue = process.env.SE_EDGEDRIVER
+        })
+
+        afterEach(function () {
+          if (originalEnvValue) {
+            process.env.SE_EDGEDRIVER = originalEnvValue
+          } else {
+            delete process.env.SE_EDGEDRIVER
+          }
+        })
+
+        it('uses SE_EDGEDRIVER environment variable when set', function () {
+          const testPath = '/custom/path/to/edgedriver'
+          process.env.SE_EDGEDRIVER = testPath
+          
+          const serviceBuilder = new edge.ServiceBuilder()
+          const service = serviceBuilder.build()
+          assert.strictEqual(service.getExecutable(), testPath)
+        })
+
+        it('explicit path overrides environment variable', function () {
+          const envPath = '/env/path/to/edgedriver'
+          const explicitPath = '/explicit/path/to/edgedriver'
+          
+          process.env.SE_EDGEDRIVER = envPath
+          const serviceBuilder = new edge.ServiceBuilder(explicitPath)
+          const service = serviceBuilder.build()
+          
+          assert.strictEqual(service.getExecutable(), explicitPath)
+        })
+
+        it('falls back to default behavior when environment variable is not set', function () {
+          delete process.env.SE_EDGEDRIVER
+          
+          const serviceBuilder = new edge.ServiceBuilder()
+          const service = serviceBuilder.build()
+          // Should be null/undefined when no explicit path and no env var
+          assert.ok(!service.getExecutable())
+        })
+      })
     })
   },
   { browsers: ['MicrosoftEdge'] },

javascript/selenium-webdriver/test/firefox/service_test.js

@@ -0,0 +1,90 @@
+// 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.
+
+'use strict'
+
+const assert = require('node:assert')
+const firefox = require('selenium-webdriver/firefox')
+const test = require('../../lib/test')
+const { getBinaryPaths } = require('selenium-webdriver/common/driverFinder')
+
+test.suite(
+  function (_env) {
+    describe('geckodriver', function () {
+      let service
+
+      afterEach(function () {
+        if (service) {
+          return service.kill()
+        }
+      })
+
+      it('can start geckodriver', async function () {
+        service = new firefox.ServiceBuilder().build()
+        service.setExecutable(getBinaryPaths(new firefox.Options()).driverPath)
+        let url = await service.start()
+        assert(/127\.0\.0\.1/.test(url), `unexpected url: ${url}`)
+      })
+
+      describe('environment variable support', function () {
+        let originalEnvValue
+
+        beforeEach(function () {
+          originalEnvValue = process.env.SE_GECKODRIVER
+        })
+
+        afterEach(function () {
+          if (originalEnvValue) {
+            process.env.SE_GECKODRIVER = originalEnvValue
+          } else {
+            delete process.env.SE_GECKODRIVER
+          }
+        })
+
+        it('uses SE_GECKODRIVER environment variable when set', function () {
+          const testPath = '/custom/path/to/geckodriver'
+          process.env.SE_GECKODRIVER = testPath
+          
+          const serviceBuilder = new firefox.ServiceBuilder()
+          const service = serviceBuilder.build()
+          assert.strictEqual(service.getExecutable(), testPath)
+        })
+
+        it('explicit path overrides environment variable', function () {
+          const envPath = '/env/path/to/geckodriver'
+          const explicitPath = '/explicit/path/to/geckodriver'
+          
+          process.env.SE_GECKODRIVER = envPath
+          const serviceBuilder = new firefox.ServiceBuilder(explicitPath)
+          const service = serviceBuilder.build()
+          
+          assert.strictEqual(service.getExecutable(), explicitPath)
+        })
+
+        it('falls back to default behavior when environment variable is not set', function () {
+          delete process.env.SE_GECKODRIVER
+          
+          const serviceBuilder = new firefox.ServiceBuilder()
+          const service = serviceBuilder.build()
+          // Should be null/undefined when no explicit path and no env var
+          assert.ok(!service.getExecutable())
+        })
+      })
+    })
+  },
+  { browsers: ['firefox'] },
+)

javascript/selenium-webdriver/test/ie/service_test.js

@@ -0,0 +1,93 @@
+// 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.
+
+'use strict'
+
+const assert = require('node:assert')
+const ie = require('selenium-webdriver/ie')
+const test = require('../../lib/test')
+const { getBinaryPaths } = require('selenium-webdriver/common/driverFinder')
+
+test.suite(
+  function (_env) {
+    describe('iedriver', function () {
+      let service
+
+      afterEach(function () {
+        if (service) {
+          return service.kill()
+        }
+      })
+
+      it('can start iedriver', async function () {
+        // Skip on non-Windows platforms
+        if (process.platform !== 'win32') {
+          this.skip()
+          return
+        }
+        
+        service = new ie.ServiceBuilder().build()
+        service.setExecutable(getBinaryPaths(new ie.Options()).driverPath)
+        let url = await service.start()
+        assert(/127\.0\.0\.1/.test(url), `unexpected url: ${url}`)
+      })
+
+      describe('environment variable support', function () {
+        let originalEnvValue
+
+        beforeEach(function () {
+          originalEnvValue = process.env.SE_IEDRIVER
+        })
+
+        afterEach(function () {
+          if (originalEnvValue) {
+            process.env.SE_IEDRIVER = originalEnvValue
+          } else {
+            delete process.env.SE_IEDRIVER
+          }
+        })
+
+        it('uses SE_IEDRIVER environment variable when set', function () {
+          const testPath = '/custom/path/to/iedriver'
+          process.env.SE_IEDRIVER = testPath
+          
+          const serviceBuilder = new ie.ServiceBuilder()
+          assert.strictEqual(serviceBuilder.getExecutable(), testPath)
+        })
+
+        it('explicit path overrides environment variable', function () {
+          const envPath = '/env/path/to/iedriver'
+          const explicitPath = '/explicit/path/to/iedriver'
+          
+          process.env.SE_IEDRIVER = envPath
+          const serviceBuilder = new ie.ServiceBuilder(explicitPath)
+          
+          assert.strictEqual(serviceBuilder.getExecutable(), explicitPath)
+        })
+
+        it('falls back to default behavior when environment variable is not set', function () {
+          delete process.env.SE_IEDRIVER
+          
+          const serviceBuilder = new ie.ServiceBuilder()
+          // Should be null/undefined when no explicit path and no env var
+          assert.ok(!serviceBuilder.getExecutable())
+        })
+      })
+    })
+  },
+  { browsers: ['ie'] },
+)

javascript/selenium-webdriver/test/safari_test.js

@@ -38,6 +38,51 @@ test.suite(
         let url = await service.start()
         assert(/127\.0\.0\.1/.test(url), `unexpected url: ${url}`)
       })
+
+      describe('environment variable support', function () {
+        let originalEnvValue
+
+        beforeEach(function () {
+          originalEnvValue = process.env.SE_SAFARIDRIVER
+        })
+
+        afterEach(function () {
+          if (originalEnvValue) {
+            process.env.SE_SAFARIDRIVER = originalEnvValue
+          } else {
+            delete process.env.SE_SAFARIDRIVER
+          }
+        })
+
+        it('uses SE_SAFARIDRIVER environment variable when set', function () {
+          const testPath = '/custom/path/to/safaridriver'
+          process.env.SE_SAFARIDRIVER = testPath
+          
+          const serviceBuilder = new safari.ServiceBuilder()
+          const service = serviceBuilder.build()
+          assert.strictEqual(service.getExecutable(), testPath)
+        })
+
+        it('explicit path overrides environment variable', function () {
+          const envPath = '/env/path/to/safaridriver'
+          const explicitPath = '/explicit/path/to/safaridriver'
+          
+          process.env.SE_SAFARIDRIVER = envPath
+          const serviceBuilder = new safari.ServiceBuilder(explicitPath)
+          const service = serviceBuilder.build()
+          
+          assert.strictEqual(service.getExecutable(), explicitPath)
+        })
+
+        it('falls back to default behavior when environment variable is not set', function () {
+          delete process.env.SE_SAFARIDRIVER
+          
+          const serviceBuilder = new safari.ServiceBuilder()
+          const service = serviceBuilder.build()
+          // Should be null/undefined when no explicit path and no env var
+          assert.ok(!service.getExecutable())
+        })
+      })
     })
   },
   { browsers: ['safari'] },