Document fielddata.yaml fail, ignore vim swp files (#473)

* Document fielddata.yaml fail, ignore vim swp files * Ignore test files that start with . so vim swp files are ignored * fielddata.yaml test files if opensearch cluster was stopped with docker kill instead of docker stop, document the issue * upgrade remaining actions/checkout@v3 to v4 to stop warnings Signed-off-by: Andy Wick <[email protected]> * fixed FAILED placment Signed-off-by: Andy Wick <[email protected]> * switch to only processing .yaml files Signed-off-by: Andy Wick <[email protected]> * Remove EXCLUDED_FILES instead only process .yaml Signed-off-by: Andy Wick <[email protected]> --------- Signed-off-by: Andy Wick <[email protected]>
opensearch-project · Aug 11, 2024 · 56a5a22 · 56a5a22
1 parent d7e6971
commit 56a5a22
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -7,7 +7,7 @@ jobs:
   verify-changelog:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           ref: ${{ github.event.pull_request.head.sha }}

diff --git a/.github/workflows/test-spec.yml b/.github/workflows/test-spec.yml
@@ -95,7 +95,7 @@ jobs:
     if: github.event_name == 'pull_request'
     needs: test-opensearch-spec
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Download Spec Coverage Data
         uses: actions/download-artifact@v4

diff --git a/TESTING_GUIDE.md b/TESTING_GUIDE.md
@@ -6,6 +6,7 @@
     - [Common Errors](#common-errors)
       - [401 Unauthorized](#401-unauthorized)
       - [FORBIDDEN/10/cluster create-index blocked (api)](#forbidden10cluster-create-index-blocked-api)
+      - [FAILED  Cat with a json response (from security-analytics).](#failed--cat-with-a-json-response-from-security-analytics)
   - [Writing Spec Tests](#writing-spec-tests)
     - [Simple Test Story](#simple-test-story)
     - [Using Output from Previous Chapters](#using-output-from-previous-chapters)
@@ -85,6 +86,9 @@ curl -k -X PUT --user "admin:${OPENSEARCH_PASSWORD}" https://localhost:9200/_clu
 '
 ```
 
+#### FAILED  Cat with a json response (from security-analytics).
+The cluster is not loading plugins correctly, maybe it was stopped using `docker kill` instead of `docker stop`. Recreating the cluster should fix the issue: `docker compose up --force-recreate -d`.
+
 ## Writing Spec Tests
 
 The spec tests reside in the [tests/](tests) directory. Tests are organized in suites ([default](tests/default/), etc.), and subsequently in folders that match [namespaces](spec/namespaces). For example, tests for APIs defined in [spec/namespaces/indices.yaml](spec/namespaces/indices.yaml) can be found in [tests/default/indices/index.yaml](tests/default/indices/index.yaml) (for `/{index}`), and [tests/default/indices/doc.yaml](tests/default/indices/doc.yaml) (for `/{index}/_doc`). 

diff --git a/tools/src/tester/TestRunner.ts b/tools/src/tester/TestRunner.ts
@@ -20,10 +20,6 @@ import { OpenSearchHttpClient } from 'OpenSearchHttpClient'
 import * as ansi from './Ansi'
 import _ from 'lodash'
 
-const EXCLUDED_FILES = [
-  'docker-compose.yml'
-]
-
 export default class TestRunner {
   private readonly _http_client: OpenSearchHttpClient
   private readonly _story_validator: StoryValidator
@@ -69,6 +65,9 @@ export default class TestRunner {
     const path = file === '' ? folder : `${folder}/${file}`
     const next_prefix = prefix === '' ? file : `${prefix}/${file}`
     if (fs.statSync(path).isFile()) {
+      if (!path.endsWith('.yaml')) {
+        return []
+      }
       const story: Story = read_yaml(path)
       return [{
         display_path: next_prefix === '' ? basename(path) : next_prefix,
@@ -77,9 +76,7 @@ export default class TestRunner {
       }]
     } else {
       return _.compact(fs.readdirSync(path).flatMap(next_file => {
-        if (!EXCLUDED_FILES.includes(next_file)) {
-          return this.#collect_story_files(path, next_file, next_prefix)
-        }
+        return this.#collect_story_files(path, next_file, next_prefix)
       }))
     }
   }

diff --git a/tools/tests/tester/fixtures/stories/ignore.wrong.extension b/tools/tests/tester/fixtures/stories/ignore.wrong.extension
@@ -0,0 +1 @@
+Not a .yaml file, should be ignored