This is an automated email from the ASF dual-hosted git repository. chenyulin0719 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/yunikorn-k8shim.git
The following commit(s) were added to refs/heads/master by this push: new 5f944a16 [YUNIKORN-2522] Move e2e test doc from k8shim to website (#815) 5f944a16 is described below commit 5f944a16d2968e97896622359f6e71752a0d25a4 Author: targetoee <target...@gmail.com> AuthorDate: Sat Apr 27 08:33:26 2024 +0000 [YUNIKORN-2522] Move e2e test doc from k8shim to website (#815) Move test/e2e/README.md to website. Closes: #815 Signed-off-by: Yu-Lin Chen <chenyulin0...@apache.org> --- test/e2e/README.md | 67 +----------------------------------------------------- 1 file changed, 1 insertion(+), 66 deletions(-) diff --git a/test/e2e/README.md b/test/e2e/README.md index eec52dbe..87645b2b 100644 --- a/test/e2e/README.md +++ b/test/e2e/README.md @@ -17,69 +17,4 @@ --> # End to End Testing in YuniKorn-K8shim - -End-to-end (e2e) tests for YuniKorn-K8shim provide a mechanism to test end-to-end behavior of the system, and is the last signal to ensure end user operations match developer specifications. - -The primary objectives of the e2e tests are to ensure a consistent and reliable behavior of the yunikorn code base, and to catch hard-to-test bugs before users do, when unit and integration tests are insufficient. - -The e2e tests are built atop of [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://github.com/onsi/gomega). There are a host of features that this Behavior-Driven Development (BDD) testing framework provides, and it is recommended that the developer read the documentation prior to diving into the tests. - -Below is the structure of the project. -* `test/e2e/` contains tests for YuniKorn Features like Scheduling, Predicates etc -* `test/e2e/framework/configManager` manages & maintains the test and cluster configuration -* `test/e2e/framework/helpers` contains utility modules for k8s client, (de)serializers, rest api client and other common libraries. -* `test/e2e/testdata` contains all the test related data like configmaps, pod specs etc - -## Pre-requisites -This project requires Go to be installed. On OS X with Homebrew you can just run `brew install go`. -OR follow this doc for deploying go https://golang.org/doc/install - -## Understanding the Command Line Arguments -* `yk-namespace` - namespace under which YuniKorn is deployed. [Required] -* `kube-config` - path to kube config file, needed for k8s client [Required] -* `yk-host` - hostname of the YuniKorn REST Server, defaults to localhost. -* `yk-port` - port number of the YuniKorn REST Server, defaults to 9080. -* `yk-scheme` - scheme of the YuniKorn REST Server, defaults to http. -* `timeout` - timeout for all tests, defaults to 24 hours - -## Launching Tests - -### Trigger through CLI -* Begin by installing a new cluster dedicated to testing, such as one named 'yktest' -```shell -$ ./scripts/run-e2e-tests.sh -a install -n yktest -v kindest/node:v1.28.0 -``` - -* Launching CI tests is as simple as below. -```shell -# We need to add a 'kind' prefix to the argument of the run-e2e-tests.sh -n command. - -$ kubectl config use-context kind-yktest -$ ginkgo -r -v ci -timeout=2h -- -yk-namespace "yunikorn" -kube-config "$HOME/.kube/config" -``` - -* Launching all the tests can be done as. -```shell -$ ginkgo -r -v -timeout=2h -- -yk-namespace "yunikorn" -kube-config "$HOME/.kube/config" -``` - -* Launching all the tests in specified e2e folder. -e.g. test/e2e/user_group_limit/ -```shell -$ cd test/e2e/ -$ ginkgo -r user_group_limit -v -- -yk-namespace "yunikorn" -kube-config "$HOME/.kube/config" -``` - -* Launching specified test. -e.g. Run test with ginkgo.it() spec name "Verify_maxapplications_with_a_specific_group_limit" -```shell -$ cd test/e2e/ -$ ginkgo run -r -v --focus "Verify_maxapplications_with_a_specific_group_limit" \ --- -yk-namespace "yunikorn" \ --kube-config "$HOME/.kube/config" -``` -* Delete the cluster after we finish testing (this step is optional). - -```shell -$ ./scripts/run-e2e-tests.sh -a cleanup -n yktest -``` \ No newline at end of file +This document has been moved to the Yunikorn site, which can be found [here](https://yunikorn.apache.org/docs/next/developer_guide/e2e_test). \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@yunikorn.apache.org For additional commands, e-mail: issues-h...@yunikorn.apache.org