ui5-test-runner 5.13.1 → 6.0.0-beta.2

package/src/defaults/report.js

@@ -1,91 +0,0 @@
-'use strict'
-
-const { join, isAbsolute } = require('path')
-const { readFile, writeFile } = require('fs').promises
-const zlib = require('zlib')
-const [,, reportDir] = process.argv
-const verbose = process.argv.includes('--verbose')
-const { resolveDependencyPath } = require('../npm.js')
-
-const log = verbose ? console.log : () => {}
-
-log('🏗 Building report...')
-
-const defaultDir = join(__dirname, 'report')
-
-async function readDefault (name) {
-  return (await readFile(join(defaultDir, name))).toString()
-}
-
-async function readDependency (name) {
-  const path = join(resolveDependencyPath(name), `dist/${name}.js`)
-  return (await readFile(path)).toString()
-}
-
-function minifyJs (src) {
-  return src
-    .replace(/\/\*.*\*\//g, '')
-    .replace(/\{\r?\n\s*/g, '{')
-    .replace(/\r?\n\s*\}/g, '}')
-    .replace(/,?\r?\n\s*\.?/g, match => {
-      let result = ''
-      if (match.startsWith(',')) {
-        result = ','
-      }
-      if (match.endsWith('.')) {
-        result += '.'
-      }
-      return result || ';'
-    })
-}
-
-async function main () {
-  const html = await readDefault('default.html')
-  log('📦 default.html    :', html.length)
-  const styles = (await readDefault('styles.css'))
-    .replace(/\{\r?\n\s+/g, '{')
-    .replace(/\}(\r?\n)+/g, '} ')
-    .replace(/;\r?\n\s*/g, ';')
-    .replace(/(:|,)\s*/g, (_, c) => c)
-  log('📦 styles.css      :', styles.length)
-
-  const punyexpr = await readDependency('punyexpr')
-  log('📦 punyexpr        :', punyexpr.length)
-  const punybind = await readDependency('punybind')
-  log('📦 punybind        :', punybind.length)
-  const common = minifyJs(await readDefault('common.js'))
-  log('📦 common          :', common.length)
-  const main = minifyJs(await readDefault('main.js'))
-  log('📦 main            :', main.length)
-
-  const decompress = minifyJs(await readDefault('decompress.js'))
-  log('📦 decompress      :', decompress.length)
-  const jobPath = isAbsolute(reportDir) ? reportDir : join(process.cwd(), reportDir)
-  log('📦 job path        :', jobPath)
-  const rawJob = require(join(jobPath, 'job.js'))
-  const json = JSON.stringify(rawJob)
-  log('📦 json            :', json.length)
-  const buffer = zlib.gzipSync(json)
-  const base64 = buffer.toString('base64')
-  log('📦 json (Gzip/b64) :', base64.length)
-  log('📦 compression     :', (100 * base64.length / json.length).toFixed(2) + '%')
-
-  await writeFile(join(reportDir, 'report.html'), html
-    .replace(/(>|\}\})\r?\n\s*</g, (_, c) => `${c}<`)
-    .replace('<link rel="stylesheet" href="/_/report/styles.css">', `<style>${styles}</style>`)
-    .replace('<script src="/_/punyexpr.js"></script>', `<script>${punyexpr}</script>`)
-    .replace('<script src="/_/punybind.js"></script>', `<script>${punybind}</script>`)
-    .replace('<script src="/_/report/common.js"></script>', `<script>${common}</script>`)
-    .replace('<script src="/_/report/main.js"></script>', `<script>${decompress};let job={};decompress("${base64}").then(json=>{job=json;report.ready.then(update=>update({...json,elapsed:report.elapsed}))});${main}</script>`)
-  )
-  log('✅ generated.')
-}
-
-main()
-  .catch(reason => {
-    console.error(reason)
-    return -1
-  })
-  .then((code = 0) => {
-    process.exit(code)
-  })

package/src/defaults/scan-ui5.js

@@ -1,26 +0,0 @@
-module.exports = async function scanUI5 (url, onFolder, onFile) {
-  if (url.match(/\/((?:test-)?resources\/.*)/)) {
-    return // ignore UI5 resources
-  }
-  let html
-  try {
-    html = await (await fetch(url)).text()
-  } catch (e) {
-    e.url = url
-    throw e
-  }
-  const items = [...html.matchAll(/<a href="([^"]+)" class="icon/ig)]
-    .map(([_, item]) => item)
-    .filter(item => item.endsWith('/') || item.endsWith('.js') || item.endsWith('.ts'))
-  await onFolder(items.length)
-  for (const item of items) {
-    const itemUrl = new URL(item, url).toString()
-    if (item.endsWith('/')) {
-      await scanUI5(itemUrl, onFolder, onFile)
-    } else if (item.endsWith('.ts')) {
-      await onFile(itemUrl, await (await fetch(itemUrl.replace(/\.ts$/, '.js'))).text())
-    } else {
-      await onFile(itemUrl, await (await fetch(itemUrl + '?instrument=true')).text())
-    }
-  }
-}

