tests: update self-file reference normalization tests and fixtures for OAS2 and AsyncAPI 3

Author: vadyvas

__tests__/bundle/self-file-ref-normalization/redocly.yaml

@@ -1,6 +1,3 @@
 apis:
   main:
     root: ./openapi.yaml
-
-extends:
-  - recommended

packages/core/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -104,40 +104,6 @@ components: {}
 
 `;
 
-exports[`bundle > should dereference even if self-file explicit $ref is used 1`] = `
-openapi: 3.0.0
-info:
-  title: Self-file ref normalization
-  version: 1.0.0
-  license:
-    name: MIT
-servers:
-  - url: https://api.example.org
-security: []
-paths:
-  /test:
-    get:
-      summary: Test
-      operationId: getTest
-      parameters:
-        - name: myParam
-          in: query
-          schema: &ref_0
-            type: string
-      responses:
-        '200':
-          description: OK
-        '400':
-          description: Bad Request
-components:
-  parameters:
-    myParam:
-      name: myParam
-      in: query
-      schema: *ref_0
-
-`;
-
 exports[`bundle > should dereferenced correctly when used with dereference 1`] = `
 openapi: 3.0.0
 paths:
@@ -158,66 +124,54 @@ components:
 
 `;
 
-exports[`bundle > should normalize self-file explicit $ref in oas2 1`] = `
-swagger: '2.0'
+exports[`bundle > should normalize self-file explicit $ref in nested referenced file 1`] = `
+openapi: 3.0.0
 info:
-  title: OAS2 self-file ref
-  version: '1.0'
-  license:
-    name: MIT
-host: example.com
-schemes:
-  - https
-security: []
+  title: OAS3 root with external ref to file with self-refs
+  version: 1.0.0
 paths:
   /test:
     get:
-      summary: Test
-      operationId: getTest
       parameters:
-        - $ref: '#/parameters/p1'
-      responses:
-        '200':
-          description: OK
-        '400':
-          description: Bad Request
-parameters:
-  p1:
-    name: p1
-    in: query
-    type: string
+        - $ref: '#/components/parameters/testParam'
+components:
+  schemas:
+    NestedSchema:
+      type: object
+      properties:
+        value:
+          type: string
+    TestSchema:
+      type: object
+      properties:
+        id:
+          type: string
+        nested:
+          $ref: '#/components/schemas/NestedSchema'
+  parameters:
+    testParam:
+      name: testParam
+      in: query
+      schema:
+        $ref: '#/components/schemas/TestSchema'
 
 `;
 
-exports[`bundle > should normalize self-file explicit $ref to internal pointer 1`] = `
-openapi: 3.0.0
+exports[`bundle > should normalize self-file explicit $ref in oas2 1`] = `
+swagger: '2.0'
 info:
-  title: Self-file ref normalization
-  version: 1.0.0
-  license:
-    name: MIT
-servers:
-  - url: https://api.example.org
-security: []
+  title: OAS2 self-file ref
+  version: '1.0'
 paths:
   /test:
     get:
-      summary: Test
-      operationId: getTest
       parameters:
-        - $ref: '#/components/parameters/myParam'
-      responses:
-        '200':
-          description: OK
-        '400':
-          description: Bad Request
-components:
-  parameters:
-    myParam:
-      name: myParam
-      in: query
-      schema:
-        type: string
+        - $ref: '#/parameters/testParam'
+parameters:
+  testParam:
+    name: testParam
+    in: query
+    type: string
 
 `;
 
@@ -381,32 +335,42 @@ info:
   title: AsyncAPI 2 self-file ref
   version: 1.0.0
 channels:
-  c:
+  user/test:
     subscribe:
       message:
         payload:
-          $ref: '#/components/schemas/A'
+          $ref: '#/components/schemas/TestPayload'
 components:
   schemas:
-    A:
+    TestPayload:
       type: string
 
 `;
 
-exports[`bundle async > should normalize self-file explicit $ref in asyncapi 3 1`] = `
+exports[`bundle async > should normalize self-file explicit $ref in nested referenced file for async3 1`] = `
 asyncapi: 3.0.0
 info:
-  title: AsyncAPI 3 self-file ref
+  title: AsyncAPI 3 root with external ref to file with self-refs
   version: 1.0.0
 channels:
-  test:
+  userTest:
     messages:
-      M1:
-        $ref: '#/components/messages/M'
+      TestMessage:
+        payload:
+          $ref: '#/components/schemas/TestPayload'
 components:
-  messages:
-    M:
-      payload:
-        type: string
+  schemas:
+    NestedSchema:
+      type: object
+      properties:
+        value:
+          type: string
+    TestPayload:
+      type: object
+      properties:
+        id:
+          type: string
+        nested:
+          $ref: '#/components/schemas/NestedSchema'
 
 `;

packages/core/src/__tests__/bundle.test.ts

@@ -274,39 +274,26 @@ describe('bundle', () => {
     `);
   });
 
