opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-27 07:57:30 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #908 from jbenet/sharness_readme_improvements

Browse Source 
sharness/README: add writing tests and debugging
This commit is contained in:
Juan Batiz-Benet
2015-03-10 07:04:48 -07:00
parent ae35bd261c f67522e3f3
commit adeb243afc
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
test/sharness/README.md
View File

@ -16,7 +16,6 @@ The usual ipfs env flags also apply:
IPFS_LOGGING=debug TEST_VERBOSE=1 make
```
## Running just one test
You can run only one test script by launching it like a regular shell
@ -26,6 +25,16 @@ script:
$ ./t0010-basic-commands.sh
```
## Debugging one test
You can use the `-v` option to make it verbose and the `-i` option to
make it stop as soon as one test fails.
For example:
```
$ ./t0010-basic-commands.sh -v -i
```
## Sharness
When running "make" in this directory for the first time, sharness
@ -40,6 +49,17 @@ send pull requests there.
## Writing Tests
Please have a look at existing tests and try to follow their example.
When possible and not too inefficient, that means most of the time,
an ipfs command should not be on the left side of a pipe, because if
the ipfs command fails (exit non zero), the pipe will mask this failure.
For example after `false | true`, `echo $?` prints 0 (despite `false`
failing).
It should be possible to put most of the code inside `test_expect_success`,
or sometimes `test_expect_failure`, blocks, and to chain all the commands
inside those blocks with `&&`, or `||` for diagnostic commands.
### Diagnostics