ui5-test-runner 2.0.4 → 3.0.0

package/README.md

@@ -20,7 +20,7 @@ A self-sufficient test runner for UI5 applications enabling parallel execution o
 
 ## 💿 How to install
 
-* Works with [Node.js](https://nodejs.org/en/download/) >= 14
+* Works with [Node.js](https://nodejs.org/en/download/) >= 16
 * Local installation
   * `npm install --save-dev ui5-test-runner`
   * Trigger either with `npx ui5-test-runner` or through an npm script invoking `ui5-test-runner`
@@ -47,7 +47,10 @@ A self-sufficient test runner for UI5 applications enabling parallel execution o
 ## ⚖️ License
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FArnaudBuchholz%2Fui5-test-runner.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FArnaudBuchholz%2Fui5-test-runner?ref=badge_large)
 
-## ⚠️ Breaking change
+## ⚠️ Breaking changes
+
+### v3
+* Dropping support of Node.js 14
 
 ### v2
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "files": [
@@ -12,7 +12,7 @@
     "ui5-test-runner": "./index.js"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16"
   },
   "scripts": {
     "lint": "standard --fix",
@@ -22,7 +22,7 @@
     "test:integration:puppeteer": "node . --capabilities --browser $/puppeteer.js",
     "test:integration:selenium-webdriver-chrome": "node . --capabilities --browser $/selenium-webdriver.js -- --browser chrome",
     "test:integration:jsdom": "node . --capabilities --browser $/jsdom.js",
-    "test:report": "reserve --config ./test/report/reserve.json",
+    "test:report": "node ./src/defaults/report.js ./test/report && reserve --config ./test/report/reserve.json",
     "build:doc": "node build/doc"
   },
   "repository": {
@@ -45,7 +45,7 @@
   },
   "homepage": "https://github.com/ArnaudBuchholz/ui5-test-runner#readme",
   "dependencies": {
-    "commander": "^10.0.0",
+    "commander": "^10.0.1",
     "mime": "^3.0.0",
     "punybind": "^1.2.1",
     "punyexpr": "^1.0.4",
@@ -53,7 +53,7 @@
   },
   "devDependencies": {
     "jest": "^29.5.0",
-    "nock": "^13.3.0",
+    "nock": "^13.3.1",
     "nyc": "^15.1.0",
     "standard": "^17.0.0"
   },

package/src/browser.spec.js

@@ -142,7 +142,7 @@ describe('src/browser', () => {
         })
         await probe(job)
         expect(job.browserCapabilities.modules).toStrictEqual(['reserve', 'dependentModule'])
-        expect(job.browserModules.reserve).toStrictEqual('reserve')
+        expect(job.browserModules.reserve).toStrictEqual(join(__dirname, '../node_modules/reserve'))
         expect(job.browserModules.dependentModule).toStrictEqual(join(npmGlobal, 'dependentModule'))
       })
 

package/src/defaults/report/default.html

@@ -78,6 +78,7 @@
         <pre {{else}}>&#10060; {{ log.message }}</pre>
         <img {{if}}="log.screenshot" loading="lazy" class="log" src="{{ qunitTest.pageId }}/{{ log.screenshot }}" alt="Copy folder '{{ qunitTest.pageId }}' from the job report">
       </div>
+      <img {{if}}="qunitTest.screenshot" loading="lazy" class="log" src="{{ qunitTest.pageId }}/{{ qunitTest.screenshot }}" alt="Copy folder '{{ qunitTest.pageId }}' from the job report">
     </div>
     <div style="display: {{ disconnected ? 'block' : 'none' }};">&#10060; Disconnected</div>
   </body>

package/src/defaults/report/main.js

