Separated merger and tester fixtures, fixed leftoever nulls. (#559)

* Separated merger and tester fixtures. Signed-off-by: dblock <[email protected]> * Fix: delete leftoever undefined array items. Signed-off-by: dblock <[email protected]> * Re-add x-version-added for geo types. Signed-off-by: dblock <[email protected]> --------- Signed-off-by: dblock <[email protected]>
opensearch-project · Sep 9, 2024 · 29185f4 · 29185f4
1 parent a768a73
commit 29185f4
Show file tree

Hide file tree

Showing 24 changed files with 305 additions and 12 deletions.
diff --git a/spec/schemas/_common.mapping.yaml b/spec/schemas/_common.mapping.yaml
@@ -934,7 +934,7 @@ components:
         - recursive
         - term
     XyPointProperty:
-      # x-version-added: 2.4
+      x-version-added: '2.4'
       allOf:
         - $ref: '#/components/schemas/DocValuesPropertyBase'
         - type: object
@@ -952,7 +952,7 @@ components:
           required:
             - type
     XyShapeProperty:
-      # x-version-added: 2.4
+      x-version-added: '2.4'
       allOf:
         - $ref: '#/components/schemas/DocValuesPropertyBase'
         - type: object

diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml
@@ -2001,7 +2001,7 @@ components:
       required:
         - shape
     XyShapeQuery:
-      x-version-added: 2.4
+      x-version-added: '2.4'
       allOf:
         - $ref: '#/components/schemas/QueryBase'
         - type: object

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -134,7 +134,7 @@ components:
       required:
         - wkt
     XyLocation:
-      x-version-added: 2.4
+      x-version-added: '2.4'
       description: |-
         A two-dimensional Cartesian point specified by x and y coordinates. It can be represented in various ways:
         - as a `{x, y}` object

diff --git a/tools/src/helpers.ts b/tools/src/helpers.ts
@@ -67,11 +67,15 @@ export function sort_array_by_keys (values: any[], priorities: string[] = []): s
 export function delete_matching_keys(obj: any, condition: (obj: any) => boolean): void {
   for (const key in obj) {
     var item = obj[key]
+
     if (_.isObject(item)) {
       if (condition(item)) {
         delete obj[key]
       } else {
         delete_matching_keys(item, condition)
+        if (_.isArray(item)) {
+          obj[key] = _.compact(item)
+        }
       }
     }
   }

diff --git a/tools/tests/helpers.test.ts b/tools/tests/helpers.test.ts
@@ -122,6 +122,25 @@ describe('helpers', () => {
         expect(obj).toStrictEqual({ foo: [{}] })
       })
     })
