From 636c2d3946868bd61113a6ac3b587faaabd05d93 Mon Sep 17 00:00:00 2001 From: marknyny Date: Tue, 3 Sep 2024 23:49:00 -0400 Subject: [PATCH] Replaced with backtick quotes (#517) Signed-off-by: marknyny Signed-off-by: Daniel (dB.) Doubrovkine Co-authored-by: Daniel (dB.) Doubrovkine --- TESTING_GUIDE.md | 12 ++++++++++++ package-lock.json | 1 + 2 files changed, 13 insertions(+) diff --git a/TESTING_GUIDE.md b/TESTING_GUIDE.md index 98dae41ab..954017c90 100644 --- a/TESTING_GUIDE.md +++ b/TESTING_GUIDE.md @@ -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) @@ -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 `<>` with your desired password. If not provided, the default password inside the `docker-compose.yml` file will be used.) @@ -37,6 +48,7 @@ export OPENSEARCH_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 diff --git a/package-lock.json b/package-lock.json index 13350495f..a6dae5581 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3930,6 +3930,7 @@ "version": "1.7.5", "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.5.tgz", "integrity": "sha512-fZu86yCo+svH3uqJ/yTdQ0QHpQu5oL+/QE+QPSv6BZSkDAoky9vytxp7u5qk83OJFS3kEBcesWni9WTZAv3tSw==", + "license": "MIT", "dependencies": { "follow-redirects": "^1.15.6", "form-data": "^4.0.0",