We greatly appreciate pull requests that extend the automated tests that vet the basic functionality of the Docker images.
How the Tests Work#
A GitHub Action workflow
runs tests against pull requests submitted to the
We use the
pytest module to run tests on the image.
pytest.ini in the
tests folder define the environment in which tests are run.
More info on
pytest can be found here.
The actual image-specific test files are located in folders like
If your test is located in
tests/<somestack>/, it will be run against
jupyter/<somestack> image and against all the [images inherited from this image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#image-relationships.
You can add a unit test if you want to run a python script in one of our images.
You should create a
tests/<somestack>/units/ directory, if it doesn’t already exist and put your file there.
Files in this folder will be executed in the container when tests are run.
You can see an example for the TensorFlow package here.
Contributing New Tests#
Please follow the process below to add new tests:
Add your test code to one of the modules in
tests/<somestack>/directory or create a new module.
Build one or more images you intend to test and run the tests locally. If you use
make build/<somestack> make test/<somestack>
Submit a pull request (PR) with your changes.
Watch for GitHub to report a build success or failure for your PR on GitHub.
Discuss changes with the maintainers and address any issues running the tests on GitHub.