package/src/defaults/selenium-webdriver/chrome.js

@@ -1,39 +0,0 @@
-const { join } = require('path')
-
-module.exports = async ({
-  seleniumWebdriver,
-  settings,
-  options,
-  loggingPreferences
-}) => {
-  const { Browser, Builder } = seleniumWebdriver
-  const chrome = require(join(settings.modules['selenium-webdriver'], 'chrome'))
-
-  const chromeOptions = new chrome.Options()
-  const chromeArgs = options.chromeArgs()
-  for (const arg of chromeArgs) {
-    if (arg !== 'true') {
-      chromeOptions.addArguments(arg)
-    }
-  }
-  chromeOptions.setLoggingPrefs(loggingPreferences)
-  if (options.binary) {
-    chromeOptions.setChromeBinaryPath(options.binary)
-  }
-  chromeOptions.excludeSwitches('--enable-logging')
-
-  const builder = new Builder()
-    .forBrowser(Browser.CHROME)
-    .setChromeOptions(chromeOptions)
-
-  if (options.server) {
-    builder.usingServer(options.server)
-  }
-
-  const driver = await builder.build()
-  driver.__console__ = true
-  driver.__addScript__ = async function (source) {
-    return await driver.sendDevToolsCommand('Page.addScriptToEvaluateOnNewDocument', { source })
-  }
-  return driver
-}

package/src/defaults/selenium-webdriver/edge.js

@@ -1,24 +0,0 @@
-const { join } = require('path')
-
-module.exports = async ({
-  seleniumWebdriver,
-  settings,
-  options,
-  loggingPreferences
-}) => {
-  const { Browser, Builder } = seleniumWebdriver
-  const edge = require(join(settings.modules['selenium-webdriver'], 'edge'))
-
-  const edgeOptions = new edge.Options()
-  edgeOptions.setLoggingPrefs(loggingPreferences)
-
-  const builder = new Builder()
-    .forBrowser(Browser.EDGE)
-    .setEdgeOptions(edgeOptions)
-
-  if (options.server) {
-    builder.usingServer(options.server)
-  }
-
-  return await builder.build()
-}

package/src/defaults/selenium-webdriver/firefox.js

@@ -1,30 +0,0 @@
-const { join } = require('path')
-
-module.exports = async ({
-  seleniumWebdriver,
-  settings,
-  options,
-  loggingPreferences
-}) => {
-  const { Browser, Builder } = seleniumWebdriver
-  const firefox = require(join(settings.modules['selenium-webdriver'], 'firefox'))
-
-  const firefoxOptions = new firefox.Options()
-  if (!options.visible) {
-    firefoxOptions.addArguments('-headless')
-  }
-  firefoxOptions.setLoggingPrefs(loggingPreferences)
-  if (options.binary) {
-    firefoxOptions.setBinary(options.binary)
-  }
-
-  const builder = new Builder()
-    .forBrowser(Browser.FIREFOX)
-    .setFirefoxOptions(firefoxOptions)
-
-  if (options.server) {
-    builder.usingServer(options.server)
-  }
-
-  return await builder.build()
-}

package/src/defaults/selenium-webdriver.js

