diff --git a/test/README.md b/test/README.md new file mode 100644 index 00000000..f0c887ea --- /dev/null +++ b/test/README.md @@ -0,0 +1,12 @@ +# Docker stacks testing + +We test our images using `pytest` module. + +There are two kinds of tests we use: + +- General tests - these are located in [this](https://github.com/jupyter/docker-stacks/blob/master/test) folder +- Image specific tests - for example, [base-notebook/test](https://github.com/jupyter/docker-stacks/blob/master/base-notebook/test) folder + +We also have a way to easily run arbitrary python files in a container. +This is useful for running unit tests of packages we use, so we put these files in `{image}/test/units` folder. +An example of such a test is [unit_pandas.py](https://github.com/jupyter/docker-stacks/blob/master/scipy-notebook/test/units)