selenium-side-runner 3.16.0 → 4.0.0-alpha.15

package/package.json

@@ -1,18 +1,13 @@
 {
   "name": "selenium-side-runner",
-  "version": "3.16.0",
+  "version": "4.0.0-alpha.15",
   "description": "Run Selenium IDE projects in cli",
   "repository": "https://github.com/SeleniumHQ/selenium-ide",
-  "scripts": {
-    "build": "babel -d dist src --ignore=src/__test__",
-    "prepublishOnly": "yarn build",
-    "watch": "yarn build -w"
-  },
   "bin": {
-    "selenium-side-runner": "dist/index.js"
+    "selenium-side-runner": "dist/bin.js"
   },
   "engines": {
-    "node": ">=8"
+    "node": ">=14"
   },
   "keywords": [
     "selenium",
@@ -20,24 +15,34 @@
     "line"
   ],
   "license": "Apache-2.0",
-  "private": false,
   "dependencies": {
-    "commander": "^2.12.2",
-    "glob": "^7.1.2",
-    "global-npm": "^0.3.0",
-    "jest-cli": "24.7.1",
-    "jest-environment-selenium": "2.1.2",
-    "js-beautify": "^1.7.5",
-    "js-yaml": "^3.13.1",
-    "rimraf": "^2.6.2",
-    "selenium-webdriver": "4.0.0-alpha.4",
-    "selianize": "^3.16.0",
-    "semver": "^5.5.1",
-    "winston": "^2.4.0"
+    "@seleniumhq/side-model": "^4.0.0-alpha.1",
+    "@seleniumhq/side-runtime": "^4.0.0-alpha.5",
+    "commander": "^9.4.0",
+    "glob": "^7.2.0",
+    "jest": "^27.5.1",
+    "jest-cli": "^27.5.1",
+    "jest-each": "^27.5.1",
+    "js-beautify": "^1.14.2",
+    "js-yaml": "^4.1.0",
+    "rimraf": "^3.0.2",
+    "semver": "^7.3.5",
+    "winston": "^3.6.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.2.3",
-    "@babel/preset-env": "^7.3.4"
+    "@types/glob": "7.2.0",
+    "@types/jest": "^27.4.1",
+    "@types/js-beautify": "1.13.3",
+    "@types/js-yaml": "4.0.5",
+    "@types/rimraf": "3.0.2",
+    "@types/semver": "7.3.9",
+    "@types/winston": "2.4.4"
   },
-  "gitHead": "70be270a6733b9cd14a9a86f11cbffaf7892c585"
-}
+  "gitHead": "f58e327e7616e23a3e926e4b80cf9952164e5744",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo node_modules",
+    "start": "node dist/bin.js",
+    "watch": "tsc --watch"
+  }
+}

package/src/__tests__/capabilities.spec.ts

