Merge branch 'opensearch-project:main' into main

Tokesh · Aug 22, 2024 · 9620b94 · 9620b94
2 parents 1d051cd + b28c1cf
commit 9620b94
Show file tree

Hide file tree

Showing 119 changed files with 1,548 additions and 302 deletions.
diff --git a/.github/pr-comment-templates/pr-test-coverage-analysis.template.md b/.github/pr-comment-templates/pr-test-coverage-analysis.template.md
@@ -1,8 +1,8 @@
 ## Spec Test Coverage Analysis
 {{with .test_coverage}}
 
-| Total             | Tested                                                   |
-|-------------------|----------------------------------------------------------|
-| {{.paths_count}}  | {{.evaluated_paths_count}} ({{.evaluated_paths_pct}} %)  |
+| Total                        | Tested                                                        |
+|------------------------------|---------------------------------------------------------------|
+| {{.total_operations_count}}  | {{.evaluated_operations_count}} ({{.evaluated_paths_pct}} %)  |
 
 {{end}}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -77,6 +77,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `read_time`, `write_time`, `queue_size` and `io_time_in_millis` to `IoStatDevice` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
 - Added `total_rejections_breakup` to `ShardIndexingPressureStats` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
 - Added `cancelled_task_percentage` and `current_cancellation_eligible_tasks_count` to `ShardSearchBackpressureTaskCancellationStats` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