+
+    describe('an object with an array where some items are removed', () => {
+      var obj: object
+
+      beforeEach(() => {
+        obj = {
+          foo: [
+            { value: 1 },
+            { value: 1 },
+            { value: 2 }
+          ]
+        }
+      })
+
+      test('removes matching values', () => {
+        delete_matching_keys(obj, (_item: any) => _item.value == 1)
+        expect(obj).toStrictEqual({ foo: [{ value: 2 }] })
+      })
+    })
   })
 
   describe('find_refs', () => {

diff --git a/tools/tests/merger/OpenApiMerger.test.ts b/tools/tests/merger/OpenApiMerger.test.ts
@@ -16,7 +16,7 @@ describe('OpenApiMerger', () => {
 
   describe('defaults', () => {
     beforeEach(() => {
-      merger = new OpenApiMerger('./tools/tests/merger/fixtures/spec/')
+      merger = new OpenApiMerger('./tools/tests/merger/fixtures/specs/animals')
     })
 
     describe('merge()', () => {
@@ -45,7 +45,7 @@ describe('OpenApiMerger', () => {
 
       test('writes a spec', () => {
         merger.write_to(filename)
-        expect(fs.readFileSync('./tools/tests/merger/fixtures/merger/expected.yaml', 'utf8'))
+        expect(fs.readFileSync('./tools/tests/merger/fixtures/merger/animals/expected.yaml', 'utf8'))
           .toEqual(fs.readFileSync(filename, 'utf8'))
       })
     })

diff --git a/tools/tests/merger/OpenApiVersionExtractor.test.ts b/tools/tests/merger/OpenApiVersionExtractor.test.ts
@@ -14,7 +14,7 @@ import fs from 'fs'
 import tmp from 'tmp'
 
 describe('extract() from a merged API spec', () => {
-  const merger = new OpenApiMerger('tools/tests/tester/fixtures/specs/complete')
+  const merger = new OpenApiMerger('tools/tests/merger/fixtures/specs/opensearch')
 
   describe('1.3', () => {
     const extractor = new OpenApiVersionExtractor(merger.spec(), '1.3', 'ignore')
@@ -35,15 +35,15 @@ describe('extract() from a merged API spec', () => {
 
       test('writes a spec', () => {
         extractor.write_to(filename)
-        expect(fs.readFileSync('./tools/tests/merger/fixtures/extractor/expected_1.3.yaml', 'utf8'))
+        expect(fs.readFileSync('./tools/tests/merger/fixtures/extractor/opensearch/expected_1.3.yaml', 'utf8'))
           .toEqual(fs.readFileSync(filename, 'utf8'))
       })
     })
 
     test('has matching responses', () => {
       const spec = extractor.extract()
       expect(_.keys(spec.paths['/index']?.get?.responses)).toEqual([
-        '200', '201', '404', '500', '503', 'removed-2.0', 'added-1.3-removed-2.0', 'distributed-excluded-amazon-serverless'
+        '200', '201', '404', '500', '503', 'removed-2.0', 'removed-2.0-refs', 'added-1.3-removed-2.0', 'distributed-excluded-amazon-serverless'
       ])
     })
   })
@@ -54,7 +54,7 @@ describe('extract() from a merged API spec', () => {
     test('has matching responses', () => {
       const spec = extractor.extract()
       expect(_.keys(spec.paths['/index']?.get?.responses)).toEqual([
-        '200', '201', '404', '500', '503', 'added-2.0', 'distributed-excluded-amazon-serverless'
+        '200', '201', '404', '500', '503', 'added-2.0', 'removed-2.0-refs', 'distributed-excluded-amazon-serverless'
       ])
     })
 
@@ -74,7 +74,7 @@ describe('extract() from a merged API spec', () => {
 
       test('writes a spec', () => {
         extractor.write_to(filename)
-        expect(fs.readFileSync('./tools/tests/merger/fixtures/extractor/expected_2.0.yaml', 'utf8'))
+        expect(fs.readFileSync('./tools/tests/merger/fixtures/extractor/opensearch/expected_2.0.yaml', 'utf8'))
           .toEqual(fs.readFileSync(filename, 'utf8'))
       })
     })
@@ -86,7 +86,7 @@ describe('extract() from a merged API spec', () => {
     test('has matching responses', () => {
       const spec = extractor.extract()
       expect(_.keys(spec.paths['/index']?.get?.responses)).toEqual([
-        '200', '201', '404', '500', '503', 'added-2.0', 'added-2.1', 'distributed-excluded-amazon-serverless'
+        '200', '201', '404', '500', '503', 'added-2.0', 'removed-2.0-refs', 'added-2.1', 'distributed-excluded-amazon-serverless'
       ])
     })
   })

diff --git a/...rger/fixtures/extractor/expected_1.3.yaml → ...es/extractor/opensearch/expected_1.3.yaml b/...rger/fixtures/extractor/expected_1.3.yaml → ...es/extractor/opensearch/expected_1.3.yaml
@@ -33,6 +33,8 @@ paths:
         removed-2.0:
           $ref: '#/components/responses/[email protected]'
           x-version-removed: '2.0'
+        removed-2.0-refs:
+          $ref: '#/components/responses/[email protected]'
         added-1.3-removed-2.0:
           $ref: '#/components/responses/[email protected]'
         distributed-excluded-amazon-serverless:
@@ -114,13 +116,21 @@ components:
       description: Distributed in opensearch.org, AOS and AOSS.
     [email protected]:
       description: Removed in 2.0 via attribute next to ref.
+    [email protected]:
+      description: One of the ref values removed in 2.0.
+      schema:
+        oneOf:
+          - $ref: '#/components/schemas/_common:Type'
+          - $ref: '#/components/schemas/_common:OldId'
     nodes.info@200:
       description: All nodes.
       content:
         application/json:
           schema:
             type: object
   schemas:
+    _common:OldId:
+      type: string
     _common:Type:
       type: string
       x-version-removed: '2.0'
diff --git a/...rger/fixtures/extractor/expected_2.0.yaml → ...es/extractor/opensearch/expected_2.0.yaml b/...rger/fixtures/extractor/expected_2.0.yaml → ...es/extractor/opensearch/expected_2.0.yaml
@@ -57,6 +57,8 @@ paths:
         added-2.0:
           $ref: '#/components/responses/[email protected]'
           x-version-added: '2.0'
+        removed-2.0-refs:
+          $ref: '#/components/responses/[email protected]'
         distributed-excluded-amazon-serverless:
           $ref: '#/components/responses/info@distributed-all'
           x-distributions-excluded:
@@ -150,6 +152,11 @@ components:
       description: Added in 2.0 via attribute next to ref.
     info@distributed-all:
       description: Distributed in opensearch.org, AOS and AOSS.
+    [email protected]:
+      description: One of the ref values removed in 2.0.
+      schema:
+        oneOf:
+          - $ref: '#/components/schemas/_common:OldId'
     nodes.info@200:
       description: All nodes.
       content:

diff --git a/...ests/merger/fixtures/merger/expected.yaml → ...ger/fixtures/merger/animals/expected.yaml b/...ests/merger/fixtures/merger/expected.yaml → ...ger/fixtures/merger/animals/expected.yaml
diff --git a/...ger/fixtures/spec/_global_parameters.yaml → ...res/specs/animals/_global_parameters.yaml b/...ger/fixtures/spec/_global_parameters.yaml → ...res/specs/animals/_global_parameters.yaml
diff --git a/tools/tests/merger/fixtures/spec/_info.yaml → .../merger/fixtures/specs/animals/_info.yaml b/tools/tests/merger/fixtures/spec/_info.yaml → .../merger/fixtures/specs/animals/_info.yaml
diff --git a/...fixtures/spec/_superseded_operations.yaml → ...specs/animals/_superseded_operations.yaml b/...fixtures/spec/_superseded_operations.yaml → ...specs/animals/_superseded_operations.yaml
diff --git a/...ger/fixtures/spec/namespaces/indices.yaml → ...res/specs/animals/namespaces/indices.yaml b/...ger/fixtures/spec/namespaces/indices.yaml → ...res/specs/animals/namespaces/indices.yaml
diff --git a/...ger/fixtures/spec/namespaces/shelter.yaml → ...res/specs/animals/namespaces/shelter.yaml b/...ger/fixtures/spec/namespaces/shelter.yaml → ...res/specs/animals/namespaces/shelter.yaml
diff --git a/...merger/fixtures/spec/schemas/actions.yaml → ...xtures/specs/animals/schemas/actions.yaml b/...merger/fixtures/spec/schemas/actions.yaml → ...xtures/specs/animals/schemas/actions.yaml
diff --git a/...merger/fixtures/spec/schemas/animals.yaml → ...xtures/specs/animals/schemas/animals.yaml b/...merger/fixtures/spec/schemas/animals.yaml → ...xtures/specs/animals/schemas/animals.yaml
diff --git a/tools/tests/merger/fixtures/specs/opensearch/_global_parameters.yaml b/tools/tests/merger/fixtures/specs/opensearch/_global_parameters.yaml
@@ -0,0 +1,4 @@
+openapi: 3.1.0
+info:
+  title: ''
+  version: ''
diff --git a/tools/tests/merger/fixtures/specs/opensearch/_info.yaml b/tools/tests/merger/fixtures/specs/opensearch/_info.yaml
@@ -0,0 +1,6 @@
+$schema: should-be-ignored
+
+title: OpenSearch API
+description: OpenSearch API
+version: 1.0.0
+x-api-version: 1.2.3
diff --git a/tools/tests/merger/fixtures/specs/opensearch/_superseded_operations.yaml b/tools/tests/merger/fixtures/specs/opensearch/_superseded_operations.yaml
@@ -0,0 +1 @@
+$schema: should-be-ignored
diff --git a/tools/tests/merger/fixtures/specs/opensearch/namespaces/cluster_manager.yaml b/tools/tests/merger/fixtures/specs/opensearch/namespaces/cluster_manager.yaml
@@ -0,0 +1,17 @@
+openapi: 3.1.0
+info:
+  title: OpenSearch API
+  description: OpenSearch API
+  version: 1.0.0
+paths:
+  /cluster_manager:
+    get:
+      operationId: cluster_manager.0
+      x-version-added: '2.0'
+    post:
+      operationId: cluster_manager.0
+      x-version-added: '2.0'
+components:
+  requestBodies: []
+  parameters: []
+  responses: []
diff --git a/tools/tests/merger/fixtures/specs/opensearch/namespaces/index.yaml b/tools/tests/merger/fixtures/specs/opensearch/namespaces/index.yaml
@@ -0,0 +1,117 @@
+openapi: 3.1.0
+info:
+  title: OpenSearch API
+  description: OpenSearch API
+  version: 1.0.0
+paths:
+  /index:
+    get:
+      operationId: get.0
+      responses:
+        '200':
+          $ref: '#/components/responses/info@200'
+        '201':
+          $ref: '#/components/responses/info@201'
+        '404':
+          $ref: '#/components/responses/info@404'
+        added-2.0:
+          $ref: '#/components/responses/[email protected]'
+          x-version-added: '2.0'
+        removed-2.0:
+          $ref: '#/components/responses/[email protected]'
+          x-version-removed: '2.0'
+        removed-2.0-refs:
+          $ref: '#/components/responses/[email protected]'
+        added-1.3-removed-2.0:
+          $ref: '#/components/responses/[email protected]'
+        added-2.1:
+          $ref: '#/components/responses/[email protected]'
+        '500':
+          $ref: '#/components/responses/info@500'
+        '503':
+          $ref: '#/components/responses/info@503'
+        distributed-included-all:
+          $ref: '#/components/responses/info@distributed-all'
+          x-distributions-included:
+            - amazon-managed
+            - amazon-serverless
+            - opensearch.org
+        distributed-included-amazon-managed:
+          $ref: '#/components/responses/info@distributed-amazon-managed'
+          x-distributions-included:
+            - amazon-managed
+        distributed-excluded-amazon-serverless:
+          $ref: '#/components/responses/info@distributed-all'
+          x-distributions-excluded:
+            - amazon-serverless
+components:
+  responses:
+    info@200:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              _type:
+                $ref: '../schemas/_common.yaml#/components/schemas/Type'
+              tagline:
+                type: string
+            required:
+              - tagline
+    info@201:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              tagline:
+                type: string
+            required:
+              - tagline
+            unevaluatedProperties: true
+    info@404:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              tagline:
+                type: string
+            required:
+              - tagline
+            unevaluatedProperties:
+              type: object
+    [email protected]:
+      description: Added in 2.0 via attribute next to ref.
+    [email protected]:
+      description: Removed in 2.0 via attribute next to ref.
+    [email protected]:
+      description: One of the ref values removed in 2.0.
+      schema:
+        oneOf:
+          - $ref: '../schemas/_common.yaml#/components/schemas/Type'
+          - $ref: '../schemas/_common.yaml#/components/schemas/OldId'
+    [email protected]:
+      description: Added in 1.3, removed in 2.0 via attribute in response body.
+      x-version-added: '1.3'
+      x-version-removed: '2.0'
+    [email protected]:
+      description: Added in 2.1 via attribute in response body.
+      x-version-added: '2.1'
+    info@distributed-amazon-managed:
+      description: Distributed only in AOS.
+    info@distributed-all:
+      description: Distributed in opensearch.org, AOS and AOSS.
+    info@500:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              tagline:
+                type: string
+    info@503:
+      content:
+        application/json:
+          schema:
+            type: object