ui5-test-runner 5.3.7 → 5.4.0

package/README.md

@@ -48,3 +48,4 @@ A self-sufficient test runner for UI5 applications enabling parallel execution o
 
 * [Marian Zeis](https://github.com/marianfoo): Documentation page revamp [PR #54](https://github.com/ArnaudBuchholz/ui5-test-runner/pull/54)
 * [Raj Singh](https://github.com/rajxsingh): Basic HTTP Authentication in Puppeteer [PR #71](https://github.com/ArnaudBuchholz/ui5-test-runner/pull/71)
+* [Andreas Kunz](https://github.com/akudev): Improved documentation for TypeScript testing and reviewed `nyc` settings handling [PR #110](https://github.com/ArnaudBuchholz/ui5-test-runner/pull/110)

package/index.js

@@ -3,13 +3,16 @@
 'use strict'
 
 const { serve } = require('reserve')
+const { watch } = require('fs')
+const { capabilities } = require('./src/capabilities')
+const { execute } = require('./src/tests')
 const { fromCmdLine } = require('./src/job')
 const { getOutput } = require('./src/output')
+const { preload } = require('./src/ui5')
+const { probe: probeBrowser } = require('./src/browsers')
+const { recreateDir, allocPromise } = require('./src/tools')
 const reserveConfigurationFactory = require('./src/reserve')
-const { execute } = require('./src/tests')
-const { capabilities } = require('./src/capabilities')
-const { watch } = require('fs')
-const { recreateDir } = require('./src/tools')
+const start = require('./src/start')
 
 function send (message) {
   if (process.send) {
@@ -20,7 +23,7 @@ function send (message) {
   }
 }
 
-async function notifyAndExecuteTests (job, output) {
+async function notifyAndExecuteTests (job) {
   send({ msg: 'begin' })
   try {
     await execute(job)
@@ -44,8 +47,8 @@ async function main () {
   job = fromCmdLine(process.cwd(), process.argv.slice(2))
   output = getOutput(job)
   await recreateDir(job.reportDir)
+  output.version()
   if (job.mode === 'capabilities') {
-    output.version()
     return capabilities(job)
   }
   const configuration = await reserveConfigurationFactory(job)
@@ -54,43 +57,61 @@ async function main () {
   if (job.logServer) {
     server.on('redirected', output.redirected)
   }
+
+  const { promise: serverStarted, resolve: serverReady, reject: serverError } = allocPromise()
   server
     .on('ready', async ({ url, port }) => {
       job.port = port
       send({ msg: 'ready', port: job.port })
       output.serving(url)
       output.reportOnJobProgress()
-      if (job.serveOnly) {
-        job.status = 'Serving'
-        return
-      }
-      await notifyAndExecuteTests(job)
-      if (job.watch) {
-        delete job.start
-        if (!job.watching) {
-          output.watching(job.webapp)
-          watch(job.webapp, { recursive: true }, (eventType, filename) => {
-            output.changeDetected(eventType, filename)
-            if (!job.start) {
-              notifyAndExecuteTests(job)
-            }
-          })
-          job.watching = true
-        }
-      } else if (job.keepAlive) {
-        job.status = 'Serving'
-      } else if (job.failed) {
-        output.stop()
-        process.exit(-1)
-      } else {
-        output.stop()
-        process.exit(0)
-      }
+      serverReady()
     })
     .on('error', error => {
       output.serverError(error)
       send({ msg: 'error', error })
+      serverError()
     })
+  await serverStarted
+  let startedCommand
+  if (job.start) {
+    output.reportOnJobProgress()
+    startedCommand = await start(job)
+  }
+  if (job.preload) {
+    await preload(job)
+  }
+  if (job.serveOnly) {
+    job.status = 'Serving'
+    return
+  }
+  await probeBrowser(job)
+  await notifyAndExecuteTests(job)
+  if (job.watch) {
+    delete job.start
+    if (!job.watching) {
+      output.watching(job.webapp)
+      watch(job.webapp, { recursive: true }, async (eventType, filename) => {
+        output.changeDetected(eventType, filename)
+        if (!job.start) {
+          await recreateDir(job.reportDir)
+          notifyAndExecuteTests(job)
+        }
+      })
+      job.watching = true
+    }
+  } else if (job.keepAlive) {
+    job.status = 'Serving'
+    return
+  } else if (job.failed) {
+    process.exitCode = -1
+  }
+  output.stop()
+  await server.close()
+  if (startedCommand) {
+    await startedCommand.stop()
+  }
+  console.log('done ?')
 }
 
 main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.3.7",
+  "version": "5.4.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -44,23 +44,23 @@
   "homepage": "https://github.com/ArnaudBuchholz/ui5-test-runner#readme",
   "dependencies": {
     "commander": "^12.1.0",
+    "ps-tree": "^1.2.0",
     "punybind": "^1.2.1",
     "punyexpr": "^1.0.4",
     "reserve": "2.0.5"
   },
   "devDependencies": {
-    "@openui5/types": "^1.130.1",
-    "@ui5/cli": "^4.0.11",
+    "@openui5/types": "^1.132.0",
+    "@ui5/cli": "^4.0.12",
     "@ui5/middleware-code-coverage": "^2.0.1",
-    "dotenv": "^16.4.5",
+    "dotenv": "^16.4.7",
     "jest": "^29.7.0",
     "nock": "^13.5.6",
     "nyc": "^17.1.0",
     "rimraf": "^6.0.1",
     "standard": "^17.1.2",
-    "start-server-and-test": "^2.0.8",
-    "typescript": "^5.7.2",
-    "ui5-tooling-transpile": "^3.5.1"
+    "typescript": "^5.7.3",
+    "ui5-tooling-transpile": "^3.5.3"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"

package/src/coverage.js

@@ -60,7 +60,7 @@ const customFileSystem = {
 
 async function instrument (job) {
   await setupNyc(job)
-  job[$nycSettingsPath] = join(job.coverageTempDir, 'settings/nyc.json')
+  job[$nycSettingsPath] = join(job.coverageTempDir, 'settings/.nycrc.json')
   await cleanDir(job.coverageTempDir)
   await createDir(join(job.coverageTempDir, 'settings'))
   const settings = JSON.parse((await readFile(job.coverageSettings)).toString())

package/src/inject/qunit-hooks.js

@@ -40,11 +40,11 @@
       details.isOpa = isOpa()
       return post('QUnit/begin', details)
     })
-  
+
     QUnit.testStart(function (details) {
       return post('QUnit/testStart', extend(details))
     })
-  
+
     QUnit.log(function (log) {
       let ready = false
       post('QUnit/log', extend(log))
@@ -64,11 +64,11 @@
         })
       }
     })
-  
+
     QUnit.testDone(function (report) {
       return post('QUnit/testDone', report)
     })
-  
+
     QUnit.done(function (report) {
       if (window.__coverage__) {
         report.__coverage__ = window.__coverage__
@@ -78,7 +78,7 @@
   }
 
   if (typeof window.QUnit !== 'undefined' && QUnit.begin) {
-    installQUnitHooks();
+    installQUnitHooks()
   } else {
     let QUnit
     let install = true
@@ -87,7 +87,7 @@
       get: function () {
         return QUnit
       },
-  
+
       set: function (value) {
         QUnit = value
         if (QUnit && QUnit.begin && install) {
@@ -97,5 +97,4 @@
       }
     })
   }
-
 }())

package/src/job-mode.js

@@ -33,7 +33,7 @@ function buildAndCheckMode (job) {
       'keepAlive',
       'alternateNpmPath',
       'outputInterval'
-    ])
+    ], ['start'])
     return 'capabilities'
   }
   if (job.url && job.url.length) {
@@ -50,7 +50,8 @@ function buildAndCheckMode (job) {
   check(job, undefined, [
     'coverageProxy',
     'coverageProxyInclude',
-    'coverageProxyExclude'
+    'coverageProxyExclude',
+    'start'
   ])
   return 'legacy'
 }

package/src/job.js

@@ -103,11 +103,11 @@ function getCommand (cwd) {
     .option('-b, --browser <command>', '[💻🔗🧪] Browser instantiation command (relative to cwd or use $/ for provided ones)', '$/puppeteer.js')
     .option('--browser-args <argument...>', '[💻🔗🧪] Browser instantiation command parameters (use -- instead)')
     .option('--alternate-npm-path <path>', '[💻🔗] Alternate NPM path to look for packages (priority: local, alternate, global)')
-    .option('--no-npm-install', '[💻🔗🧪] Prevent any NPM install (execution may fail if a dependency is missing)')
+    .option('--no-npm-install [flag]', '[💻🔗🧪] Prevent any NPM install (execution may fail if a dependency is missing)', boolean)
     .option('-bt, --browser-close-timeout <timeout>', '[💻🔗🧪] Maximum waiting time for browser close', timeout, 2000)
     .option('-br, --browser-retry <count>', '[💻🔗🧪] Browser instantiation retries : if the command fails unexpectedly, it is re-executed (0 means no retry)', 1)
     .option('-oi, --output-interval <interval>', '[💻🔗🧪] Interval for reporting progress on non interactive output (CI/CD) (0 means no output)', timeout, 30000)
-    .option('--offline', '[💻🔗🧪] Limit network usage (implies --no-npm-install)', boolean, false)
+    .option('--offline [flag]', '[💻🔗🧪] Limit network usage (implies --no-npm-install)', boolean, false)
 
     // Common to legacy and url
     .option('--webapp <path>', '[💻🔗] Base folder of the web application (relative to cwd)', 'webapp')
@@ -116,15 +116,15 @@ function getCommand (cwd) {
     .option('--page-close-timeout <timeout>', '[💻🔗] Maximum waiting time for page close', timeout, 250)
     .option('-t, --global-timeout <timeout>', '[💻🔗] Limit the pages execution time, fail the page if it takes longer than the timeout (0 means no timeout)', timeout, 0)
     .option('--screenshot [flag]', '[💻🔗] Take screenshots during the tests execution (if supported by the browser)', boolean, true)
-    .option('--no-screenshot', '[💻🔗] Disable screenshots')
+    .option('--no-screenshot [flag]', '[💻🔗] Disable screenshots', boolean)
     .option('-st, --screenshot-timeout <timeout>', '[💻🔗] Maximum waiting time for browser screenshot', timeout, 5000)
-    .option('-so, --split-opa', '[💻🔗] Split OPA tests using QUnit modules', boolean, false)
+    .option('-so, --split-opa [flag]', '[💻🔗] Split OPA tests using QUnit modules', boolean, false)
     .option('-rg, --report-generator <path...>', '[💻🔗] Report generator paths (relative to cwd or use $/ for provided ones)', ['$/report.js'])
     .option('--progress-page <path>', '[💻🔗] Progress page path (relative to cwd or use $/ for provided ones)', '$/report/default.html')
 
     .option('--coverage [flag]', '[💻🔗] Enable or disable code coverage', boolean)
-    .option('--no-coverage', '[💻🔗] Disable code coverage')
-    .option('-cs, --coverage-settings <path>', '[💻🔗] Path to a custom nyc.json file providing settings for instrumentation (relative to cwd or use $/ for provided ones)', '$/nyc.json')
+    .option('--no-coverage [flag]', '[💻🔗] Disable code coverage', boolean)
+    .option('-cs, --coverage-settings <path>', '[💻🔗] Path to a custom .nycrc.json file providing settings for instrumentation (relative to cwd or use $/ for provided ones)', '$/.nycrc.json')
     .option('-ctd, --coverage-temp-dir <path>', '[💻🔗] Directory to output raw coverage information to (relative to cwd)', '.nyc_output')
     .option('-crd, --coverage-report-dir <path>', '[💻🔗] Directory to store the coverage report files (relative to cwd)', 'coverage')
     .option('-cr, --coverage-reporters <reporter...>', '[💻🔗] List of nyc reporters to use (text is always used)', ['lcov', 'cobertura'])
@@ -137,7 +137,7 @@ function getCommand (cwd) {
 
     // Specific to legacy (and might be used with url if pointing to local project)
     .option('--ui5 <url>', '[💻] UI5 url', url, 'https://ui5.sap.com')
-    .option('--disable-ui5', '[💻] Disable UI5 mapping (also disable libs)', boolean, false)
+    .option('--disable-ui5 [flag]', '[💻] Disable UI5 mapping (also disable libs)', boolean, false)
     .option('--libs <lib...>', '[💻] Library mapping (<relative>=<path> or <path>)', arrayOf(lib))
     .option('--mappings <mapping...>', '[💻] Custom mapping (<match>=<file|url>(<config>))', arrayOf(mapping))
     .option('--cache <path>', '[💻] Cache UI5 resources locally in the given folder (empty to disable)')
@@ -145,6 +145,10 @@ function getCommand (cwd) {
     .option('--testsuite <path>', '[💻] Path of the testsuite file (relative to webapp, URL parameters are supported)', 'test/testsuite.qunit.html')
     .option('-w, --watch [flag]', '[💻] Monitor the webapp folder and re-execute tests on change', boolean, false)
 
+    // Specific to url
+    .option('--start <command>', '[🔗] Start command (might be an NPM script or a shell command)', string)
+    .option('--start-timeout <timeout>', '[🔗] Maximum waiting time for the start command (based on when the first URL becomes available)', timeout, 5000)
+
     // Specific to coverage in url mode (experimental)
     .option('-cp, --coverage-proxy [flag]', `[🔗] ${EXPERIMENTAL_OPTION} use internal proxy to instrument remote files`, boolean, false)
     .option('-cpi, --coverage-proxy-include <regexp>', `[🔗] ${EXPERIMENTAL_OPTION} urls to instrument for coverage`, regex, '.*')

package/src/output.js

@@ -171,16 +171,23 @@ function output (job, ...args) {
   writeFileSync(
     join(job.reportDir, 'output.txt'),
     args.map(arg => {
-      if (typeof arg === 'object') {
-        return JSON.stringify(arg, undefined, 2)
-      }
       if (arg === undefined) {
         return 'undefined'
       }
       if (arg === null) {
         return 'null'
       }
-      return arg.toString()
+      if (arg instanceof Error) {
+        let error = `${arg.name} ${arg.message}`
+        if (arg.cause) {
+          error += `, cause : ${arg.cause.name} ${arg.cause.message}`
+        }
+        return error
+      }
+      if (typeof arg !== 'string') {
+        return JSON.stringify(arg, undefined, 2)
+      }
+      return arg
     }).join(' ') + '\n',
     {
       encoding: 'utf-8',
@@ -324,6 +331,9 @@ function build (job) {
     }),
 
     reportOnJobProgress () {
+      if (this.reportIntervalId) {
+        return
+      }
       if (interactive) {
         this.reportIntervalId = setInterval(progress.bind(null, job), 250)
       } else if (job.outputInterval && !inJest) {

package/src/start.js

@@ -0,0 +1,91 @@
+const { exec } = require('child_process')
+const { stat, readFile } = require('fs/promises')
+const { join } = require('path')
+const { getOutput } = require('./output')
+const psTreeNodeCb = require('ps-tree')
+const { promisify } = require('util')
+const psTree = promisify(psTreeNodeCb)
+
+const $startedProcess = Symbol('startedProcess')
+
+module.exports = async function start (job) {
+  let { start } = job
+  const output = getOutput(job)
+  const [command] = start.split(' ')
+
+  job.status = 'Executing start command'
+
+  // check if existing NPM script
+  const packagePath = join(job.cwd, 'package.json')
+  try {
+    const packageStat = await stat(packagePath)
+    if (packageStat.isFile()) {
+      output.debug('start', 'Found package.json in cwd')
+      const packageFile = JSON.parse(await readFile(packagePath, 'utf-8'))
+      if (packageFile.scripts[command]) {
+        output.debug('start', 'Found matching start script in package.json')
+        start = `npm run ${start}`
+      }
+    }
+  } catch (e) {
+    output.debug('start', 'Missing or invalid package.json in cwd', e)
+  }
+
+  let childProcessExited = false
+  output.debug('start', 'Starting command :', start)
+  const childProcess = exec(start, {
+    cwd: job.cwd,
+    windowsHide: true
+  })
+  childProcess.on('close', () => {
+    output.debug('start', 'start command process exited')
+    childProcessExited = true
+  })
+  output.monitor(childProcess)
+  job[$startedProcess] = childProcess
+
+  job.status = 'Waiting for URL to be reachable'
+
+  const [url] = job.url
+
+  const begin = Date.now()
+  // eslint-disable-next-line no-unmodified-loop-condition
+  while (!childProcessExited && Date.now() - begin <= job.startTimeout) {
+    try {
+      const response = await fetch(url)
+      output.debug('start', url, response.status)
+      if (response.status === 200) {
+        break
+      }
+    } catch (e) {
+      output.debug('start', url, e)
+      await new Promise(resolve => setTimeout(resolve, 250))
+    }
+  }
+
+  if (childProcessExited) {
+    throw new Error(`Start command failed with exit code ${childProcess.exitCode}`)
+  }
+
+  const stop = async () => {
+    output.debug('start', 'Getting child processes...')
+    const childProcesses = await psTree(childProcess.pid)
+    for (const child of childProcesses) {
+      output.debug('start', 'Terminating process', child.PID)
+      try {
+        process.kill(child.PID, 'SIGKILL')
+      } catch (e) {
+        output.debug('start', 'Failed to terminate process', child.PID, ':', e)
+      }
+    }
+  }
+
+  if (Date.now() - begin > job.startTimeout) {
+    await stop()
+    throw new Error(`Timeout while waiting for ${url}`)
+  }
+
+  return {
+    stop
+  }
+}

package/src/tests.js

@@ -1,8 +1,7 @@
 'use strict'
 
-const { probe: probeBrowser, start } = require('./browsers')
+const { start } = require('./browsers')
 const { instrument } = require('./coverage')
-const { recreateDir } = require('./tools')
 const { globallyTimedOut } = require('./timeout')
 const { save, generate } = require('./report')
 const { getOutput } = require('./output')
@@ -12,7 +11,6 @@ const {
   $proxifiedUrls
 } = require('./symbols')
 const { UTRError } = require('./error')
-const { preload } = require('./ui5')
 const parallelize = require('./parallelize')
 
 function task (job, method) {
@@ -128,12 +126,6 @@ async function process (job) {
 
 module.exports = {
   async execute (job) {
-    await recreateDir(job.reportDir)
-    getOutput(job).version()
-    if (job.preload) {
-      await preload(job)
-    }
-    await probeBrowser(job)
     if (job.mode !== 'url') {
       job.url = [`http://localhost:${job.port}/${job.testsuite}`]
     } else if (!job.browserCapabilities.scripts) {