@@ -0,0 +1,137 @@
+// 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.
+
+import Capabilities from '../capabilities'
+
+describe('capabilities string parser', () => {
+  it('should parse capability key', () => {
+    const capabilities = 'browserName=chrome'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      browserName: 'chrome',
+    })
+  })
+  it('should parse multiple capabilities keys', () => {
+    const capabilities =
+      'browserName=chrome platform=MAC unexpectedAlertBehaviour=ignore'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      browserName: 'chrome',
+      platform: 'MAC',
+      unexpectedAlertBehaviour: 'ignore',
+    })
+  })
+  it('should parse quoted capability key', () => {
+    const capabilities = 'browserName="chrome"'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      browserName: 'chrome',
+    })
+  })
+  it('should parse multiword capability key', () => {
+    const capabilities =
+      'binary="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      binary: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+    })
+    const capabilities2 =
+      "binary='/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'"
+    expect(Capabilities.parseString(capabilities2)).toEqual({
+      binary: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+    })
+  })
+  it('should parse multiple multiword capability keys', () => {
+    const expected = {
+      browserName: 'internet explorer',
+      version: 10,
+      platform: 'Windows 8.1',
+    }
+    const capabilitiesSingleQuotes =
+      "browserName='internet explorer' version=10.0 platform='Windows 8.1'"
+    expect(Capabilities.parseString(capabilitiesSingleQuotes)).toEqual(expected)
+    const capabilitiesDoubleQuotes =
+      'browserName="internet explorer" version=10.0 platform="Windows 8.1"'
+    expect(Capabilities.parseString(capabilitiesDoubleQuotes)).toEqual(expected)
+  })
+  it('should parse boolean capability key', () => {
+    const capabilities = 'javascriptEnabled=false databaseEnabled=true'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      javascriptEnabled: false,
+      databaseEnabled: true,
+    })
+  })
+  it('should parse integer capability key', () => {
+    const capabilities = 'elementScrollBehavior=1'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      elementScrollBehavior: 1,
+    })
+  })
+  it('should parse dot-notation capability key', () => {
+    const capabilities = 'webdriver.remote.sessionid=someId'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      webdriver: {
+        remote: {
+          sessionid: 'someId',
+        },
+      },
+    })
+  })
+  it('should parse multiple dot-notation capability key', () => {
+    const capabilities = `
+webdriver.remote.sessionid=someId
+webdriver.remote.username=username
+    `
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      webdriver: {
+        remote: {
+          sessionid: 'someId',
+          username: 'username',
+        },
+      },
+    })
+  })
+  it('should parse dot-notation arrays', () => {
+    const capabilities = 'chromeOptions.args=[disable-infobars, headless]'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      chromeOptions: {
+        args: ['disable-infobars', 'headless'],
+      },
+    })
+  })
+  it('should parse space separated capability keys', () => {
+    const capabilities =
+      'browserName =chrome platform= MAC unexpectedAlertBehaviour = ignore'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      browserName: 'chrome',
+      platform: 'MAC',
+      unexpectedAlertBehaviour: 'ignore',
+    })
+  })
+  it('should trim the capability values', () => {
+    const capabilities =
+      'platform="  macOS 10.13   " chromeOptions.args=[   disable-infobars  ,  headless   ]'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      platform: 'macOS 10.13',
+      chromeOptions: {
+        args: ['disable-infobars', 'headless'],
+      },
+    })
+  })
+  it('should parse urls in list', () => {
+    const capabilities = 'bypass=[http://localhost:434, http://localhost:321]'
+    expect(Capabilities.parseString(capabilities)).toEqual({
+      bypass: ['http://localhost:434', 'http://localhost:321'],
+    })
+  })
+})

package/{dist/npm.js → src/__tests__/config.spec.ts}

@@ -1,5 +1,3 @@
-"use strict";
-
 // 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
@@ -16,27 +14,13 @@
 // KIND, either express or implied.  See the License for the
 // specific language governing permissions and limitations
 // under the License.
-const npm = require('global-npm');
 
-function install() {
-  return new Promise((res, rej) => {
-    npm.load({
-      progress: false,
-      loglevel: 'silent'
-    }, e => {
-      if (e) {
-        rej(e);
-      } else {
-        npm.commands.install(e => {
-          if (e) {
-            rej(e);
-          } else {
-            res();
-          }
-        });
-      }
-    });
-  });
-}
+import path from 'path'
+import Config from '../config'
 
-install();
+describe('configuration loader', () => {
+  it('should load the config from a file', () => {
+    const configuration = Config.load(path.join(__dirname, 'config_1.yml'))
+    expect(configuration.capabilities).toBeDefined()
+  })
+})

package/src/__tests__/config_1.yml

@@ -0,0 +1,4 @@
+capabilities:
+  browserName: chrome
+  platform: MAC
+  unexpectedAlertBehaviour: ignore

package/src/__tests__/config_2.yml

@@ -0,0 +1,3 @@
+capabilities:
+  browserName: chrome
+  platform: UNIX

package/src/__tests__/proxy.spec.ts

@@ -0,0 +1,138 @@
+// 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.
+
+import ParseProxy from '../proxy'
+
+describe('proxy parser', () => {
+  it('should parse a direct proxy', () => {
+    expect(ParseProxy('direct')).toEqual({
+      proxyType: 'direct',
+    })
+  })
+  it('should parse a system proxy', () => {
+    expect(ParseProxy('system')).toEqual({
+      proxyType: 'system',
+    })
+  })
+  it('should parse a pac proxy', () => {
+    expect(ParseProxy('pac', 'http://localhost/pac')).toEqual({
+      proxyType: 'pac',
+      proxyOptions: 'http://localhost/pac',
+    })
+  })
+  it('should throw if no pac file was given', () => {
+    expect(() => ParseProxy('pac')).toThrowError(
+      'A proxy autoconfig URL was not passed (e.g. --proxy-options="http://localhost/pac")'
+    )
+  })
+  it('should parse a manual proxy', () => {
+    expect(ParseProxy('manual', {})).toEqual({
+      proxyType: 'manual',
+      proxyOptions: {},
+    })
+  })
+  it('should omit redundant keys from the proxy', () => {
+    expect(
+      ParseProxy('manual', { test: 4, http: 'http://localhost:4324' })
+    ).toEqual({
+      proxyType: 'manual',
+      proxyOptions: {
+        http: 'http://localhost:4324',
+      },
+    })
+  })
+  it('should whitelist the allowed proxy protocols', () => {
+    expect(
+      ParseProxy('manual', {
+        test: 4,
+        http: 'http://localhost:4324',
+        https: 'http://localhost:4324',
+        ftp: 'http://localhost:4324',
+        bypass: ['http://something.com'],
+      })
+    ).toEqual({
+      proxyType: 'manual',
+      proxyOptions: {
+        http: 'http://localhost:4324',
+        https: 'http://localhost:4324',
+        ftp: 'http://localhost:4324',
+        bypass: ['http://something.com'],
+      },
+    })
+  })
+  it('should return an empty object if no options were given to manual proxy', () => {
+    expect(ParseProxy('manual')).toEqual({
+      proxyType: 'manual',
+      proxyOptions: {},
+    })
+  })
+  it('should throw if non object was passed to manual proxy type', () => {
+    // @ts-expect-error intentionally invalid type
+    expect(() => ParseProxy('manual', 5)).toThrowError(
+      'Proxy options were not passed to manual proxy (e.g. --proxy-options="http=localhost:321 ftp=localhost:4324")'
+    )
+  })
+  it('should parse socks proxy', () => {
+    expect(ParseProxy('socks', { socksProxy: 'localhost:213' })).toEqual({
+      proxyType: 'socks',
+      proxyOptions: {
+        socksProxy: 'localhost:213',
+      },
+    })
+  })
+  it('should parse socks proxy version', () => {
+    expect(
+      ParseProxy('socks', { socksProxy: 'localhost:213', socksVersion: 5 })
+    ).toEqual({
+      proxyType: 'socks',
+      proxyOptions: {
+        socksProxy: 'localhost:213',
+        socksVersion: 5,
+      },
+    })
+    expect(
+      ParseProxy('socks', { socksProxy: 'localhost:213', socksVersion: '5' })
+    ).toEqual({
+      proxyType: 'socks',
+      proxyOptions: {
+        socksProxy: 'localhost:213',
+        socksVersion: 5,
+      },
+    })
+  })
+  it('should throw if no socks proxy url was given', () => {
+    expect(() => ParseProxy('socks')).toThrowError(
+      'Proxy options were not passed to socks proxy (e.g. --proxy-options="socksProxy=localhost:321")'
+    )
+    expect(() => ParseProxy('socks', {})).toThrowError(
+      'Proxy options were not passed to socks proxy (e.g. --proxy-options="socksProxy=localhost:321")'
+    )
+  })
+  it('should throw if a non-number was passed as socks version', () => {
+    expect(() =>
+      ParseProxy('socks', { socksProxy: 'localhost:434', socksVersion: 'test' })
+    ).toThrowError(
+      'Proxy socks version is invalid (e.g. --proxy-options="socksProxy=localhost:321 socksVersion=5")'
+    )
+  })
+  it('should throw if an invalid proxy type was passed', () => {
+    // @ts-expect-error intentionally invalid type
+    expect(() => ParseProxy('invalid')).toThrowError(
+      'An unknown proxy type was passed, use one of: direct, system, manual, socks or pac (e.g. --proxy-type="direct")'
+    )
+  })
+})

