refactor: make tests respect CHROMEDRIVER_PATH (dequelabs#690)

* refactor(webdriverjs): make code more DRY * refactor: make tests respect CHROMEDRIVER_PATH
mrtnvh · Mar 20, 2023 · b09ec5a · b09ec5a
1 parent d11481b
commit b09ec5a
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 20 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -155,11 +155,13 @@ jobs:
     steps:
       - checkout
       - restore_dependency_cache
-      # required for browser-driver-manager
-      - run: sudo apt-get update -y
-      - run: cd packages/webdriverjs && npx [email protected] install chrome chromedriver --verbose
+      - browser-tools/install-chrome
+      - browser-tools/install-chromedriver
       - run: npm --prefix=packages/webdriverjs run build
-      - run: npm run coverage --prefix=packages/webdriverjs
+      - run:
+          command: npm run coverage --prefix=packages/webdriverjs
+          environment:
+            CHROMEDRIVER_PATH: /usr/local/bin/chromedriver
 
   webdriverjs-example:
     <<: *defaults
@@ -169,7 +171,10 @@ jobs:
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
       - run: npm --prefix=packages/webdriverjs run build
-      - run: npm run test --prefix=packages/webdriverjs/tests/example
+      - run:
+          command: npm run test --prefix=packages/webdriverjs/tests/example
+          environment:
+            CHROMEDRIVER_PATH: /usr/local/bin/chromedriver
 
   webdriverio:
     docker:
@@ -182,7 +187,10 @@ jobs:
       - restore_dependency_cache
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
-      - run: npm run coverage --prefix=packages/webdriverio
+      - run:
+          command: npm run coverage --prefix=packages/webdriverio
+          environment:
+            CHROMEDRIVER_PATH: /usr/local/bin/chromedriver
 
   reporter-earl:
     <<: *defaults

diff --git a/packages/webdriverio/src/test.ts b/packages/webdriverio/src/test.ts
@@ -56,7 +56,7 @@ describe('@axe-core/webdriverio', () => {
       let chromedriverProcess: ChildProcessWithoutNullStreams;
 
       before(async () => {
-        const path = process.env.CI ? '/usr/local/bin/chromedriver' : chromedriver.path;
+        const path = process.env.CHROMEDRIVER_PATH ?? chromedriver.path;
         chromedriverProcess = child_process.spawn(path, [`--port=${port}`]);
         chromedriverProcess.stdout.pipe(process.stdout);
         chromedriverProcess.stderr.pipe(process.stderr);

diff --git a/packages/webdriverjs/tests/axe-webdriverjs.spec.ts b/packages/webdriverjs/tests/axe-webdriverjs.spec.ts
@@ -12,6 +12,9 @@ import { Server, createServer } from 'http';
 import { Webdriver, connectToChromeDriver } from './test-utils';
 import AxeBuilder from '../src';
 import { axeRunPartial } from '../src/browser';
+import child_process from 'child_process';
+import { ChildProcessWithoutNullStreams } from 'child_process';
+
 const dylangConfig = JSON.parse(
   fs.readFileSync(
     require.resolve('./fixtures/external/dylang-config.json'),
@@ -29,6 +32,8 @@ describe('@axe-core/webdriverjs', () => {
   let axeForceLegacy: string;
   let axeLargePartial: string;
 
+  let chromedriverProcess: ChildProcessWithoutNullStreams;
+
   before(async () => {
     const axePath = require.resolve('axe-core');
     axeSource = fs.readFileSync(axePath, 'utf8');
@@ -46,13 +51,17 @@ describe('@axe-core/webdriverjs', () => {
       'utf8'
     );
 
-    chromedriver.start([`--port=${port}`]);
+    const binPath = process.env.CHROMEDRIVER_PATH ?? chromedriver.path;
+    chromedriverProcess = child_process.spawn(binPath, [`--port=${port}`]);
+    chromedriverProcess.stdout.pipe(process.stdout);
+    chromedriverProcess.stderr.pipe(process.stderr);
+
     await delay(500);
     await connectToChromeDriver(port);
   });
 
   after(() => {
-    chromedriver.stop();
+    chromedriverProcess.kill();
   });
 
   beforeEach(async () => {

diff --git a/packages/webdriverjs/tests/example/webdriverjs-example.ts b/packages/webdriverjs/tests/example/webdriverjs-example.ts
@@ -20,10 +20,17 @@ describe('@axe-core/webdriverjs example', () => {
   });
 
   beforeEach(async () => {
-    driver = new Builder()
+    const builder = new Builder()
       .forBrowser('chrome')
-      .setChromeOptions(new chrome.Options().headless())
-      .build();
+      .setChromeOptions(new chrome.Options().headless());
+
+    if (process.env.CHROMEDRIVER_PATH) {
+      builder.setChromeService(
+        new chrome.ServiceBuilder(process.env.CHROMEDRIVER_PATH)
+      );
+    }
+
+    driver = builder.build();
   });
 
   afterEach(() => {

diff --git a/packages/webdriverjs/tests/test-utils.ts b/packages/webdriverjs/tests/test-utils.ts
@@ -3,20 +3,23 @@ import net from 'net';
 import chrome from 'selenium-webdriver/chrome';
 
 export const Webdriver = (): WebDriver => {
-  let webdriver: WebDriver;
+  let builder: Builder;
   if (process.env.REMOTE_SELENIUM_URL) {
-    webdriver = new Builder()
+    builder = new Builder()
       .forBrowser('chrome')
       .usingServer(process.env.REMOTE_SELENIUM_URL)
-      .setChromeOptions(new chrome.Options().headless())
-      .build();
+      .setChromeOptions(new chrome.Options().headless());
   } else {
-    webdriver = new Builder()
+    builder = new Builder()
       .setChromeOptions(new chrome.Options().headless())
-      .forBrowser('chrome')
-      .build();
+      .forBrowser('chrome');
+  }
+  if (process.env.CHROMEDRIVER_PATH) {
+    builder.setChromeService(
+      new chrome.ServiceBuilder(process.env.CHROMEDRIVER_PATH)
+    );
   }
-  return webdriver;
+  return builder.build();
 };
 
 export const connectToChromeDriver = (port: number): Promise<void> => {