Skip to content

Commit 9c303c2

Browse files
committed
Update tests.md for new test directories
1 parent 5a556f5 commit 9c303c2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/contributing/tests.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ We greatly appreciate Pull Requests that extend the automated tests that vet the
44

55
## How the Tests Work
66

7-
A [GitHub Action workflow](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker.yml)
7+
A [GitHub Action workflow](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-build-test-upload.yml)
88
runs tests against pull requests submitted to the `jupyter/docker-stacks` repository.
99

1010
We use the `pytest` module to run tests on the image.
1111
`conftest.py` and `pytest.ini` in the `tests` folder define the environment in which tests are run.
1212
More info on `pytest` can be found [here](https://docs.pytest.org/en/latest/contents.html).
1313

14-
The actual image-specific test files are located in folders like `tests/<somestack>/` (e.g., `tests/docker-stacks-foundation/`, `tests/minimal-notebook/`, etc.).
14+
The actual image-specific test files are located in folders like `tests/by_image/<somestack>/` (e.g., `tests/by_image/docker-stacks-foundation/`, etc.).
1515

1616
```{note}
17-
If your test is located in `tests/<somestack>/`, it will be run against the `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.
17+
If your test is located in `tests/by_image/<somestack>/`, it will be run against the `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).
1818
```
1919

2020
Many tests make use of global [pytest fixtures](https://docs.pytest.org/en/latest/reference/fixtures.html)
@@ -23,15 +23,15 @@ defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/main/
2323
## Unit tests
2424

2525
You can add a unit test if you want to run a Python script in one of our images.
26-
You should create a `tests/<somestack>/units/` directory, if it doesn't already exist, and put your file there.
26+
You should create a `tests/by_image/<somestack>/units/` directory, if it doesn't already exist, and put your file there.
2727
Files in this folder will be executed in the container when tests are run.
28-
You can see an [TensorFlow package example here](https://github.com/jupyter/docker-stacks/blob/HEAD/tests/tensorflow-notebook/units/unit_tensorflow.py).
28+
You can see an [TensorFlow package example here](https://github.com/jupyter/docker-stacks/blob/HEAD/tests/by_image/tensorflow-notebook/units/unit_tensorflow.py).
2929

3030
## Contributing New Tests
3131

3232
Please follow the process below to add new tests:
3333

34-
1. Add your test code to one of the modules in the `tests/<somestack>/` directory or create a new module.
34+
1. Add your test code to one of the modules in the `tests/by_image/<somestack>/` directory or create a new module.
3535
2. Build one or more images you intend to test and run the tests locally.
3636
If you use `make`, call:
3737

0 commit comments

Comments
 (0)