hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-08 02:24:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
59b37d2ee808c21519f993de8cc86dd98165941f
docker-stacks/docs/contributing/tests.md
Peter Parente 59b37d2ee8 Add contributing tests section
2018-05-26 15:06:37 -04:00

1.7 KiB
Raw Blame History

Image Tests

We greatly appreciate pull requests that extend the automated tests that vet the basic functionality of the Docker images.

How the Tests Work

Travis executes make build-test-all against every pull request submitted to the jupyter/docker-stacks repository. The make command builds every docker image. After building each image, the make command executes pytest to run both image-specific tests like those in base-notebook/test/ and common tests defined in test/. Both kinds of tests make use of global pytest fixtures defined in the conftest.py file at the root of the projects.

Contributing New Tests

Please follow the process below to add new tests:

  1. If the test should run against every image built, add your test code to one of the modules in test/ or create a new module.
  2. If your test should run against a single image, add your test code to one of the modules in some-notebook/test/ or create a new module.
  3. Build one or more images you intend to test and run the tests locally. If you use make, call:
make image/somestack-notebook
make test/somestack-notebook
  1. Submit a pull request (PR) with your changes.
  2. Watch for Travis to report a build success or failure for your PR on GitHub.
  3. Discuss changes with the maintainers and address any issues running the tests on Travis.