ui5-test-runner 5.5.1 → 5.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.5.1",
+  "version": "5.6.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {

package/src/batch.js

@@ -7,6 +7,8 @@ const { parallelize } = require('./parallelize')
 const { $statusProgressCount } = require('./symbols')
 const { $valueSources } = require('./symbols')
 const { getCommand, toLongName } = require('./job')
+const { save } = require('./report')
+const { end } = require('./end')
 
 const batchParameters = getCommand('.').options
   .filter(option => option.description.includes('📡'))
@@ -17,10 +19,9 @@ const batchParameters = getCommand('.').options
 
 const root = join(__dirname, '..')
 
-const folder = (batchItems, job, folderPath) => {
+const folder = (job, folderPath) => {
   getOutput(job).debug('batch', `adding folder: ${folderPath}`)
-  batchItems.push({
-    job,
+  job.batchItems.push({
     path: folderPath,
     id: filename(folderPath),
     label: folderPath,
@@ -28,15 +29,14 @@ const folder = (batchItems, job, folderPath) => {
   })
 }
 
-const configurationFile = (batchItems, job, configurationFilePath) => {
+const configurationFile = (job, configurationFilePath) => {
   getOutput(job).debug('batch', `adding configuration file: ${configurationFilePath}`)
   try {
     const {
       batchId: id = filename(configurationFilePath),
       batchLabel: label = configurationFilePath
     } = require(configurationFilePath)
-    batchItems.push({
-      job,
+    job.batchItems.push({
       path: configurationFilePath,
       id,
       label,
@@ -47,7 +47,10 @@ const configurationFile = (batchItems, job, configurationFilePath) => {
   }
 }
 
-const task = async ({ job, id, label, args }) => {
+const task = async function (batchItem) {
+  const { id, label, args } = batchItem
+  batchItem.start = new Date()
+  const job = this
   const output = getOutput(job)
   const progress = newProgress(job)
   const reportDir = join(job.reportDir, id)
@@ -73,7 +76,11 @@ const task = async ({ job, id, label, args }) => {
         if (option) {
           parameters.push(`--${longName}`)
           if (!option.optional && !option.negate) {
-            if (option.variadic) {
+            if (name === 'env') {
+              Object.keys(job.env).forEach(key => {
+                parameters.push(`${key}=${job.env[key]}`)
+              })
+            } else if (option.variadic) {
               parameters.push(...job[name].map(value => value.toString()))
             } else {
               parameters.push(job[name].toString())
@@ -104,6 +111,8 @@ const task = async ({ job, id, label, args }) => {
   childProcess.on('close', async code => {
     await stdout.close()
     await stderr.close()
+    batchItem.statusCode = code
+    batchItem.end = new Date()
     if (code !== 0) {
       reject(code)
     } else {
@@ -116,7 +125,7 @@ const task = async ({ job, id, label, args }) => {
     .then(() => {
       output.log('✔️ ', progress.label)
     }, (reason) => {
-      ++job.errors
+      ++job.failed
       output.log('❌', progress.label, reason)
     })
     .finally(() => {
@@ -135,7 +144,9 @@ async function batch (job) {
    *   --report-dir is always passed to aggregate reports under one root folder
    */
   const output = getOutput(job)
-  const batchItems = []
+  job.start = new Date()
+  job.failed = 0
+  job.batchItems = []
   for (const batch of job.batch) {
     output.debug('batch', `processing: ${batch}`)
     // check if path
@@ -146,9 +157,9 @@ async function batch (job) {
       }
       const pathStat = await stat(path)
       if (pathStat.isDirectory()) {
-        folder(batchItems, job, path)
+        folder(job, path)
       } else if (pathStat.isFile() && extname(path) === '.json') {
-        configurationFile(batchItems, job, path)
+        configurationFile(job, path)
       } else {
         output.batchFailed(batch, 'only folders and JSON configuration files are supported')
       }
@@ -171,24 +182,33 @@ async function batch (job) {
         const pathStat = await stat(path)
         if (pathStat.isDirectory()) {
           if (re.test(path) || re.test(path.replaceAll('\\', '/'))) {
-            folder(batchItems, job, path)
+            folder(job, path)
             continue
           }
           await scan(path)
         } else if (pathStat.isFile() && (re.test(path) || re.test(path.replaceAll('\\', '/')))) {
-          configurationFile(batchItems, job, path)
+          configurationFile(job, path)
         }
       }
     }
     await scan(job.cwd)
   }
-  if (batchItems.length) {
+  if (job.batchItems.length) {
     job.status = 'Running batch items...'
-    await parallelize(task, batchItems, job.parallel)
-    // TODO: end command ?
+    await parallelize(task.bind(job), job.batchItems, job.parallel)
   } else {
     output.batchFailed(job.batch, 'no match')
   }
+
+  job.end = new Date()
+  job.failed = !!job.failed
+  if (job.failed) {
+    process.exitCode = -1
+  }
+  await save(job)
+  if (job.endScript) {
+    await end(job)
+  }
   output.stop()
   return 0
 }

package/src/browsers.js

@@ -29,7 +29,11 @@ async function instantiate (job, config) {
   const stdout = await open(stdoutFilename, 'w')
   const stderr = await open(stderrFilename, 'w')
   const childProcess = fork(job.browser, [browserConfigPath], {
-    stdio: [0, stdout, stderr, 'ipc']
+    stdio: [0, stdout, stderr, 'ipc'],
+    env: {
+      ...process.env,
+      ...job.env
+    }
   })
   const { promise, resolve } = allocPromise()
   childProcess.on('close', async code => {
@@ -127,7 +131,7 @@ async function start (job, url, scripts = []) {
   }
   if (resolvedScripts.length) {
     resolvedScripts.unshift(`(function () {
-  window['ui5-test-runner/base-host'] = 'http://localhost:${job.port}'
+  window['ui5-test-runner/base-host'] = 'http://${job.callbackHost}:${job.port}'
 }())`)
   }
   const progress = newProgress(job, url)

package/src/capabilities/tests/ui5/timezone.html

@@ -0,0 +1,27 @@
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <script id='sap-ui-bootstrap'
+      src='https://ui5.sap.com/resources/sap-ui-core.js'
+      data-sap-ui-libs='sap.m'
+      data-sap-ui-theme='sap_horizon'
+      data-sap-ui-compatVersion='edge'>
+    </script>
+    <style>
+html, body { height: 100%; }
+    </style>
+    <script>
+sap.ui.require([
+  "sap/ui/core/date/UI5Date", 
+], function (UI5Date) {
+  console.log(UI5Date.getInstance(2025,2,15,23,2,0))
+});
+    </script>
+  </head>
+  <body class='sapUiBody'>
+    <pre>TZ=UTC node . --webapp . --url http://localhost:0/src/capabilities/tests/ui5/timezone.html --debug-keep-browser-open -- --visible</pre>
+    and check the console
+  </body>
+</html>

package/src/end.js

@@ -17,7 +17,11 @@ async function end (job) {
     {
       cwd: job.cwd,
       stdio: [0, 'pipe', 'pipe', 'ipc'],
-      windowsHide: true
+      windowsHide: true,
+      env: {
+        ...process.env,
+        ...job.env
+      }
     }
   )
 

package/src/job.js

@@ -3,7 +3,7 @@
 const { Command, Option, InvalidArgumentError } = require('commander')
 const { statSync, accessSync, constants } = require('fs')
 const { dirname, join, isAbsolute } = require('path')
-const { name, description, version } = require(join(__dirname, '../package.json'))
+const { name, description, version = 'dev' } = require(join(__dirname, '../package.json'))
 const { getOutput } = require('./output')
 const { $valueSources, $remoteOnLegacy } = require('./symbols')
 const { buildAndCheckMode } = require('./job-mode')
@@ -79,6 +79,7 @@ function getCommand (cwd) {
 
   const DEBUG_OPTION = '(🐞 for debugging purpose)'
   const EXPERIMENTAL_OPTION = '[⚠️ experimental]'
+  const DANGEROURS_OPTION = '[💣 use carefully]'
 
   command
     .name(name)
@@ -110,6 +111,8 @@ function getCommand (cwd) {
     .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 [flag]', '[💻🔗🧪📡] Limit network usage (implies --no-npm-install)', boolean, false)
+    .option('--env <name=value...>', '[💻🔗🧪📡] Set environment variable', arrayOf(string))
+    .option('--callback-host <host>', `[💻🔗🧪📡] ${DANGEROURS_OPTION} Hostname for callbacks`, string, 'localhost')
 
     // Common to legacy and url
     .option('--webapp <path>', '[💻🔗] Base folder of the web application (relative to cwd)', 'webapp')
@@ -299,6 +302,20 @@ function finalize (job) {
     })
   }
 
+  if (!job.env) {
+    job.env = {}
+  } else {
+    job.env = job.env.reduce((dictionary, env) => {
+      const equalPos = env.indexOf('=')
+      if (equalPos === -1) {
+        dictionary[env] = ''
+      } else {
+        dictionary[env.slice(0, equalPos)] = env.slice(equalPos + 1)
+      }
+      return dictionary
+    }, {})
+  }
+
   if (job.watchFolder) {
     job.watch = true
     job.watchFolder = updateToAbsolute(job.watchFolder)

package/src/output.js

@@ -265,7 +265,7 @@ function build (job) {
     lines: 0,
 
     version: () => {
-      const { name, version } = require(join(__dirname, '../package.json'))
+      const { name, version = 'dev' } = require(join(__dirname, '../package.json'))
       log(job, p80()`${name}@${version}`)
       if (job.debugDevMode) {
         log(job, p80()`⚠️  Development mode ⚠️`)

package/src/report.js

@@ -22,7 +22,17 @@ async function save (job) {
 
 function generateTextReport (job) {
   const { promise, resolve } = allocPromise()
-  const childProcess = fork(join(__dirname, 'defaults/text-report.js'), [job.reportDir, process.stdout.columns || ''], { stdio: 'pipe' })
+  const childProcess = fork(
+    join(__dirname, 'defaults/text-report.js'),
+    [job.reportDir, process.stdout.columns || ''],
+    {
+      stdio: 'pipe',
+      env: {
+        ...process.env,
+        ...job.env
+      }
+    }
+  )
   getOutput(job).monitor(childProcess, true)
   childProcess.on('close', resolve)
   return promise
@@ -41,7 +51,17 @@ module.exports = {
     await generateTextReport(job)
     const promises = job.reportGenerator.map(generator => {
       const { promise, resolve } = allocPromise()
-      const childProcess = fork(generator, [job.reportDir], { stdio: 'pipe' })
+      const childProcess = fork(
+        generator,
+        [job.reportDir],
+        {
+          stdio: 'pipe',
+          env: {
+            ...process.env,
+            ...job.env
+          }
+        }
+      )
       const buffers = output.monitor(childProcess, false)
       childProcess.on('close', exitCode => {
         if (exitCode !== 0) {

package/src/start.js

@@ -16,8 +16,12 @@ async function start (job) {
 
   // check if node
   if (command === 'node') {
-    output.debug('start', `Replacing node with ${process.argv[0]}`)
-    start = [process.argv[0], ...parameters].join(' ')
+    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
     const packagePath = join(job.cwd, 'package.json')

package/src/timeout.js

@@ -46,8 +46,8 @@ module.exports = {
           }
         })
       })
-      job.failed = true
-      job.timedOut = true
     }
+    job.failed = true
+    job.timedOut = true
   }
 }