ui5-test-runner 3.3.5 → 4.1.0

package/src/job.js

@@ -7,7 +7,7 @@ const { name, description, version } = require(join(__dirname, '../package.json'
 const { getOutput } = require('./output')
 const { $valueSources, $remoteOnLegacy } = require('./symbols')
 const { buildAndCheckMode } = require('./job-mode')
-const { boolean, integer, timeout, url, arrayOf, regex, percent } = require('./options')
+const { boolean, integer, timeout, url, arrayOf, regex, percent, string } = require('./options')
 
 const $status = Symbol('status')
 
@@ -105,9 +105,10 @@ function getCommand (cwd) {
     .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)
+    .option('-oi, --output-interval <interval>', '[💻🔗🧪] Interval for reporting progress on non interactive output (CI/CD) (0 means no output)', timeout, 30000)
 
     // Common to legacy and url
-    .option('-qs, --qunit-strict', '[💻🔗] Strict mode on qunit execution (fails if no modules declared)', boolean, false)
+    .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('-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)
@@ -115,7 +116,7 @@ function getCommand (cwd) {
     .option('--no-screenshot', '[💻🔗] Disable screenshots')
     .option('-st, --screenshot-timeout <timeout>', '[💻🔗] Maximum waiting time for browser screenshot', timeout, 5000)
     .option('-rg, --report-generator <path...>', '[💻🔗] Report generator paths (relative to cwd or use $/ for provided ones)', ['$/report.js'])
-    .option('-pp, --progress-page <path>', '[💻🔗] progress page path (relative to cwd or use $/ for provided ones)', '$/report/default.html')
+    .option('--progress-page <path>', '[💻🔗] progress page path (relative to cwd or use $/ for provided ones)', '$/report/default.html')
 
     .option('--coverage [flag]', '[💻🔗] Enable or disable code coverage', boolean)
     .option('--no-coverage', '[💻🔗] Disable code coverage')
@@ -135,8 +136,7 @@ function getCommand (cwd) {
     .option('--libs <lib...>', '[💻] Library mapping (<relative>=<path> or <path>)', arrayOf(lib))
     .option('--mappings <mapping...>', '[💻] Custom mapping (<match>=<file|url>(<config>))', arrayOf(mapping))
     .option('--cache <path>', '[💻] Cache UI5 resources locally in the given folder (empty to disable)')
-    .option('--webapp <path>', '[💻] Base folder of the web application (relative to cwd)', 'webapp')
-    .option('--testsuite <path>', '[💻] Path of the testsuite file (relative to webapp)', 'test/testsuite.qunit.html')
+    .option('--testsuite <path>', '[💻] Path of the testsuite file (relative to webapp, URL parameters are supported)', 'test/testsuite.qunit.html')
     .option('-w, --watch [flag]', '[💻] Monitor the webapp folder and re-execute tests on change', boolean, false)
 
     // Specific to coverage in url mode (experimental)
@@ -150,8 +150,8 @@ function getCommand (cwd) {
     .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())
-    .addOption(new Option('--debug-coverage', DEBUG_OPTION, boolean).hideHelp())
     .addOption(new Option('--debug-coverage-no-custom-fs', DEBUG_OPTION, boolean).hideHelp())
+    .addOption(new Option('--debug-verbose <module...>', DEBUG_OPTION, arrayOf(string), []).hideHelp())
 
   return command
 }
@@ -227,7 +227,9 @@ function finalize (job) {
   job.mode = buildAndCheckMode(job)
   if (job.mode === 'legacy') {
     checkAccess({ path: job.webapp, label: 'webapp folder' })
-    const testsuitePath = toAbsolute(job.testsuite, job.webapp)
+
+    const [, testsuiteFile] = job.testsuite.match(/([^?]*)(\?.*)?$/)
+    const testsuitePath = toAbsolute(testsuiteFile, job.webapp)
     checkAccess({ path: testsuitePath, label: 'testsuite', file: true })
   } else if (job.mode === 'url') {
     if (job[$valueSources].coverage !== 'cli') {
@@ -261,9 +263,7 @@ function finalize (job) {
   if (job.coverage) {
     function overrideIfNotSet (option, valueFromSettings) {
       if (valueFromSettings && job[$valueSources][option] !== 'cli') {
-        if (job.debugCoverage) {
-          output.wrap(() => console.log(`${option} extracted from nyc settings : ${valueFromSettings}`))
-        }
+        output.debug('coverage', `${option} extracted from nyc settings : ${valueFromSettings}`)
         job[option] = valueFromSettings
       }
     }

package/src/options.js

@@ -41,6 +41,10 @@ module.exports = {
 
   integer,
 
+  string (value) {
+    return value
+  },
+
   timeout (value) {
     const int = integer(value)
     if (value.endsWith('ms')) {

package/src/output.js

@@ -14,6 +14,7 @@ const { filename, noop, pad } = require('./tools')
 const inJest = typeof jest !== 'undefined'
 const interactive = process.stdout.columns !== undefined && !inJest
 const $output = Symbol('output')
+const $outputStart = Symbol('output-start')
 
 if (!interactive) {
   const UTF8_BOM_CODE = '\ufeff'
@@ -31,6 +32,15 @@ if (inJest) {
   cons = console
 }
 
+const formatTime = duration => {
+  duration = Math.ceil(duration / 1000)
+  const seconds = duration % 60
+  const minutes = (duration - seconds) / 60
+  return minutes.toString().padStart(2, '0') + ':' + seconds.toString().padStart(2, '0')
+}
+
+const getElapsed = job => formatTime(Date.now() - job[$outputStart])
+
 const write = (...parts) => parts.forEach(part => process.stdout.write(part))
 
 function clean (job) {
@@ -84,8 +94,16 @@ function bar (ratio, msg) {
 const TICKS = ['\u280b', '\u2819', '\u2839', '\u2838', '\u283c', '\u2834', '\u2826', '\u2827', '\u2807', '\u280f']
 
 function progress (job, cleanFirst = true) {
-  if (cleanFirst) {
-    clean(job)
+  if (interactive) {
+    if (cleanFirst) {
+      clean(job)
+    }
+  } else {
+    if (job[$browsers]) {
+      write(`${getElapsed(job)} │ Progress\n──────┴──────────\n`)
+    } else {
+      return
+    }
   }
   const output = job[$output]
   output.lines = 1
@@ -131,11 +149,26 @@ function progress (job, cleanFirst = true) {
   }
 }
 
-function output (job, ...texts) {
-  writeFileSync(join(job.reportDir, 'output.txt'), texts.map(t => t.toString()).join(' ') + '\n', {
-    encoding: 'utf-8',
-    flag: 'a'
-  })
+function output (job, ...args) {
+  writeFileSync(
+    join(job.reportDir, 'output.txt'),
+    args.map(arg => {
+      if (typeof arg === 'object') {
+        return JSON.stringify(arg, undefined, 2)
+      }
+      if (arg === undefined) {
+        return 'undefined'
+      }
+      if (arg === null) {
+        return 'null'
+      }
+      return arg.toString()
+    }).join(' ') + '\n',
+    {
+      encoding: 'utf-8',
+      flag: 'a'
+    }
+  )
 }
 
 function log (job, ...texts) {
@@ -185,13 +218,6 @@ function browserIssue (job, { type, url, code, dir }) {
   log(job, p`└──────────${pad.x('─')}┘`)
 }
 
-const formatTime = duration => {
-  duration = Math.ceil(duration / 1000)
-  const seconds = duration % 60
-  const minutes = (duration - seconds) / 60
-  return minutes.toString().padStart(2, '0') + ':' + seconds.toString().padStart(2, '0')
-}
-
 function build (job) {
   let wrap
   if (interactive) {
@@ -206,8 +232,7 @@ function build (job) {
   } else {
     wrap = method => method
   }
-  const outputStart = Date.now()
-  const getElapsed = () => formatTime(Date.now() - outputStart)
+  job[$outputStart] = Date.now()
 
   return {
     lastTick: 0,
@@ -225,6 +250,13 @@ function build (job) {
       log(job, p80()`Server running at ${pad.lt(url)}`)
     },
 
+    debug: wrap((module, ...args) => {
+      if (job.debugVerbose && job.debugVerbose.includes(module)) {
+        console.log(`🐞${module}`, ...args)
+        output(job, `🐞${module}`, ...args)
+      }
+    }),
+
     redirected: wrap(({ method, url, statusCode, timeSpent }) => {
       if (url.startsWith('/_/progress')) {
         return // avoids pollution
@@ -245,7 +277,7 @@ function build (job) {
       } else {
         method = log
       }
-      const text = `${getElapsed()} │ ${status}`
+      const text = `${getElapsed(job)} │ ${status}`
       method(job, '')
       method(job, text)
       method(job, '──────┴'.padEnd(text.length, '─'))
@@ -262,6 +294,8 @@ function build (job) {
     reportOnJobProgress () {
       if (interactive) {
         this.reportIntervalId = setInterval(progress.bind(null, job), 250)
+      } else if (job.outputInterval) {
+        this.reportIntervalId = setInterval(progress.bind(null, job), job.outputInterval)
       }
     },
 
@@ -305,7 +339,7 @@ function build (job) {
     },
 
     browserStart (url) {
-      const text = p80()`${getElapsed()} >> ${pad.lt(url)} [${filename(url)}]`
+      const text = p80()`${getElapsed(job)} >> ${pad.lt(url)} [${filename(url)}]`
       if (interactive) {
         output(job, text)
       } else {
@@ -319,7 +353,7 @@ function build (job) {
       if (page) {
         duration = ' (' + formatTime(page.end - page.start) + ')'
       }
-      const text = p80()`${getElapsed()} << ${pad.lt(url)} ${duration} [${filename(url)}]`
+      const text = p80()`${getElapsed(job)} << ${pad.lt(url)} ${duration} [${filename(url)}]`
       if (interactive) {
         output(job, text)
       } else {
@@ -412,10 +446,6 @@ function build (job) {
       log(job, p80()`Skipping nyc instrumentation (--url)`)
     }),
 
-    qunitEarlyStart: wrap(url => {
-      log(job, p80()`QUnit start without tests in ${pad.lt(url)}`)
-    }),
-
     endpointError: wrap(({ api, url, data, error }) => {
       const p = p80()
       log(job, p`┌──────────${pad.x('─')}┐`)
@@ -508,7 +538,9 @@ function build (job) {
     stop () {
       if (this.reportIntervalId) {
         clearInterval(this.reportIntervalId)
-        clean(job)
+        if (interactive) {
+          clean(job)
+        }
       }
     }
   }

package/src/qunit-hooks.js

@@ -17,12 +17,38 @@ function invalidTestId (job, url, testId) {
   error(job, url, `No QUnit unit test found with id ${testId}`)
 }
 
-function get (job, urlWithHash, testId) {
+function merge (targetModules, modules) {
+  let count = 0
+  modules.forEach(module => {
+    const { name } = module
+    const targetModule = targetModules.filter(({ name: targetName }) => name === targetName)[0]
+    if (targetModule === undefined) {
+      targetModules.push(module)
+    } else {
+      module.tests.forEach(test => {
+        const targetTest = targetModule.tests.filter(({ testId }) => test.testId === testId)[0]
+        if (!targetTest) {
+          targetModule.tests.push(test)
+        }
+      })
+    }
+    count += module.tests.length
+  })
+  return count
+}
+
+function get (job, urlWithHash, { testId, modules, isOpa } = {}) {
   const url = stripUrlHash(urlWithHash)
   const page = job.qunitPages && job.qunitPages[url]
   if (!page) {
     error(job, url, `No QUnit page found for ${urlWithHash}`)
   }
+  if (modules && modules.length) {
+    page.count = merge(page.modules, modules)
+  }
+  if (!page.isOpa && isOpa) {
+    page.isOpa = true
+  }
   let testModule
   let test
   if (testId !== undefined) {
@@ -35,7 +61,7 @@ function get (job, urlWithHash, testId) {
         return false
       }
     })
-    if (!test && job.qunitStrict) {
+    if (!test) {
       invalidTestId(job, url, testId)
     }
   }
@@ -44,7 +70,7 @@ function get (job, urlWithHash, testId) {
 
 async function done (job, urlWithHash, report) {
   const { url, page } = get(job, urlWithHash)
-  if (page.earlyStart && page.count === 0) {
+  if (page.count === 0) {
     return // wait
   }
   if (job.browserCapabilities.screenshot) {
@@ -66,15 +92,10 @@ async function done (job, urlWithHash, report) {
 module.exports = {
   get,
 
-  async begin (job, urlWithHash, { isOpa, totalTests, modules }) {
+  async begin (job, urlWithHash, details) {
+    getOutput(job).debug('qunit', 'begin', urlWithHash, details)
+    const { isOpa, totalTests, modules } = details
     const url = stripUrlHash(urlWithHash)
-    const earlyStart = !totalTests || !modules
-    if (earlyStart) {
-      getOutput(job).qunitEarlyStart(url)
-      if (job.qunitStrict) {
-        error(job, url, 'Invalid begin hook details')
-      }
-    }
     if (!job.qunitPages) {
       job.qunitPages = {}
     }
@@ -87,28 +108,19 @@ module.exports = {
       count: totalTests,
       modules
     }
-    if (earlyStart) {
-      qunitPage.earlyStart = true
-    }
     job.qunitPages[url] = qunitPage
   },
 
-  async testStart (job, urlWithHash, { module, name, testId }) {
-    let { page, testModule, test } = get(job, urlWithHash, testId)
-    if (!testModule) {
-      testModule = { name: module, tests: [] }
-      page.modules.push(testModule)
-    }
-    if (!test) {
-      test = { name, testId }
-      testModule.tests.push(test)
-      ++page.count
-    }
+  async testStart (job, urlWithHash, details) {
+    getOutput(job).debug('qunit', 'testStart', urlWithHash, details)
+    const { test } = get(job, urlWithHash, details)
     test.start = new Date()
   },
 
-  async log (job, urlWithHash, { module, name, testId, ...log }) {
-    const { url, page, test } = get(job, urlWithHash, testId)
+  async log (job, urlWithHash, details) {
+    getOutput(job).debug('qunit', 'log', urlWithHash, details)
+    const { url, page, test } = get(job, urlWithHash, details)
+    const { isOpa, modules, module, name, testId, ...log } = details
     if (!test) {
       invalidTestId(job, url, testId)
     }
@@ -126,9 +138,11 @@ module.exports = {
     }
   },
 
-  async testDone (job, urlWithHash, { name, module, testId, assertions, ...report }) {
+  async testDone (job, urlWithHash, details) {
+    getOutput(job).debug('qunit', 'testDone', urlWithHash, details)
+    const { name, module, testId, assertions, ...report } = details
     const { failed } = report
-    const { url, page, test } = get(job, urlWithHash, testId)
+    const { url, page, test } = get(job, urlWithHash, { testId })
     if (!test) {
       invalidTestId(job, url, testId)
     }

package/src/symbols.js

@@ -5,5 +5,6 @@ module.exports = {
   $testPagesStarted: Symbol('testPagesStarted'),
   $testPagesCompleted: Symbol('testPagesCompleted'),
   $valueSources: Symbol('valueSources'),
-  $remoteOnLegacy: Symbol('remoteOnLegacy')
+  $remoteOnLegacy: Symbol('remoteOnLegacy'),
+  $proxifiedUrls: Symbol('proxifiedUrls')
 }

package/src/tests.js

@@ -13,6 +13,7 @@ const {
   $testPagesCompleted
 } = require('./symbols')
 const { UTRError } = require('./error')
+const { $proxifiedUrls } = require('./symbols')
 
 async function run (task, job) {
   const {
@@ -70,7 +71,7 @@ async function runTestPage (job, url) {
   const output = getOutput(job)
   try {
     let scripts
-    if (job.mode === 'url' && job.browserCapabilities.scripts) {
+    if (job.browserCapabilities.scripts) {
       scripts = [
         'post.js',
         'qunit-intercept.js',
@@ -86,6 +87,10 @@ async function runTestPage (job, url) {
     if (job.coverageProxy) {
       const { origin } = new URL(url)
       const proxifiedUrl = url.replace(origin, `http://localhost:${job.port}`)
+      if (!job[$proxifiedUrls]) {
+        job[$proxifiedUrls] = {}
+      }
+      job[$proxifiedUrls][proxifiedUrl] = url
       await start(job, proxifiedUrl, scripts)
       job.qunitPages[url] = job.qunitPages[proxifiedUrl]
       delete job.qunitPages[proxifiedUrl]

package/src/add-test-pages.spec.js

@@ -1,95 +0,0 @@
-jest.mock('./browsers.js', () => ({
-  stop: jest.fn()
-}))
-const { stop } = require('./browsers')
-const { join } = require('path')
-const { createDir } = require('./tools')
-
-const {
-  addTestPages
-} = require('./add-test-pages')
-
-describe('src/add-test-pages', () => {
-  const url = 'http://localhost:8045/index.html'
-  const reportDir = join(__dirname, '../tmp/add-test-pages')
-  let job
-
-  beforeAll(() => createDir(reportDir))
-
-  beforeEach(() => {
-    stop.mockClear()
-    job = {
-      reportDir
-    }
-  })
-
-  describe('addTestPages', () => {
-    it('keeps track of added test pages and stops browser', async () => {
-      await addTestPages(job, url, [
-        '/page1.html',
-        'page2.html'
-      ])
-      expect(job.testPageUrls).toEqual([
-        'http://localhost:8045/page1.html',
-        'http://localhost:8045/page2.html'
-      ])
-      expect(stop).toHaveBeenCalledWith(job, url)
-    })
-
-    it('supports regexp filtering', async () => {
-      job.pageFilter = 'page(1|3)'
-      await addTestPages(job, url, [
-        '/page1.html',
-        'page2.html',
-        'page3.html'
-      ])
-      expect(job.testPageUrls).toEqual([
-        'http://localhost:8045/page1.html',
-        'http://localhost:8045/page3.html'
-      ])
-      expect(stop).toHaveBeenCalledWith(job, url)
-    })
-
-    it('supports parameters injection', async () => {
-      job.pageParams = 'a&b'
-      await addTestPages(job, url, [
-        '/page1.html',
-        'page2.html?test'
-      ])
-      expect(job.testPageUrls).toEqual([
-        'http://localhost:8045/page1.html?a&b',
-        'http://localhost:8045/page2.html?test&a&b'
-      ])
-      expect(stop).toHaveBeenCalledWith(job, url)
-    })
-
-    it('filters out duplicates', async () => {
-      await addTestPages(job, url, [
-        '/page1.html',
-        'page1.html'
-      ])
-      expect(job.testPageUrls).toEqual([
-        'http://localhost:8045/page1.html'
-      ])
-      expect(stop).toHaveBeenCalledWith(job, url)
-    })
-
-    it('supports multiple calls', async () => {
-      await addTestPages(job, url, ['/page1.html'])
-      await addTestPages(job, url, ['page1.html', '/page2.html'])
-      expect(job.testPageUrls).toEqual([
-        'http://localhost:8045/page1.html',
-        'http://localhost:8045/page2.html'
-      ])
-    })
-
-    it('supports absolute urls', async () => {
-      await addTestPages(job, url, ['/page1.html'])
-      await addTestPages(job, url, ['http://localhost:8045/page2.html'])
-      expect(job.testPageUrls).toEqual([
-        'http://localhost:8045/page1.html',
-        'http://localhost:8045/page2.html'
-      ])
-    })
-  })
-})