@redocly/openapi-core 1.0.0-rc.3 → 1.0.1

package/src/rules/oas3/__tests__/fixtures/common.yaml

@@ -0,0 +1,11 @@
+components:
+  schemas:
+    A:
+      type: object
+      properties:
+        a:
+          type: string
+        b:
+          $ref: '#/components/schemas/B'
+    B:
+      type: string

package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts

@@ -0,0 +1,205 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Oas3 as3-no-server-variables-empty-enum', () => {
+  it('oas3-no-server-variables-empty-enum: should report on server object with empty enum and unknown enum value', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          title: API
+          version: 1.0.0
+        servers:
+          - url: https://example.com/{var}
+            variables:
+              var:
+                enum: []
+                default: a
+        components: {}
+      `
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/servers",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Server variable with \`enum\` must be a non-empty array.",
+          "ruleId": "no-server-variables-empty-enum",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/servers",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Server variable define \`enum\` and \`default\`. \`enum\` must include default value",
+          "ruleId": "no-server-variables-empty-enum",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('oas3-no-server-variables-empty-enum: should report on server object with empty enum', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          title: API
+          version: 1.0.0
+        servers:
+          - url: https://example.com/{var}
+            variables:
+              var:
+                enum: []
+        components: {}
+      `
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/servers",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Server variable with \`enum\` must be a non-empty array.",
+          "ruleId": "no-server-variables-empty-enum",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('oas3-no-server-variables-empty-enum: should be success because variables is empty object', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          title: API
+          version: 1.0.0
+        servers:
+          - url: https://example.com/{var}
+            variables: {}
+        components: {}
+      `
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('oas3-no-server-variables-empty-enum: should be success because variable is empty object', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          title: API
+          version: 1.0.0
+        servers:
+          - url: https://example.com/{var}
+            variables:
+              var: {}
+        components: {}
+      `
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('oas3-no-server-variables-empty-enum: should be success because enum contains default value', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          title: API
+          version: 1.0.0
+        servers:
+          - url: https://example.com/{var}
+            variables:
+              var:
+                enum:
+                  - a
+                default: a
+        components: {}
+      `
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('oas3-no-server-variables-empty-enum: should be success because enum contains default value', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        info:
+          title: API
+          version: 1.0.0
+        servers:
+          - url: https://example.com/{var}
+            variables:
+              var:
+                type: ['string', 'null']
+                enum:
+                  - 'some string'
+                  - null
+                default: 'some string'
+        components: {}
+      `
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-server-variables-empty-enum': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+});

package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts

@@ -0,0 +1,65 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Oas3 oas3-no-example-value-and-externalValue', () => {
+  it('oas3-no-example-value-and-externalValue: should report on example object with both value and external value', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          openapi: 3.0.0
+          components:
+            examples:
+              some:
+                value: 12
+                externalValue: https://1.1.1.1
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-example-value-and-externalValue': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/components/examples/some/value",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example object can have either \`value\` or \`externalValue\` fields.",
+          "ruleId": "no-example-value-and-externalValue",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('oas3-no-example-value-and-externalValue: should not report on example object with value OR external value', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          openapi: 3.0.0
+          components:
+            examples:
+              some:
+                value: 12
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-example-value-and-externalValue': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+});