@redocly/openapi-core 1.0.0 → 1.0.1

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -0,0 +1,298 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
+import { StyleguideConfig, defaultPlugin, resolvePlugins, resolvePreset } from '../../../../config';
+
+import { BaseResolver } from '../../../../resolve';
+
+const plugins = resolvePlugins([defaultPlugin]);
+const pressets = resolvePreset('all', plugins);
+const allConfig = new StyleguideConfig({ ...pressets, plugins });
+describe('Oas3 Structural visitor basic', () => {
+  it('should report wrong types', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          openapi: 3.0.0
+          tags:
+            - 25.3
+            - test
+          servers:
+          - url: 'http://example.com'
+            variables:
+              a:
+                default: test
+                enum:
+                  - 123
+                  - test
+          info:
+            title: Test
+            version: '1.0'
+            description: test description
+            contact:
+              name: string
+              url: []
+              email: false
+            license: invalid
+          paths: {}
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: allConfig,
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/info/contact/url",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`string\` but got \`array\`.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/info/contact/email",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`string\` but got \`boolean\`.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/info/license",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`License\` (object) but got \`string\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": Object {
+            "pointer": "#/servers/0/url",
+            "source": "foobar.yaml",
+          },
+          "location": Array [
+            Object {
+              "pointer": "#/servers/0/variables/a",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "The \`a\` variable is not used in the server's \`url\` field.",
+          "ruleId": "no-undefined-server-variable",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/servers/0/variables/a/enum/0",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`string\` but got \`integer\`.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/tags/0",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`Tag\` (object) but got \`number\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/tags/1",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`Tag\` (object) but got \`string\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should report unexpected properties', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          openapi: 3.0.0
+          components1: 1
+          info:
+            title: Test
+            version: '1.0'
+            description: test description
+            license:
+              name: MIT
+              url: google.com
+            contact:
+              name: string
+              test: blah
+              x-test: vendor
+          paths: {}
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: allConfig,
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/components1",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Property \`components1\` is not expected here.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [
+            "components",
+          ],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/openapi",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Servers must be present.",
+          "ruleId": "no-empty-servers",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/info/contact/test",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Property \`test\` is not expected here.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should report required properties missing', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          openapi: 3.0.0
+          info:
+            version: '1.0'
+            description: test description
+            license:
+              name: MIT
+              url: google.com
+            contact:
+              name: string
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: allConfig,
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "The field \`paths\` must be present on this level.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/openapi",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Servers must be present.",
+          "ruleId": "no-empty-servers",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/info",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "The field \`title\` must be present on this level.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+});

package/src/rules/oas3/__tests__/spec/utils.ts

@@ -0,0 +1,32 @@
+import { StyleguideConfig, RuleConfig, resolveStyleguideConfig } from '../../../../config';
+import { parseYamlToDocument } from '../../../../../__tests__/utils';
+import { lintDocument } from '../../../../lint';
+import { BaseResolver } from '../../../../resolve';
+
+export async function validateDoc(
+  source: string,
+  rules: Record<string, RuleConfig> = { spec: 'error' }
+) {
+  const document = parseYamlToDocument(source, 'foobar.yaml');
+
+  const results = await lintDocument({
+    externalRefResolver: new BaseResolver(),
+    document,
+    config: new StyleguideConfig(
+      await resolveStyleguideConfig({
+        styleguideConfig: {
+          plugins: [],
+          extends: [],
+          rules,
+        },
+      })
+    ),
+  });
+
+  return results.map((res) => {
+    return {
+      message: res.message,
+      location: res.location[0].pointer || '',
+    };
+  });
+}

package/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts

@@ -0,0 +1,276 @@
+import { makeConfig, parseYamlToDocument } from '../../../../__tests__/utils';
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { BaseResolver } from '../../../resolve';
+
+describe('Oas3 spec-components-invalid-map-name', () => {
+  it('should report about invalid keys inside components', async () => {
+    const document = parseYamlToDocument(outdent`
+      openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+        examples:
+          invalid identifier:
+            description: 'Some description'
+            value: 21      
+        responses: 
+          400 status:
+            description: bad request   
+        schemas: 
+          first schema:
+            type: integer
+            format: int64     
+		`);
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        'spec-components-invalid-map-name': 'error',
+      }),
+    });
+
+    expect(results).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/components/parameters/my Param",
+              "reportOnKey": true,
+              "source": Source {
+                "absoluteRef": "",
+                "body": "openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+        examples:
+          invalid identifier:
+            description: 'Some description'
+            value: 21      
+        responses: 
+          400 status:
+            description: bad request   
+        schemas: 
+          first schema:
+            type: integer
+            format: int64     ",
+                "mimeType": undefined,
+              },
+            },
+          ],
+          "message": "The map key in parameters \\"my Param\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "ruleId": "spec-components-invalid-map-name",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/components/schemas/first schema",
+              "reportOnKey": true,
+              "source": Source {
+                "absoluteRef": "",
+                "body": "openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+        examples:
+          invalid identifier:
+            description: 'Some description'
+            value: 21      
+        responses: 
+          400 status:
+            description: bad request   
+        schemas: 
+          first schema:
+            type: integer
+            format: int64     ",
+                "mimeType": undefined,
+              },
+            },
+          ],
+          "message": "The map key in schemas \\"first schema\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "ruleId": "spec-components-invalid-map-name",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/components/responses/400 status",
+              "reportOnKey": true,
+              "source": Source {
+                "absoluteRef": "",
+                "body": "openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+        examples:
+          invalid identifier:
+            description: 'Some description'
+            value: 21      
+        responses: 
+          400 status:
+            description: bad request   
+        schemas: 
+          first schema:
+            type: integer
+            format: int64     ",
+                "mimeType": undefined,
+              },
+            },
+          ],
+          "message": "The map key in responses \\"400 status\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "ruleId": "spec-components-invalid-map-name",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/components/examples/invalid identifier",
+              "reportOnKey": true,
+              "source": Source {
+                "absoluteRef": "",
+                "body": "openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+        examples:
+          invalid identifier:
+            description: 'Some description'
+            value: 21      
+        responses: 
+          400 status:
+            description: bad request   
+        schemas: 
+          first schema:
+            type: integer
+            format: int64     ",
+                "mimeType": undefined,
+              },
+            },
+          ],
+          "message": "The map key in examples \\"invalid identifier\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "ruleId": "spec-components-invalid-map-name",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report a key of the example does not match the regular expression', async () => {
+    const document = parseYamlToDocument(outdent`
+      openapi: 3.0.0
+      info:
+        version: 3.0.0
+      paths:
+        /store/subscribe:
+          post:
+            parameters:
+              - name: petId
+                in: path
+                schema:
+                  type: integer
+                  format: int64
+                examples:
+                  valid-identifier-1.key:
+                      description: 'Some description'
+                      value: 21
+		`);
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        'spec-components-invalid-map-name': 'error',
+      }),
+    });
+
+    expect(results).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('should not report invalid keys inside nested examples', async () => {
+    const document = parseYamlToDocument(outdent`
+      openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+            examples:
+              valid identifier:
+                description: 'Some description'
+                value: 21 
+		`);
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        'spec-components-invalid-map-name': 'error',
+      }),
+    });
+
+    expect(results).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/components/parameters/my Param",
+              "reportOnKey": true,
+              "source": Source {
+                "absoluteRef": "",
+                "body": "openapi: 3.0.0
+      info:
+        version: 3.0.0
+      components:
+        parameters:
+          my Param:
+            name: param
+            description: param
+            in: path
+            examples:
+              valid identifier:
+                description: 'Some description'
+                value: 21 ",
+                "mimeType": undefined,
+              },
+            },
+          ],
+          "message": "The map key in parameters \\"my Param\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "ruleId": "spec-components-invalid-map-name",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+});

package/src/rules/oas3/__tests__/utils/lint-document-for-test.ts

@@ -0,0 +1,23 @@
+import { BaseResolver, Document } from '../../../../resolve';
+import { makeConfig, parseYamlToDocument } from '../../../../../__tests__/utils';
+import { lintDocument } from '../../../../lint';
+import { RuleConfig } from '../../../../config';
+
+export async function lintDocumentForTest(
+  rules: Record<string, RuleConfig>,
+  document: Document,
+  additionalDocuments: { absoluteRef: string; body: string }[]
+) {
+  const baseResolver = new BaseResolver();
+  additionalDocuments.forEach((item) =>
+    baseResolver.cache.set(
+      item.absoluteRef,
+      Promise.resolve(parseYamlToDocument(item.body, item.absoluteRef))
+    )
+  );
+  return await lintDocument({
+    externalRefResolver: baseResolver,
+    document,
+    config: await makeConfig(rules),
+  });
+}

package/src/rules/oas3/boolean-parameter-prefixes.ts

@@ -0,0 +1,28 @@
+import { Oas3Rule } from '../../visitors';
+
+export type BooleanParameterPrefixesOptions = {
+  prefixes?: string[];
+};
+
+export const BooleanParameterPrefixes: Oas3Rule = (options: BooleanParameterPrefixesOptions) => {
+  const prefixes = options.prefixes || ['is', 'has'];
+  const regexp = new RegExp(`^(${prefixes.join('|')})[A-Z-_]`);
+  const wrappedPrefixes = prefixes.map((p) => `\`${p}\``);
+  const prefixesString =
+    wrappedPrefixes.length === 1
+      ? wrappedPrefixes[0]
+      : wrappedPrefixes.slice(0, -1).join(', ') + ' or ' + wrappedPrefixes[prefixes.length - 1];
+
+  return {
+    Parameter: {
+      Schema(schema, { report, parentLocations }, parents) {
+        if (schema.type === 'boolean' && !regexp.test(parents.Parameter.name)) {
+          report({
+            message: `Boolean parameter \`${parents.Parameter.name}\` should have ${prefixesString} prefix.`,
+            location: parentLocations.Parameter.child(['name']),
+          });
+        }
+      },
+    },
+  };
+};