Skip to content

Commit

Permalink
documentation(coverage): document new options
Browse files Browse the repository at this point in the history
  • Loading branch information
@ArnaudBuchholz
ArnaudBuchholz committed Sep 25, 2023
1 parent 6427526 commit c0cf335
Showing 1 changed file with 68 additions and 61 deletions.
129 changes: 68 additions & 61 deletions docs/usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,67 +5,74 @@ Use `ui5-test-runner --help` to display the list of options. The mapping between
Check additional information below.

```text
-V, --version output the version number
--capabilities 🧪 Capabilities tester for browser
-u, --url <url...> 🔗 URL of the testsuite / page to test
-c, --cwd <path> [💻🔗🧪] Set working directory (default: current working directory)
--port <port> [💻🔗🧪] Port to use (0 to use any free one) (default: 0)
-r, --report-dir <path> [💻🔗🧪] Directory to output test reports (relative to cwd) (default:
"report")
-pt, --page-timeout <timeout> [💻🔗🧪] Limit the page execution time, fails the page if it takes longer
than the timeout (0 means no timeout) (default: 0)
-f, --fail-fast [flag] [💻🔗🧪] Stop the execution after the first failing page (default: false)
-fo, --fail-opa-fast [flag] [💻🔗] Stop the OPA page execution after the first failing test (default:
false)
-k, --keep-alive [flag] [💻🔗🧪] Keep the server alive (default: false)
-l, --log-server [flag] [💻🔗🧪] Log inner server traces (default: false)
-p, --parallel <count> [💻🔗🧪] Number of parallel tests executions (default: 2)
-b, --browser <command> [💻🔗🧪] Browser instantiation command (relative to cwd or use $/ for
provided ones) (default: "$/puppeteer.js")
--browser-args <argument...> [💻🔗🧪] Browser instantiation command parameters (use -- instead)
--no-npm-install [💻🔗🧪] Prevent any NPM install (execution may fail if a dependency is
missing)
-bt, --browser-close-timeout <timeout> [💻🔗🧪] Maximum waiting time for browser close (default: 2000)
-br, --browser-retry <count> [💻🔗🧪] Browser instantiation retries : if the command fails unexpectedly,
it is re-executed (0 means no retry) (default: 1)
-pf, --page-filter <regexp> [💻🔗] Filter out pages not matching the regexp
-pp, --page-params <params> [💻🔗] Add parameters to page URL
-t, --global-timeout <timeout> [💻🔗] Limit the pages execution time, fail the page if it takes longer than
the timeout (0 means no timeout) (default: 0)
--screenshot [flag] [💻🔗] Take screenshots during the tests execution (if supported by the
browser) (default: true)
--no-screenshot [💻🔗] Disable screenshots
-st, --screenshot-timeout <timeout> [💻🔗] Maximum waiting time for browser screenshot (default: 5000)
-rg, --report-generator <path...> [💻🔗] Report generator paths (relative to cwd or use $/ for provided ones)
(default: ["$/report.js"])
-pp, --progress-page <path> [💻🔗] progress page path (relative to cwd or use $/ for provided ones)
(default: "$/report/default.html")
--coverage [flag] [💻🔗] Enable or disable code coverage
--no-coverage [💻🔗] Disable code coverage
-cs, --coverage-settings <path> [💻🔗] Path to a custom nyc.json file providing settings for instrumentation
(relative to cwd or use $/ for provided ones) (default: "$/nyc.json")
-ct, --coverage-temp-dir <path> [💻🔗] Directory to output raw coverage information to (relative to cwd)
(default: ".nyc_output")
-cr, --coverage-report-dir <path> [💻🔗] Directory to store the coverage report files (relative to cwd)
(default: "coverage")
-cr, --coverage-reporters <reporter...> [💻🔗] List of nyc reporters to use (default: ["lcov","cobertura"])
-s, --serve-only [flag] [💻🔗] Serve only (default: false)
--ui5 <url> [💻] UI5 url (default: "https://ui5.sap.com")
--no-ui5 [💻] Disable UI5 mapping (also disable libs)
--libs <lib...> [💻] Library mapping (<relative>=<path> or <path>)
--mappings <mapping...> [💻] Custom mapping (<match>=<file|url>(<config>))
--cache <path> [💻] Cache UI5 resources locally in the given folder (empty to disable)
--webapp <path> [💻] Base folder of the web application (relative to cwd) (default:
"webapp")
--testsuite <path> [💻] Path of the testsuite file (relative to webapp) (default:
"test/testsuite.qunit.html")
-w, --watch [flag] [💻] Monitor the webapp folder and re-execute tests on change (default:
false)
-cp, --coverage-proxy [flag] [🔗] [⚠️ experimental] use internal proxy to instrument remote files
(default: false)
-cpi, --coverage-proxy-include <regexp> [🔗] [⚠️ experimental] urls to instrument for coverage (default: {})
-cpe, --coverage-proxy-exclude <regexp> [🔗] [⚠️ experimental] urls to ignore for coverage (default: {})
-h, --help display help for command
-V, --version output the version number
--capabilities 🧪 Capabilities tester for browser
-u, --url <url...> 🔗 URL of the testsuite / page to test
-c, --cwd <path> [💻🔗🧪] Set working directory (default: current working directory)
--port <port> [💻🔗🧪] Port to use (0 to use any free one) (default: 0)
-r, --report-dir <path> [💻🔗🧪] Directory to output test reports (relative to cwd) (default:
"report")
-pt, --page-timeout <timeout> [💻🔗🧪] Limit the page execution time, fails the page if it takes
longer than the timeout (0 means no timeout) (default: 0)
-f, --fail-fast [flag] [💻🔗🧪] Stop the execution after the first failing page (default:
false)
-fo, --fail-opa-fast [flag] [💻🔗] Stop the OPA page execution after the first failing test
(default: false)
-k, --keep-alive [flag] [💻🔗🧪] Keep the server alive (default: false)
-l, --log-server [flag] [💻🔗🧪] Log inner server traces (default: false)
-p, --parallel <count> [💻🔗🧪] Number of parallel tests executions (default: 2)
-b, --browser <command> [💻🔗🧪] Browser instantiation command (relative to cwd or use $/ for
provided ones) (default: "$/puppeteer.js")
--browser-args <argument...> [💻🔗🧪] Browser instantiation command parameters (use -- instead)
--no-npm-install [💻🔗🧪] Prevent any NPM install (execution may fail if a dependency is
missing)
-bt, --browser-close-timeout <timeout> [💻🔗🧪] Maximum waiting time for browser close (default: 2000)
-br, --browser-retry <count> [💻🔗🧪] Browser instantiation retries : if the command fails
unexpectedly, it is re-executed (0 means no retry) (default: 1)
-pf, --page-filter <regexp> [💻🔗] Filter out pages not matching the regexp
-pp, --page-params <params> [💻🔗] Add parameters to page URL
-t, --global-timeout <timeout> [💻🔗] Limit the pages execution time, fail the page if it takes longer
than the timeout (0 means no timeout) (default: 0)
--screenshot [flag] [💻🔗] Take screenshots during the tests execution (if supported by the
browser) (default: true)
--no-screenshot [💻🔗] Disable screenshots
-st, --screenshot-timeout <timeout> [💻🔗] Maximum waiting time for browser screenshot (default: 5000)
-rg, --report-generator <path...> [💻🔗] Report generator paths (relative to cwd or use $/ for provided
ones) (default: ["$/report.js"])
-pp, --progress-page <path> [💻🔗] progress page path (relative to cwd or use $/ for provided ones)
(default: "$/report/default.html")
--coverage [flag] [💻🔗] Enable or disable code coverage
--no-coverage [💻🔗] Disable code coverage
-cs, --coverage-settings <path> [💻🔗] Path to a custom nyc.json file providing settings for
instrumentation (relative to cwd or use $/ for provided ones) (default:
"$/nyc.json")
-ctd, --coverage-temp-dir <path> [💻🔗] Directory to output raw coverage information to (relative to cwd)
(default: ".nyc_output")
-crd, --coverage-report-dir <path> [💻🔗] Directory to store the coverage report files (relative to cwd)
(default: "coverage")
-cr, --coverage-reporters <reporter...> [💻🔗] List of nyc reporters to use (text is always used) (default:
["lcov","cobertura"])
-ccb, --coverage-check-branches <percent> [💻🔗] What % of branches must be covered (default: 0)
-ccf, --coverage-check-functions <percent> [💻🔗] What % of functions must be covered (default: 0)
-ccl, --coverage-check-lines <percent> [💻🔗] What % of lines must be covered (default: 0)
-ccs, --coverage-check-statements <percent> [💻🔗] What % of statements must be covered (default: 0)
-s, --serve-only [flag] [💻🔗] Serve only (default: false)
--ui5 <url> [💻] UI5 url (default: "https://ui5.sap.com")
--no-ui5 [💻] Disable UI5 mapping (also disable libs)
--libs <lib...> [💻] Library mapping (<relative>=<path> or <path>)
--mappings <mapping...> [💻] Custom mapping (<match>=<file|url>(<config>))
--cache <path> [💻] Cache UI5 resources locally in the given folder (empty to disable)
--webapp <path> [💻] Base folder of the web application (relative to cwd) (default:
"webapp")
--testsuite <path> [💻] Path of the testsuite file (relative to webapp) (default:
"test/testsuite.qunit.html")
-w, --watch [flag] [💻] Monitor the webapp folder and re-execute tests on change (default:
false)
-cp, --coverage-proxy [flag] [🔗] [⚠️ experimental] use internal proxy to instrument remote files
(default: false)
-cpi, --coverage-proxy-include <regexp> [🔗] [⚠️ experimental] urls to instrument for coverage (default: {})
-cpe, --coverage-proxy-exclude <regexp> [🔗] [⚠️ experimental] urls to ignore for coverage (default: {})
-h, --help display help for command
```

Meaning of option values :
Expand Down

0 comments on commit c0cf335

Please sign in to comment.