@@ -1,129 +0,0 @@
-'use strict'
-
-const { url } = require('../options')
-const { writeFile } = require('fs/promises')
-
-let logging
-let driver
-
-async function buildDriver (settings, options) {
-  const seleniumWebdriver = require(settings.modules['selenium-webdriver'])
-
-  logging = seleniumWebdriver.logging
-  logging.getLogger(logging.Type.BROWSER).setLevel(logging.Level.ALL)
-
-  const loggingPreferences = new logging.Preferences()
-  loggingPreferences.setLevel(logging.Type.BROWSER, logging.Level.ALL)
-
-  driver = await require('./selenium-webdriver/' + options.browser)({
-    seleniumWebdriver,
-    settings,
-    options,
-    loggingPreferences
-  })
-}
-
-require('./browser')({
-  metadata: {
-    name: 'selenium-webdriver',
-    options: [
-      ['browser', 'chrome', 'firefox', 'edge'],
-      'visible',
-      ['-s, --server <server>', 'Selenium server URL', url],
-      'binary',
-      'unsecure'
-    ]
-  },
-
-  async capabilities ({ settings, options }) {
-    const capabilities = {
-      modules: ['selenium-webdriver'],
-      screenshot: '.png',
-      scripts: false,
-      traces: []
-    }
-    if (!settings.modules) {
-      return {
-        ...capabilities,
-        'probe-with-modules': true
-      }
-    }
-    await buildDriver(settings, options)
-    if (driver.__console__) {
-      capabilities.traces.push('console')
-    }
-    if (driver.__network__) {
-      capabilities.traces.push('network')
-    }
-    if (driver.__addScript__) {
-      capabilities.scripts = true
-    }
-    return capabilities
-  },
-
-  async screenshot ({ filename }) {
-    if (driver) {
-      const data = await driver.takeScreenshot()
-      await writeFile(filename, data.replace(/^data:image\/png;base64,/, ''), {
-        encoding: 'base64'
-      })
-      return true
-    }
-  },
-
-  async flush ({
-    settings,
-    consoleWriter
-  }) {
-    if (driver && settings.capabilities.traces.includes('console')) {
-      const logs = await driver.manage().logs().get(logging.Type.BROWSER)
-      const logLevelMapping = {
-        DEBUG: 'debug',
-        INFO: 'log',
-        WARNING: 'warning',
-        SEVERE: 'error'
-      }
-      if (logs.length) {
-        consoleWriter.append(logs.map(({ timestamp, message, level }) => {
-          return {
-            timestamp,
-            type: logLevelMapping[level.toString()],
-            text: message
-          }
-        }))
-      }
-    }
-  },
-
-  async beforeExit () {
-    if (driver) {
-      await driver.quit()
-    }
-  },
-
-  async run ({
-    settings,
-    options
-  }) {
-    await buildDriver(settings, options)
-
-    const { url, scripts } = settings
-
-    if (scripts && scripts.length) {
-      for await (const script of scripts) {
-        await driver.__addScript__(script)
-      }
-    }
-
-    await driver.get(url)
-  },
-
-  async error ({ error: e }) {
-    if (e.name === 'SessionNotCreatedError') {
-      console.error(e.message)
-    } else {
-      console.error(e)
-    }
-    console.error('Please check https://www.npmjs.com/package/selenium-webdriver#installation for browser driver')
-  }
-})

package/src/defaults/text-report.js

@@ -1,108 +0,0 @@
-'use strict'
-
-const { join, isAbsolute } = require('path')
-const [, , reportDir, expectedWidth] = process.argv
-const { pad } = require('../tools')
-
-const p = pad(process.stdout.columns || parseInt(expectedWidth || '80', 10))
-const log = console.log.bind(console)
-
-function collectErrors (page) {
-  const errors = []
-  page.modules.forEach(module => {
-    module.tests.every(test => {
-      if (!test.report) {
-        if (!test.skip) {
-          test.logs ??= []
-          test.logs.push({
-            message: '(no report found)'
-          })
-          errors.push({ module: module.name, ...test })
-          return false
-        }
-      } else if (test.report.failed) {
-        errors.push({ module: module.name, ...test })
-      }
-      return true
-    })
-  })
-  return errors
-}
-
-async function main () {
-  let jobPath
-  if (isAbsolute(reportDir)) {
-    jobPath = join(reportDir, 'job.js')
-  } else {
-    jobPath = join(process.cwd(), reportDir, 'job.js')
-  }
-  const job = require(jobPath)
-  const failedUrls = []
-  let rendered = 0
-  function render (url) {
-    if (++rendered === 1) {
-      log(p`┌─${pad.x('─')}───────────────────┐`)
-    }
-    const page = job.qunitPages && job.qunitPages[url]
-    if (!page || !page.report) {
-      log(p`│${pad.lt(url)} 🧨           │`)
-      failedUrls.push(url)
-    } else {
-      const type = page.isOpa ? '🥼' : '🧪'
-      const status = page.report.failed > 0 ? '🐞' : '  '
-      if (page.report.failed > 0) {
-        failedUrls.push(url)
-      }
-      log(p`│${pad.lt(url)} ${type} ${status} ${page.passed.toString().padStart(3, ' ')}/${page.count.toString().padEnd(3, ' ')}│`)
-    }
-  }
-  job.testPageUrls.forEach(render)
-  Object.keys(job.qunitPages || []).forEach(url => {
-    if (!job.testPageUrls.includes(url)) {
-      render(url)
-    }
-  })
-  if (rendered > 0) {
-    log(p`└─${pad.x('─')}────────────────────┘`)
-  }
-  failedUrls.forEach(url => {
-    log()
-    log(p`[${pad.lt(url)}]`)
-    const page = job.qunitPages && job.qunitPages[url]
-    if (!page) {
-      log(p`Unable to run the page (check the execution log)`)
-    } else {
-      const pageIndex = job.testPageUrls.indexOf(url)
-      const pageHash = job.testPageHashes[pageIndex]
-      if (pageHash) {
-        log(p`Page execution folder name : ${pageHash}`)
-      }
-      let errors = collectErrors(page)
-      const { length } = errors
-      if (page.isOpa) {
-        // Focus on the first error only
-        errors = errors.slice(0, 1)
-      }
-      errors.forEach((test, index) => {
-        if (index > 0) {
-          log()
-        }
-        log(`${test.module} ▶ ${test.name}`)
-        test.logs.filter(({ result }) => !result).forEach(({ message }) => log(message))
-      })
-      if (page.isOpa && length > 1) {
-        log()
-        log(p`(${length} errors occurred but it is recommended to focus on the first OPA error)`)
-      }
-    }
-  })
-}
-
-main()
-  .catch(reason => {
-    console.error(reason)
-    return -1
-  })
-  .then((code = 0) => {
-    process.exit(code)
-  })

