Skip to content

Commit 7c0d46e

Browse files
authored
Fix testing documentation (opensearch-project#5289)
Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>
1 parent 177687d commit 7c0d46e

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/Testing-the-Distribution.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ Additional arguments:
2121
|------------------------|-------------------------------------------------------------------------|
2222
| test-type | Run tests of a test suite. [integ-test, bwc-test, perf-test] |
2323
| test-manifest-path | Specify a test manifest path. |
24-
| --paths | Location of manifest(s). |
24+
| --paths | Specify paths for OpenSearch and OpenSearch Dashboards. |
2525
| --test-run-id | Unique identifier for a test run. |
2626
| --component [name ...] | Test a subset of specific components. |
2727
| --keep | Do not delete the temporary working directory on both success or error. |
2828
| -v, --verbose | Show more verbose output. |
2929

3030
### Integration Tests
31-
In order to run the tests in your local, you can avoid installing the packages with right version by using a docker image. Each test manifest consist of the docker image to run tests on.
31+
In order to run the tests in your local, you can avoid installing the packages with right version by using a docker image. Each test manifest consist of the docker image to run tests on. Check the [test manifest](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/2.19.0/opensearch-2.19.0.yml#L8) or [jenkins file](https://github.com/opensearch-project/opensearch-build/blob/main/jenkins/opensearch/integ-test.jenkinsfile#L15-L20) to retrieve the docker images.
3232

3333
```
3434
docker run -u root -it opensearchstaging/ci-runner:ci-runner-centos7-opensearch-build-v3 /bin/bash
3535
```
3636

37-
Set up the right JAVA_HOME version or node version as per the distribution version and clone this repository to start using testing framework.
37+
Set up the right JAVA_HOME version (check test manifest to see what version is being used to test the distribution) or node version as per the distribution version and clone this repository to start using testing framework.
3838

3939

4040
To run integration tests locally, use below command. This pulls down the built bundle and its manifest file, reads all components of the distribution, and runs integration tests against each component.
@@ -45,15 +45,15 @@ Usage:
4545
./test.sh integ-test <test-manifest-path> <target>
4646
```
4747

48-
For example, build locally and run integration tests.
48+
For example, to build the distribution locally and run integration test on locally built distribution:
4949

5050
```bash
5151
./build.sh manifests/1.3.5/opensearch-1.3.5.yml
5252
./assemble.sh builds/opensearch/manifest.yml
5353
./test.sh integ-test manifests/1.3.5/opensearch-1.3.5-test.yml . # looks for "./builds/opensearch/manifest.yml" and "./dist/opensearch/manifest.yml"
5454
```
5555

56-
Or run integration tests against an existing build.
56+
Or run integration tests against an existing build:
5757

5858
```bash
5959
./test.sh integ-test manifests/1.3.5/opensearch-1.3.5-test.yml --paths opensearch=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.5/5960/linux/x64/tar # looks for https://.../builds/opensearch/manifest.yml and https://.../dist/opensearch/manifest.yml

0 commit comments

Comments
 (0)