Skip to content

Commit

Permalink
Replaced with backtick quotes (opensearch-project#517)
Browse files Browse the repository at this point in the history
Signed-off-by: marknyny <marknyny@users.noreply.github.com>
Signed-off-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>
Co-authored-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>
  • Loading branch information
marknyny and dblock authored Sep 4, 2024
1 parent 147e77e commit 636c2d3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions TESTING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
- [Spec Testing Guide](#spec-testing-guide)
- [Running Spec Tests](#running-spec-tests)
- [Running Spec Tests Locally](#running-spec-tests-locally)
- [Prerequisites](#prerequisites)
- [OpenSearch Cluster](#opensearch-cluster)
- [Run Tests](#run-tests)
- [Running Spec Tests with Amazon OpenSearch](#running-spec-tests-with-amazon-opensearch)
- [Common Errors](#common-errors)
- [401 Unauthorized](#401-unauthorized)
Expand Down Expand Up @@ -29,6 +32,14 @@ We have devised our own test framework to test the spec against an OpenSearch cl

### Running Spec Tests Locally

#### Prerequisites

Download and install the latest version of Node.js and npm from [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) and run `npm install`.

Install Docker Desktop from [here](https://www.docker.com/products/docker-desktop).

#### OpenSearch Cluster

Set up an OpenSearch cluster with Docker:

(Replace `<<your_password>>` with your desired password. If not provided, the default password inside the `docker-compose.yml` file will be used.)
Expand All @@ -37,6 +48,7 @@ export OPENSEARCH_PASSWORD=<<your_password>>
cd tests/default
docker compose up -d
```
#### Run Tests
Run the tests (use `--opensearch-insecure` for a local cluster running in Docker that does not have a valid SSL certificate):
```bash
Expand Down
1 change: 1 addition & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 636c2d3

Please sign in to comment.