Gathering detailed insights and metrics for wdio-qunit-service
Gathering detailed insights and metrics for wdio-qunit-service
Installations
npm install wdio-qunit-serviceDeveloper
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
18.20.5
NPM Version
10.8.2
Statistics
9 Stars
28 Commits
2 Forks
3 Watching
1 Branches
1 Contributors
Updated on 22 Nov 2024
Languages
TypeScript (94.27%)
JavaScript (5.73%)
Total Downloads
Cumulative downloads
Total Downloads
15,008
Last day
47.2%
78
Compared to previous day
Last week
73.7%
521
Compared to previous week
Last month
0.1%
1,820
Compared to previous month
Last year
3,105.7%
14,554
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
7
Versions
wdio-qunit-service
WebdriverIO (wdio) service for running QUnit browser-based tests and dynamically converting them to wdio test suites.
Replacing Karma
QUnit Service is a drop-in replacement for those using Karma JS to run their QUnit tests (karma-qunit, karma-ui5 or any other combination of Karma and QUnit). Karma is deprecated and people should move to modern alternatives!
If you want to keep your QUnit tests as they are, with no rewriting and no refactoring, QUnit Service is everything you need. It runs your QUnit HTML files in a browser and captures all the results in wdio format.
Because of that, developers can use QUnit Service in tandem with everything else available in the wdio ecosystem.
Want to record the test run in a video? Perhaps take a screenshot or save it in PDF? Check the Code coverage? Save the test results in JUnit format? Go for it, QUnit Service doesn't get on your way.
Installation
After configuring WebdriverIO, install wdio-qunit-service as a devDependency in your package.json file.
1npm install wdio-qunit-service --save-dev
If you haven't configured WebdriverIO yet, check the official documentation out.
Configuration
In order to use QUnit Service you just need to add it to the services list in your wdio.conf.js file. The wdio documentation has all information related to the configuration file:
1// wdio.conf.js 2export const config = { 3 // ... 4 services: ["qunit"], 5 // ... 6};
Usage
Make sure the web server is up and running before executing the tests. wdio will not start the web server.
With .spec or .test files
In your WebdriverIO test, you need to navigate to the QUnit HTML test page, then call browser.getQUnitResults().
1describe("QUnit test page", () => { 2 it("should pass QUnit tests", async () => { 3 await browser.url("http://localhost:8080/test/unit/unitTests.qunit.html"); 4 await browser.getQUnitResults(); 5 }); 6});
It's recommended to have one WebdriverIO test file per QUnit HTML test page. This ensures the tests will run in parallel and fully isolated.
Configuration only, no .spec or .test files
If you don't want to create spec/test files, you can pass a list of QUnit HTML files to the configuration and the tests will be automatically generated.
1// wdio.conf.js 2export const config = { 3 // ... 4 baseUrl: 'http://localhost:8080', 5 services: [ 6 ['qunit', { 7 paths: [ 8 'unit-tests.html', 9 'integration-tests.html', 10 'test/qunit.html' 11 ] 12 }], 13 // ... 14};
Test results
Test results could look like:
Examples
Check the examples folder out for samples using javascript, typescript and more.
Usage in SAP Fiori / UI5 apps
Straight forward example using the well known openui5-sample-app:
-
Create a configuration file: wdio.conf.js
-
Tell
wdiowhere to find the QUnit test files: -
- Include the QUnit files to the service configuration
-
- or
-
- Create a WebdriverIO test file for unit tests and another for OPA5 tests
-
The web server must be running before executing the tests
-
Run it $
wdio run ./webapp/test/wdio.conf.js
Author
Mauricio Lauffer
License
This project is licensed under the MIT License - see the LICENSE file for details.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
17 out of 17 merged PRs checked by a CI test -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
update tool detected
Details
- Info: detected update tool: Dependabot: .github/dependabot.yml:1
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
10 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
SAST tool is not run on all commits -- score normalized to 9
Details
- Warn: 20 commits out of 21 are checked with a SAST tool
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'security-events' permission set to 'write': .github/workflows/codeql-analysis.yml:13
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release.yml:9
- Warn: jobLevel 'security-events' permission set to 'write': .github/workflows/scorecards-analysis.yml:17
- Info: topLevel permissions set to 'read-all': .github/workflows/auto-assign.yml:9
- Info: topLevel permissions set to 'read-all': .github/workflows/codeql-analysis.yml:8
- Info: topLevel permissions set to 'read-all': .github/workflows/pnpm-publish.yml:7
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: topLevel permissions set to 'read-all': .github/workflows/scorecards-analysis.yml:11
- Info: topLevel permissions set to 'read-all': .github/workflows/test.yml:8
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'allow deletion' disabled on branch 'main'
- Info: 'force pushes' disabled on branch 'main'
- Warn: 'branch protection settings apply to administrators' is disable on branch 'main'
- Info: 'stale review dismissal' is required to merge on branch 'main'
- Warn: required approving review count is 1 on branch 'main'
- Warn: codeowners review is not required on branch 'main'
- Info: 'last push approval' is required to merge on branch 'main'
- Info: 'up-to-date branches' is required to merge on branch 'main'
- Warn: no status checks found to merge onto branch 'main'
- Info: PRs are required in order to make changes on branch 'main'
Reason
4 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
Found 0/24 approved changesets -- score normalized to 0
Reason
project has 0 contributing companies or organizations -- score normalized to 0
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/mauriciolauffer/wdio-qunit-service/test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/mauriciolauffer/wdio-qunit-service/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mauriciolauffer/wdio-qunit-service/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/mauriciolauffer/wdio-qunit-service/test.yml/main?enable=pin
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Score
6.8
/10
Last Scanned on 2024-11-25T05:31:27Z
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More