Skip to content

Commit 506f372

Browse files
committed
docs(readme): explain unit tests
1 parent 2ec6185 commit 506f372

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,4 +486,19 @@ Node.js script at that time.
486486

487487
## Contributing
488488

489-
Please see the [CONTRIBUTING](/CONTRIBUTING.md) file for all the details.
489+
### Unit Tests
490+
491+
The buildpack is tested with unit tests. One can execute them using `make`:
492+
493+
```sh
494+
make
495+
```
496+
497+
Understanding the root cause of a failing test is (not yet) easy. In case of failing test, we suggest you execute this single test by commenting all the other tests in `test/tests`. Then find the location of your test and add the following right after the failed test:
498+
499+
```sh
500+
cat "${STD_OUT}"
501+
cat "${STD_ERR}"
502+
```
503+
504+
Execute the test again, these two `cat` calls will output the stdout and stderr.

0 commit comments

Comments
 (0)