package/src/defaults/webdriverio.js

@@ -1,80 +0,0 @@
-'use strict'
-
-let browserio
-
-require('./browser')({
-  metadata: {
-    name: 'webdriverio',
-    options: [
-      'visible',
-      ['browser', 'chrome', 'firefox'],
-      'binary',
-      'viewport',
-      'language',
-      'unsecure'
-    ]
-  },
-
-  async capabilities ({ settings, options }) {
-    return {
-      modules: ['webdriverio'],
-      screenshot: '.png',
-      scripts: true,
-      traces: []
-    }
-  },
-
-  async screenshot ({ filename }) {
-    if (browserio) {
-      await browserio.saveScreenshot(filename)
-      return true
-    }
-  },
-
-  async beforeExit () {
-    if (browserio) {
-      await browserio.deleteSession()
-    }
-  },
-
-  async run ({
-    settings: { url, scripts, modules },
-    options,
-    consoleWriter,
-    networkWriter
-  }) {
-    const { remote } = require(modules.webdriverio)
-
-    const [browserOptions, args] = {
-      chrome: [
-        'goog:chromeOptions',
-        options.chromeArgs()
-      ],
-      firefox: [
-        'moz:firefoxOptions',
-        options.visible ? [] : ['-headless']
-      ]
-    }[options.browser]
-
-    browserio = await remote({
-      capabilities: {
-        browserName: options.browser,
-        webSocketUrl: true,
-        [browserOptions]: {
-          args,
-          binary: options.binary
-        }
-      }
-    })
-
-    if (scripts && scripts.length) {
-      for (const script of scripts) {
-        await browserio.scriptAddPreloadScript({
-          functionDeclaration: `() => ${script}`
-        })
-      }
-    }
-
-    await browserio.url(url)
-  }
-})

package/src/end.js

@@ -1,62 +0,0 @@
-const { fork } = require('node:child_process')
-const { join } = require('node:path')
-const { getOutput } = require('./output')
-const { allocPromise } = require('./tools')
-
-async function end (job) {
-  const { endScript: end } = job
-  const output = getOutput(job)
-  const [script, ...args] = end.split(' ')
-
-  job.status = 'Executing end script'
-
-  output.debug('end', 'Starting script :', end)
-  const childProcess = fork(
-    script,
-    [...args, join(job.reportDir, 'job.js')],
-    {
-      cwd: job.cwd,
-      stdio: [0, 'pipe', 'pipe', 'ipc'],
-      windowsHide: true,
-      env: {
-        ...process.env,
-        ...job.env
-      }
-    }
-  )
-
-  const { promise: childProcessExit, resolve: childProcessExited } = allocPromise()
-  childProcess.on('close', childProcessExited)
-  output.monitor(childProcess)
-
-  job.status = 'Waiting for script to end'
-
-  if (job.endTimeout) {
-    let timedOut = false
-    const { promise: endTimeoutSignal, resolve: endTimeoutReached } = allocPromise()
-    const timeoutId = setTimeout(() => {
-      timedOut = true
-      endTimeoutReached()
-    }, job.endTimeout)
-
-    await Promise.race([
-      childProcessExit,
-      endTimeoutSignal
-    ])
-    clearTimeout(timeoutId)
-
-    if (timedOut) {
-      childProcess.kill()
-      throw new Error('Timeout while waiting for end script')
-    }
-  } else {
-    await childProcessExit
-  }
-
-  output.debug('end', 'Ended with exit code :', childProcess.exitCode)
-
-  // IMPORTANT : the end command CHANGES the exit code
-  process.exitCode = childProcess.exitCode
-}
-
-module.exports = { end }