ui5-test-runner 5.11.2 → 5.13.0

package/index.js

@@ -58,14 +58,14 @@ async function main () {
   }
   output.reportOnJobProgress()
   checkLatest(job, name, version)
-  if (job.mode === 'capabilities') {
-    return capabilities(job)
-  }
   if (job.if && !executeIf(job)) {
     output.skipIf()
     output.stop()
     return
   }
+  if (job.mode === 'capabilities') {
+    return capabilities(job)
+  }
 
   let startedCommand
   if (job.startCommand) {
@@ -74,10 +74,11 @@ async function main () {
 
   if (job.mode === 'batch') {
     return await batch(job)
-      .finally(() => {
+      .finally(async () => {
         if (startedCommand) {
-          return startedCommand.stop()
+          await startedCommand.stop()
         }
+        cleanHandles(job)
       })
   }
 

package/jest.config.json

@@ -5,7 +5,8 @@
   ],
   "testPathIgnorePatterns": [
     "/node_modules/",
-    "/capabilities/"
+    "/capabilities/",
+    "/e2e/"
   ],
   "collectCoverage": true,
   "collectCoverageFrom": [
@@ -16,6 +17,7 @@
     "\\.spec\\.js",
     "output\\.js",
     "handle\\.js",
+    "coverage\\.js",
     "b\\capabilities\\b"
   ],
   "coverageThreshold": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.11.2",
+  "version": "5.13.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -23,6 +23,8 @@
     "test:unit:debug": "node --inspect node_modules/jest/bin/jest.js --runInBand --no-coverage",
     "pretest:e2e": "npm install -g puppeteer selenium-webdriver playwright webdriverio jsdom",
     "test:e2e": "node . --batch \"test/e2e/[\\w_]*\\.json\" --report-dir e2e --start \"node test/e2e/serve.js\" --start-wait-url http://localhost:8081 --start-wait-method HEAD --start-timeout 30s",
+    "serve:e2e": "node test/e2e/serve.js",
+    "test:e2e:legacy-only": "node . --batch \"test/e2e/JS_LEGACY_[\\w_]*\\.json\" --report-dir e2e --start serve:e2e --start-wait-url http://localhost:8081 --start-wait-method HEAD --start-timeout 30s --debug-verbose start handle --ci",
     "test:report": "node ./src/defaults/report.js ./test/report && reserve --config ./test/report/reserve.json",
     "test:text-report": "node ./src/defaults/text-report.js ./test/report",
     "build:doc": "node build/doc",
@@ -51,17 +53,16 @@
   "homepage": "https://github.com/ArnaudBuchholz/ui5-test-runner#readme",
   "dependencies": {
     "commander": "^12.1.0",
-    "pidtree": "^0.6.0",
     "punybind": "^1.2.1",
     "punyexpr": "1.2.0",
     "reserve": "2.3.4"
   },
   "devDependencies": {
-    "@openui5/types": "^1.143.0",
-    "@semantic-release/npm": "^13.1.2",
-    "@ui5/cli": "^4.0.37",
+    "@openui5/types": "^1.143.1",
+    "@semantic-release/npm": "^13.1.3",
+    "@ui5/cli": "^4.0.38",
     "@ui5/middleware-code-coverage": "^2.0.2",
-    "baseline-browser-mapping": "^2.8.32",
+    "baseline-browser-mapping": "^2.9.11",
     "dotenv": "^16.5.0",
     "jest": "^29.7.0",
     "nock": "^14.0.10",
@@ -71,7 +72,7 @@
     "semantic-release": "^25.0.2",
     "standard": "^17.1.2",
     "typescript": "^5.9.3",
-    "ui5-tooling-transpile": "^3.9.2"
+    "ui5-tooling-transpile": "^3.10.0"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"

package/src/defaults/json-report.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const { join, isAbsolute } = require('path')
+const { writeFile } = require('fs').promises
+const [,, reportDir] = process.argv
+const verbose = process.argv.includes('--verbose')
+
+const log = verbose ? console.log : () => {}
+
+log('🏗 Building JSON report...')
+
+async function main () {
+  const jobPath = isAbsolute(reportDir) ? reportDir : join(process.cwd(), reportDir)
+  log('📦 job path        :', jobPath)
+  const rawJob = require(join(jobPath, 'job.js'))
+  const cleanJob = JSON.parse(JSON.stringify(rawJob, (key, value) => {
+    if (value && value instanceof RegExp) {
+      return value.toString()
+    }
+    return value
+  }))
+  const json = JSON.stringify(cleanJob, null, 2)
+  log('📦 json            :', json.length)
+
+  await writeFile(join(reportDir, 'report.json'), json)
+  log('✅ generated.')
+}
+
+main()
+  .catch(reason => {
+    console.error(reason)
+    return -1
+  })
+  .then((code = 0) => {
+    process.exit(code)
+  })

package/src/job-mode.js

@@ -41,16 +41,13 @@ function buildAndCheckMode (job) {
       'batchMode',
       'batchId',
       'batchLabel',
-      'ci'
+      'ci',
+      'if'
     ])
     return 'capabilities'
   }
   if (job.url && job.url.length) {
     check(job, undefined, [
-      'ui5',
-      'libs',
-      'mappings',
-      'cache',
       'testsuite'
     ])
     return 'url'

package/src/job.js

@@ -159,7 +159,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 [flag]', '[💻📡] Disable UI5 mapping (also disable libs)', boolean, false)
-    .option('--libs <lib...>', '[💻📡] Library mapping (<relative>=<path> or <path>)', arrayOf(lib))
+    .option('--libs <lib...>', '[💻📡] Library mapping (<relative>=<path> or <path>), use *=webapp/resources to map resources sub folder', 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)')
     .option('--preload <library...>', '[💻📡] Preload UI5 libraries in the cache folder (only if --cache is used)', arrayOf(string))

package/src/start.js

@@ -1,58 +1,71 @@
-const { exec } = require('child_process')
-const { stat, readFile } = require('fs/promises')
+const { spawn } = require('child_process')
+const { readFile, access, constants } = require('fs/promises')
 const { join } = require('path')
 const { getOutput } = require('./output')
-const pidtree = require('pidtree')
+const { platform } = require('os')
+const { allocPromise } = require('./tools')
 
 async function start (job) {
   const { startWaitUrl: url, startWaitMethod: method } = job
-  let { startCommand: start } = job
+  const { startCommand: start } = job
   const output = getOutput(job)
-  const [command, ...parameters] = start.split(' ')
+  let [command, ...parameters] = start.split(' ')
 
   job.status = 'Executing start command'
 
-  // check if node
-  if (command === 'node') {
-    let [node] = process.argv
-    if (node.includes(' ')) {
-      node = `"${node}"`
-    }
-    output.debug('start', `Replacing node with ${node}`)
-    start = [node, ...parameters].join(' ')
-  } else {
-    // check if existing NPM script
+  // check if existing NPM script
+  if (command !== 'node' && parameters.length === 0) {
     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}`
-        }
+      await access(packagePath, constants.F_OK)
+      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 script in package.json')
+        // grab npm-cli path
+        const { promise, resolve } = allocPromise()
+        const npmChildProcess = spawn('npm', {
+          shell: true,
+          encoding: 'utf8'
+        })
+        npmChildProcess.on('close', resolve)
+        const npmOutput = []
+        npmChildProcess.stdout.on('data', (data) => npmOutput.push(data.toString()))
+        await promise
+        const [, version, path] = /^npm@([^ ]+) (.*)$/gm.exec(npmOutput.join(''))
+        output.debug('start', `npm@${version} ${path}`)
+        parameters = [join(path, 'bin/npm-cli.js'), 'run', command]
+        command = 'node'
       }
     } catch (e) {
       output.debug('start', 'Missing or invalid package.json in cwd', e)
     }
   }
 
+  if (command === 'node') {
+    const [node] = process.argv
+    output.debug('start', `Replacing node with ${node}`)
+    command = node
+  }
+
   let startProcessExited = false
-  output.debug('start', 'Starting command :', start)
-  const startProcess = exec(start, {
+  output.debug('start', 'Spawning', [command, ...parameters])
+  const startProcess = spawn(command, parameters, {
     cwd: job.cwd,
-    windowsHide: true
+    windowsHide: true,
+    detached: true
   })
   startProcess.on('close', () => {
     output.debug('start', 'Start command process exited')
     startProcessExited = true
   })
   output.monitor(startProcess)
+  output.debug('start', `Spawned process id ${startProcess.pid}`)
 
   job.status = 'Waiting for URL to be reachable'
 
   const begin = Date.now()
+  let lastError
   // eslint-disable-next-line no-unmodified-loop-condition
   while (!startProcessExited && Date.now() - begin <= job.startTimeout) {
     try {
@@ -62,7 +75,10 @@ async function start (job) {
         break
       }
     } catch (e) {
-      output.debug('start', url, e)
+      if (e.toString() !== lastError) {
+        output.debug('start', url, e)
+        lastError = e.toString()
+      }
       await new Promise(resolve => setTimeout(resolve, 250))
     }
   }
@@ -73,61 +89,30 @@ async function start (job) {
 
   const stop = async () => {
     job.status = 'Terminating start command'
-    const begin = new Date()
-    // eslint-disable-next-line no-unmodified-loop-condition
-    while (!startProcessExited && Date.now() - begin <= job.startTimeout) {
-      output.debug('start', `Getting start command ${startProcess.pid} child processes...`)
-      let childProcesses
+    if (platform() === 'win32') {
+      const killProcess = spawn('taskkill', ['/F', '/T', '/PID', startProcess.pid], {
+        windowsHide: true
+      })
+      const { promise, resolve } = allocPromise()
+      killProcess.on('close', resolve)
+      output.monitor(killProcess)
+      await promise
+    } else {
       try {
-        childProcesses = await pidtree(startProcess.pid, { advanced: true })
-      } catch (e) {
-        output.genericError(e)
-        break
-      }
-      output.debug('start', 'Child processes', JSON.stringify(childProcesses))
-      if (childProcesses.length === 0) {
-        try {
-          output.debug('start', 'Terminating start command')
-          process.kill(startProcess.pid, 'SIGKILL')
-        } catch (e) {
-          output.debug('start', 'Failed to terminate start command', startProcess.pid, ':', e)
-        }
-      } else {
-        const depth = {}
-        let deepest = 1
-        let deepless = childProcesses.length
-        while (deepless > 0) {
-          for (const { ppid, pid } of childProcesses) {
-            if (ppid === startProcess.pid) {
-              depth[pid] = 1
-              --deepless
-            } else {
-              const parentDepth = depth[ppid]
-              if (parentDepth !== undefined) {
-                depth[pid] = parentDepth + 1
-                deepest = Math.max(deepest, parentDepth + 1)
-                --deepless
-              }
-            }
-          }
-        }
-        output.debug('start', 'Child processes', JSON.stringify(depth), 'terminating', deepest)
-        for (const { pid } of childProcesses) {
-          if (depth[pid] === deepest) {
-            output.debug('start', 'Terminating start child process', pid)
-            try {
-              process.kill(pid, 'SIGKILL')
-            } catch (e) {
-              output.debug('start', 'Failed to terminate start child process', pid, ':', e)
-            }
-          }
-        }
+        process.kill(-startProcess.pid)
+      } catch (error) {
+        output.genericError(error)
+        return
       }
+    }
+    const begin = Date.now()
+    // eslint-disable-next-line no-unmodified-loop-condition
+    while (!startProcessExited && Date.now() - begin <= job.startTimeout) {
       await new Promise(resolve => setTimeout(resolve, 250))
     }
-    if (!startProcessExited) {
-      output.failedToTerminateStartCommand()
-      startProcess.kill()
+    if (startProcessExited) {
+      // Additional waiting time to release handles
+      await new Promise(resolve => setTimeout(resolve, 250))
     }
   }
 

package/src/ui5.js

@@ -17,6 +17,7 @@ const buildCacheBase = job => {
 }
 
 const ui5mappings = async job => {
+  const output = getOutput(job)
   const cacheBase = buildCacheBase(job)
   const match = /\/((?:test-)?resources\/.*)/ // Captured value never starts with /
   const ifCacheEnabled = () => job.cache
@@ -35,12 +36,12 @@ const ui5mappings = async job => {
     const versionUrl = mappingUrl.replace('$1', 'resources/sap-ui-version.json')
     const versionResponse = await fetch(versionUrl)
     if (versionResponse.status !== 200) {
-      getOutput(job).log('Unable to fetch UI5 version: ' + versionResponse.status + ' ' + versionResponse.statusText)
+      output.log('Unable to fetch UI5 version: ' + versionResponse.status + ' ' + versionResponse.statusText)
       throw new Error('Unable to fetch UI5 version')
     }
     const version = await versionResponse.json()
     const { version: coreVersion } = version.libraries.find(({ name }) => name === 'sap.ui.core')
-    getOutput(job).log('UI5 version used by the local server: ' + coreVersion)
+    output.log('UI5 version used by the local server: ' + coreVersion)
   }
 
   const mappings = [{
@@ -86,7 +87,7 @@ const ui5mappings = async job => {
           file.end()
           uncachable[path] = true
           if (response.statusCode !== 404) {
-            getOutput(job).failedToCacheUI5resource(path, response.statusCode)
+            output.failedToCacheUI5resource(path, response.statusCode)
           }
           return unlink(cachePath)
         })
@@ -107,12 +108,24 @@ const ui5mappings = async job => {
     }
     const relativeUrl = relative.replace(/\//g, '\\/')
     if (source.startsWith(job.webapp)) {
-      const relativeAbsoluteUrl = '/' + relativePath(job.webapp, source).replace(/\\/g, '/')
-      getOutput(job).debug('libs', `${relative} maps to webapp sub directory, use internal redirection to ${relativeAbsoluteUrl}`)
-      mappings.unshift({
-        match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
-        custom: (request, response, $1) => `${relativeAbsoluteUrl}${$1}`
-      })
+      if (relative === '*') {
+        // Special handling to support webapp/resources folder (/!\ coverage won't be extracted for those files)
+        output.debug('libs', '* map to webapp sub directory (expected resources), use file access')
+        mappings.unshift({
+          match: /\/resources\/(.*)/,
+          cwd: source,
+          file: '$1',
+          static: !job.watch && !job.debugDevMode
+        })
+      } else {
+        // Use redirection to support local coverage instrumentation
+        const relativeAbsoluteUrl = '/' + relativePath(job.webapp, source).replace(/\\/g, '/')
+        output.debug('libs', `${relative} maps to webapp sub directory, use internal redirection to ${relativeAbsoluteUrl}`)
+        mappings.unshift({
+          match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
+          custom: (request, response, $1) => `${relativeAbsoluteUrl}${$1}`
+        })
+      }
     } else {
       mappings.unshift({
         match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
@@ -123,9 +136,9 @@ const ui5mappings = async job => {
         match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
         custom: (request, response, $1) => {
           if ($1 === undefined) {
-            getOutput(job).debug('libs', `Unable to map ${relative} : $1 is undefined`)
+            output.debug('libs', `Unable to map ${relative} : $1 is undefined`)
           } else {
-            getOutput(job).debug('libs', `Unable to map ${relative}/${$1} to ${join(source, $1)}`)
+            output.debug('libs', `Unable to map ${relative}/${$1} to ${join(source, $1)}`)
           }
           return 404
         }