package/src/__tests__/versioner.spec.ts

@@ -0,0 +1,44 @@
+// 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.
+
+import Satisfies from '../versioner'
+
+describe('semantic versioner', () => {
+  it('should return `undefined` for exact version match', () => {
+    expect(Satisfies('2.1', '2.1')).toBeUndefined()
+  })
+  it('should return a runner upgrade warning for upper minor version mismatch', () => {
+    expect(Satisfies('2.1', '2.0')).toEqual(
+      'runner is older than project file, in case of issues upgrade the runner using: `npm i -g selenium-side-runner@latest`'
+    )
+  })
+  it('should return an IDE upgrade warning for lower minor version mismatch', () => {
+    expect(Satisfies('2.1', '2.2')).toEqual(
+      'project file is older than recommended, in case of issues upgrade the project via the IDE'
+    )
+  })
+  it('should throw a runner upgrade error for upper major version mismatch', () => {
+    expect(() => Satisfies('2.1', '1.1')).toThrow(
+      'runner is too old to run the project file, upgrade the runner using: `npm i -g selenium-side-runner@latest`'
+    )
+  })
+  it('should throw an IDE upgrade error for lower major version mismatch', () => {
+    expect(() => Satisfies('2.1', '3.1')).toThrow(
+      'project file is too old for the runner, upgrade the project via the IDE'
+    )
+  })
+})

package/src/bin.ts