-  it('should normalize self-file explicit $ref to internal pointer', async () => {
-    const config = await createConfig({});
-
+  it('should normalize self-file explicit $ref in oas2', async () => {
     const { bundle: res, problems } = await bundle({
-      config,
-      ref: path.join(__dirname, 'fixtures/self-file-refs/oas3.yaml'),
+      config: await createConfig({}),
+      ref: path.join(__dirname, 'fixtures/self-file-refs/oas2.yaml'),
     });
-
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
 
-  it('should dereference even if self-file explicit $ref is used', async () => {
+  it('should normalize self-file explicit $ref in nested referenced file', async () => {
     const config = await createConfig({});
 
     const { bundle: res, problems } = await bundle({
       config,
-      ref: path.join(__dirname, 'fixtures/self-file-refs/oas3.yaml'),
-      dereference: true,
+      ref: path.join(__dirname, 'fixtures/self-file-refs/oas3-root.yaml'),
     });
 
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
-
-  it('should normalize self-file explicit $ref in oas2', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: await createConfig({}),
-      ref: path.join(__dirname, 'fixtures/self-file-refs/oas2.yaml'),
-    });
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
 });
 
 describe('bundleFromString', () => {
@@ -477,10 +464,10 @@ describe('bundle async', () => {
     expect(res.parsed).toMatchSnapshot();
   });
 
-  it('should normalize self-file explicit $ref in asyncapi 3', async () => {
+  it('should normalize self-file explicit $ref in nested referenced file for async3', async () => {
     const { bundle: res, problems } = await bundle({
       config: await createConfig({}),
-      ref: path.join(__dirname, 'fixtures/self-file-refs/async3.yaml'),
+      ref: path.join(__dirname, 'fixtures/self-file-refs/async3-root.yaml'),
     });
 
     expect(problems).toHaveLength(0);

packages/core/src/__tests__/fixtures/self-file-refs/async2.yaml

@@ -3,12 +3,12 @@ info:
   title: AsyncAPI 2 self-file ref
   version: '1.0.0'
 channels:
-  c:
+  user/test:
     subscribe:
       message:
         payload:
-          $ref: 'async2.yaml#/components/schemas/A'
+          $ref: 'async2.yaml#/components/schemas/TestPayload'
 components:
   schemas:
-    A:
+    TestPayload:
       type: string

packages/core/src/__tests__/fixtures/self-file-refs/async3-nested.yaml

@@ -0,0 +1,23 @@
+asyncapi: 3.0.0
+info:
+  title: AsyncAPI 3 nested file with self-refs
+  version: '1.0.0'
+channels: {}
+components:
+  messages:
+    TestMessage:
+      payload:
+        $ref: 'async3-nested.yaml#/components/schemas/TestPayload'
+  schemas:
+    TestPayload:
+      type: object
+      properties:
+        id:
+          type: string
+        nested:
+          $ref: 'async3-nested.yaml#/components/schemas/NestedSchema'
+    NestedSchema:
+      type: object
+      properties:
+        value:
+          type: string

packages/core/src/__tests__/fixtures/self-file-refs/async3-root.yaml

@@ -0,0 +1,9 @@
+asyncapi: 3.0.0
+info:
+  title: AsyncAPI 3 root with external ref to file with self-refs
+  version: '1.0.0'
+channels:
+  userTest:
+    messages:
+      TestMessage:
+        $ref: './async3-nested.yaml#/components/messages/TestMessage'

packages/core/src/__tests__/fixtures/self-file-refs/async3.yaml

@@ -2,26 +2,13 @@ swagger: '2.0'
 info:
   title: OAS2 self-file ref
   version: '1.0'
-  license:
-    name: MIT
-host: example.com
-schemes:
-  - https
-security: []
 paths:
   /test:
     get:
-      summary: Test
-      operationId: getTest
       parameters:
-        - $ref: 'oas2.yaml#/parameters/p1'
-      responses:
-        200:
-          description: OK
-        400:
-          description: Bad Request
+        - $ref: 'oas2.yaml#/parameters/testParam'
 parameters:
-  p1:
-    name: p1
+  testParam:
+    name: testParam
     in: query
     type: string

packages/core/src/__tests__/fixtures/self-file-refs/oas2.yaml

@@ -0,0 +1,25 @@
+openapi: 3.0.0
+info:
+  title: OAS3 nested file with self-refs
+  version: 1.0.0
+paths: {}
+components:
+  parameters:
+    testParam:
+      name: testParam
+      in: query
+      schema:
+        $ref: 'oas3-nested.yaml#/components/schemas/TestSchema'
+  schemas:
+    TestSchema:
+      type: object
+      properties:
+        id:
+          type: string
+        nested:
+          $ref: 'oas3-nested.yaml#/components/schemas/NestedSchema'
+    NestedSchema:
+      type: object
+      properties:
+        value:
+          type: string

packages/core/src/__tests__/fixtures/self-file-refs/oas3-nested.yaml

@@ -0,0 +1,9 @@
+openapi: 3.0.0
+info:
+  title: OAS3 root with external ref to file with self-refs
+  version: 1.0.0
+paths:
+  /test:
+    get:
+      parameters:
+        - $ref: './oas3-nested.yaml#/components/parameters/testParam'