ui5-test-runner 2.0.5 → 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.5",
+  "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",
@@ -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/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/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,
 
@@ -95,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

@@ -603,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/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]