ui5-test-runner 5.5.2 → 5.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.5.2",
+  "version": "5.6.1",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -17,7 +17,8 @@
     "test:coverall": "rimraf .nyc_output && jest --coverageDirectory .nyc_output --coverageReporters json && nyc --silent --no-clean npm run test:e2e && nyc merge .nyc_output .nyc_output/final/coverage.json && nyc report --temp-dir .nyc_output/final/ --report-dir coverage --branches 80 --functions 80 --lines 80 --statements 80",
     "test:unit": "jest",
     "test:unit:debug": "node --inspect node_modules/jest/bin/jest.js --runInBand --no-coverage",
-    "test:e2e": "node . --batch test/e2e/.*\\.json --report-dir e2e --start \"node test/e2e/serve.js\" --start-wait-url http://localhost:8081 --start-wait-method HEAD --start-timeout 30s",
+    "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",
     "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",
@@ -50,8 +51,8 @@
     "reserve": "2.1.0"
   },
   "devDependencies": {
-    "@openui5/types": "^1.133.0",
-    "@ui5/cli": "^4.0.13",
+    "@openui5/types": "^1.134.0",
+    "@ui5/cli": "^4.0.14",
     "@ui5/middleware-code-coverage": "^2.0.1",
     "dotenv": "^16.4.7",
     "jest": "^29.7.0",
@@ -60,7 +61,7 @@
     "rimraf": "^6.0.1",
     "standard": "^17.1.2",
     "typescript": "^5.8.2",
-    "ui5-tooling-transpile": "^3.7.1"
+    "ui5-tooling-transpile": "^3.7.3"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"

package/src/batch.js

@@ -76,7 +76,11 @@ const task = async function (batchItem) {
         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())

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/coverage.js

@@ -30,16 +30,19 @@ async function nyc (job, ...args) {
   output.nyc(...args)
   const childProcess = fork(nycScript, args, { stdio: 'pipe' })
   output.monitor(childProcess)
-  const { promise, resolve, reject } = allocPromise()
-  childProcess.on('close', async code => {
-    if (code !== 0) {
-      reject(UTRError.NYC_FAILED(`Return code ${code}`))
-    }
-    resolve()
-  })
+  const { promise, resolve } = allocPromise()
+  childProcess.on('close', resolve)
   return promise
 }
 
+async function safeNyc (job, ...args) {
+  const code = await nyc(job, ...args)
+  if (code !== 0) {
+    const [command] = args
+    throw UTRError.NYC_FAILED(`nyc ${command} failed with code ${code}`)
+  }
+}
+
 const globalContextSearch = 'var global=new Function("return this")();'
 const globalContextReplace = 'var global=window.top;'
 
@@ -84,7 +87,7 @@ async function instrument (job) {
     }
   }
   job.status = 'Instrumenting'
-  await nyc(job, 'instrument', job.webapp, join(job.coverageTempDir, 'instrumented'), '--nycrc-path', job[$nycSettingsPath])
+  await safeNyc(job, 'instrument', job.webapp, join(job.coverageTempDir, 'instrumented'), '--nycrc-path', job[$nycSettingsPath])
 }
 
 function getUrlOrigin (job) {
@@ -250,7 +253,7 @@ async function generateCoverageReport (job) {
   const coverageMergedDir = join(job.coverageTempDir, 'merged')
   await createDir(coverageMergedDir)
   const coverageFilename = join(coverageMergedDir, 'coverage.json')
-  await nyc(job, 'merge', job.coverageTempDir, coverageFilename)
+  await safeNyc(job, 'merge', job.coverageTempDir, coverageFilename)
   if (job[$coverageRemote]) {
     await checkAllSourcesAreAvailable(job, coverageFilename)
   }
@@ -271,13 +274,20 @@ async function generateCoverageReport (job) {
       '--check-coverage'
     )
   }
-  await nyc(job, 'report', ...reporters, ...checks, '--temp-dir', coverageMergedDir, '--report-dir', job.coverageReportDir, '--nycrc-path', job[$nycSettingsPath])
+  const returnCode = await nyc(job, 'report', ...reporters, ...checks, '--temp-dir', coverageMergedDir, '--report-dir', job.coverageReportDir, '--nycrc-path', job[$nycSettingsPath])
   if (checks.length) {
     // The checks are not triggered if the coverage is empty
     const lcov = await stat(join(job.coverageReportDir, 'lcov.info'))
     if (lcov.size === 0) {
       throw UTRError.NYC_FAILED('No coverage information extracted')
     }
+    if (returnCode === 1) {
+      // Assuming coverage report shows the error
+      output.debug('coverage', `nyc report failed with code ${returnCode}`)
+      job.failed = true
+    }
+  } else if (returnCode !== 0) {
+    throw UTRError.NYC_FAILED(`nyc report failed with code ${returnCode}`)
   }
 }
 

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

@@ -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/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
@@ -33,15 +43,31 @@ module.exports = {
 
   async generate (job) {
     const output = getOutput(job)
+    try {
+      await generateCoverageReport(job)
+    } catch (e) {
+      output.genericError(e)
+      job.failed = true
+    }
+    job.status = 'Generating reports'
     job.end = new Date()
     job.failed = !!job.failed
-    job.status = 'Generating reports'
     job.testPageHashes = job.testPageUrls.map(url => filename(url))
     await save(job)
     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) {
@@ -51,11 +77,7 @@ module.exports = {
       })
       return promise
     })
-    promises.push(generateCoverageReport(job).catch(e => {
-      output.genericError(e)
-      job.failed = true
-    }))
     await Promise.all(promises)
-    job.status = 'Reports gemerated'
+    job.status = 'Reports generated'
   }
 }

package/src/tests.js

@@ -127,8 +127,6 @@ async function process (job) {
   }
 
   await generate(job)
-
-  // TODO: #105 integrate end, find a way it can change job.failed
 }
 
 module.exports = {

package/src/ui5.js

@@ -8,6 +8,7 @@ const { getOutput, newProgress } = require('./output')
 const { download } = require('./tools')
 const { $statusProgressCount, $statusProgressTotal } = require('./symbols')
 const { parallelize } = require('./parallelize')
+const { relative: relativePath } = require('path')
 
 const buildCacheBase = job => {
   const [, hostName] = /https?:\/\/([^/]*)/.exec(job.ui5)
@@ -128,27 +129,37 @@ module.exports = {
       'ignore-unverifiable-certificate': true
     }]
 
-    job.libs.forEach(({ relative, source }) => {
+    for (let { relative, source } of job.libs) {
       if (source.endsWith('/') || source.endsWith('\\')) {
         source = source.substring(0, source.length - 1)
       }
-      mappings.unshift({
-        match: new RegExp(`\\/resources\\/${relative.replace(/\//g, '\\/')}(.*)`),
-        cwd: source,
-        file: '$1',
-        static: !job.watch && !job.debugDevMode
-      }, {
-        match: new RegExp(`\\/resources\\/${relative.replace(/\//g, '\\/')}(.*)`),
-        custom: async (request, response, $1) => {
-          if ($1 === undefined) {
-            getOutput(job).debug('libs', `Unable to map ${relative} : $1 is undefined`)
-          } else {
-            getOutput(job).debug('libs', `Unable to map ${relative}/${$1} to ${join(source, $1)}`)
+      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}`
+        })
+      } else {
+        mappings.unshift({
+          match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
+          cwd: source,
+          file: '$1',
+          static: !job.watch && !job.debugDevMode
+        }, {
+          match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
+          custom: (request, response, $1) => {
+            if ($1 === undefined) {
+              getOutput(job).debug('libs', `Unable to map ${relative} : $1 is undefined`)
+            } else {
+              getOutput(job).debug('libs', `Unable to map ${relative}/${$1} to ${join(source, $1)}`)
+            }
+            return 404
           }
-          return 404
-        }
-      })
-    })
+        })
+      }
+    }
 
     return mappings
   }