Skip to content

Commit 66aa53b

Browse files
fjgliraluksa
andauthored
Update e2e Documentation with env var to set sample yaml files (openshift-service-mesh#487)
* Update e2e Documentation with env var to set sample yaml files Signed-off-by: Francisco H <[email protected]> * Minor improvements Signed-off-by: Marko Lukša <[email protected]> --------- Signed-off-by: Francisco H <[email protected]> Signed-off-by: Marko Lukša <[email protected]> Co-authored-by: Marko Lukša <[email protected]>
1 parent 2e33d68 commit 66aa53b

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

tests/e2e/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ This end-to-end test suite utilizes Ginkgo, a testing framework known for its ex
1515
1. [Pre-requisites](#Pre-requisites)
1616
1. [How to Run the test](#How-to-Run-the-test)
1717
1. [Running the test locally](#Running-the-test-locally)
18-
1. [Settings for end-to-end test execution](#Settings-for-end-to-end-test-execution)
18+
1. [Settings for end-to-end test execution](#Settings-for-end-to-end-test-execution)
19+
1. [Customizing the test run](#Customizing-the-test-run)
1920
1. [Get test definitions for the end-to-end test](#Get-test-definitions-for-the-end-to-end-test)
2021
1. [Contributing](#contributing)
2122

@@ -215,6 +216,23 @@ The following environment variables define the behavior of the test run:
215216
* DEPLOYMENT_NAME=sail-operator - The name of the operator deployment.
216217
* EXPECTED_REGISTRY=`^docker\.io|^gcr\.io` - Which image registry should the operand images come from. Useful for downstream tests.
217218

219+
### Customizing the test run
220+
221+
The test run can be customized by setting the following environment variables:
222+
223+
To change all the sample files used in the test, you can use the following environment variable:
224+
* SAMPLE_YAML_BASE_URL=https://raw.githubusercontent.com/orgName/repoName - The base URL where the sample YAML files are located. This is useful when you want to test the operator with different sample YAML files defined in another repository. Currently the e2e framework use the upstream Istio repository to get the sample YAML files, for example: `https://raw.githubusercontent.com/istio/istio/master/samples/helloworld/helloworld.yaml` for `hello-world` sample yaml file on `master` branch.
225+
226+
Note: when setting this environment variable, make sure that the sample files are available in the same paths as in the Istio upstream repository. For more information check the [code](https://github.com/istio-ecosystem/sail-operator/blob/74f96ab4a56e3d41e2d31faede290116a68551e9/tests/e2e/util/common/e2e_utils.go#L271).
227+
Alternatively, set the following environment variables to change these file paths:
228+
* TCP_ECHO_DUAL_STACK_YAML_PATH
229+
* TCP_ECHO_IPV4_YAML_PATH
230+
* TCP_ECHO_IPV6_YAML_PATH
231+
* SLEEP_YAML_PATH
232+
* HELLOWORLD_YAML_PATH
233+
234+
`TCP_ECHO_*` are used in the `dual-stack` test suite, `SLEEP_YAML_PATH` and `HELLOWORLD_YAML_PATH` are used in both `Multicluster` and default test run.
235+
218236
### Get test definitions for the end-to-end test
219237

220238
The end-to-end test suite is defined in the `tests/e2e/operator` directory. If you want to check the test definition without running the test, you can use the following make target:

0 commit comments

Comments
 (0)