+- Added detailed test coverage report ([#513](https://github.com/opensearch-project/opensearch-api-specification/pull/513))
+- Added 404 responses to `/_alias/{name}` and `/{index}/_alias/{name}` ([#519](https://github.com/opensearch-project/opensearch-api-specification/pull/519))
 
 ### Changed
 
@@ -122,6 +124,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed accuracy of the index stats schemas ([#491](https://github.com/opensearch-project/opensearch-api-specification/pull/491))
 - Fixed security spec to add support for 400 and 403s ([#439](https://github.com/opensearch-project/opensearch-api-specification/pull/439))
 - Fixed required parameters in `NodeInfo` and `NodeOperatingSystemInfo` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
+- Fixed query DSL `neural` field `query_image` set `contentEncoding` and `model_id` as optional ([#512](https://github.com/opensearch-project/opensearch-api-specification/pull/512))
 
 ### Security
 

diff --git a/TESTING_GUIDE.md b/TESTING_GUIDE.md
@@ -16,6 +16,9 @@
     - [Warnings](#warnings)
       - [multiple-paths-detected](#multiple-paths-detected)
       - [Suppressing Warnings](#suppressing-warnings)
+  - [Collecting Test Coverage](#collecting-test-coverage)
+    - [Coverage Summary](#coverage-summary)
+    - [Coverage Report](#coverage-report)
 <!-- TOC -->
 
 # Spec Testing Guide
@@ -37,6 +40,7 @@ docker compose up -d
 
 Run the tests (use `--opensearch-insecure` for a local cluster running in Docker that does not have a valid SSL certificate):
 ```bash
+export OPENSEARCH_PASSWORD=<<your_password>>
 npm run test:spec -- --opensearch-insecure
 ```
 
@@ -50,6 +54,11 @@ Verbose output:
 npm run test:spec -- --opensearch-insecure --verbose
 ```
 
+Want to help with some missing tests? Choose from the remaining paths in the test coverage report:
+```bash
+npm run test:spec -- --opensearch-insecure --coverage-report
+```
+
 ### Running Spec Tests with Amazon OpenSearch
 
 Use an Amazon OpenSearch service instance.
@@ -228,13 +237,16 @@ OpenSearch consists of plugins that may or may not be present in various distrib
     description: Returns basic information about the cluster.
 ```
 
-Similarly, skip tests that are not applicable to a distribution by listing the distributions that support it.
+Similarly, skip tests that are not applicable to a distribution by listing the distributions that support or do not support it.
 
 ```yaml
 description: Test root endpoint.
 distributions:
-  - amazon-managed
-  - opensearch.org
+  included:
+    - amazon-managed
+    - opensearch.org
+  excluded:
+    - amazon-serverless
 chapters:
   - synopsis: Get server info.
     path: /
@@ -299,7 +311,7 @@ WARNING Multiple paths detected, please group similar tests together and move pa
 
 #### Suppressing Warnings
 
-The test runner may generate warnings that can be suppressed with `warnings:`. For example, to suppress the multiple paths detected warning.
+The test runner may generate warnings that can be suppressed with `warnings:` at story or chapter level. For example, to suppress the multiple paths detected warning.
 
 ```yaml
 - synopsis: Create an index.
@@ -315,3 +327,32 @@ The test runner may generate warnings that can be suppressed with `warnings:`. F
   parameters:
     index: movies
 ```
+
+## Collecting Test Coverage
+
+### Coverage Summary
+
+The test tool can generate a test coverage summary using `--coverage <path>` with the number of evaluated verb + path combinations, a total number of paths and the % of paths tested. 
+
+```json
+{
+  "evaluated_operations_count": 214,
+  "operations_count": 550,
+  "evaluated_paths_pct": 38.91
+}
+```
+
+The report is then used by the [test-spec.yml](.github/workflows/test-spec.yml) workflow, uploaded with every run, combined across various versions of OpenSearch, and reported as a comment on each pull request.
+
+### Coverage Report
+
+The test tool can display detailed and hierarchal test coverage with `--coverage-report`. This is useful to identify untested paths. The report produces the following output with the missing ones.
+
+```
+/_alias (4)
+  GET /_alias
+  /{name} (3)
+    GET /_alias/{name}
+    POST /_alias/{name}
+    HEAD /_alias/{name}
+```
diff --git a/json_schemas/test_story.schema.yaml b/json_schemas/test_story.schema.yaml
@@ -23,6 +23,8 @@ properties:
     $ref: '#/definitions/Version'
   distributions:
     $ref: '#/definitions/Distributions'
+  warnings:
+    $ref: '#/definitions/Warnings'
 required: [chapters,description]
 additionalProperties: false
 
@@ -111,6 +113,16 @@ definitions:
     type: string
 
   Distributions:
+    description: |
+      The list of distributions that support this API.
+    type: object
+    properties:
+      included:
+        $ref: '#/definitions/DistributionsList'
+      excluded:
+        $ref: '#/definitions/DistributionsList'
+
+  DistributionsList:
     description: |
       The list of distributions that support this API.
     type: array

diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
@@ -696,6 +696,10 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/search@200'
+        '400':
+          $ref: '#/components/responses/search@400'
+        '404':
+          $ref: '#/components/responses/search@404'
     post:
       operationId: search.1
       x-operation-group: search
@@ -755,6 +759,10 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/search@200'
+        '400':
+          $ref: '#/components/responses/search@400'
+        '404':
+          $ref: '#/components/responses/search@404'
   /_search/point_in_time:
     delete:
       operationId: delete_pit.0
@@ -1724,6 +1732,10 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/search@200'
+        '400':
+          $ref: '#/components/responses/search@400'
+        '404':
+          $ref: '#/components/responses/search@404'
     post:
       operationId: search.3
       x-operation-group: search
@@ -1784,6 +1796,10 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/search@200'
+        '400':
+          $ref: '#/components/responses/search@400'
+        '404':
+          $ref: '#/components/responses/search@404'
   /{index}/_search/point_in_time:
     post:
       operationId: create_pit.0
@@ -3044,6 +3060,16 @@ components:
         application/json:
           schema:
             $ref: '../schemas/_core.search.yaml#/components/schemas/ResponseBody'
+    search@400:
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/query._common.yaml#/components/schemas/ErrorResponse'
+    search@404:
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/query._common.yaml#/components/schemas/ErrorResponse'
     search_shards@200:
       content:
         application/json:
@@ -6259,4 +6285,4 @@ components:
       description: The throttle for this request in sub-requests per second.
       schema:
         type: number
-      style: form
+      style: form
diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
@@ -291,6 +291,9 @@ paths:
       operationId: cat.nodeattrs.0
       x-operation-group: cat.nodeattrs
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Returns information about custom node attributes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -20,6 +20,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.get_alias@200'
+        '404':
+          $ref: '#/components/responses/indices.get_alias@404'
     put:
       operationId: indices.put_alias.0
       x-operation-group: indices.put_alias
@@ -53,6 +55,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.get_alias@200'
+        '404':
+          $ref: '#/components/responses/indices.get_alias@404'
     head:
       operationId: indices.exists_alias.0
       x-operation-group: indices.exists_alias
@@ -69,6 +73,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.exists_alias@200'
+        '404':
+          $ref: '#/components/responses/indices.exists_alias@404'
     post:
       operationId: indices.put_alias.1
       x-operation-group: indices.put_alias
@@ -189,6 +195,9 @@ paths:
       operationId: indices.clear_cache.0
       x-operation-group: indices.clear_cache
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Clears all or specific caches for one or more indices.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/
@@ -319,6 +328,9 @@ paths:
       operationId: indices.forcemerge.0
       x-operation-group: indices.forcemerge
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Performs the force merge operation on one or more indices.
       externalDocs:
         url: https://opensearch.org/docs/latest
@@ -589,6 +601,9 @@ paths:
       operationId: indices.segments.0
       x-operation-group: indices.segments
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Provides low-level information about segments in a Lucene index.
       externalDocs:
         url: https://opensearch.org/docs/latest
@@ -605,6 +620,9 @@ paths:
       operationId: indices.get_settings.0
       x-operation-group: indices.get_settings
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Returns settings for one or more indices.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/
@@ -1043,6 +1061,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.get_alias@200'
+        '404':
+          $ref: '#/components/responses/indices.get_alias@404'
     put:
       operationId: indices.put_alias.5
       x-operation-group: indices.put_alias
@@ -1078,6 +1098,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.get_alias@200'
+        '404':
+          $ref: '#/components/responses/indices.get_alias@404'
     head:
       operationId: indices.exists_alias.1
       x-operation-group: indices.exists_alias
@@ -1095,6 +1117,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.exists_alias@200'
+        '404':
+          $ref: '#/components/responses/indices.exists_alias@404'
     post:
       operationId: indices.put_alias.6
       x-operation-group: indices.put_alias
@@ -1564,6 +1588,9 @@ paths:
       operationId: indices.segments.1
       x-operation-group: indices.segments
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Provides low-level information about segments in a Lucene index.
       externalDocs:
         url: https://opensearch.org/docs/latest
@@ -2402,6 +2429,9 @@ components:
     indices.exists_alias@200:
       content:
         application/json: {}
+    indices.exists_alias@404:
+      content:
+        application/json: {}
     indices.exists_index_template@200:
       content:
         application/json: {}
@@ -2440,6 +2470,9 @@ components:
             type: object
             additionalProperties:
               $ref: '../schemas/indices.get_alias.yaml#/components/schemas/IndexAliases'
+    indices.get_alias@404:
+      content:
+        application/json: {}
     indices.get_data_stream@200:
       content:
         application/json: