Mirroristas/openpgpjs
2
0
Fork 0
mirror of https://github.com/openpgpjs/openpgpjs.git synced 2025-11-27 15:53:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(test): remove detailled test instructions

Browse Source
This commit is contained in:
hulkoba 2024-01-29 08:53:47 +01:00
parent 089abc0001
commit 532314837e
No known key found for this signature in database
GPG Key ID: ACB6C4A3A4F2BE2F
1 changed files with 3 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@ -79,38 +79,14 @@ Additionally, please try to follow the style of the commit messages on our [main
## Testing ## Testing
We have multiple types of tests. They are located in the root [`/test`](https://github.com/openpgpjs/openpgpjs/tree/main/test) folder. Tests. They are located in the root [`/test`](https://github.com/openpgpjs/openpgpjs/tree/main/test) folder.
Before you can run the tests you need to build the project using `npm run build` and this will bundle the project and the tests for it be used in our different testing environments. Before running the tests, run `npm run build` to build OpenPGP.js if you've made changes since running `npm install`.
**Unit Tests:** **Unit Tests:**
To run the tests in Node.js, run `npm test`. To run the tests in Node.js, run `npm test`.
**Browser Tests:** To run the tests in a browser, run `npm run browsertest`.
For debugging browser errors, you can run `npm start` and open [`http://localhost:8080/test/unittests.html`](http://localhost:8080/test/unittests.html) in a browser, or run one the following commands:
This will run the tests inside a browser environment:
```sh
npm run browsertest
```
You can run the tests for multiple headless browsers using KarmaJs:
` npm run test-browser`
If you wanna start the tests using KarmaJs and BrowserStack:
`npm run test-browserstack`
**_NOTE_**: You need to configure you env with `BROWSER_STACK_ACCESS_KEY` and `BROWSERSTACK_USERNAME` to be able to run the BrowserStack tests.
**Performance:**
To avoid performance regressions, we measure time and memory usage with the following testing suites (in `/benchmarks`):
```sh
npm run benchmark-time
npm run benchmark-memory-usage
```
**Typescript definitions** **Typescript definitions**