zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update test docs

Browse Source
This commit is contained in:
Jordan Bradford
2025-09-27 22:11:32 -04:00
parent 50a74417f6
commit 784e237831
1 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/contributing/tests.md
View File

@@ -28,35 +28,43 @@ against the same installation of TLJH.
### Running integration tests locally ### Running integration tests locally
You need `docker` installed and callable by the user running You need `docker` or `podman` installed and callable by the user
the integration tests without needing sudo. running the integration tests without needing sudo.
You can then run the tests with: First build the container with a Ubuntu-based image:
```bash ```bash
.github/integration-test.py run-test <name-of-run> <test-file-names> .github/integration-test.py build-image \
--build-arg "BASE_IMAGE=ubuntu:22.04"
``` ```
- `<name-of-run>` is an identifier for the tests - you can choose anything you want Then you can then run the tests with the `run-test` function. For usage run:
- `<test-file-names>>` is list of test files (under `integration-tests`) that should be run in one go.
```bash
.github/integration-test.py run-test --help
```
For example, to run all the basic tests, you would write: For example, to run all the basic tests, you would write:
```bash ```bash
.github/integration-test.py run-test basic-tests \ .github/integration-test.py run-test basic-tests \
test_hub.py \ test_hub.py \
test_proxy.py \ test_proxy.py \
test_install.py \ test_install.py \
test_extensions.py test_extensions.py
``` ```
This will run the tests in the three files against the same installation This will run the tests in the four files against the same installation
of TLJH and report errors. of TLJH and report errors.
If you would like to run the tests with a custom pip spec for the bootstrap script, you can use the `--bootstrap-pip-spec` If you would like to run the tests with a custom `pip` spec for the bootstrap script, you can use the `--bootstrap-pip-spec`
parameter: parameter:
```bash ```bash
.github/integration-test.py run-test <name-of-run> <test-file-names> \ .github/integration-test.py run-test custom-pip-spec \
--bootstrap-pip-spec="git+https://github.com/your-username/the-littlest-jupyterhub.git@branch-name" test_hub.py \
test_proxy.py \
test_install.py \
test_extensions.py \
--bootstrap-pip-spec="git+https://github.com/your-username/the-littlest-jupyterhub.git@branch-name"
``` ```