ui5-test-runner 4.1.1 → 4.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "4.1.1",
+  "version": "4.2.1",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -78,7 +78,7 @@
     "standard": "^17.1.0",
     "start-server-and-test": "^2.0.3",
     "typescript": "^5.3.3",
-    "ui5-tooling-transpile": "^3.3.4"
+    "ui5-tooling-transpile": "^3.3.5"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.3"

package/src/add-test-pages.js

@@ -2,9 +2,11 @@
 
 const { stop } = require('./browsers')
 const { URL } = require('url')
+const { getOutput } = require('./output')
 
 module.exports = {
   async addTestPages (job, url, pages) {
+    getOutput(job).debug('probe', `addTestPages from ${url}`, pages)
     let testPageUrls
     pages = pages.map(relativeUrl => {
       const absoluteUrl = new URL(relativeUrl, url)

package/src/job-mode.js

@@ -29,7 +29,8 @@ function buildAndCheckMode (job) {
       'pageTimeout',
       'browserCloseTimeout',
       'failFast',
-      'keepAlive'
+      'keepAlive',
+      'alternateNpmPath'
     ])
     return 'capabilities'
   }

package/src/job.js

@@ -102,6 +102,7 @@ function getCommand (cwd) {
     .option('-p, --parallel <count>', '[💻🔗🧪] Number of parallel tests executions', 2)
     .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('-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)
@@ -111,6 +112,7 @@ function getCommand (cwd) {
     .option('--webapp <path>', '[💻🔗] Base folder of the web application (relative to cwd)', 'webapp')
     .option('-pf, --page-filter <regexp>', '[💻🔗] Filter out pages not matching the regexp')
     .option('-pp, --page-params <params>', '[💻🔗] Add parameters to page URL')
+    .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')
@@ -224,6 +226,9 @@ function finalize (job) {
   if (job.cache) {
     updateToAbsolute('cache')
   }
+  if (job.alternateNpmPath) {
+    checkAccess({ path: job.alternateNpmPath, label: 'Alternate NPM path' })
+  }
   job.mode = buildAndCheckMode(job)
   if (job.mode === 'legacy') {
     checkAccess({ path: job.webapp, label: 'webapp folder' })

package/src/npm.js

@@ -41,6 +41,38 @@ function resolveDependencyPath (name) {
   }
 }
 
+async function findDependencyPath (job, name) {
+  if (!localRoot) {
+    [localRoot, globalRoot] = await Promise.all([
+      npm(job, 'root'),
+      npm(job, 'root', '--global')
+    ])
+  }
+  const localPath = join(localRoot, name)
+  if (await folderExists(localPath)) {
+    return [localPath, false]
+  }
+  if (job.alternateNpmPath) {
+    const alternatePath = join(job.alternateNpmPath, name)
+    if (await folderExists(alternatePath)) {
+      return [alternatePath, false]
+    }
+  }
+  const globalPath = join(globalRoot, name)
+  let justInstalled = false
+  if (!await folderExists(globalPath)) {
+    if (!job.npmInstall) {
+      throw UTRError.NPM_DEPENDENCY_NOT_FOUND(name)
+    }
+    const previousStatus = job.status
+    job.status = `Installing ${name}...`
+    await npm(job, 'install', name, '-g')
+    justInstalled = true
+    job.status = previousStatus
+  }
+  return [globalPath, justInstalled]
+}
+
 module.exports = {
   resolveDependencyPath,
 
@@ -52,29 +84,7 @@ module.exports = {
     } catch (e) {
     }
     if (!modulePath) {
-      if (!localRoot) {
-        [localRoot, globalRoot] = await Promise.all([
-          npm(job, 'root'),
-          npm(job, 'root', '--global')
-        ])
-      }
-      const localPath = join(localRoot, name)
-      if (await folderExists(localPath)) {
-        modulePath = localPath
-      } else {
-        const globalPath = join(globalRoot, name)
-        if (!await folderExists(globalPath)) {
-          if (!job.npmInstall) {
-            throw UTRError.NPM_DEPENDENCY_NOT_FOUND(name)
-          }
-          const previousStatus = job.status
-          job.status = `Installing ${name}...`
-          await npm(job, 'install', name, '-g')
-          justInstalled = true
-          job.status = previousStatus
-        }
-        modulePath = globalPath
-      }
+      [modulePath, justInstalled] = await findDependencyPath(job, name)
     }
     const output = getOutput(job)
     const installedPackage = require(join(modulePath, 'package.json'))

package/src/output.js

@@ -250,8 +250,9 @@ function build (job) {
       log(job, p80()`Server running at ${pad.lt(url)}`)
     },
 
-    debug: wrap((module, ...args) => {
-      if (job.debugVerbose && job.debugVerbose.includes(module)) {
+    debug: wrap((moduleSpecifier, ...args) => {
+      const [mainModule] = moduleSpecifier.split('/')
+      if (job.debugVerbose && (job.debugVerbose.includes(moduleSpecifier) || job.debugVerbose.includes(mainModule))) {
         console.log(`🐞${module}`, ...args)
         output(job, `🐞${module}`, ...args)
       }

package/src/qunit-hooks.js

@@ -5,7 +5,9 @@ const { collect } = require('./coverage')
 const { UTRError } = require('./error')
 const { getOutput } = require('./output')
 const { basename } = require('path')
-const { filename, stripUrlHash } = require('./tools')
+const { filename, stripUrlHash, allocPromise } = require('./tools')
+const $doneResolve = Symbol('doneResolve')
+const $doneTimeout = Symbol('doneTimeout')
 
 function error (job, url, details = '') {
   stop(job, url)
@@ -73,27 +75,33 @@ async function done (job, urlWithHash, report) {
   if (page.count === 0) {
     return // wait
   }
-  if (job.browserCapabilities.screenshot) {
-    try {
-      await screenshot(job, url, 'done')
-    } catch (error) {
-      getOutput(job).genericError(error, url)
+  const { promise, resolve } = allocPromise()
+  page[$doneResolve] = resolve
+  page[$doneTimeout] = setTimeout(async () => {
+    if (job.browserCapabilities.screenshot) {
+      try {
+        await screenshot(job, url, 'done')
+      } catch (error) {
+        getOutput(job).genericError(error, url)
+      }
     }
-  }
-  page.end = new Date()
-  if (report.__coverage__) {
-    await collect(job, url, report.__coverage__)
-    delete report.__coverage__
-  }
-  page.report = report
-  stop(job, url)
+    page.end = new Date()
+    if (report.__coverage__) {
+      await collect(job, url, report.__coverage__)
+      delete report.__coverage__
+    }
+    page.report = report
+    stop(job, url)
+    resolve()
+  }, job.pageCloseTimeout)
+  return promise
 }
 
 module.exports = {
   get,
 
   async begin (job, urlWithHash, details) {
-    getOutput(job).debug('qunit', 'begin', urlWithHash, details)
+    getOutput(job).debug('qunit/begin', 'begin', urlWithHash, details)
     const { isOpa, totalTests, modules } = details
     const url = stripUrlHash(urlWithHash)
     if (!job.qunitPages) {
@@ -112,13 +120,18 @@ module.exports = {
   },
 
   async testStart (job, urlWithHash, details) {
-    getOutput(job).debug('qunit', 'testStart', urlWithHash, details)
-    const { test } = get(job, urlWithHash, details)
+    getOutput(job).debug('qunit/testStart', 'testStart', urlWithHash, details)
+    const { page, test } = get(job, urlWithHash, details)
+    const { [$doneTimeout]: doneTimeout, [$doneResolve]: doneResolve } = page
+    if (doneTimeout) {
+      clearTimeout(doneTimeout)
+      doneResolve()
+    }
     test.start = new Date()
   },
 
   async log (job, urlWithHash, details) {
-    getOutput(job).debug('qunit', 'log', urlWithHash, details)
+    getOutput(job).debug('qunit/log', 'log', urlWithHash, details)
     const { url, page, test } = get(job, urlWithHash, details)
     const { isOpa, modules, module, name, testId, ...log } = details
     if (!test) {
@@ -139,7 +152,7 @@ module.exports = {
   },
 
   async testDone (job, urlWithHash, details) {
-    getOutput(job).debug('qunit', 'testDone', urlWithHash, details)
+    getOutput(job).debug('qunit/testDone', 'testDone', urlWithHash, details)
     const { name, module, testId, assertions, ...report } = details
     const { failed } = report
     const { url, page, test } = get(job, urlWithHash, { testId })
@@ -180,5 +193,8 @@ module.exports = {
     }
   },
 
-  done
+  async done (job, urlWithHash, report) {
+    getOutput(job).debug('qunit/done', 'done', urlWithHash, report)
+    await done(job, urlWithHash, report)
+  }
 }