@redocly/openapi-core 1.0.0-beta.125 → 1.0.0-beta.127

package/src/config/__tests__/config.test.ts

@@ -1,307 +0,0 @@
-import { OasVersion } from '../../oas-types';
-import { Config, StyleguideConfig } from '../config';
-import { getMergedConfig } from '../utils';
-import { doesYamlFileExist } from '../../utils';
-import { parseYaml } from '../../js-yaml';
-import { readFileSync } from 'fs';
-import { ignoredFileStub } from './fixtures/ingore-file';
-import * as path from 'path';
-import { NormalizedProblem } from '../../walk';
-import { Source } from '../../resolve';
-
-jest.mock('../../utils');
-jest.mock('../../js-yaml');
-jest.mock('fs');
-
-const testConfig: Config = {
-  rawConfig: {
-    apis: {
-      'test@v1': {
-        root: 'resources/pets.yaml',
-        styleguide: { rules: { 'operation-summary': 'warn' } },
-      },
-    },
-    organization: 'redocly-test',
-    styleguide: {
-      rules: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
-      plugins: [],
-    },
-  },
-  configFile: 'redocly.yaml',
-  apis: {
-    'test@v1': {
-      root: 'resources/pets.yaml',
-      styleguide: { rules: { 'operation-summary': 'warn' } },
-    },
-  },
-
-  styleguide: {
-    rawConfig: {
-      rules: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
-      plugins: [],
-    },
-    configFile: 'redocly.yaml',
-    ignore: {},
-    _usedRules: new Set(),
-    _usedVersions: new Set(),
-    recommendedFallback: false,
-    plugins: [],
-    doNotResolveExamples: false,
-    rules: {
-      oas2: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
-      oas3_0: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
-      oas3_1: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
-    },
-    preprocessors: { oas2: {}, oas3_0: {}, oas3_1: {} },
-    decorators: { oas2: {}, oas3_0: {}, oas3_1: {} },
-  } as unknown as StyleguideConfig,
-  theme: {
-    openapi: {},
-    mockServer: {},
-  },
-  resolve: { http: { headers: [] } },
-  organization: 'redocly-test',
-  files: [],
-};
-
-describe('getMergedConfig', () => {
-  it('should get styleguide defined in "apis" section', () => {
-    expect(getMergedConfig(testConfig, 'test@v1')).toMatchInlineSnapshot(`
-      Config {
-        "apis": Object {
-          "test@v1": Object {
-            "root": "resources/pets.yaml",
-            "styleguide": Object {
-              "rules": Object {
-                "operation-summary": "warn",
-              },
-            },
-          },
-        },
-        "configFile": "redocly.yaml",
-        "files": Array [],
-        "organization": "redocly-test",
-        "rawConfig": Object {
-          "apis": Object {
-            "test@v1": Object {
-              "root": "resources/pets.yaml",
-              "styleguide": Object {
-                "rules": Object {
-                  "operation-summary": "warn",
-                },
-              },
-            },
-          },
-          "files": Array [],
-          "organization": "redocly-test",
-          "styleguide": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "rules": Object {
-              "operation-summary": "warn",
-            },
-          },
-          "theme": Object {},
-        },
-        "region": undefined,
-        "resolve": Object {
-          "http": Object {
-            "customFetch": undefined,
-            "headers": Array [],
-          },
-        },
-        "styleguide": StyleguideConfig {
-          "_usedRules": Set {},
-          "_usedVersions": Set {},
-          "configFile": "redocly.yaml",
-          "decorators": Object {
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
-          },
-          "doNotResolveExamples": false,
-          "extendPaths": Array [],
-          "ignore": Object {},
-          "pluginPaths": Array [],
-          "plugins": Array [],
-          "preprocessors": Object {
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
-          },
-          "rawConfig": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "rules": Object {
-              "operation-summary": "warn",
-            },
-          },
-          "recommendedFallback": false,
-          "rules": Object {
-            "oas2": Object {
-              "operation-summary": "warn",
-            },
-            "oas3_0": Object {
-              "operation-summary": "warn",
-            },
-            "oas3_1": Object {
-              "operation-summary": "warn",
-            },
-          },
-        },
-        "theme": Object {},
-      }
-    `);
-  });
-  it('should take into account a config file', () => {
-    const result = getMergedConfig(testConfig, 'test@v1');
-    expect(result.configFile).toEqual('redocly.yaml');
-    expect(result.styleguide.configFile).toEqual('redocly.yaml');
-  });
-  it('should return the same config when there is no alias provided', () => {
-    expect(getMergedConfig(testConfig)).toEqual(testConfig);
-  });
-  it('should handle wrong alias - return the same styleguide, empty features', () => {
-    expect(getMergedConfig(testConfig, 'wrong-alias')).toMatchInlineSnapshot(`
-      Config {
-        "apis": Object {
-          "test@v1": Object {
-            "root": "resources/pets.yaml",
-            "styleguide": Object {
-              "rules": Object {
-                "operation-summary": "warn",
-              },
-            },
-          },
-        },
-        "configFile": "redocly.yaml",
-        "files": Array [],
-        "organization": "redocly-test",
-        "rawConfig": Object {
-          "apis": Object {
-            "test@v1": Object {
-              "root": "resources/pets.yaml",
-              "styleguide": Object {
-                "rules": Object {
-                  "operation-summary": "warn",
-                },
-              },
-            },
-          },
-          "files": Array [],
-          "organization": "redocly-test",
-          "styleguide": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "plugins": Array [],
-            "rules": Object {
-              "no-empty-servers": "error",
-              "operation-summary": "error",
-            },
-          },
-          "theme": Object {},
-        },
-        "region": undefined,
-        "resolve": Object {
-          "http": Object {
-            "customFetch": undefined,
-            "headers": Array [],
-          },
-        },
-        "styleguide": StyleguideConfig {
-          "_usedRules": Set {},
-          "_usedVersions": Set {},
-          "configFile": "redocly.yaml",
-          "decorators": Object {
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
-          },
-          "doNotResolveExamples": false,
-          "extendPaths": Array [],
-          "ignore": Object {},
-          "pluginPaths": Array [],
-          "plugins": Array [],
-          "preprocessors": Object {
-            "oas2": Object {},
-            "oas3_0": Object {},
-            "oas3_1": Object {},
-          },
-          "rawConfig": Object {
-            "extendPaths": Array [],
-            "pluginPaths": Array [],
-            "plugins": Array [],
-            "rules": Object {
-              "no-empty-servers": "error",
-              "operation-summary": "error",
-            },
-          },
-          "recommendedFallback": false,
-          "rules": Object {
-            "oas2": Object {
-              "no-empty-servers": "error",
-              "operation-summary": "error",
-            },
-            "oas3_0": Object {
-              "no-empty-servers": "error",
-              "operation-summary": "error",
-            },
-            "oas3_1": Object {
-              "no-empty-servers": "error",
-              "operation-summary": "error",
-            },
-          },
-        },
-        "theme": Object {},
-      }
-    `);
-  });
-});
-
-describe('StyleguideConfig.extendTypes', () => {
-  let oas3 = jest.fn();
-  let oas2 = jest.fn();
-  let testRawConfigStyleguide = {
-    plugins: [
-      {
-        id: 'test-types-plugin',
-        typeExtension: {
-          oas3,
-          oas2,
-        },
-      },
-    ],
-  };
-  it('should call only oas3 types extension', () => {
-    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
-    styleguideConfig.extendTypes({}, OasVersion.Version3_0);
-    expect(oas3).toHaveBeenCalledTimes(1);
-    expect(oas2).toHaveBeenCalledTimes(0);
-  });
-  it('should call only oas2 types extension', () => {
-    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
-    styleguideConfig.extendTypes({}, OasVersion.Version2);
-    expect(oas3).toHaveBeenCalledTimes(0);
-    expect(oas2).toHaveBeenCalledTimes(1);
-  });
-  it('should throw error if for oas version different from 2 and 3', () => {
-    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
-    expect(() => styleguideConfig.extendTypes({}, 'something else' as OasVersion)).toThrowError(
-      'Not implemented'
-    );
-  });
-});
-
-describe('generation ignore object', () => {
-  it('should generate config with absoluteUri for ignore', () => {
-    (readFileSync as jest.Mock<any, any>).mockImplementationOnce(() => '');
-    (parseYaml as jest.Mock<any, any>).mockImplementationOnce(() => ignoredFileStub);
-    (doesYamlFileExist as jest.Mock<any, any>).mockImplementationOnce(() => true);
-
-    jest.spyOn(path, 'resolve').mockImplementationOnce((_, filename) => `some-path/${filename}`);
-
-    const styleguideConfig = new StyleguideConfig(testConfig.styleguide);
-
-    expect(styleguideConfig).toMatchSnapshot();
-  });
-});