@@ -0,0 +1,202 @@
+#!/usr/bin/env node
+
+// 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.
+
+import os from 'os'
+import path from 'path'
+import crypto from 'crypto'
+import util from 'util'
+import { Command } from 'commander'
+import Capabilities from './capabilities'
+import Config from './config'
+import ParseProxy from './proxy'
+import { Configuration, ProxyInputOptions, SideRunnerAPI } from './types'
+import { spawn } from 'child_process'
+
+const isWindows = os.platform() === 'win32'
+
+const metadata = require('../package.json')
+
+const DEFAULT_TIMEOUT = 15000
+
+process.title = metadata.name
+
+const program: SideRunnerAPI = new Command() as SideRunnerAPI
+program
+  .usage(
+    '[options] your-project-glob-here-*.side [variadic-project-globs-*.side]'
+  )
+  .version(metadata.version)
+  .option('--base-url [url]', 'Override the base URL that was set in the IDE')
+  .option('-c, --capabilities [list]', 'Webdriver capabilities')
+  .option('-s, --server [url]', 'Webdriver remote server')
+  .option('-p, --params [list]', 'General parameters')
+  .option(
+    '-f, --filter [string]',
+    'Run suites matching name, takes a regex without slashes, eg (^(hello|goodbye).*$)'
+  )
+  .option(
+    '-w, --max-workers [number]',
+    `Maximum amount of workers that will run your tests, defaults to number of cores`,
+    (str) => parseInt(str),
+    os.cpus().length
+  )
+  .option(
+    '-t, --timeout [number]',
+    `The maximimum amount of time, in milliseconds, to spend attempting to locate an element. (default: ${DEFAULT_TIMEOUT})`,
+    (str) => parseInt(str),
+    DEFAULT_TIMEOUT
+  )
+  .option(
+    '-x, --proxy-type [type]',
+    'Type of proxy to use (one of: direct, manual, pac, socks, system)'
+  )
+  .option(
+    '-y, --proxy-options [list]',
+    'Proxy options to pass, for use with manual, pac and socks proxies'
+  )
+  .option(
+    '-n, --config-file [filepath]',
+    'Use specified YAML file for configuration. (default: .side.yml)'
+  )
+  .option(
+    '-o, --output-directory [directory]',
+    'Write test results to files, format is defined by --output-format'
+  )
+  .option(
+    '-f, --force',
+    "Forcibly run the project, regardless of project's version"
+  )
+  .option('-d, --debug', 'Print debug logs')
+
+program.parse()
+
+if (!program.args.length) {
+  program.outputHelp()
+  // eslint-disable-next-line no-process-exit
+  process.exit(1)
+}
+const options = program.opts()
+const configuration: Configuration = {
+  baseUrl: '',
+  capabilities: {
+    browserName: 'chrome',
+  },
+  debug: options.debug,
+  filter: '.*',
+  force: options.force,
+  maxWorkers: options.maxWorkers,
+  params: {},
+  // Convert all project paths into absolute paths
+  projects: program.args.map((arg) => {
+    if (path.isAbsolute(arg)) return arg
+    return path.join(process.cwd(), arg)
+  }),
+  proxyOptions: {},
+  runId: crypto.randomBytes(16).toString('hex'),
+  path: path.join(__dirname, '../../'),
+  server: '',
+  timeout: options.timeout,
+}
+
+const confPath = options.configFile || '.side.yml'
+const configFilePath = path.isAbsolute(confPath)
+  ? confPath
+  : path.join(process.cwd(), confPath)
+try {
+  Object.assign(configuration, Config.load(configFilePath))
+} catch (e) {
+  options.debug && console.debug('Could not load ' + configFilePath)
+}
+
+if (options.filter) {
+  configuration.filter = options.filter
+}
+configuration.server = options.server ? options.server : configuration.server
+
+if (options.capabilities) {
+  try {
+    configuration.capabilities = Capabilities.parseString(options.capabilities)
+  } catch (e) {
+    options.debug && console.debug('Failed to parse inline capabilities')
+  }
+}
+
+if (options.params) {
+  try {
+    configuration.params = Capabilities.parseString(options.params)
+  } catch (e) {
+    options.debug && console.debug('Failed to parse additional params')
+  }
+}
+
+if (options.proxyType) {
+  try {
+    let opts
+    if (options.proxyType === 'manual' || options.proxyType === 'socks') {
+      opts = Capabilities.parseString(options.proxyOptions as string)
+    }
+    const proxy = ParseProxy(options.proxyType, opts as ProxyInputOptions)
+    Object.assign(configuration.capabilities, proxy)
+  } catch (e) {
+    console.error((e as Error).message)
+    // eslint-disable-next-line no-process-exit
+    process.exit(1)
+  }
+} else if (configuration.proxyType) {
+  try {
+    const proxy = ParseProxy(
+      configuration.proxyType,
+      configuration.proxyOptions
+    )
+    Object.assign(configuration.capabilities, proxy)
+  } catch (e) {
+    console.error((e as Error).message)
+    // eslint-disable-next-line no-process-exit
+    process.exit(1)
+  }
+}
+
+configuration.baseUrl = options.baseUrl
+  ? options.baseUrl
+  : configuration.baseUrl
+
+options.debug && console.debug(util.inspect(configuration))
+
+const jestExecutable = isWindows ? 'jest.cmd' : 'jest'
+spawn(
+  path.join(__dirname, '..', 'node_modules', '.bin', jestExecutable),
+  [
+    '--config=' + path.join(__dirname, '..', 'jest.config.js'),
+    '--maxConcurrency=' + configuration.maxWorkers,
+    '--runTestsByPath',
+    path.join(__dirname, 'main.test.js'),
+  ],
+  {
+    env: {
+      ...process.env,
+      SE_CONFIGURATION: JSON.stringify(configuration),
+    },
+    shell: true,
+    stdio: 'inherit',
+  }
+).on('exit', (code) => {
+  // This is my bin, my process
+  // eslint-disable-next-line no-process-exit
+  process.exit(code as number)
+})