Skip to content

Commit 940aa15

Browse files
authored
update testing section of README (#43)
1 parent 11984fc commit 940aa15

File tree

2 files changed

+29
-20
lines changed

2 files changed

+29
-20
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,34 @@ pre-commit install
190190
```
191191
See [https://pre-commit.com](https://pre-commit.com) for prerequisites.
192192

193-
### Running tests locally
193+
### Running unit tests
194194

195-
TODO: Document this once we finish porting the scripts from MCADv2.
195+
Unit tests can be run at any time by doing `make test`.
196+
No additional setup is required.
197+
198+
### Running end-to-end tests
199+
200+
A suite of end-to-end tests are run as part of the project's
201+
[continuous intergration workflow](./.github/workflows/CI.yaml).
202+
These tests can also be run locally aginst a deployed version of Kueue
203+
and the AppWrapper controller.
204+
205+
To create and initialize your cluster, perform the following steps:
206+
```shell
207+
./hack/create-test-cluster.sh
208+
./hack/deploy-kueue.sh
209+
```
210+
211+
Next build and deploy the AppWrapper operator
212+
```shell
213+
make docker-build kind-push
214+
make deploy
215+
```
216+
217+
Finally, run the test suite
218+
```shell
219+
./hack/run-tests-on-cluster.sh
220+
```
196221

197222
## License
198223

test/README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,8 @@
22

33
This directory contains both go and kuttl tests suites that are
44
designed to be run against an AppWrapper operator deployed on a
5-
Kubernetes cluster with Kueue installed.
5+
Kubernetes cluster with Kueue and the Kubeflow operator installed.
66

77
The [../hack/](../hack) directory contains scripts that can be used to
88
create an appropriately configured test cluster using `kind` and to run
9-
the tests. The tests can be run in two primary modes:
10-
1. ***Fully automated*** The script [../hack/run-e2e-kind.sh](../hack/run-e2e-kind.sh)
11-
fully automates creating a properly configured `kind` cluster, deploying
12-
Kueue and the AppWrapper CRDs and controller on the cluster, running all
13-
tests on the cluster, and then deleting the cluster when the tests are completed.
14-
For easy of use, run this script by doing a `make run-e2e` to ensure that the tests are run
15-
against an image that contains your locally modified code.
16-
2. ***Development mode*** The script [../hack/create-test-cluster.sh](../hack/create-test-cluster.sh)
17-
can be used to create a correctly configured test cluster.
18-
The script [../hack/deploy-kueue.sh](../hack/deploy-kueue.sh) can be used to
19-
deploy Kueue on the test cluster.
20-
You can then use either `make install; make run` or `make install; make kind-push; make deploy`
21-
to deploy the AppWrapper CRDs and run the controller.
22-
After everything is running, you can then either run test cases
23-
individually or use the script
24-
[../hack/run-tests-on-cluster.sh](../hack/run-tests-on-cluster.sh) to
25-
run the entire AppWrapper test suite against the system you just deployed.
9+
the tests.

0 commit comments

Comments
 (0)