ui5-test-runner 5.9.1 → 5.10.0

package/src/inject/post.js

@@ -7,7 +7,8 @@
   }
 
   const base = window['ui5-test-runner/base-host'] || ''
-  const XHR = window.XMLHttpRequest
+  const probe = window['ui5-test-runner/probe'] || false
+  const batchSize = !probe && (window['ui5-test-runner/batch'] || 0)
 
   let lastPost = Promise.resolve()
 
@@ -64,9 +65,10 @@
               'circular:array': [].concat(value) // 'new' object
             }
           }
-          return Object.assign({
-            'circular:id': id
-          }, value)
+          return {
+            'circular:id': id,
+            ...value
+          }
         }
       }
       return value
@@ -77,8 +79,26 @@
 
   const xPageUrl = top.location.toString()
 
-  window[MODULE] = function post (url, data) {
-    function request () {
+  const nativeFetch = window.fetch
+  let request
+  if (nativeFetch) {
+    request = async function (url, data) {
+      const response = await nativeFetch(base + '/_/' + url, {
+        method: 'POST',
+        headers: {
+          'x-page-url': xPageUrl,
+          'content-type': 'application/json'
+        },
+        body: stringify(data)
+      })
+      if (response.status !== 200) {
+        throw response.statusText
+      }
+      return response.text()
+    }
+  } else {
+    const XHR = window.XMLHttpRequest
+    request = function (url, data) {
       return new Promise(function (resolve, reject) {
         const xhr = new XHR()
         xhr.addEventListener('load', () => {
@@ -94,7 +114,10 @@
         xhr.send(json)
       })
     }
-    lastPost = lastPost.then(request)
+  }
+
+  function post (url, data) {
+    lastPost = lastPost.then(() => request(url, data))
     if (!window.__unsafe__) {
       lastPost = lastPost
         .then(undefined, function (reason) {
@@ -103,4 +126,16 @@
     }
     return lastPost
   }
+
+  const aggregatedData = []
+
+  function batch (url, data) {
+    aggregatedData.push([url, data])
+    if (url === 'QUnit/done' || aggregatedData.length === batchSize) {
+      post('QUnit/batch', [...aggregatedData])
+      aggregatedData.length = 0
+    }
+  }
+
+  window[MODULE] = batchSize ? batch : post
 }())

package/src/inject/qunit-hooks.js

@@ -36,6 +36,10 @@
   }
 
   function installQUnitHooks () {
+    if (window !== window.top || window !== window.parent) {
+      return // Do not install in iframe
+    }
+
     QUnit.begin(function (details) {
       details.isOpa = isOpa()
       return post('QUnit/begin', details)
@@ -47,21 +51,24 @@
 
     QUnit.log(function (log) {
       let ready = false
-      post('QUnit/log', extend(log))
-        .then(undefined, function () {
-          console.error('Failed to POST to QUnit/log (no timestamp)', log)
-        })
-        .then(function () {
-          ready = true
-        })
-      if (isOpa()) {
-        window.sap.ui.test.Opa5.prototype.waitFor({
-          timeout: 10,
-          autoWait: false, // Ignore interactable constraint
-          check: function () {
-            return ready
-          }
-        })
+      const result = post('QUnit/log', extend(log))
+      if (result && result.then) {
+        result
+          .then(undefined, function () {
+            console.error('Failed to POST to QUnit/log (no timestamp)', log)
+          })
+          .then(function () {
+            ready = true
+          })
+        if (isOpa()) {
+          window.sap.ui.test.Opa5.prototype.waitFor({
+            timeout: 10,
+            autoWait: false, // Ignore interactable constraint
+            check: function () {
+              return ready
+            }
+          })
+        }
       }
     })
 

package/src/job.js

@@ -114,6 +114,8 @@ function getCommand (cwd) {
     .option('--env <name=value...>', '[💻🔗🧪📡] Set environment variable', arrayOf(string))
     .option('--localhost <host>', `[💻🔗🧪📡] ${DANGEROUS_OPTION} Hostname for legacy URLs and callbacks`, string, 'localhost')
     .option('--ci [flag]', '[💻🔗🧪📡] CI mode (no interactive output)', boolean, false)
+    .option('--deep-probe [flag]', '[💻🔗🧪📡] Deep probe (recursive, slower)', boolean, false)
+    .option('--probe-parallel <count>', '[💻🔗🧪📡] Number of parallel probes (0 to use --parallel)', integer, 0)
 
     // Common to legacy and url
     .option('--webapp <path>', '[💻🔗] Base folder of the web application (relative to cwd)', 'webapp')
@@ -128,6 +130,8 @@ function getCommand (cwd) {
     .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('--jest [flag]', `[💻🔗📡] ${EXPERIMENTAL_OPTION} Simulate jest environment`)
+    .option('--qunit-batch-size <size>', `[💻🔗📡] ${EXPERIMENTAL_OPTION} QUnit hooks batch size (disables screenshots)`, integer, 0)
 
     .option('--coverage [flag]', '[💻🔗📡] Enable or disable code coverage', boolean)
     .option('--no-coverage', '[💻🔗📡] Disable code coverage')
@@ -145,10 +149,11 @@ function getCommand (cwd) {
     .option('-w, --watch [flag]', '[💻🔗] Monitor the webapp folder (or the one specified with --watch-folder) and re-execute tests on change', boolean, false)
     .option('--watch-folder <path>', '[💻🔗] Folder to monitor with watch (enables --watch if not specified)', string)
 
-    .option('--start <command>', '[💻🔗] Start command (might be an NPM script or a shell command)', string)
+    .option('--start <command>', '[💻🔗] Start command (might be an NPM script or a shell command) ⚠️ the command is killed on tests completion', string)
     .option('--start-wait-url <command>', '[💻🔗] URL to wait for (🔗 defaulted to first url)', url)
     .option('--start-wait-method <method>', '[💻🔗] HTTP method to check the waited URL', 'GET')
-    .option('--start-timeout <timeout>', '[💻🔗] Maximum waiting time for the start command (based on when the first URL becomes available)', timeout, 5000)
+
+    .option('--start-timeout <timeout>', '[💻🔗] Maximum waiting time for the start command (based on when the first URL becomes available, also used for termination)', timeout, 5000)
 
     .option('--end <script>', '[💻🔗] End script (will receive path to `job.js`)', string)
     .option('--end-timeout <timeout>', '[💻🔗] Maximum waiting time for the end script', timeout, 15000)
@@ -178,6 +183,7 @@ function getCommand (cwd) {
     .addOption(new Option('--debug-probe-only', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-keep-browser-open', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-memory', DEBUG_OPTION, boolean).hideHelp())
+    .addOption(new Option('--debug-handles', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-keep-report', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-capabilities-test <name>', DEBUG_OPTION).hideHelp())
     .addOption(new Option('--debug-capabilities-no-timeout', DEBUG_OPTION, boolean).hideHelp())
@@ -214,7 +220,7 @@ function checkAccess ({ path, label, file /*, write */ }) {
     // }
     accessSync(path, mode)
   } catch (error) {
-    throw new Error(`Unable to access ${label}, check your settings`)
+    throw new Error(`Unable to access ${label || path}, check your settings`)
   }
   const stat = statSync(path)
   if (file) {
@@ -361,13 +367,18 @@ function finalize (job) {
 
   if (job.mode === 'url') {
     const port = job.port.toString()
-    job[$remoteOnLegacy] = job.url.every(url => {
+    job[$remoteOnLegacy] = job.url && job.url.every(url => {
       // ignore host name since the machine might be exposed with any name
       const parsedUrl = new URL(url)
       return parsedUrl.port === port
     })
   }
 
+  if (job.qunitBatchSize) {
+    job.screenshot = false
+    job.screenshotOnFailure = false
+  }
+
   job[$status] = 'Starting'
   Object.defineProperty(job, 'status', {
     get () {

package/src/npm.js

@@ -80,7 +80,9 @@ function getSafeJobAndOutput (nullableJob) {
     return { job: nullableJob, output: getOutput(nullableJob) }
   }
   return {
-    job: {},
+    job: {
+      offline: true
+    },
     output: {
       debug: noop,
       resolvedPackage: noop,

package/src/output.js

@@ -9,6 +9,8 @@ const {
   $statusProgressTotal
 } = require('./symbols')
 const { filename, noop, pad } = require('./tools')
+const os = require('os')
+const { describeHandle } = require('./handle')
 
 const $output = Symbol('output')
 const $outputStart = Symbol('output-start')
@@ -134,6 +136,22 @@ function progress (job, cleanFirst = true) {
     const fmt = size => `${(size / (1024 * 1024)).toFixed(2)}M`
     sequence.push(`MEM r:${fmt(rss)}, h:${fmt(heapUsed)}/${fmt(heapTotal)}, x:${fmt(external)}, a:${fmt(arrayBuffers)}\n`)
   }
+  if (job.debugHandles) {
+    ++output.lines
+    const activeHandles = process._getActiveHandles ? process._getActiveHandles() : []
+    sequence.push(`HANDLES ${activeHandles.length}\n`)
+    for (let index = 0; index < activeHandles.length; ++index) {
+      const handle = activeHandles[index]
+      const bullet = index === activeHandles.length - 1 ? '└' : '├'
+      ++output.lines
+      const handleDescription = describeHandle(handle).label
+      if (handleDescription.length > process.stdout.columns - 4) {
+        sequence.push(`${bullet}─ ${handleDescription.slice(0, process.stdout.columns - 4)}\n`)
+      } else {
+        sequence.push(`${bullet}─ ${handleDescription}\n`)
+      }
+    }
+  }
   if (job[$outputProgress]) {
     output.lines += job[$outputProgress].length
     job[$outputProgress].forEach(({ count, total, label }) => {
@@ -270,7 +288,24 @@ function build (job) {
 
     version: wrap(() => {
       const { name, version = 'dev' } = require(join(__dirname, '../package.json'))
-      log(job, p80()`${name}@${version}`)
+      log(job, p80()`       _ ____        _            _                                         
+ _   _(_) ___|      | |_ ___  ___| |_      _ __ _   _ _ __  _ __   ___ _ __ 
+| | | | |___ \\ _____| __/ _ \\/ __| __|____| '__| | | | '_ \\| '_ \\ / _ \\ '__|
+| |_| | |___) |_____| ||  __/\\__ \\ ||_____| |  | |_| | | | | | | |  __/ |   
+ \\__,_|_|____/       \\__\\___||___/\\__|    |_|   \\__,_|_| |_|_| |_|\\___|_|   `)
+      const now = new Date()
+      log(job, p80()`${name}@${version} / Node.js ${process.version} / ${now.toISOString()} (${now.getTimezoneOffset()})`)
+      const cpus = {}
+      for (const { model } of os.cpus()) {
+        if (cpus[model]) {
+          ++cpus[model]
+        } else {
+          cpus[model] = 1
+        }
+      }
+      for (const [model, count] of Object.entries(cpus)) {
+        log(job, p80()`${os.machine()} / ${count}x ${model}`)
+      }
       if (job.debugDevMode) {
         log(job, p80()`⚠️  Development mode ⚠️`)
       }
@@ -422,7 +457,7 @@ function build (job) {
     },
 
     packageNotLatest (name, latestVersion) {
-      wrap(() => log(job, `⚠️ [PKGVRS] latest version of ${name} is ${latestVersion}`))()
+      wrap(() => log(job, `⚠️ [PKGVRS] Latest version of ${name} is ${latestVersion}`))()
     },
 
     emptyBrowserArg () {
@@ -430,7 +465,11 @@ function build (job) {
     },
 
     detectedLeakOfHandles () {
-      wrap(() => log(job, '⚠️ [HDLEAK] leaking Node.js handle(s) detected. This may cause issues with the shutdown'))()
+      wrap(() => log(job, '⚠️ [HDLEAK] Leaking Node.js handle(s) detected. This may cause issues with the shutdown'))()
+    },
+
+    failedToTerminateStartCommand () {
+      wrap(() => log(job, '⚠️ [STRTCT] Failed to terminate start command. This may cause issues with the shutdown'))()
     },
 
     browserStart (url) {
@@ -476,6 +515,10 @@ function build (job) {
       browserIssue(job, { type: 'failed', url, code, dir })
     }),
 
+    browserChildProcessError: wrap((url, { code }) => {
+      log(job, p80()`⚠️ [BRWCPE] Child process error ${code}: ${pad.lt(url)}`)
+    }),
+
     skipIf: wrap(() => {
       log(job, p80()`⚠️ [SKIPIF] Skipping execution (--if)`)
     }),
@@ -640,6 +683,15 @@ function build (job) {
       } else {
         log(job, p`│ ${pad.w(error.toString())} │`)
       }
+      if (error.cause) {
+        log(job, p`├────────${pad.x('─')}──┤`)
+        log(job, p`│ Cause : ${pad.x(' ')} │`)
+        if (error.cause.stack) {
+          log(job, p`│ ${pad.w(error.cause.stack)} │`)
+        } else {
+          log(job, p`│ ${pad.w(error.cause.toString())} │`)
+        }
+      }
       log(job, p`└──────────${pad.x('─')}┘`)
     }),
 

package/src/reserve.js

@@ -11,7 +11,7 @@ module.exports = async job => check({
     cors,
     ...job.mappings ?? [],
     ...job.serveOnly ? [] : endpoints(job),
-    ...ui5(job),
+    ...await ui5(job),
     ...job.serveOnly ? [] : await coverage(job),
     {
       // Project mapping

package/src/start.js

@@ -2,9 +2,7 @@ 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 pidtree = require('pidtree')
 
 async function start (job) {
   const { startWaitUrl: url, startWaitMethod: method } = job
@@ -40,23 +38,23 @@ async function start (job) {
     }
   }
 
-  let childProcessExited = false
+  let startProcessExited = false
   output.debug('start', 'Starting command :', start)
-  const childProcess = exec(start, {
+  const startProcess = exec(start, {
     cwd: job.cwd,
     windowsHide: true
   })
-  childProcess.on('close', () => {
-    output.debug('start', 'start command process exited')
-    childProcessExited = true
+  startProcess.on('close', () => {
+    output.debug('start', 'Start command process exited')
+    startProcessExited = true
   })
-  output.monitor(childProcess)
+  output.monitor(startProcess)
 
   job.status = 'Waiting for URL to be reachable'
 
   const begin = Date.now()
   // eslint-disable-next-line no-unmodified-loop-condition
-  while (!childProcessExited && Date.now() - begin <= job.startTimeout) {
+  while (!startProcessExited && Date.now() - begin <= job.startTimeout) {
     try {
       const response = await fetch(url, { method })
       output.debug('start', url, response.status)
@@ -69,20 +67,60 @@ async function start (job) {
     }
   }
 
-  if (childProcessExited) {
-    throw new Error(`Start command failed with exit code ${childProcess.exitCode}`)
+  if (startProcessExited) {
+    throw new Error(`Start command failed with exit code ${startProcess.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)
+    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...`)
+      const childProcesses = await pidtree(startProcess.pid, { advanced: true })
+      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)
+            }
+          }
+        }
       }
+      await new Promise(resolve => setTimeout(resolve, 250))
+    }
+    if (!startProcessExited) {
+      output.failedToTerminateStartCommand()
     }
   }
 

package/src/tests.js

@@ -48,9 +48,13 @@ async function probeUrl (job, url) {
     let scripts
     if (job.browserCapabilities.scripts) {
       scripts = [
+        '(function () { window[\'ui5-test-runner/probe\'] = true }())',
         'post.js',
         'qunit-redirect.js'
       ]
+      if (job.jest) {
+        scripts.push('jest2qunit.js')
+      }
     }
     await start(job, url, scripts)
   } catch (error) {
@@ -64,10 +68,19 @@ async function runTestPage (job, url) {
   try {
     let scripts
     if (job.browserCapabilities.scripts) {
-      scripts = [
+      scripts = []
+      if (job.qunitBatchSize) {
+        scripts.push(
+          `(function () { window['ui5-test-runner/batch'] = ${job.qunitBatchSize} }())`
+        )
+      }
+      scripts.push(
         'post.js',
         'qunit-hooks.js'
-      ]
+      )
+      if (job.jest) {
+        scripts.push('jest2qunit.js')
+      }
       if (job.coverage && !job.coverageProxy) {
         scripts.push(
           'opa-iframe-coverage.js',
@@ -102,13 +115,42 @@ async function process (job) {
   await save(job)
   job.testPageUrls = []
 
+  let probingRound = 0
+  const parallel = job.probeParallel || job.parallel
+  const confirmedTestPageUrls = []
   job.status = 'Probing urls'
-  try {
-    await parallelize(task(job, probeUrl), job.url, job.parallel)
-  } catch (e) {
-    output.genericError(e)
-    job.failed = true
-  }
+  do {
+    ++probingRound
+    if (probingRound >= 2) {
+      if (job.testPageUrls.length === 0) {
+        break
+      }
+      job.status = `Probing urls (${probingRound})`
+      job.url = job.testPageUrls.filter(url => !confirmedTestPageUrls.includes(url))
+      if (job.url.length) {
+        job.testPageUrls = []
+      } else {
+        job.testPageUrls = confirmedTestPageUrls
+        break
+      }
+    }
+    try {
+      await parallelize(task(job, probeUrl), job.url, parallel)
+    } catch (e) {
+      output.genericError(e)
+      job.failed = true
+      break
+    }
+    job.testPageUrls.forEach(url => {
+      if ((job.url.includes(url) && !confirmedTestPageUrls.includes(url)) ||
+        (url.includes('/resources/sap/ui/test/starter/Test.qunit.html?testsuite=') && url.includes('&test='))
+      ) {
+        confirmedTestPageUrls.push(url)
+        getOutput(job).debug('probe', 'confirmed:', url)
+      }
+    })
+    getOutput(job).debug('probe', 'from', job.url.length, 'to', job.testPageUrls.length, 'confirmed', confirmedTestPageUrls.length)
+  } while (job.deepProbe)
 
   /* istanbul ignore else */
   if (!job.debugProbeOnly && !job.failed) {