ui5-test-runner 5.1.0 → 5.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -46,21 +46,21 @@
     "commander": "^12.1.0",
     "punybind": "^1.2.1",
     "punyexpr": "^1.0.4",
-    "reserve": "2.0.1"
+    "reserve": "2.0.2"
   },
   "devDependencies": {
-    "@openui5/types": "^1.124.0",
-    "@ui5/cli": "^3.10.3",
+    "@openui5/types": "^1.125.0",
+    "@ui5/cli": "^3.11.0",
     "@ui5/middleware-code-coverage": "^1.1.1",
     "dotenv": "^16.4.5",
     "jest": "^29.7.0",
     "nock": "^13.5.4",
-    "nyc": "^15.1.0",
+    "nyc": "^17.0.0",
     "rimraf": "^5.0.7",
     "standard": "^17.1.0",
-    "start-server-and-test": "^2.0.3",
-    "typescript": "^5.4.5",
-    "ui5-tooling-transpile": "^3.4.2"
+    "start-server-and-test": "^2.0.4",
+    "typescript": "^5.5.2",
+    "ui5-tooling-transpile": "^3.4.5"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"

package/src/coverage.js

@@ -310,13 +310,27 @@ module.exports = {
       await setupNyc(job)
       // Assuming all files are coming from the same server
       const { origin } = new URL(job.url[0])
-      const { createInstrumenter } = require(join(await nycInstallationPath, 'node_modules/istanbul-lib-instrument'))
-      const instrumenter = createInstrumenter({
-        produceSourceMap: true,
-        coverageGlobalScope: 'window.top',
-        coverageGlobalScopeFunc: false
-      })
-      const instrument = promisify(instrumenter.instrument.bind(instrumenter))
+      let instrument
+      try {
+        const { createInstrumenter } = require(join(await nycInstallationPath, 'node_modules/istanbul-lib-instrument'))
+        const instrumenter = createInstrumenter({
+          produceSourceMap: true,
+          coverageGlobalScope: 'window.top',
+          coverageGlobalScopeFunc: false
+        })
+        instrument = promisify(instrumenter.instrument.bind(instrumenter))
+      } catch (e) {
+        // Recent version of nyc offers a different interface
+        const createInstrumenter = require(join(await nycInstallationPath, 'lib/instrumenters/istanbul.js'))
+        const instrumenter = createInstrumenter({
+          produceSourceMap: true
+        })
+        instrument = async function (code, sourcePath) {
+          return instrumenter.instrumentSync(code, sourcePath, { registerMap: () => {} })
+            // TODO use regular expression !
+            .replace(globalContextSearch, globalContextReplace)
+        }
+      }
       const sources = {}
       return [{
         match: /(.*\.js)(\?.*)?$/,

package/src/defaults/browser.js

@@ -1,6 +1,6 @@
 const { readFile, writeFile } = require('fs/promises')
 const { join } = require('path')
-const { Command } = require('commander')
+const { Command, InvalidArgumentError } = require('commander')
 const { buildCsvWriter } = require('../csv-writer')
 const { any, boolean, integer } = require('../options')
 
@@ -20,19 +20,58 @@ module.exports = ({
     .name(`ui5-test-runner/@/${metadata.name}`)
     .description(`Browser instantiation command for ${metadata.name}`)
     .helpOption(false)
-  metadata.options.forEach(([label, description, parser, defaultValue]) => {
-    if (defaultValue === undefined && typeof parser !== 'function') {
-      defaultValue = parser
-      if (typeof defaultValue === 'number') {
-        parser = integer
-      } else if (typeof defaultValue === 'boolean') {
-        parser = boolean
-      } else {
-        parser = any
+  metadata.options
+    .map(option => {
+      if (option[0] === 'browser') {
+        const [, ...browsers] = option
+        return [[
+          '-b, --browser <name>', 'Browser driver',
+          function (value) {
+            if (value === undefined) {
+              return browsers[0]
+            }
+            if (!browsers.includes(value)) {
+              throw new InvalidArgumentError('Browser name')
+            }
+            return value
+          },
+          browsers[0]
+        ]]
       }
-    }
-    command.option(label, description, parser, defaultValue)
-  })
+      if (option === 'binary') {
+        return [['--binary <binary>', 'Binary path']]
+      }
+      if (option === 'visible') {
+        return [['--visible [flag]', 'Show the browser', false]]
+      }
+      if (option === 'viewport') {
+        return [
+          ['-w, --viewport-width <width>', 'Viewport width', 1920],
+          ['-h, --viewport-height <height>', 'Viewport height', 1080]
+        ]
+      }
+      if (option === 'language') {
+        return [['-l, --language <lang...>', 'Language(s)', ['en-US']]]
+      }
+      if (option === 'unsecure') {
+        return [['-u, --unsecure', 'Disable security features', false]]
+      }
+      return [option]
+    })
+    .flat()
+    .forEach(([label, description, parser, defaultValue]) => {
+      if (defaultValue === undefined && typeof parser !== 'function') {
+        defaultValue = parser
+        if (typeof defaultValue === 'number') {
+          parser = integer
+        } else if (typeof defaultValue === 'boolean') {
+          parser = boolean
+        } else {
+          parser = any
+        }
+      }
+      command.option(label, description, parser, defaultValue)
+    })
 
   const append = () => { }
   let consoleWriter = { ready: Promise.resolve(), append }
@@ -95,6 +134,12 @@ module.exports = ({
     }
   })
 
+  if (process.argv[2] === 'test') {
+    command.parse(process.argv.slice(3), { from: 'user' })
+    console.log(command.opts(), command.args)
+    return exit(0)
+  }
+
   if (process.argv.length !== 3) {
     command.outputHelp()
     return exit(0)
@@ -105,6 +150,31 @@ module.exports = ({
     command.parse(settings.args, { from: 'user' })
     options = command.opts()
 
+    options.chromeArgs = function () {
+      const args = [
+        '--start-maximized',
+        '--no-sandbox',
+        '--disable-gpu',
+        '--disable-extensions',
+        '--log-level=3',
+        `--window-size=${options.viewportWidth},${options.viewportHeight}`,
+        `--lang=${options.language.join(',')}`
+      ]
+      if (!options.visible) {
+        args.push('--headless=new')
+      }
+      if (options.unsecure) {
+        args.push(
+          '--ignore-certificate-errors',
+          '--disable-web-security',
+          '--disable-features=IsolateOrigins',
+          '--disable-features=BlockInsecurePrivateNetworkRequests',
+          '--disable-site-isolation-trials'
+        )
+      }
+      return args.concat(command.args)
+    }
+
     if (typeof settings.capabilities === 'string') {
       let capabilities
       if (computeCapabilities !== undefined) {

package/src/defaults/playwright.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const { InvalidArgumentError } = require('commander')
 const { join } = require('path')
 const { exec } = require('child_process')
 
@@ -8,26 +7,15 @@ let browser
 let context
 let page
 
-function browserSelector (value, defaultValue) {
-  if (value === undefined) {
-    return 'chromium'
-  }
-  if (!['chromium', 'firefox', 'webkit'].includes(value)) {
-    throw new InvalidArgumentError('Browser name')
-  }
-  return value
-}
-
 require('./browser')({
   metadata: {
     name: 'playwright',
     options: [
-      ['-b, --browser <name>', 'Browser driver', browserSelector, 'chromium'],
-      ['--visible [flag]', 'Show the browser', false],
-      ['-w, --viewport-width <width>', 'Viewport width', 1280],
-      ['-h, --viewport-height <height>', 'Viewport height', 720],
-      ['-l, --language <lang>', 'Language', 'en-US'],
-      ['-u, --unsecure', 'Disable security features', false],
+      ['browser', 'chromium', 'firefox', 'webkit'],
+      'visible',
+      'viewport',
+      'language',
+      'unsecure',
       ['-v, --video', 'Record video', false],
       ['-n, --har', 'Record network activity with har file', false]
     ]
@@ -111,7 +99,7 @@ require('./browser')({
         width: options.viewportWidth,
         height: options.viewportHeight
       },
-      locale: options.language,
+      locale: options.language[0],
       bypassCSP: options.unsecure,
       ignoreHTTPSErrors: options.unsecure,
       recordVideo,

package/src/defaults/puppeteer.js

@@ -7,13 +7,12 @@ require('./browser')({
   metadata: {
     name: 'puppeteer',
     options: [
-      ['--visible [flag]', 'Show the browser', false],
+      'visible',
       ['--firefox [flag]', 'Use firefox instead of chrome', false],
-      ['--binary <binary>', 'Binary path'],
-      ['-w, --viewport-width <width>', 'Viewport width', 1920],
-      ['-h, --viewport-height <height>', 'Viewport height', 1080],
-      ['-l, --language <lang...>', 'Language(s)', ['en-US']],
-      ['-u, --unsecure', 'Disable security features', false],
+      'binary',
+      'viewport',
+      'language',
+      'unsecure',
       ['--basic-auth-username <username>', 'Username for basic authentication', ''],
       ['--basic-auth-password <password>', 'Password for basic authentication', '']
     ]
@@ -55,27 +54,12 @@ require('./browser')({
   }) {
     const puppeteer = require(modules.puppeteer)
 
-    const args = [
-      '--start-maximized',
-      '--no-sandbox',
-      '--disable-gpu',
-      '--disable-extensions',
-      `--window-size=${options.viewportWidth},${options.viewportHeight}`,
-      `--lang=${options.language.join(',')}`
-    ]
-
-    if (options.unsecure) {
-      args.push(
-        '--disable-web-security',
-        '--disable-features=IsolateOrigins',
-        '--disable-features=BlockInsecurePrivateNetworkRequests',
-        '--disable-site-isolation-trials'
-      )
-    }
-
+    let args = []
     let product
     if (options.firefox) {
       product = 'firefox'
+    } else {
+      args = options.chromeArgs()
     }
 
     browser = await puppeteer.launch({

package/src/defaults/selenium-webdriver.js

@@ -1,22 +1,11 @@
 'use strict'
 
-const { InvalidArgumentError } = require('commander')
 const { url } = require('../options')
 const { writeFile } = require('fs/promises')
 
 let logging
 let driver
 
-function browser (value) {
-  if (value === undefined) {
-    return 'chrome'
-  }
-  if (!['chrome', 'firefox', 'edge'].includes(value)) {
-    throw new InvalidArgumentError('Browser name')
-  }
-  return value
-}
-
 async function buildDriver (settings, options) {
   const seleniumWebdriver = require(settings.modules['selenium-webdriver'])
 
@@ -38,10 +27,10 @@ require('./browser')({
   metadata: {
     name: 'selenium-webdriver',
     options: [
-      ['-b, --browser <name>', 'Browser driver', browser, 'chrome'],
-      ['--visible [flag]', 'Show the browser', false],
+      ['browser', 'chrome', 'firefox', 'edge'],
+      'visible',
       ['-s, --server <server>', 'Selenium server URL', url],
-      ['--binary <binary>', 'Binary path']
+      'binary'
     ]
   },
 

package/src/defaults/webdriverio.js

@@ -1,26 +1,17 @@
 'use strict'
 
-const { InvalidArgumentError } = require('commander')
-
 let browserio
 
-function browser (value) {
-  if (value === undefined) {
-    return 'chrome'
-  }
-  if (!['chrome', 'firefox'].includes(value)) {
-    throw new InvalidArgumentError('Browser name')
-  }
-  return value
-}
-
 require('./browser')({
   metadata: {
     name: 'webdriverio',
     options: [
-      ['--visible [flag]', 'Show the browser', false],
-      ['-b, --browser <name>', 'Browser driver', browser, 'chrome'],
-      ['--binary <binary>', 'Binary path']
+      'visible',
+      ['browser', 'chrome', 'firefox'],
+      'binary',
+      'viewport',
+      'language',
+      'unsecure'
     ]
   },
 
@@ -57,7 +48,7 @@ require('./browser')({
     const [browserOptions, args] = {
       chrome: [
         'goog:chromeOptions',
-        options.visible ? [] : ['--headless=new', '--log-level=3', '--disable-gpu']
+        options.chromeArgs()
       ],
       firefox: [
         'moz:firefoxOptions',

package/src/inject/post.js

@@ -9,14 +9,17 @@
   const base = window['ui5-test-runner/base-host'] || ''
 
   let lastPost = Promise.resolve()
-  let UI5Object
+
+  function isUI5Object (obj) {
+    return typeof obj === 'object' &&
+      obj !== null &&
+      typeof obj.getId === 'function' &&
+      typeof obj.getMetadata === 'function'
+  }
 
   function stringify (data) {
     const objects = []
     const referenced = []
-    if (!UI5Object && window.sap && window.sap.ui && window.sap.ui.base) {
-      UI5Object = window.sap.ui.base.Object
-    }
     const ui5Summary = obj => {
       const id = obj.getId && obj.getId()
       const className = obj.getMetadata && obj.getMetadata() && obj.getMetadata().getName()
@@ -27,7 +30,7 @@
     }
     const simple = JSON.stringify(data, function (key, value) {
       if (typeof value === 'object' && value) {
-        if (UI5Object && value instanceof UI5Object) {
+        if (isUI5Object(value)) {
           return ui5Summary(value)
         }
         const id = objects.indexOf(value)
@@ -45,7 +48,7 @@
     const stringified = []
     return JSON.stringify(data, function (key, value) {
       if (typeof value === 'object' && value) {
-        if (UI5Object && value instanceof UI5Object) {
+        if (isUI5Object(value)) {
           return ui5Summary(value)
         }
         const id = objects.indexOf(value)

package/src/inject/qunit-intercept.js

@@ -29,7 +29,9 @@
     set: function (value) {
       QUnit = value
       Object.keys(callbacks).forEach(property => {
-        QUnit[property](callbacks[property])
+        if (typeof QUnit[property] === 'function') {
+          QUnit[property](callbacks[property])
+        }
       })
     }
   })

package/src/inject/qunit-redirect.js

@@ -33,20 +33,22 @@
       QUnit = value
 
       const { test } = QUnit
-      QUnit.test = (label) => test(label, (assert) => assert.ok(true, label))
+      if (typeof test === 'function') {
+        QUnit.test = (label) => test(label, (assert) => assert.ok(true, label))
 
-      let timeoutId
-      QUnit.moduleDone(function () {
-        if (timeoutId) {
-          clearTimeout(timeoutId)
-        }
-        timeoutId = setTimeout(notify, 10)
-      })
+        let timeoutId
+        QUnit.moduleDone(function () {
+          if (timeoutId) {
+            clearTimeout(timeoutId)
+          }
+          timeoutId = setTimeout(notify, 10)
+        })
 
-      function notify () {
-        const modules = QUnit.config.modules.map(({ moduleId }) => moduleId)
-        const opa = !!window?.sap?.ui?.test?.Opa5
-        post('addTestPages', { type: 'qunit', opa, modules, page: location.toString() })
+        function notify () {
+          const modules = QUnit.config.modules.map(({ moduleId }) => moduleId)
+          const opa = !!window?.sap?.ui?.test?.Opa5
+          post('addTestPages', { type: 'qunit', opa, modules, page: location.toString() })
+        }
       }
     }
   })