kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-22 22:59:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

document integration test workflow 📝

Browse source 
[ci skip]
This commit is contained in:
Jannis R 2020-05-22 17:08:52 +02:00 • committed by Jannis Redmann
parent 3109a92b19
commit 6f65d82edf
2 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
contributing.md Normal file
View file

@ -0,0 +1,14 @@
# Contributing
Thanks for helping! 🙏
## Adding integration/end-to-end tests
The [end-to-end/system tests](https://en.wikipedia.org/wiki/System_testing) in [`test/e2e`](test/e2e), executing via `npm run test-e2e`, are querying real HAFAS endpoints, expecting valid & *reasonable* responses.
The [integration tests](https://en.wikipedia.org/wiki/Integration_testing) (`npm run test-integration`) are the same `test/e2e` tests, running against *mocked* HAFAS responses from [`test/e2e/fixtures`](test/e2e/fixtures).
1. Add a new end-to-end test that tests your feature/bugfix.
2. Make sure the test passes. You can run your test exclusively using `test.only`.
3. Record the HAFAS responses as [fixtures](https://en.wikipedia.org/wiki/Test_fixture) using `npm run test-integration:record`.
4. Make sure the passes against *only* mocked responses using `npm run test-integration`.

2
readme.md
View file

@ -265,3 +265,5 @@ HAFAS endpoint | library
If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/public-transport/hafas-client/issues).
This project needs help! Check the [list of "help wanted" Issues](https://github.com/public-transport/hafas-client/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
If you're contributing code, please read the [contribution guidelines](contributing.md).