ui5-test-runner 5.9.0 → 5.10.0

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) {

package/src/ui5.js

@@ -16,6 +16,109 @@ const buildCacheBase = job => {
   return join(job.cache || '', hostName.replace(':', '_'), version || '')
 }
 
+const ui5mappings = job => {
+  const cacheBase = buildCacheBase(job)
+  const match = /\/((?:test-)?resources\/.*)/
+  const ifCacheEnabled = (request, url, match) => job.cache
+  const uncachable = {}
+  const cachingInProgress = {}
+
+  const mappings = [{
+    /* Prevent caching issues :
+      * - Caching was not possible (99% URL does not exist)
+      * - Caching is in progress (must wait for the end of the writing stream)
+      */
+    match,
+    'if-match': ifCacheEnabled,
+    custom: async (request, response, path) => {
+      if (uncachable[path]) {
+        response.writeHead(404)
+        response.end()
+        return
+      }
+      const cachingPromise = cachingInProgress[path]
+      /* istanbul ignore next */ // Hard to reproduce
+      if (cachingPromise) {
+        await cachingPromise
+      }
+    }
+  }, {
+    // UI5 from cache
+    match,
+    'if-match': ifCacheEnabled,
+    cwd: cacheBase,
+    file: '$1',
+    static: !job.debugDevMode
+  }, {
+    // UI5 caching
+    method: 'GET',
+    match,
+    'if-match': ifCacheEnabled,
+    custom: async (request, response, path) => {
+      const filePath = /([^?#]+)/.exec(unescape(path))[1] // filter URL parameters & hash (assuming resources are static)
+      const cachePath = join(cacheBase, filePath)
+      const cacheFolder = dirname(cachePath)
+      await mkdir(cacheFolder, { recursive: true })
+      if (cachingInProgress[path]) {
+        return request.url // loop back to use cached result
+      }
+      const file = createWriteStream(cachePath)
+      cachingInProgress[path] = capture(response, file)
+        .catch(reason => {
+          file.end()
+          uncachable[path] = true
+          if (response.statusCode !== 404) {
+            getOutput(job).failedToCacheUI5resource(path, response.statusCode)
+          }
+          return unlink(cachePath)
+        })
+        .then(() => {
+          delete cachingInProgress[path]
+        })
+    }
+  }, {
+    // UI5 from url
+    method: ['GET', 'HEAD'],
+    match,
+    url: `${job.ui5}/$1`,
+    'ignore-unverifiable-certificate': true
+  }]
+
+  for (let { relative, source } of job.libs) {
+    if (source.endsWith('/') || source.endsWith('\\')) {
+      source = source.substring(0, source.length - 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 mappings
+}
+
 module.exports = {
   preload: async job => {
     const cacheBase = buildCacheBase(job)
@@ -57,110 +160,10 @@ module.exports = {
     progress.done()
   },
 
-  mappings: job => {
+  mappings: async job => {
     if (job.disableUi5) {
       return []
     }
-
-    const cacheBase = buildCacheBase(job)
-    const match = /\/((?:test-)?resources\/.*)/
-    const ifCacheEnabled = (request, url, match) => job.cache
-    const uncachable = {}
-    const cachingInProgress = {}
-
-    const mappings = [{
-      /* Prevent caching issues :
-      * - Caching was not possible (99% URL does not exist)
-      * - Caching is in progress (must wait for the end of the writing stream)
-      */
-      match,
-      'if-match': ifCacheEnabled,
-      custom: async (request, response, path) => {
-        if (uncachable[path]) {
-          response.writeHead(404)
-          response.end()
-          return
-        }
-        const cachingPromise = cachingInProgress[path]
-        /* istanbul ignore next */ // Hard to reproduce
-        if (cachingPromise) {
-          await cachingPromise
-        }
-      }
-    }, {
-      // UI5 from cache
-      match,
-      'if-match': ifCacheEnabled,
-      cwd: cacheBase,
-      file: '$1',
-      static: !job.debugDevMode
-    }, {
-      // UI5 caching
-      method: 'GET',
-      match,
-      'if-match': ifCacheEnabled,
-      custom: async (request, response, path) => {
-        const filePath = /([^?#]+)/.exec(unescape(path))[1] // filter URL parameters & hash (assuming resources are static)
-        const cachePath = join(cacheBase, filePath)
-        const cacheFolder = dirname(cachePath)
-        await mkdir(cacheFolder, { recursive: true })
-        if (cachingInProgress[path]) {
-          return request.url // loop back to use cached result
-        }
-        const file = createWriteStream(cachePath)
-        cachingInProgress[path] = capture(response, file)
-          .catch(reason => {
-            file.end()
-            uncachable[path] = true
-            if (response.statusCode !== 404) {
-              getOutput(job).failedToCacheUI5resource(path, response.statusCode)
-            }
-            return unlink(cachePath)
-          })
-          .then(() => {
-            delete cachingInProgress[path]
-          })
-      }
-    }, {
-      // UI5 from url
-      method: ['GET', 'HEAD'],
-      match,
-      url: `${job.ui5}/$1`,
-      'ignore-unverifiable-certificate': true
-    }]
-
-    for (let { relative, source } of job.libs) {
-      if (source.endsWith('/') || source.endsWith('\\')) {
-        source = source.substring(0, source.length - 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 mappings
+    return ui5mappings(job)
   }
 }