Skip to content

Commit b5f645c

Browse files
committed
enable allure dev reporting
Signed-off-by: PatStLouis <[email protected]>
1 parent 54a8ce1 commit b5f645c

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ localConfig.cjs
1717
config.json
1818
reports/**
1919
!.gitkeep
20+
allure-results

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ specification.
1616
- [Setup](#setup)
1717
- [Usage](#usage)
1818
- [Testing Locally](#testing-locally)
19+
- [Allure Reporting](#allure-reporting)
1920
- [Implementation](#implementation)
2021
- [VC-API](#vc-api)
2122
- [Contribute](#contribute)
@@ -326,6 +327,19 @@ you can check the
326327
[vc-test-suite-implementations](https://github.com/w3c/vc-test-suite-implementations)
327328
library.
328329
330+
### Allure Reporting
331+
It's also possible to generate local allure reports for analyzing and debuging results.
332+
333+
To run the tests and browse the report, use the following commands:
334+
```bash
335+
# Running the tests
336+
npx mocha tests/
337+
338+
# Running the reporting server
339+
allure serve allure-results
340+
341+
```
342+
329343
## Contribute
330344
331345
See [the CONTRIBUTING.md file in the `w3c/vc-test-suite-implementations` repo](https://github.com/w3c/vc-test-suite-implementations/blob/main/CONTRIBUTING.md).

package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,18 @@
4949
"vc-test-suite-implementations": "github:w3c/vc-test-suite-implementations"
5050
},
5151
"devDependencies": {
52+
"allure-commandline": "^2.30.0",
53+
"allure-mocha": "^3.0.3",
5254
"eslint": "^8.19.0",
5355
"eslint-config-digitalbazaar": "^4.0.1",
5456
"eslint-plugin-jsdoc": "^39.3.3",
5557
"eslint-plugin-unicorn": "^43.0.0"
58+
},
59+
"mocha": {
60+
"parallel": false,
61+
"reporter": "allure-mocha",
62+
"reporterOptions": {
63+
"resultsDir": "allure-results"
64+
}
5665
}
5766
}

0 commit comments

Comments
 (0)