package/src/config/__tests__/fixtures/ingore-file.ts

@@ -1,8 +0,0 @@
-export const ignoredFileStub = {
-  'openapi.yaml': {
-    'no-unused-components': ['#/components/schemas/Foo'],
-  },
-  'https://some-path.yaml': {
-    'no-unused-components': ['#/components/schemas/Foo'],
-  },
-};

package/src/config/__tests__/fixtures/load-redocly.yaml

@@ -1,2 +0,0 @@
-  rules:
-    info-contact: warn

package/src/config/__tests__/fixtures/plugin-config.yaml

@@ -1,2 +0,0 @@
-plugins:
-  - './plugin.js'

package/src/config/__tests__/fixtures/plugin.js

@@ -1,56 +0,0 @@
-const id = 'test-plugin';
-
-/** @type {import('../../config').PreprocessorsConfig} */
-const preprocessors = {
-  oas2: {
-    'description-preprocessor': () => {
-      return {
-        Info(info) {
-          const title = info.title || 'API title';
-          info.description = `# ${title}\n\n${info.description || ''}`;
-        },
-      };
-    },
-  },
-};
-
-/** @type {import('../../config').CustomRulesConfig} */
-const rules = {
-  oas3: {
-    'openid-connect-url-well-known': () => {
-      return {
-        SecurityScheme(scheme, { location, report }) {
-          if (scheme.type === 'openIdConnect') {
-            if (!scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
-              report({
-                message:
-                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
-                location: location.child('openIdConnectUrl'),
-              });
-            }
-          }
-        },
-      };
-    },
-  },
-};
-
-/** @type {import('../../config').DecoratorsConfig} */
-const decorators = {
-  oas3: {
-    'inject-x-stats': () => {
-      return {
-        Info(info) {
-          info['x-stats'] = { test: 1 };
-        },
-      };
-    },
-  },
-};
-
-module.exports = {
-  id,
-  preprocessors,
-  rules,
-  decorators,
-};

