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

Merge pull request #1040 from jrdnbradford/testing-updates

Browse Source 
Local integration testing updates
This commit is contained in:
Min RK
2025-10-07 12:02:06 -07:00
committed by GitHub
parent 5415cc471a fb1e1063d2
commit ca25444915
2 changed files with 51 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
.github/integration-test.py vendored
View File

@@ -226,12 +226,35 @@ def main():
copy_parser.add_argument("src")
copy_parser.add_argument("dest")
run_test_parser = subparsers.add_parser("run-test")
run_test_parser.add_argument("--installer-args", action="append")
run_test_parser.add_argument("--upgrade-from", default="")
run_test_parser.add_argument("--bootstrap-pip-spec", default="/srv/src")
run_test_parser.add_argument("container_name")
run_test_parser.add_argument("test_files", nargs="+")
run_test_parser = subparsers.add_parser(
"run-test",
help="Runs the bootstrap script in a container, then executes specified integration tests.",
)
run_test_parser.add_argument(
"--installer-args",
action="append",
default=[],
help="Additional arguments to pass to bootstrap.py during the main installation. Can be used multiple times.",
)
run_test_parser.add_argument(
"--upgrade-from",
default="",
help="A version/tag (e.g., 'main', 'v0.1.0') to install first, simulating an upgrade to the current source code.",
)
run_test_parser.add_argument(
"--bootstrap-pip-spec",
default="/srv/src",
help="The pip specification used by the bootstrap script to install TLJH (for example: '--bootstrap-pip-spec=git+https://github.com/your-username/the-littlest-jupyterhub.git@branch-name'). Defaults to the local source code path.",
)
run_test_parser.add_argument(
"container_name",
help="An identifier for the container/test run (for example: 'basic-tests').",
)
run_test_parser.add_argument(
"test_files",
nargs="+",
help="A list of one or more test files under 'integration-tests/' to be executed.",
)
show_logs_parser = subparsers.add_parser("show-logs")
show_logs_parser.add_argument("container_name")

26
docs/contributing/tests.md
View File

@@ -28,17 +28,21 @@ against the same installation of TLJH.
### Running integration tests locally
You need `docker` installed and callable by the user running
the integration tests without needing sudo.
You need `docker` or `podman` installed and callable by the user
running the integration tests without needing sudo.
You can then run the tests with:
First build the container with a Ubuntu-based image:
```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
- `<test-file-names>>` is list of test files (under `integration-tests`) that should be run in one go.
Then you can then run the tests with the `run-test` function. For usage run:
```bash
.github/integration-test.py run-test --help
```
For example, to run all the basic tests, you would write:
@@ -50,13 +54,17 @@ For example, to run all the basic tests, you would write:
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.
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:
```bash
.github/integration-test.py run-test <name-of-run> <test-file-names> \
.github/integration-test.py run-test custom-pip-spec \
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"
```