jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add comments on "untestable" tests directory

Browse source
This commit is contained in:
Federico Ceratto 2017-11-03 20:58:32 +00:00
commit da2fd42e67
2 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
readme.md
View file

@ -127,6 +127,7 @@ However, if you are short on time, you can just run the tests specific to your
changes by only running the corresponding categories of tests. Travis CI verifies changes by only running the corresponding categories of tests. Travis CI verifies
that all tests pass before allowing the pull request to be accepted, so only that all tests pass before allowing the pull request to be accepted, so only
running specific tests should be harmless. running specific tests should be harmless.
Integration tests should go in ``tests/untestable``.
If you're looking for ways to contribute, please look at our [issue tracker][nim-issues]. If you're looking for ways to contribute, please look at our [issue tracker][nim-issues].
There are always plenty of issues labelled [``Easy``][nim-issues-easy]; these should There are always plenty of issues labelled [``Easy``][nim-issues-easy]; these should

11
tests/untestable/readme.markdown
View file

@ -1,2 +1,9 @@
This directory contains tests which are not automatically executed This directory contains integration tests which are not automatically executed
for various reasons. Mainly due to dependencies on external services. for various reasons:
- dependency on external services
- dependency on files / configuration / state of the local host
- tests that are extremely slow or require large amounts of memory or storage
- tests that spawn local daemons
Integration tests can become stale very quickly. Automated ./koch tests are
strongly recommended.