package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml

@@ -1,11 +0,0 @@
-plugins:
-  - plugin.js
-rules:
-  operation-2xx-response: error
-  assert/path-item-get-defined:
-    subject: PathItem
-    property: get
-    message: Every path item must have a GET operation.
-    defined: true
-extends:
-  - test-plugin-nested/all

package/src/config/__tests__/fixtures/resolve-config/api/plugin.js

@@ -1,69 +0,0 @@
-const id = 'test-plugin-nested';
-
-/** @type {import('../../config').PreprocessorsConfig} */
-const preprocessors = {
-  oas2: {
-    'description-preprocessor': () => {
-      return {
-        Info(info) {
-          const title = info.title || 'API title';
-          info.description = `# ${title}\n\n${info.description || ''}`;
-        },
-      };
-    },
-  },
-};
-
-/** @type {import('../../config').CustomRulesConfig} */
-const rules = {
-  oas3: {
-    'openid-connect-url-well-known': () => {
-      return {
-        SecurityScheme(scheme, { location, report }) {
-          if (scheme.type === 'openIdConnect') {
-            if (
-              scheme.openIdConnectUrl &&
-              !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')
-            ) {
-              report({
-                message:
-                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
-                location: location.child('openIdConnectUrl'),
-              });
-            }
-          }
-        },
-      };
-    },
-  },
-};
-
-/** @type {import('../../config').DecoratorsConfig} */
-const decorators = {
-  oas3: {
-    'inject-x-stats': () => {
-      return {
-        Info(info) {
-          info['x-stats'] = { test: 1 };
-        },
-      };
-    },
-  },
-};
-
-const configs = {
-  all: {
-    rules: {
-      'local/operation-id-not-test': 'error',
-      'boolean-parameter-prefixes': 'error',
-    },
-  },
-};
-
-module.exports = {
-  id,
-  preprocessors,
-  rules,
-  decorators,
-  configs,
-};

package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml

