test(cli): add test to cover selenium-webdriver <4.17.0

packages/cli/package.json

@@ -59,11 +59,13 @@
     "@types/chromedriver": "^81.0.1",
     "@types/mocha": "^10.0.0",
     "@types/selenium-webdriver": "^4.1.5",
+    "@types/sinon": "^17.0.3",
     "chai": "^4.3.6",
     "execa": "5.1.1",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",
     "rimraf": "^5.0.5",
+    "sinon": "^17.0.1",
     "tempy": "^1.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2"

packages/cli/src/lib/axe-test-urls.ts

@@ -19,7 +19,7 @@ const testPages = async (
     const currentUrl = urls[0].replace(/[,;]$/, '');
 
     if (events?.onTestStart) {
-      events?.onTestStart(currentUrl);
+      events.onTestStart(currentUrl);
     }
 
     if (config.timer) {

packages/cli/src/lib/utils.test.ts

@@ -3,7 +3,6 @@ import { assert } from 'chai';
 import tempy from 'tempy';
 import { join } from 'path';
 import { mkdirSync, writeFileSync, rmSync } from 'fs';
-import { dependencies } from '../../package.json';
 import * as utils from './utils';
 
 describe('utils', () => {
@@ -83,11 +82,7 @@ describe('utils', () => {
         writeFileSync(join(parentDirname, 'axe.js'), 'parent');
 
         const cliDirname = join(tempDir, 'packages', 'cli');
-        const nodeModDirname = join(
-          cliDirname,
-          'node_modules',
-          'axe-core'
-        );
+        const nodeModDirname = join(cliDirname, 'node_modules', 'axe-core');
         mkdirSync(nodeModDirname, { recursive: true });
         writeFileSync(join(nodeModDirname, 'axe.js'), 'node modules');
 

packages/cli/src/lib/webdriver.test.ts

@@ -4,9 +4,10 @@ import { startDriver } from './webdriver';
 import { WebDriver } from 'selenium-webdriver';
 import chromedriver from 'chromedriver';
 import chrome from 'selenium-webdriver/chrome';
-import type { Options } from 'selenium-webdriver/chrome';
 import path from 'path';
 import { WebdriverConfigParams } from '../types';
+import sinon from 'sinon';
+
 describe('startDriver', () => {
   let config: WebdriverConfigParams;
   let browser: string;
@@ -22,7 +23,11 @@ describe('startDriver', () => {
   });
 
   afterEach(async () => {
-    await driver.quit();
+    // try catch required due to `chrome.options` being mocked with sinon
+    // and not properly creating a driver
+    try {
+      await driver.quit();
+    } catch (error) {}
   });
 
   it('creates a driver', async () => {
@@ -101,4 +106,18 @@ describe('startDriver', () => {
     assert.isObject(timeoutValue);
     assert.deepEqual(timeoutValue.script, 10000000);
   });
+
+  it('invokes `options.headless()` on versions of selenium-webdriver < 4.17.0', async () => {
+    const stub = sinon.stub(chrome, 'Options').returns({
+      headless: () => {}
+    });
+
+    // try catch required due to `chrome.options` being mocked with sinon
+    // and not properly creating a driver
+    try {
+      driver = await startDriver(config);
+    } catch (error) {}
+    assert.isTrue(stub.calledOnce);
+    stub.restore();
+  });
 });