Skip to content

Commit

Permalink
Fix testing documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>
  • Loading branch information
gaiksaya committed Feb 3, 2025
1 parent 5813fa5 commit daf79a1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/Testing-the-Distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Additional arguments:
| -v, --verbose | Show more verbose output. |

### Integration Tests
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.
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.

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

Set up the right JAVA_HOME version or node version as per the distribution version and clone this repository to start using testing framework.
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.


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.
Expand All @@ -45,15 +45,15 @@ Usage:
./test.sh integ-test <test-manifest-path> <target>
```

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

```bash
./build.sh manifests/1.3.5/opensearch-1.3.5.yml
./assemble.sh builds/opensearch/manifest.yml
./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"
```

Or run integration tests against an existing build.
Or run integration tests against an existing build:

```bash
./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
Expand Down

0 comments on commit daf79a1

Please sign in to comment.