@@ -1,7 +0,0 @@
-extends:
-  - local-config-with-circular.yaml
-rules:
-  no-invalid-media-type-examples: error
-  operation-description: error
-  path-http-verbs-order: error
-  operation-2xx-response: off

package/src/config/__tests__/fixtures/resolve-config/local-config-with-custom-function.yaml

@@ -1,17 +0,0 @@
-  rules:
-    no-invalid-media-type-examples: warn
-    operation-4xx-response: off
-    assert/tag-description:
-      subject: 
-        type: Tag
-        property: description
-      message: Tag description must have at least 3 words.
-      severity: error
-      assertions:
-        test-plugin/checkWordsCount:
-          min: 3
-  plugins:
-    - plugin.js
-  extends:
-    - recommended
-    - test-plugin/all

package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml

@@ -1,18 +0,0 @@
-rules:
-  no-invalid-media-type-examples: warn
-  operation-4xx-response: off
-  assert/tag-description:
-    subject: Tag
-    property: description
-    message: Tag description must be at least 13 characters and end with a full stop.
-    severity: error
-    minLength: 13
-    pattern: /\.$/
-plugins:
-  - plugin.js
-  - api/plugin.js
-extends:
-  - recommended
-  - api/nested-config.yaml
-  - test-plugin-nested/all
-  - test-plugin/all

package/src/config/__tests__/fixtures/resolve-config/local-config-with-wrong-custom-function.yaml

@@ -1,15 +0,0 @@
-  rules:
-    no-invalid-media-type-examples: warn
-    operation-4xx-response: off
-    assert/tag-description:
-      subject: Tag
-      property: description
-      message: Tag description must have at least 3 words.
-      severity: error
-      test-plugin/checkWordsCount2:
-        min: 3
-  plugins:
-    - plugin.js
-  extends:
-    - recommended
-    - test-plugin/all

package/src/config/__tests__/fixtures/resolve-config/local-config.yaml

@@ -1,9 +0,0 @@
-plugins:
-  - plugin.js
-extends:
-  - test-plugin/all
-rules:
-  no-invalid-media-type-examples: error
-  operation-description: error
-  path-http-verbs-order: error
-  operation-2xx-response: off

package/src/config/__tests__/fixtures/resolve-config/plugin.js

@@ -1,80 +0,0 @@
-const id = 'test-plugin';
-
-/** @type {import('../../config').PreprocessorsConfig} */
-const preprocessors = {
-  oas2: {
-    'description-preprocessor': () => {
-      return {
-        Info(info) {
-          const title = info.title || 'API title';
-          info.description = `# ${title}\n\n${info.description || ''}`;
-        },
-      };
-    },
-  },
-};
-
-/** @type {import('../../config').CustomRulesConfig} */
-const rules = {
-  oas3: {
-    'openid-connect-url-well-known': () => {
-      return {
-        SecurityScheme(scheme, { location, report }) {
-          if (scheme.type === 'openIdConnect') {
-            if (
-              scheme.openIdConnectUrl &&
-              !scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')
-            ) {
-              report({
-                message:
-                  'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',
-                location: location.child('openIdConnectUrl'),
-              });
-            }
-          }
-        },
-      };
-    },
-  },
-};
-
-/** @type {import('../../config').DecoratorsConfig} */
-const decorators = {
-  oas3: {
-    'inject-x-stats': () => {
-      return {
-        Info(info) {
-          info['x-stats'] = { test: 1 };
-        },
-      };
-    },
-  },
-};
-
-const assertions = {
-  checkWordsCount: (value, opts, location) => {
-    const words = value.split(' ');
-    if (words.length >= opts.min) {
-      return { isValid: true };
-    }
-    return { isValid: false, location };
-  },
-};
-
-const configs = {
-  all: {
-    rules: {
-      'local/operation-id-not-test': 'error',
-      'boolean-parameter-prefixes': 'error',
-    },
-  },
-};
-
-module.exports = {
-  id,
-  preprocessors,
-  rules,
-  decorators,
-  configs,
-  assertions,
-};

package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml

@@ -1,3 +0,0 @@
-rules:
-  operation-2xx-response: off
-  operation-4xx-response: error

package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml

@@ -1,4 +0,0 @@
-extends:
-  - nested-remote-config.yaml
-rules:
-  operation-2xx-response: error