ui5-test-runner 5.11.1 → 5.12.0

package/.releaserc

@@ -0,0 +1,5 @@
+{
+  "branches": [
+    { "name": "5.x.y", "channel": "latest" }
+  ]
+}

package/index.js

@@ -58,14 +58,14 @@ async function main () {
   }
   output.reportOnJobProgress()
   checkLatest(job, name, version)
-  if (job.mode === 'capabilities') {
-    return capabilities(job)
-  }
   if (job.if && !executeIf(job)) {
     output.skipIf()
     output.stop()
     return
   }
+  if (job.mode === 'capabilities') {
+    return capabilities(job)
+  }
 
   let startedCommand
   if (job.startCommand) {

package/jest.config.json

@@ -5,7 +5,8 @@
   ],
   "testPathIgnorePatterns": [
     "/node_modules/",
-    "/capabilities/"
+    "/capabilities/",
+    "/e2e/"
   ],
   "collectCoverage": true,
   "collectCoverageFrom": [
@@ -16,6 +17,7 @@
     "\\.spec\\.js",
     "output\\.js",
     "handle\\.js",
+    "coverage\\.js",
     "b\\capabilities\\b"
   ],
   "coverageThreshold": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ui5-test-runner",
-  "version": "5.11.1",
+  "version": "5.12.0",
   "description": "Standalone test runner for UI5",
   "main": "index.js",
   "bin": {
@@ -57,16 +57,17 @@
     "reserve": "2.3.4"
   },
   "devDependencies": {
-    "@openui5/types": "^1.142.0",
+    "@openui5/types": "^1.143.0",
     "@semantic-release/npm": "^13.1.2",
-    "@ui5/cli": "^4.0.35",
+    "@ui5/cli": "^4.0.37",
     "@ui5/middleware-code-coverage": "^2.0.2",
+    "baseline-browser-mapping": "^2.8.32",
     "dotenv": "^16.5.0",
     "jest": "^29.7.0",
     "nock": "^14.0.10",
     "npm-check-updates": "^18.3.0",
     "nyc": "^17.1.0",
-    "rimraf": "^6.1.0",
+    "rimraf": "^6.1.2",
     "semantic-release": "^25.0.2",
     "standard": "^17.1.2",
     "typescript": "^5.9.3",

package/src/job-mode.js

@@ -41,16 +41,13 @@ function buildAndCheckMode (job) {
       'batchMode',
       'batchId',
       'batchLabel',
-      'ci'
+      'ci',
+      'if'
     ])
     return 'capabilities'
   }
   if (job.url && job.url.length) {
     check(job, undefined, [
-      'ui5',
-      'libs',
-      'mappings',
-      'cache',
       'testsuite'
     ])
     return 'url'

package/src/job.js

@@ -159,7 +159,7 @@ function getCommand (cwd) {
     // Specific to legacy (and might be used with url if pointing to local project)
     .option('--ui5 <url>', '[💻📡] UI5 url', url, 'https://ui5.sap.com')
     .option('--disable-ui5 [flag]', '[💻📡] Disable UI5 mapping (also disable libs)', boolean, false)
-    .option('--libs <lib...>', '[💻📡] Library mapping (<relative>=<path> or <path>)', arrayOf(lib))
+    .option('--libs <lib...>', '[💻📡] Library mapping (<relative>=<path> or <path>), use *=webapp/resources to map resources sub folder', 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('--preload <library...>', '[💻📡] Preload UI5 libraries in the cache folder (only if --cache is used)', arrayOf(string))

package/src/start.js

@@ -127,6 +127,7 @@ async function start (job) {
     }
     if (!startProcessExited) {
       output.failedToTerminateStartCommand()
+      startProcess.unref() // the runner shall not be blocked by this process
       startProcess.kill()
     }
   }

package/src/ui5.js

@@ -16,18 +16,39 @@ const buildCacheBase = job => {
   return join(job.cache || '', hostName.replace(':', '_'), version || '')
 }
 
-const ui5mappings = job => {
+const ui5mappings = async job => {
+  const output = getOutput(job)
   const cacheBase = buildCacheBase(job)
   const match = /\/((?:test-)?resources\/.*)/ // Captured value never starts with /
-  const ifCacheEnabled = (request, url, match) => job.cache
+  const ifCacheEnabled = () => job.cache
   const uncachable = {}
   const cachingInProgress = {}
 
+  let { ui5 } = job
+  if (!ui5.endsWith('/')) {
+    ui5 += '/'
+  }
+  const mappingUrl = new URL('$1', ui5).toString()
+
+  const inJest = typeof jest !== 'undefined'
+  /* istanbul ignore next */
+  if (!inJest) {
+    const versionUrl = mappingUrl.replace('$1', 'resources/sap-ui-version.json')
+    const versionResponse = await fetch(versionUrl)
+    if (versionResponse.status !== 200) {
+      output.log('Unable to fetch UI5 version: ' + versionResponse.status + ' ' + versionResponse.statusText)
+      throw new Error('Unable to fetch UI5 version')
+    }
+    const version = await versionResponse.json()
+    const { version: coreVersion } = version.libraries.find(({ name }) => name === 'sap.ui.core')
+    output.log('UI5 version used by the local server: ' + coreVersion)
+  }
+
   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)
-      */
+     * - 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) => {
@@ -42,15 +63,13 @@ const ui5mappings = job => {
         await cachingPromise
       }
     }
-  }, {
-    // UI5 from cache
+  }, { // UI5 from cache
     match,
     'if-match': ifCacheEnabled,
     cwd: cacheBase,
     file: '$1',
     static: !job.debugDevMode
-  }, {
-    // UI5 caching
+  }, { // UI5 caching
     method: 'GET',
     match,
     'if-match': ifCacheEnabled,
@@ -68,7 +87,7 @@ const ui5mappings = job => {
           file.end()
           uncachable[path] = true
           if (response.statusCode !== 404) {
-            getOutput(job).failedToCacheUI5resource(path, response.statusCode)
+            output.failedToCacheUI5resource(path, response.statusCode)
           }
           return unlink(cachePath)
         })
@@ -76,11 +95,10 @@ const ui5mappings = job => {
           delete cachingInProgress[path]
         })
     }