@@ -1,7 +1,7 @@
 /* global report, job */
 report.ready.then(update => {
-  const hashChange = () => {
-    const [, pageId, testId] = location.hash.match(/#?([^-]*)(?:-(.*))?/)
+  const hashChange = hash => {
+    const [, pageId, testId] = (hash || '').match(/#?([^-]*)(?:-(.*))?/)
     let [qunitPage, qunitTest] = [null, null]
     if (pageId) {
       const url = Object.keys(job.qunitPages).find(pageUrl => job.qunitPages[pageUrl].id === pageId)
@@ -39,6 +39,19 @@ report.ready.then(update => {
     })
   }
 
-  window.addEventListener('hashchange', hashChange)
-  hashChange()
+  window.addEventListener('hashchange', () => {
+    hashChange(location.hash)
+  })
+  if (window.location.href === 'about:srcdoc') {
+    window.addEventListener('click', (event) => {
+      const { href } = event.target
+      if (href) {
+        const lastHash = href.lastIndexOf('#')
+        hashChange(href.substring(lastHash))
+      }
+      event.preventDefault()
+      return false
+    })
+  }
+  hashChange(location.hash)
 })

package/src/defaults/report.js

@@ -12,7 +12,8 @@ async function readDefault (name) {
 }
 
 async function readDependency (name) {
-  return (await readFile(resolveDependencyPath(name))).toString()
+  const path = join(resolveDependencyPath(name), `dist/${name}.js`)
+  return (await readFile(path)).toString()
 }
 
 function minifyJs (src) {

package/src/endpoints.js

@@ -12,8 +12,8 @@ const { readFile } = require('fs/promises')
 const { TextEncoder } = require('util')
 const { resolveDependencyPath } = require('./npm.js')
 
-const punyexprBinPath = resolveDependencyPath('punyexpr')
-const punybindBinPath = resolveDependencyPath('punybind')
+const punyexprBinPath = join(resolveDependencyPath('punyexpr'), 'dist/punyexpr.js')
+const punybindBinPath = join(resolveDependencyPath('punybind'), 'dist/punybind.js')
 
 module.exports = job => {
   async function endpointImpl (api, implementation, request) {

package/src/job.js

@@ -95,6 +95,7 @@ function getCommand (cwd) {
     .option('-r, --report-dir <path>', '[💻🔗🧪] Directory to output test reports (relative to cwd)', 'report')
     .option('-pt, --page-timeout <timeout>', '[💻🔗🧪] Limit the page execution time, fails the page if it takes longer than the timeout (0 means no timeout)', timeout, 0)
     .option('-f, --fail-fast [flag]', '[💻🔗🧪] Stop the execution after the first failing page', boolean, false)
+    .option('-fo, --fail-opa-fast [flag]', '[💻🔗] Stop the OPA page execution after the first failing test', boolean, false)
     .option('-k, --keep-alive [flag]', '[💻🔗🧪] Keep the server alive', boolean, false)
     .option('-l, --log-server [flag]', '[💻🔗🧪] Log inner server traces', boolean, false)
     .option('-p, --parallel <count>', '[💻🔗🧪] Number of parallel tests executions', 2)

package/src/npm.js

@@ -1,5 +1,5 @@
 const { exec } = require('child_process')
-const { join } = require('path')
+const { sep, join } = require('path')
 const { stat } = require('fs/promises')
 const { UTRError } = require('./error')
 const { getOutput } = require('./output')
@@ -31,18 +31,24 @@ async function folderExists (path) {
 let localRoot
 let globalRoot
 
+function resolveDependencyPath (name) {
+  require(name)
+  const pattern = `${sep}node_modules${sep}${name}${sep}`
+  const path = Object.keys(require.cache).filter(path => path.includes(pattern))[0]
+  if (path) {
+    const pos = path.indexOf(pattern)
+    return path.substring(0, pos + pattern.length - 1)
+  }
+}
+
 module.exports = {
-  resolveDependencyPath (name) {
-    require(name)
-    return Object.keys(require.cache).filter(path => path.endsWith(`${name}.js`))[0]
-  },
+  resolveDependencyPath,
 
   async resolvePackage (job, name) {
     let modulePath
     let justInstalled = false
     try {
-      require(name)
-      modulePath = name
+      modulePath = resolveDependencyPath(name)
     } catch (e) {
     }
     if (!modulePath) {

package/src/npm.spec.js

@@ -40,7 +40,7 @@ describe('src/npm', () => {
 
   it('detects already installed local package', async () => {
     const path = await resolvePackage(job, 'reserve')
-    expect(path).toStrictEqual('reserve')
+    expect(path).toStrictEqual(join(__dirname, '../node_modules/reserve'))
     expect(output.resolvedPackage).toHaveBeenCalledTimes(1)
     expect(output.packageNotLatest).not.toHaveBeenCalled()
   })

package/src/output.js

@@ -185,6 +185,13 @@ 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) {
@@ -199,6 +206,8 @@ function build (job) {
   } else {
     wrap = method => method
   }
+  const outputStart = Date.now()
+  const getElapsed = () => formatTime(Date.now() - outputStart)
 
   return {
     lastTick: 0,
@@ -236,9 +245,10 @@ function build (job) {
       } else {
         method = log
       }
+      const text = `${getElapsed()} │ ${status}`
       method(job, '')
-      method(job, status)
-      method(job, ''.padStart(status.length, '─'))
+      method(job, text)
+      method(job, '──────┴'.padEnd(text.length, '─'))
     },
 
     watching: wrap(path => {
@@ -295,18 +305,25 @@ function build (job) {
     },
 
     browserStart (url) {
+      const text = p80()`${getElapsed()} >> ${pad.lt(url)}`
       if (interactive) {
-        output(job, '>>', url)
+        output(job, text)
       } else {
-        wrap(() => log(job, p80()`>> ${pad.lt(url)}`))()
+        wrap(() => log(job, text))()
       }
     },
 
     browserStopped (url) {
+      let duration = ''
+      const page = job.qunitPages && job.qunitPages[url]
+      if (page) {
+        duration = ' (' + formatTime(page.end - page.start) + ')'
+      }
+      const text = p80()`${getElapsed()} << ${pad.lt(url + duration)}`
       if (interactive) {
-        output(job, '<<', url)
+        output(job, text)
       } else {
-        wrap(() => log(job, p80()`<< ${pad.lt(url)}`))()
+        wrap(() => log(job, text))()
       }
     },
 
@@ -436,10 +453,6 @@ function build (job) {
       log(job, p80()`!! FAILFAST ${pad.lt(url)}`)
     }),
 
-    timeSpent: wrap((start, end = new Date()) => {
-      log(job, p80()`Time spent: ${end - start}ms`)
-    }),
-
     noTestPageFound: wrap(() => {
       err(job, p80()`No test page found (or all filtered out)`)
     }),

package/src/qunit-hooks.js

@@ -32,6 +32,24 @@ function get (job, urlWithHash, testId) {
   return { url, page, test }
 }
 
+async function done (job, urlWithHash, report) {
+  const { url, page } = get(job, urlWithHash)
+  if (job.browserCapabilities.screenshot) {
+    try {
+      await screenshot(job, url, 'done')
+    } catch (error) {
+      getOutput(job).genericError(error, url)
+    }
+  }
+  if (report.__coverage__) {
+    collect(job, url, report.__coverage__)
+    delete report.__coverage__
+  }
+  page.end = new Date()
+  page.report = report
+  stop(job, url)
+}
+
 module.exports = {
   get,
 
@@ -82,7 +100,8 @@ module.exports = {
     if (failed) {
       if (job.browserCapabilities.screenshot) {
         try {
-          await screenshot(job, url, testId)
+          const absoluteName = await screenshot(job, url, testId)
+          test.screenshot = basename(absoluteName)
         } catch (error) {
           getOutput(job).genericError(error, url)
         }
@@ -94,23 +113,23 @@ module.exports = {
     }
     test.end = new Date()
     test.report = report
+    if (job.failOpaFast && failed) {
+      // skip remaining tests
+      page.modules.forEach(module => {
+        module.tests.forEach(test => {
+          if (!test.report) {
+            test.skip = true
+          }
+        })
+      })
+      await done(job, urlWithHash, {
+        failed: page.failed,
+        passed: page.passed,
+        total: page.count,
+        runtime: 0
+      })
+    }
   },
 
-  async done (job, urlWithHash, report) {
-    const { url, page } = get(job, urlWithHash)
-    if (job.browserCapabilities.screenshot) {
-      try {
-        await screenshot(job, url, 'done')
-      } catch (error) {
-        getOutput(job).genericError(error, url)
-      }
-    }
-    if (report.__coverage__) {
-      collect(job, url, report.__coverage__)
-      delete report.__coverage__
-    }
-    page.end = new Date()
-    page.report = report
-    stop(job, url)
-  }
+  done
 }

package/src/qunit-hooks.spec.js

@@ -33,6 +33,7 @@ describe('src/qunit-hooks', () => {
 
   beforeEach(() => {
     screenshot.mockReset()
+    screenshot.mockImplementation((job, url, testId) => Promise.resolve(`whatever/${testId}.png`))
     stop.mockClear()
     mockGenericError.mockClear()
     job = {
@@ -549,6 +550,8 @@ describe('src/qunit-hooks', () => {
             total: 1
           })
           expect(screenshot).toHaveBeenCalledWith(job, url, '1a')
+          const { test } = get(job, url, '1a')
+          expect(test.screenshot).toStrictEqual('1a.png')
         })
 
         it('takes a screenshot (hash changing)', async () => {
@@ -600,6 +603,44 @@ describe('src/qunit-hooks', () => {
       expect(stop).toHaveBeenCalledWith(job, url)
       expect(job.failed).toStrictEqual(true)
     })
+
+    describe.only('fail OPA fast behavior', () => {
+      beforeEach(async () => {
+        job.failOpaFast = true
+        await testDone(job, url, {
+          ...getTestDoneFor1a(),
+          passed: 0,
+          failed: 1,
+          total: 1
+        })
+      })
+
+      it('fails the test immediately', () => {
+        const { test } = get(job, url, '1a')
+        expect(test).toMatchObject({
+          report: {
+            passed: 0,
+            failed: 1,
+            total: 1
+          }
+        })
+      })
+
+      it('flags the remaining tests as skipped', () => {
+        const { page } = get(job, url)
+        page.modules.forEach(module => {
+          module.tests.forEach(test => {
+            if (test.testId !== '1a') {
+              expect(test.skip).toStrictEqual(true)
+            }
+          })
+        })
+      })
+
+      it('stops the page immediately', () => {
+        expect(stop).toHaveBeenCalledWith(job, url)
+      })
+    })
   })
 
   describe('done', () => {

package/src/report.js

@@ -45,7 +45,6 @@ module.exports = {
     })
     promises.push(generateCoverageReport(job))
     await Promise.all(promises)
-    output.timeSpent(job.start)
     job.status = 'Done'
   }
 }

package/src/tools.js

@@ -1,17 +1,8 @@
 'use strict'
 
-const fsPromises = require('fs').promises
-const { mkdir, stat } = fsPromises
+const { mkdir, rm, stat } = require('fs').promises
 const { createHash } = require('crypto')
 
-let rm
-/* istanbul ignore next */ // Hard to test both in the same run
-if (process.version > 'v14.14') {
-  rm = fsPromises.rm
-} else {
-  rm = fsPromises.rmdir
-}
-
 const recursive = { recursive: true }
 
 const stripUrlHash = url => url.split('#')[0]