@redocly/openapi-core 1.0.0-beta.92 → 1.0.0-beta.95

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

@@ -0,0 +1,244 @@
+import { Config } from '../config';
+import { getMergedConfig } from '../utils';
+
+const testConfig: Config = {
+  rawConfig: {
+    apis: {
+      'test@v1': {
+        root: 'resources/pets.yaml',
+        lint: { rules: { 'operation-summary': 'warn' } },
+      },
+    },
+    organization: 'redocly-test',
+    lint: {
+      rules: { 'operation-summary': 'error', 'no-empty-servers': 'error' },
+      plugins: [],
+    },
+  },
+  configFile: 'redocly.yaml',
+  apis: {
+    'test@v1': {
+      root: 'resources/pets.yaml',
+      lint: { rules: { 'operation-summary': 'warn' } },
+    },
+  },
+  // @ts-ignore
+  lint: {
+    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: {} },
+  },
+  'features.openapi': {},
+  'features.mockServer': {},
+  resolve: { http: { headers: [] } },
+  organization: 'redocly-test',
+};
+
+describe('getMergedConfig', () => {
+  it('should get lint defined in "apis" section', () => {
+    expect(getMergedConfig(testConfig, 'test@v1')).toMatchInlineSnapshot(`
+      Config {
+        "apis": Object {
+          "test@v1": Object {
+            "lint": Object {
+              "rules": Object {
+                "operation-summary": "warn",
+              },
+            },
+            "root": "resources/pets.yaml",
+          },
+        },
+        "configFile": "redocly.yaml",
+        "features.mockServer": Object {},
+        "features.openapi": Object {},
+        "lint": LintConfig {
+          "_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",
+            },
+          },
+        },
+        "organization": "redocly-test",
+        "rawConfig": Object {
+          "apis": Object {
+            "test@v1": Object {
+              "lint": Object {
+                "rules": Object {
+                  "operation-summary": "warn",
+                },
+              },
+              "root": "resources/pets.yaml",
+            },
+          },
+          "features.mockServer": Object {},
+          "features.openapi": Object {},
+          "lint": Object {
+            "extendPaths": Array [],
+            "pluginPaths": Array [],
+            "rules": Object {
+              "operation-summary": "warn",
+            },
+          },
+          "organization": "redocly-test",
+        },
+        "region": undefined,
+        "resolve": Object {
+          "http": Object {
+            "customFetch": undefined,
+            "headers": Array [],
+          },
+        },
+      }
+    `);
+  });
+  it('should take into account a config file', () => {
+    const result = getMergedConfig(testConfig, 'test@v1');
+    expect(result.configFile).toEqual('redocly.yaml');
+    expect(result.lint.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 lint, empty features', () => {
+    expect(getMergedConfig(testConfig, 'wrong-alias')).toMatchInlineSnapshot(`
+      Config {
+        "apis": Object {
+          "test@v1": Object {
+            "lint": Object {
+              "rules": Object {
+                "operation-summary": "warn",
+              },
+            },
+            "root": "resources/pets.yaml",
+          },
+        },
+        "configFile": "redocly.yaml",
+        "features.mockServer": Object {},
+        "features.openapi": Object {},
+        "lint": LintConfig {
+          "_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",
+            },
+          },
+        },
+        "organization": "redocly-test",
+        "rawConfig": Object {
+          "apis": Object {
+            "test@v1": Object {
+              "lint": Object {
+                "rules": Object {
+                  "operation-summary": "warn",
+                },
+              },
+              "root": "resources/pets.yaml",
+            },
+          },
+          "features.mockServer": Object {},
+          "features.openapi": Object {},
+          "lint": Object {
+            "extendPaths": Array [],
+            "pluginPaths": Array [],
+            "plugins": Array [],
+            "rules": Object {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
+          },
+          "organization": "redocly-test",
+        },
+        "region": undefined,
+        "resolve": Object {
+          "http": Object {
+            "customFetch": undefined,
+            "headers": Array [],
+          },
+        },
+      }
+    `);
+  });
+});

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

@@ -21,7 +21,7 @@ const rules = {
       return {
         SecurityScheme(scheme, { location, report }) {
           if (scheme.type === 'openIdConnect') {
-            if (!scheme.openIdConnectUrl?.endsWith('/.well-known/openid-configuration')) {
+            if (!scheme.openIdConnectUrl.endsWith('/.well-known/openid-configuration')) {
               report({
                 message:
                   'openIdConnectUrl must be a URL that ends with /.well-known/openid-configuration',

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

@@ -0,0 +1,7 @@
+lint:
+  plugins:
+    - plugin.js
+  rules:
+    operation-2xx-response: error
+  extends:
+    - test-plugin-nested/all

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

@@ -0,0 +1,67 @@
+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

@@ -0,0 +1,8 @@
+lint:
+  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-file.yaml

@@ -0,0 +1,12 @@
+lint:
+  rules:
+    no-invalid-media-type-examples: warn
+    operation-4xx-response: off
+  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.yaml

@@ -0,0 +1,10 @@
+lint:
+  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

@@ -0,0 +1,66 @@
+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 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-remote-configs/nested-remote-config.yaml

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

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

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

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

@@ -1,4 +1,4 @@
-import { loadConfig, findConfig } from '../load';
+import { loadConfig, findConfig, getConfig } from '../load';
 import { RedoclyClient } from '../../redocly';
 
 const fs = require('fs');
@@ -74,3 +74,10 @@ describe('findConfig', () => {
     expect(configName).toStrictEqual('dir/redocly.yaml');
   });
 });
+
+describe('getConfig', () => {
+  jest.spyOn(fs, 'hasOwnProperty').mockImplementation(() => false);
+  it('should return empty object if there is no configPath and config file is not found', () => {
+    expect(getConfig()).toEqual(Promise.resolve({}));
+  });
+});

package/src/config/all.ts

@@ -1,4 +1,5 @@
-import { LintRawConfig } from './config';
+import type { PluginLintConfig } from "./types";
+
 
 export default {
   rules: {
@@ -61,4 +62,4 @@ export default {
     'no-undefined-server-variable': 'error',
     'no-servers-empty-enum': 'error',
   },
-} as LintRawConfig;
+} as PluginLintConfig;

package/src/config/builtIn.ts

@@ -1,7 +1,6 @@
 import recommended from './recommended';
 import all from './all';
 import minimal from './minimal';
-import { CustomRulesConfig, LintRawConfig, Plugin } from './config';
 import { rules as oas3Rules } from '../rules/oas3';
 import { rules as oas2Rules } from '../rules/oas2';
 import { preprocessors as oas3Preprocessors } from '../rules/oas3';
@@ -9,6 +8,8 @@ import { preprocessors as oas2Preprocessors } from '../rules/oas2';
 import { decorators as oas3Decorators } from '../decorators/oas3';
 import { decorators as oas2Decorators } from '../decorators/oas2';
 
+import type { CustomRulesConfig, LintRawConfig, Plugin } from './types';
+
 export const builtInConfigs: Record<string, LintRawConfig> = {
   recommended,
   minimal,