-  }, {
-    // UI5 from url
+  }, { // UI5 from url
     method: ['GET', 'HEAD'],
     match,
-    url: new URL('$1', job.ui5).toString(),
+    url: mappingUrl,
     'ignore-unverifiable-certificate': true
   }]
 
@@ -90,12 +108,24 @@ const ui5mappings = job => {
     }
     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}`
-      })
+      if (relative === '*') {
+        // Special handling to support webapp/resources folder (/!\ coverage won't be extracted for those files)
+        output.debug('libs', '* map to webapp sub directory (expected resources), use file access')
+        mappings.unshift({
+          match: /\/resources\/(.*)/,
+          cwd: source,
+          file: '$1',
+          static: !job.watch && !job.debugDevMode
+        })
+      } else {
+        // Use redirection to support local coverage instrumentation
+        const relativeAbsoluteUrl = '/' + relativePath(job.webapp, source).replace(/\\/g, '/')
+        output.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}(.*)`),
@@ -106,9 +136,9 @@ const ui5mappings = job => {
         match: new RegExp(`\\/resources\\/${relativeUrl}(.*)`),
         custom: (request, response, $1) => {
           if ($1 === undefined) {
-            getOutput(job).debug('libs', `Unable to map ${relative} : $1 is undefined`)
+            output.debug('libs', `Unable to map ${relative} : $1 is undefined`)
           } else {
-            getOutput(job).debug('libs', `Unable to map ${relative}/${$1} to ${join(source, $1)}`)
+            output.debug('libs', `Unable to map ${relative}/${$1} to ${join(source, $1)}`)
           }
           return 404
         }