@redocly/openapi-core 1.0.0-beta.100

package/src/__tests__/bundle.test.ts

@@ -0,0 +1,156 @@
+import outdent from 'outdent';
+import * as path from 'path';
+
+import { bundleDocument, bundle } from '../bundle';
+import { parseYamlToDocument, yamlSerializer } from '../../__tests__/utils';
+import { LintConfig, Config, ResolvedConfig } from '../config';
+import { BaseResolver } from '../resolve';
+
+describe('bundle', () => {
+  expect.addSnapshotSerializer(yamlSerializer);
+
+  const testDocument = parseYamlToDocument(
+    outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          get:
+            operationId: get
+            parameters:
+              - $ref: '#/components/parameters/shared_a'
+              - name: get_b
+          post:
+            operationId: post
+            parameters:
+              - $ref: '#/components/parameters/shared_a'
+      components:
+        parameters:
+          shared_a:
+            name: shared-a
+    `,
+    '',
+  );
+
+  it('change nothing with only internal refs', async () => {
+    const { bundle, problems } = await bundleDocument({
+      document: testDocument,
+      externalRefResolver: new BaseResolver(),
+      config: new LintConfig({}),
+    });
+
+    const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
+
+    expect(problems).toHaveLength(0);
+    expect(bundle.parsed).toEqual(origCopy);
+  });
+
+  it('should bundle external refs', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      ref: path.join(__dirname, 'fixtures/refs/openapi-with-external-refs.yaml'),
+    });
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should bundle external refs and warn for conflicting names', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      ref: path.join(__dirname, 'fixtures/refs/openapi-with-external-refs-conflicting-names.yaml'),
+    });
+    expect(problems).toHaveLength(1);
+    expect(problems[0].message).toEqual(
+      `Two schemas are referenced with the same name but different content. Renamed param-b to param-b-2.`,
+    );
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should dereferenced correctly when used with dereference', async () => {
+    const { bundle: res, problems } = await bundleDocument({
+      externalRefResolver: new BaseResolver(),
+      config: new LintConfig({}),
+      document: testDocument,
+      dereference: true,
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should place referenced schema inline when referenced schema name resolves to original schema name', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      ref: path.join(__dirname, 'fixtures/refs/externalref.yaml'),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should pull hosted schema', async () => {
+    const fetchMock = jest.fn(
+      () => Promise.resolve({
+        ok: true,
+        text: () => 'External schema content',
+        headers: {
+          get: () => ''
+        }
+      })
+    );
+
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: []
+        }
+      }),
+      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml')
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(fetchMock).toHaveBeenCalledWith(
+      "https://someexternal.schema",
+      {
+        headers: {}
+      }
+    );
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should not bundle url refs if used with keepUrlRefs', async () => {
+    const fetchMock = jest.fn(() =>
+        Promise.resolve({
+          ok: true,
+          text: () => 'External schema content',
+          headers: {
+            get: () => '',
+          },
+        }),
+    );
+    const { bundle: res, problems } = await bundle({
+      config: new Config({} as ResolvedConfig),
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: [],
+        },
+      }),
+      ref: path.join(__dirname, 'fixtures/refs/openapi-with-url-refs.yaml'),
+      keepUrlRefs: true,
+    });
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+});

package/src/__tests__/codeframes.test.ts

@@ -0,0 +1,531 @@
+import { outdent } from 'outdent';
+
+import { getLineColLocation, getCodeframe } from '../format/codeframes';
+import { LocationObject } from '../walk';
+import { Source } from '../resolve';
+
+describe('Location', () => {
+  it('should correctly calculate location for key', () => {
+    const loc = {
+      reportOnKey: true,
+      pointer: '#/info/license',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+        `,
+      ),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 3, col: 3 });
+    expect(preciseLocation.end).toEqual({ line: 3, col: 10 });
+  });
+
+  it('should correctly calculate location for key on top level', () => {
+    const loc = {
+      reportOnKey: true,
+      pointer: '#/info',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+        `,
+      ),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 2, col: 1 });
+    expect(preciseLocation.end).toEqual({ line: 2, col: 5 });
+  });
+
+  it('should correctly calculate location for value', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/license/name',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+        `,
+      ),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 4, col: 11 });
+    expect(preciseLocation.end).toEqual({ line: 4, col: 14 });
+  });
+
+  it('should correctly fallback to the closest parent node if pointer is incorrect', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/missing',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+        `,
+      ),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 3, col: 3 });
+    expect(preciseLocation.end).toEqual({ line: 5, col: 28 });
+  });
+
+  it('should correctly fallback to the closest parent node if node value is null', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/servers',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          servers:
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+        `,
+      ),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 2, col: 1 });
+    expect(preciseLocation.end).toEqual({ line: 2, col: 9 });
+  });
+
+
+  it('should return first line for empty doc', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/missing',
+      source: new Source('foobar.yaml', ''),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 1, col: 1 });
+    expect(preciseLocation.end).toEqual({ line: 1, col: 1 });
+  });
+
+  it('should return full range for file with newlines', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/missing',
+      source: new Source('foobar.yaml', '\n\n\n'),
+    };
+    const preciseLocation = getLineColLocation(loc);
+    expect(preciseLocation.start).toEqual({ line: 1, col: 1 });
+    expect(preciseLocation.end).toEqual({ line: 1, col: 1 });
+  });
+});
+
+describe('codeframes', () => {
+  function getColorCodeframe(loc: LocationObject) {
+    return getCodeframe(getLineColLocation(loc), true)
+      .replace(/\x1b\[90m(.*?)\x1b\[39m/g, '<g>$1</g>')
+      .replace(/\x1b\[31m(.*?)\x1b\[39m/g, '<r>$1</r>');
+  }
+
+  function getPlainCodeframe(loc: LocationObject) {
+    return getCodeframe(getLineColLocation(loc), false);
+  }
+
+  expect.addSnapshotSerializer({
+    test: (val) => typeof val === 'string',
+    print: (v) => v as string,
+  });
+
+  it('should correctly generate simple codeframe', () => {
+    const loc = {
+      reportOnKey: true,
+      pointer: '#/info/license',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+            `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+      2 | info:
+      3 |   license:
+        |   ^^^^^^^
+      4 |     name: MIT
+      5 |     url: https://google.com
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g> <g>openapi: 3.0.2</g>
+      <g>2 |</g> <g>info:</g>
+      <g>3 |</g>   <r>license</r>:
+      <g>4 |</g>     <g>name: MIT</g>
+      <g>5 |</g>     <g>url: https://google.com</g>
+    `);
+  });
+
+  it('correctly generate code-frame for single-line file on key', () => {
+    const loc = {
+      reportOnKey: true,
+      pointer: '#/openapi',
+      source: new Source('foobar.yaml', `openapi: 3.0.2`),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+        | ^^^^^^^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`<g>1 |</g> <r>openapi</r>: 3.0.2`);
+  });
+
+  it('correctly generate code-frame for single-line file on value', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/openapi',
+      source: new Source('foobar.yaml', `openapi: 3.0.2`),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+        |          ^^^^^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`<g>1 |</g> openapi: <r>3.0.2</r>`);
+  });
+
+  it('correctly generate code-frame for multiline-value', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/license',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+            `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      2 | info:
+      3 |   license:
+      4 |     name: MIT
+        |     ^^^^^^^^^
+      5 |     url: https://google.com
+        |     ^^^^^^^^^^^^^^^^^^^^^^^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>2 |</g> <g>info:</g>
+      <g>3 |</g>   <g>license:</g>
+      <g>4 |</g>     <r>name: MIT</r>
+      <g>5 |</g>     <r>url: https://google.com</r>
+    `);
+  });
+
+  it('correctly generate code-frame for multiline-value json-like', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/license',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license: {
+              name: MIT,
+              url: https://google.com
+            }
+            `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+      2 | info:
+      3 |   license: {
+        |            ^
+      4 |     name: MIT,
+        |     ^^^^^^^^^^
+      5 |     url: https://google.com
+        |     ^^^^^^^^^^^^^^^^^^^^^^^
+      6 |   }
+        |   ^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g> <g>openapi: 3.0.2</g>
+      <g>2 |</g> <g>info:</g>
+      <g>3 |</g>   license: <r>{</r>
+      <g>4 |</g>     <r>name: MIT,</r>
+      <g>5 |</g>     <r>url: https://google.com</r>
+      <g>6 |</g>   <r>}</r>
+    `);
+  });
+
+  it('correctly generate code-frame for multiline-value and show only 5 lines', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/license',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          info:
+            license:
+              name: MIT
+              field2: MIT
+              field3: MIT
+              field4: MIT
+              field5: MIT
+              url: https://google.com
+          openapi: 3.0.2
+          `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | info:
+      2 |   license:
+      3 |     name: MIT
+        |     ^^^^^^^^^
+      4 |     field2: MIT
+        |     ^^^^^^^^^^^
+      … |     < 3 more lines >
+      8 |     url: https://google.com
+        |     ^^^^^^^^^^^^^^^^^^^^^^^
+      9 | openapi: 3.0.2
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g> <g>info:</g>
+      <g>2 |</g>   <g>license:</g>
+      <g>3 |</g>     <r>name: MIT</r>
+      <g>4 |</g>     <r>field2: MIT</r>
+      <g>… |</g>     <g>< 3 more lines ></g>
+      <g>8 |</g>     <r>url: https://google.com</r>
+      <g>9 |</g> <g>openapi: 3.0.2</g>
+    `);
+  });
+
+  it('correctly generate code-frame for multiline-value and show only 5 lines with empty lines', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/license',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          info:
+
+            license:
+              name: MIT
+
+              field2: MIT
+              field3: MIT
+              field4: MIT
+              field5: MIT
+          `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      2 |
+      3 | license:
+      4 |   name: MIT
+        |   ^^^^^^^^^
+      5 |
+        |   ^
+      … |   < 3 more lines >
+      9 |   field5: MIT
+        |   ^^^^^^^^^^^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>2 |</g>
+      <g>3 |</g> <g>license:</g>
+      <g>4 |</g>   <r>name: MIT</r>
+      <g>5 |</g>
+      <g>… |</g>   <g>< 3 more lines ></g>
+      <g>9 |</g>   <r>field5: MIT</r>
+    `);
+  });
+
+  it('correctly generate code-frame dedent', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/paths/~1pet/put/parameters/0/in',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            license:
+              name: MIT
+              url: https://google.com
+          paths:
+            '/pet':
+              put:
+                operationId: test
+                parameters:
+                  - name: a
+                    in: wrong
+              post:
+                operationId: test2
+          `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      10 |   parameters:
+      11 |     - name: a
+      12 |       in: wrong
+         |           ^^^^^
+      13 | post:
+      14 |   operationId: test2
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>10 |</g>   <g>parameters:</g>
+      <g>11 |</g>     <g>- name: a</g>
+      <g>12 |</g>       in: <r>wrong</r>
+      <g>13 |</g> <g>post:</g>
+      <g>14 |</g>   <g>operationId: test2</g>
+    `);
+  });
+
+  it('correctly generate code-frame for too long line', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/description',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+          openapi: 3.0.2
+          info:
+            description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+            license:
+              name: MIT
+              url: https://google.com
+          `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+      2 | info:
+      3 |   description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua...<77 chars>
+        |                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^...<77 chars>
+      4 |   license:
+      5 |     name: MIT
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g> <g>openapi: 3.0.2</g>
+      <g>2 |</g> <g>info:</g>
+      <g>3 |</g>   description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolo<g>...<87 chars></g>
+      <g>4 |</g>   <g>license:</g>
+      <g>5 |</g>     <g>name: MIT</g>
+    `);
+  });
+
+  it('correctly generate code-frame for empty file', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/info/description',
+      source: new Source('foobar.yaml', `\n\n`),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 |
+        | ^
+      2 |
+      3 |
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g>
+      <g>2 |</g>
+      <g>3 |</g>
+    `);
+  });
+
+  it('correctly generate code-frame for whole file and correctly skip newlines', () => {
+    const loc = {
+      reportOnKey: false,
+      pointer: '#/',
+      source: new Source(
+        'foobar.yaml',
+        outdent`
+        openapi: 3.0.2
+
+        info:
+
+          description: Lorem ipsum
+          license:
+            name: MIT
+            url: https://google.com
+      `,
+      ),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+        | ^^^^^^^^^^^^^^
+      2 |
+        | ^
+      … | < 5 more lines >
+      8 |     url: https://google.com
+        |     ^^^^^^^^^^^^^^^^^^^^^^^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g> <r>openapi: 3.0.2</r>
+      <g>2 |</g>
+      <g>… |</g> <g>< 5 more lines ></g>
+      <g>8 |</g>     <r>url: https://google.com</r>
+    `);
+  });
+
+  it('should show line even if there are not so many file in the file', () => {
+    // (yaml parser sometimes shows error on the next after last line
+    const loc = {
+      reportOnKey: false,
+      pointer: undefined,
+      start: {
+        line: 2,
+        col: 1,
+      },
+      source: new Source('foobar.yaml', outdent`openapi: 3.0.2`),
+    };
+
+    expect(getPlainCodeframe(loc)).toMatchInlineSnapshot(`
+      1 | openapi: 3.0.2
+      2 |
+        | ^
+    `);
+
+    expect(getColorCodeframe(loc)).toMatchInlineSnapshot(`
+      <g>1 |</g> <g>openapi: 3.0.2</g>
+      <g>2 |</g>
+    `);
+  });
+});

package/src/__tests__/fixtures/extension.js

@@ -0,0 +1,24 @@
+const { listOf } = require('../../types');
+
+/** @type {import('../../config/types').TypesExtension} */
+function oas3_0(types) {
+  return {
+    ...types,
+    XWebHooks: {
+      properties: {
+        parameters: listOf('Parameter'),
+      },
+    },
+    DefinitionRoot: {
+      ...types.DefinitionRoot,
+      properties: {
+        ...types.DefinitionRoot.properties,
+        'x-webhooks': 'XWebHooks',
+      },
+    },
+  };
+}
+
+module.exports = {
+  oas3_0: oas3_0,
+};

package/src/__tests__/fixtures/refs/definitions.yaml

@@ -0,0 +1,3 @@
+$defs:
+  A:
+    type: string