feat: Added compatibility-suites tests

Author: makeev-pavel

test/compatibility-suites/openapi/headers.test.ts

@@ -0,0 +1,9 @@
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
+
+const SUITE_ID = 'headers'
+const PATH_TO_HEADER_DESCRIPTION = ['paths', '/user/login', 'get', 'responses', '200', 'headers', 'X-Rate-Limit']
+const PATH_TO_COMPONENT_DESCRIPTION = ['components', 'headers', 'X-Rate-Limit', 'description']
+
+describe('Reference object. Headers. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_HEADER_DESCRIPTION, PATH_TO_COMPONENT_DESCRIPTION)
+})

test/compatibility-suites/openapi/operation-parameters.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles, TEST_DEFAULTS_DECLARATION_PATHS } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, breaking, deprecated, DiffAction, nonBreaking, unclassified } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'operation-parameters'
 
@@ -338,7 +339,6 @@ describe('Openapi3 Operation Parameters', () => {
       }),
     ]))
   })
-  
 
   // TODO: fixme
   test.skip('Mark primitive parameter as exploded', async () => {
@@ -724,3 +724,10 @@ describe('Openapi3 Operation Parameters', () => {
     })
   })
 })
+
+const PATH_TO_OPERATION_PARAMETERS_DESCRIPTION = ['paths', '/pet/findByStatus', 'get', 'parameters', 0]
+const PATH_TO_COMPONENT_DESCRIPTION = ['components', 'parameters', 'status', 'description']
+
+describe('Reference object. Operation parameters. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_OPERATION_PARAMETERS_DESCRIPTION, PATH_TO_COMPONENT_DESCRIPTION)
+})

test/compatibility-suites/openapi/parameters-examples.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, DiffAction } from '../../../src'
+import { runRefObjectDescriptionTests, runRefObjectSummaryTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'parameters-examples'
 
@@ -168,3 +169,12 @@ describe('Openapi3 Parameters Examples', () => {
     ]))
   })
 })
+
+const PATH_TO_RESPONSES_DESCRIPTION = ['paths', '/pet/findByTags', 'get', 'parameters', 0, 'examples', 'ex1']
+const PATH_TO_COMPONENTS = ['components', 'examples', 'ex1']
+
+describe('Reference object. Parameters examples. Description and Summary fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_RESPONSES_DESCRIPTION, [...PATH_TO_COMPONENTS, 'description'])
+  runRefObjectSummaryTests(SUITE_ID, PATH_TO_RESPONSES_DESCRIPTION, [...PATH_TO_COMPONENTS, 'summary'])
+})
+

test/compatibility-suites/openapi/request-body-examples.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, DiffAction } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'request-body-examples'
 
@@ -166,3 +167,10 @@ describe('Openapi3 Request Body Examples', () => {
     ]))
   })
 })
+
+const PATH_TO_REQUEST_BODY_DESCRIPTION = ['paths', '/pet', 'post', 'requestBody', 'content', 'application/json', 'examples', 'ex1']
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'examples', 'ex1', 'description']
+
+describe('Reference object. Request body examples. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_REQUEST_BODY_DESCRIPTION, PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/request-body.test.ts

@@ -0,0 +1,9 @@
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
+
+const SUITE_ID = 'request-body'
+const PATH_TO_HEADER_DESCRIPTION = ['paths', '/store/order', 'post', 'requestBody']
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'requestBodies', 'rb1', 'description']
+
+describe('Reference object. Request body. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_HEADER_DESCRIPTION, PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/response-body-examples.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, DiffAction } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'response-body-examples'
 
@@ -161,3 +162,10 @@ describe('Openapi3 Response Body Examples', () => {
     ]))
   })
 })
+
+const PATH_TO_RESPONSES_DESCRIPTION = ['paths', '/pet', 'post', 'responses', '200', 'content', 'application/json', 'examples', 'ex1']
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'examples', 'ex1', 'description']
+
+describe('Reference object. Response body examples. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_RESPONSES_DESCRIPTION, PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/response.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, breaking, DiffAction, nonBreaking } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'response'
 
@@ -252,3 +253,10 @@ describe('Openapi3 Response', () => {
     })
   })
 })
+
+const PATH_TO_RESPONSES_DESCRIPTION = ['paths', '/pet', 'post', 'responses', '200']
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'responses', 'response200', 'description']
+
+describe('Reference object. Response. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_RESPONSES_DESCRIPTION, PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/templates/reference-object-31.template.ts

@@ -0,0 +1,64 @@
+import { JsonPath } from '@netcracker/qubership-apihub-json-crawl'
+import { compareFiles } from '../../utils'
+import { diffsMatcher } from '../../../helper/matchers'
+import { annotation, DiffAction } from '../../../../src'
+
+const enum OverridenFields {
+  DESCRIPTION = 'description',
+  SUMMARY = 'summary'
+}
+
+export function runRefObjectDescriptionTests(suiteId: string, commonPath: JsonPath, componentPath: JsonPath): void {
+  runReferenceObjectTests(suiteId, commonPath, componentPath, OverridenFields.DESCRIPTION)
+}
+
+export function runRefObjectSummaryTests(suiteId: string, commonPath: JsonPath, componentPath: JsonPath): void {
+  runReferenceObjectTests(suiteId, commonPath, componentPath, OverridenFields.SUMMARY)
+}
+
+function runReferenceObjectTests(suiteId: string, commonPath: JsonPath, componentPath: JsonPath, overridenField: OverridenFields): void {
+  test(`Add overriden ${overridenField}`, async () => {
+    const testId = `add-overriden-${overridenField}`
+    const result = await compareFiles(suiteId, testId)
+    expect(result).toEqual(diffsMatcher([
+      expect.objectContaining({
+        action: DiffAction.replace,
+        afterDeclarationPaths: [commonPath],
+        beforeDeclarationPaths: [componentPath],
+        type: annotation,
+      }),
+    ]))
+  })
+
+  test(`Remove overriden ${overridenField}`, async () => {
+    const testId = `remove-overriden-${overridenField}`
+    const result = await compareFiles(suiteId, testId)
+    expect(result).toEqual(diffsMatcher([
+      expect.objectContaining({
+        action: DiffAction.replace,
+        afterDeclarationPaths: [componentPath],
+        beforeDeclarationPaths: [commonPath],
+        type: annotation,
+      }),
+    ]))
+  })
+
+  test(`Change overriden ${overridenField}`, async () => {
+    const testId = `change-overriden-${overridenField}`
+    const result = await compareFiles(suiteId, testId)
+    expect(result).toEqual(diffsMatcher([
+      expect.objectContaining({
+        action: DiffAction.replace,
+        afterDeclarationPaths: [commonPath],
+        beforeDeclarationPaths: [commonPath],
+        type: annotation,
+      }),
+    ]))
+  })
+
+  test(`Change referenced ${overridenField} when overridden exists`, async () => {
+    const testId = `change-referenced-${overridenField}-when-overridden-exists`
+    const result = await compareFiles(suiteId, testId)
+    expect(result.length).toEqual(0)
+  })
+}