Skip to content

Add coverage badges #15

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
christianpaquin merged 4 commits into from
Mar 20, 2023
Merged

Add coverage badges #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2168568
Add json summary
Mar 20, 2023
1eb20a5
Add coverage
Mar 20, 2023
c94d62d
Add coverage badges
Mar 20, 2023
cf84b68
Add badges
Mar 20, 2023
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
5 changes: 5 additions & 0 deletions .github/workflows/nodejs-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,8 @@ jobs:
- run: npm install
- run: npm run build --if-present
- run: npm test
- run: npm run coverage
Copy link
Author

@OR13 OR13 Mar 20, 2023

Choose a reason for hiding this comment

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

may need to move this to a separate file...

Copy link
Contributor

@christianpaquin christianpaquin Mar 20, 2023

Choose a reason for hiding this comment

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

we'll see; let's try it. Looks like CI ran correctly but badge fail because of branch permission; it might succeed on main (let's see)

- name: Update coverage badges
uses: jpb06/jest-badges-action@latest
with:
branches: main
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

*WORK IN PROGRESS*

[![CI](https://github.com/microsoft/bbs-node-reference/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/microsoft/bbs-node-reference/actions/workflows/nodejs-ci.yml)
![Branches](./badges/coverage-branches.svg)
Copy link
Author

@OR13 OR13 Mar 20, 2023

Choose a reason for hiding this comment

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

The action will create this directory on main, and store latest badge details in it.

![Functions](./badges/coverage-functions.svg)
![Lines](./badges/coverage-lines.svg)
![Statements](./badges/coverage-statements.svg)
![Jest coverage](./badges/coverage-jest%20coverage.svg)

TypeScript reference implementation for the [BBS signature scheme](https://github.com/decentralized-identity/bbs-signature). The goal is to help understand and verify the specification. This is NOT a production-ready implementation; testing is minimal and no effort is made to optimize and protect against specialized attacks (e.g., side-channel resistance).

This project aims to keep up to date with the [latest specification](https://identity.foundation/bbs-signature/draft-looker-cfrg-bbs-signatures.html), but may be behind since the specification changes often; the current implementation matches the *11 March 2023* version of the specification, matching the [draft-irtf-cfrg-bbs-signatures-02](https://datatracker.ietf.org/doc/draft-irtf-cfrg-bbs-signatures/02/) version submitted to the CFRG.
Expand Down
3 changes: 2 additions & 1 deletion jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ module.exports = {
testEnvironment: "node",
preset: "ts-jest",
testTimeout: 15000,
testMatch: ["**/?(*.)+(spec|test).ts"]
testMatch: ["**/?(*.)+(spec|test).ts"],
coverageReporters: ['json-summary'],
};
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"fetch-fixtures": "./fetch-test-vectors.sh",
"build": "npm run fetch-fixtures && tsc",
"bbs": "ts-node --files src/index.ts",
"test": "npm run fetch-fixtures && jest --verbose"
"test": "npm run fetch-fixtures && jest --verbose",
"coverage": "jest --ci --coverage"
},
"author": "Christian Paquin",
"license": "MIT",
Expand Down