Merge pull request #783 from heroku/document-tests

Document tests
2026-06-05 23:10:16 +00:00 · 2018-11-15 12:41:15 -06:00
parent 41e0f64252 b024e644d1
commit b85fe3614c
2 changed files with 23 additions and 1 deletions
@@ -1,7 +1,7 @@
 # These targets are not files
 .PHONY: tests

-test: test-heroku-16
+test: test-heroku-18 test-heroku-16

 check:
 	@shellcheck -x bin/compile bin/detect bin/release bin/test-compile bin/utils bin/warnings
@@ -61,3 +61,25 @@ Runtime options include:
 - `python-3.7.0`
 - `python-3.6.6`
 - `python-2.7.15`
+
+## Tests
+
+The buildpack tests use [Docker](https://www.docker.com/) to simulate
+Heroku's [stack images.](https://devcenter.heroku.com/articles/stack)
+
+To run the test suite:
+
+```
+make test
+```
+
+Or to test in a particular stack:
+
+```
+make test-heroku-18
+make test-heroku-16
+```
+
+The tests are run via the vendored
+[shunit2](https://github.com/kward/shunit2)
+test framework.