Skip to content

Enable allure dev reporting #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 7, 2024
Merged

Enable allure dev reporting #125

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5f645c
enable allure dev reporting
PatStLouis Sep 30, 2024
eeecd58
add gitignore directory
PatStLouis Sep 30, 2024
f2acd7a
Add allure information link
PatStLouis Oct 7, 2024
ba12a0a
Apply typo fix
PatStLouis Oct 7, 2024
6b9ae7b
Remove codeblock newline
PatStLouis Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ localConfig.cjs
config.json
reports/**
!.gitkeep
allure-results/
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ specification.
- [Setup](#setup)
- [Usage](#usage)
- [Testing Locally](#testing-locally)
- [Allure Reporting](#allure-reporting)
- [Implementation](#implementation)
- [VC-API](#vc-api)
- [Contribute](#contribute)
Expand Down Expand Up @@ -326,6 +327,19 @@ you can check the
[vc-test-suite-implementations](https://github.com/w3c/vc-test-suite-implementations)
library.

### Allure Reporting
It's also possible to generate local allure reports for analyzing and debuging results.

To run the tests and browse the report, use the following commands:
```bash
# Running the tests
npx mocha tests/

# Running the reporting server
allure serve allure-results
Copy link
Contributor

@davidlehn davidlehn Oct 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be run with npx?

Copy link
Collaborator Author

@PatStLouis PatStLouis Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not necessary, the allure-commandline package provide a direct commandline access to the allure package:
https://www.npmjs.com/package/allure-commandline

There's 2 npm packages installed here, allure-mocha and allure-commandline. allure-mocha is the mocha specific reporter that will output the results into a directory. The allure-commandline is the allure software that will build the report and host a local reporting server.


```

## Contribute

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).
Expand Down
9 changes: 9 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,18 @@
"vc-test-suite-implementations": "github:w3c/vc-test-suite-implementations"
},
"devDependencies": {
"allure-commandline": "^2.30.0",
"allure-mocha": "^3.0.3",
"eslint": "^8.19.0",
"eslint-config-digitalbazaar": "^4.0.1",
"eslint-plugin-jsdoc": "^39.3.3",
"eslint-plugin-unicorn": "^43.0.0"
},
"mocha": {
"parallel": false,
"reporter": "allure-mocha",
"reporterOptions": {
"resultsDir": "allure-results"
}
}
}