From 748022ecf47588b4ee98f875f78be8d2faeddef6 Mon Sep 17 00:00:00 2001 From: dblock Date: Tue, 11 Jun 2024 07:51:46 -0400 Subject: [PATCH] Reorganize tests in namespaces. Signed-off-by: dblock --- DEVELOPER_GUIDE.md | 4 +++- tests/{_core/index => indices}/_doc.yaml | 2 +- .../pipeline/_common/processors.yaml => ingest/pipeline.yaml} | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) rename tests/{_core/index => indices}/_doc.yaml (95%) rename tests/{_ingest/pipeline/_common/processors.yaml => ingest/pipeline.yaml} (93%) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 1a42372cd..6462011ae 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -150,7 +150,9 @@ This repository includes several OpenAPI Specification Extensions to fill in any ## Writing Spec Tests -To assure the correctness of the spec, you must add tests for the spec in the [tests/](tests) directory. Each yaml file in the tests directory represents a test story that tests a collection of related operations. A test story has 3 main components: +To assure the correctness of the spec, you must add tests for the spec in the [tests/](tests) directory. Each yaml file in the tests directory represents a test story that tests a collection of related operations. Tests are organized in folders that match [namespaces](spec/namespaces). + +A test story has 3 main components: - prologues: These are the operations that are executed before the test story is run. They are used to set up the environment for the test story. - chapters: These are the operations that are being tested. - epilogues: These are the operations that are executed after the test story is run. They are used to clean up the environment after the test story. diff --git a/tests/_core/index/_doc.yaml b/tests/indices/_doc.yaml similarity index 95% rename from tests/_core/index/_doc.yaml rename to tests/indices/_doc.yaml index b85d72151..b4789f0c7 100644 --- a/tests/_core/index/_doc.yaml +++ b/tests/indices/_doc.yaml @@ -1,4 +1,4 @@ -$schema: ../../../json_schemas/test_story.schema.yaml +$schema: ../../json_schemas/test_story.schema.yaml skip: false description: Test inserting and retrieving a doc. diff --git a/tests/_ingest/pipeline/_common/processors.yaml b/tests/ingest/pipeline.yaml similarity index 93% rename from tests/_ingest/pipeline/_common/processors.yaml rename to tests/ingest/pipeline.yaml index 214a27cb1..2408d79d3 100644 --- a/tests/_ingest/pipeline/_common/processors.yaml +++ b/tests/ingest/pipeline.yaml @@ -1,4 +1,4 @@ -$schema: ../../../../json_schemas/test_story.schema.yaml +$schema: ../../json_schemas/test_story.schema.yaml skip: false description: |