@redocly/cli 1.0.0-beta.99 → 1.0.0-rc.2

package/lib/__tests__/commands/bundle.test.js

@@ -11,9 +11,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const openapi_core_1 = require("@redocly/openapi-core");
 const bundle_1 = require("../../commands/bundle");
+const utils_1 = require("../../utils");
+const wrapper_1 = require("../../wrapper");
 jest.mock('@redocly/openapi-core');
 jest.mock('../../utils');
-openapi_core_1.getMergedConfig.mockImplementation(config => config);
+openapi_core_1.getMergedConfig.mockImplementation((config) => config);
 describe('bundle', () => {
     let processExitMock;
     let exitCb;
@@ -28,65 +30,99 @@ describe('bundle', () => {
     afterEach(() => {
         openapi_core_1.lint.mockClear();
         openapi_core_1.bundle.mockClear();
-        openapi_core_1.getTotals.mockClear();
+        openapi_core_1.getTotals.mockReset();
     });
     it('bundles definitions w/o linting', () => __awaiter(void 0, void 0, void 0, function* () {
-        const entrypoints = ['foo.yaml', 'bar.yaml'];
-        yield bundle_1.handleBundle({
-            entrypoints,
+        const apis = ['foo.yaml', 'bar.yaml'];
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
             ext: 'yaml',
             format: 'codeframe',
-        }, '1.0.0');
+        });
         expect(openapi_core_1.lint).toBeCalledTimes(0);
-        expect(openapi_core_1.bundle).toBeCalledTimes(entrypoints.length);
+        expect(openapi_core_1.bundle).toBeCalledTimes(apis.length);
     }));
     it('exits with code 0 when bundles definitions', () => __awaiter(void 0, void 0, void 0, function* () {
-        const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-        yield bundle_1.handleBundle({
-            entrypoints,
+        const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
             ext: 'yaml',
             format: 'codeframe',
-        }, '1.0.0');
-        exitCb === null || exitCb === void 0 ? void 0 : exitCb();
+        });
+        yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
         expect(processExitMock).toHaveBeenCalledWith(0);
     }));
     it('bundles definitions w/ linting', () => __awaiter(void 0, void 0, void 0, function* () {
-        const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-        yield bundle_1.handleBundle({
-            entrypoints,
+        const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+        openapi_core_1.getTotals.mockReturnValue({
+            errors: 0,
+            warnings: 0,
+            ignored: 0,
+        });
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
             ext: 'yaml',
             format: 'codeframe',
             lint: true,
-        }, '1.0.0');
-        expect(openapi_core_1.lint).toBeCalledTimes(entrypoints.length);
-        expect(openapi_core_1.bundle).toBeCalledTimes(entrypoints.length);
+        });
+        expect(openapi_core_1.lint).toBeCalledTimes(apis.length);
+        expect(openapi_core_1.bundle).toBeCalledTimes(apis.length);
     }));
     it('exits with code 0 when bundles definitions w/linting w/o errors', () => __awaiter(void 0, void 0, void 0, function* () {
-        const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-        yield bundle_1.handleBundle({
-            entrypoints,
+        const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
             ext: 'yaml',
             format: 'codeframe',
             lint: true,
-        }, '1.0.0');
-        exitCb === null || exitCb === void 0 ? void 0 : exitCb();
+        });
+        yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
         expect(processExitMock).toHaveBeenCalledWith(0);
     }));
     it('exits with code 1 when bundles definitions w/linting w/errors', () => __awaiter(void 0, void 0, void 0, function* () {
-        const entrypoints = ['foo.yaml'];
+        const apis = ['foo.yaml'];
         openapi_core_1.getTotals.mockReturnValue({
             errors: 1,
             warnings: 0,
-            ignored: 0
+            ignored: 0,
         });
-        yield bundle_1.handleBundle({
-            entrypoints,
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
             ext: 'yaml',
             format: 'codeframe',
             lint: true,
-        }, '1.0.0');
-        expect(openapi_core_1.lint).toBeCalledTimes(entrypoints.length);
-        exitCb === null || exitCb === void 0 ? void 0 : exitCb();
+        });
+        expect(openapi_core_1.lint).toBeCalledTimes(apis.length);
+        yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
         expect(processExitMock).toHaveBeenCalledWith(1);
     }));
+    it('handleError is called when bundles an invalid definition', () => __awaiter(void 0, void 0, void 0, function* () {
+        const apis = ['invalid.json'];
+        openapi_core_1.bundle.mockImplementationOnce(() => {
+            throw new Error('Invalid definition');
+        });
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
+            ext: 'json',
+            format: 'codeframe',
+            lint: false,
+        });
+        expect(utils_1.handleError).toHaveBeenCalledTimes(1);
+        expect(utils_1.handleError).toHaveBeenCalledWith(new Error('Invalid definition'), 'invalid.json');
+    }));
+    it("handleError isn't called when bundles a valid definition", () => __awaiter(void 0, void 0, void 0, function* () {
+        const apis = ['foo.yaml'];
+        openapi_core_1.getTotals.mockReturnValue({
+            errors: 0,
+            warnings: 0,
+            ignored: 0,
+        });
+        yield wrapper_1.commandWrapper(bundle_1.handleBundle)({
+            apis,
+            ext: 'yaml',
+            format: 'codeframe',
+            lint: false,
+        });
+        expect(utils_1.handleError).toHaveBeenCalledTimes(0);
+    }));
 });

package/lib/__tests__/commands/join.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/commands/join.test.js

@@ -0,0 +1,85 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const join_1 = require("../../commands/join");
+const utils_1 = require("../../utils");
+const colorette_1 = require("colorette");
+const openapi_core_1 = require("@redocly/openapi-core");
+const openapi_core_2 = require("../../__mocks__/@redocly/openapi-core");
+const config_1 = require("../fixtures/config");
+jest.mock('../../utils');
+jest.mock('colorette');
+describe('handleJoin fails', () => {
+    const colloreteYellowMock = colorette_1.yellow;
+    colloreteYellowMock.mockImplementation((string) => string);
+    it('should call exitWithError because only one entrypoint', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield join_1.handleJoin({ apis: ['first.yaml'] }, {}, 'cli-version');
+        expect(utils_1.exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
+    }));
+    it('should call exitWithError because passed all 3 options for tags', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+            'prefix-tags-with-info-prop': 'something',
+            'without-x-tag-groups': true,
+            'prefix-tags-with-filename': true,
+        }, {}, 'cli-version');
+        expect(utils_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`);
+    }));
+    it('should call exitWithError because passed all 2 options for tags', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+            'without-x-tag-groups': true,
+            'prefix-tags-with-filename': true,
+        }, {}, 'cli-version');
+        expect(utils_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`);
+    }));
+    it('should call exitWithError because Only OpenAPI 3 is supported', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+        }, config_1.ConfigFixture, 'cli-version');
+        expect(utils_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3 is supported: undefined \n\n');
+    }));
+    it('should call writeYaml function', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+        }, config_1.ConfigFixture, 'cli-version');
+        expect(utils_1.writeYaml).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
+    }));
+    it('should call writeYaml function with custom output file', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+            output: 'output.yml',
+        }, config_1.ConfigFixture, 'cli-version');
+        expect(utils_1.writeYaml).toHaveBeenCalledWith(expect.any(Object), 'output.yml', expect.any(Boolean));
+    }));
+    it('should call skipDecorators and skipPreprocessors', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+        }, config_1.ConfigFixture, 'cli-version');
+        const config = openapi_core_2.loadConfig();
+        expect(config.styleguide.skipDecorators).toHaveBeenCalled();
+        expect(config.styleguide.skipPreprocessors).toHaveBeenCalled();
+    }));
+    it('should not call skipDecorators and skipPreprocessors', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+            decorate: true,
+            preprocess: true,
+        }, config_1.ConfigFixture, 'cli-version');
+        const config = openapi_core_2.loadConfig();
+        expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
+        expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
+    }));
+});

package/lib/__tests__/commands/lint.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/commands/lint.test.js

@@ -0,0 +1,149 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lint_1 = require("../../commands/lint");
+const openapi_core_1 = require("@redocly/openapi-core");
+const utils_1 = require("../../utils");
+const config_1 = require("../fixtures/config");
+const perf_hooks_1 = require("perf_hooks");
+const wrapper_1 = require("../../wrapper");
+const colorette_1 = require("colorette");
+jest.mock('@redocly/openapi-core');
+jest.mock('../../utils');
+jest.mock('perf_hooks');
+jest.mock('../../update-version-notifier', () => ({
+    version: '1.0.0',
+}));
+const argvMock = {
+    apis: ['openapi.yaml'],
+    'lint-config': 'off',
+    format: 'codeframe',
+};
+describe('handleLint', () => {
+    let processExitMock;
+    let exitCb;
+    const getMergedConfigMock = openapi_core_1.getMergedConfig;
+    beforeEach(() => {
+        jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+        perf_hooks_1.performance.now.mockImplementation(() => 42);
+        processExitMock = jest.spyOn(process, 'exit').mockImplementation();
+        jest.spyOn(process, 'once').mockImplementation((_e, cb) => {
+            exitCb = cb;
+            return process.on(_e, cb);
+        });
+        getMergedConfigMock.mockReturnValue(config_1.ConfigFixture);
+        openapi_core_1.doesYamlFileExist.mockImplementation((path) => path === 'redocly.yaml');
+    });
+    afterEach(() => {
+        getMergedConfigMock.mockReset();
+    });
+    describe('loadConfig and getEnrtypoints stage', () => {
+        it('should fail if config file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { config: 'config.yaml' }));
+            expect(utils_1.exitWithError).toHaveBeenCalledWith('Please, provide valid path to the configuration file');
+        }));
+        it('should call loadConfigAndHandleErrors and getFallbackApisOrExit', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            expect(utils_1.loadConfigAndHandleErrors).toHaveBeenCalledWith({
+                configPath: undefined,
+                customExtends: undefined,
+                processRawConfig: undefined,
+            });
+            expect(utils_1.getFallbackApisOrExit).toHaveBeenCalled();
+        }));
+        it('should call loadConfig with args if such exist', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { config: 'redocly.yaml', extends: ['some/path'] }));
+            expect(utils_1.loadConfigAndHandleErrors).toHaveBeenCalledWith({
+                configPath: 'redocly.yaml',
+                customExtends: ['some/path'],
+                processRawConfig: undefined,
+            });
+        }));
+        it('should call mergedConfig with clear ignore if `generate-ignore-file` argv', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { 'generate-ignore-file': true }));
+            expect(getMergedConfigMock).toHaveBeenCalled();
+        }));
+        it('should check if ruleset exist', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            expect(utils_1.checkIfRulesetExist).toHaveBeenCalledTimes(1);
+        }));
+        it('should fail if apis not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { apis: [] }));
+            expect(utils_1.getFallbackApisOrExit).toHaveBeenCalledTimes(1);
+            expect(utils_1.exitWithError).toHaveBeenCalledWith('No APIs were provided');
+        }));
+    });
+    describe('loop through entrypoints and lint stage', () => {
+        it('should call getMergedConfig and lint ', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            expect(perf_hooks_1.performance.now).toHaveBeenCalled();
+            expect(getMergedConfigMock).toHaveBeenCalled();
+            expect(openapi_core_1.lint).toHaveBeenCalled();
+        }));
+        it('should call skipRules,skipPreprocessors and addIgnore with argv', () => __awaiter(void 0, void 0, void 0, function* () {
+            openapi_core_1.lint.mockResolvedValueOnce(['problem']);
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { 'skip-preprocessor': ['preprocessor'], 'skip-rule': ['rule'], 'generate-ignore-file': true }));
+            expect(config_1.ConfigFixture.styleguide.skipRules).toHaveBeenCalledWith(['rule']);
+            expect(config_1.ConfigFixture.styleguide.skipPreprocessors).toHaveBeenCalledWith(['preprocessor']);
+        }));
+        it('should call formatProblems and getExecutionTime with argv', () => __awaiter(void 0, void 0, void 0, function* () {
+            openapi_core_1.lint.mockResolvedValueOnce(['problem']);
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { 'max-problems': 2, format: 'stylish' }));
+            expect(openapi_core_1.getTotals).toHaveBeenCalledWith(['problem']);
+            expect(openapi_core_1.formatProblems).toHaveBeenCalledWith(['problem'], {
+                format: 'stylish',
+                maxProblems: 2,
+                totals: { errors: 0 },
+                version: '1.0.0',
+            });
+            expect(utils_1.getExecutionTime).toHaveBeenCalledWith(42);
+        }));
+        it('should catch error in handleError if something fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            openapi_core_1.lint.mockRejectedValueOnce('error');
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            expect(utils_1.handleError).toHaveBeenCalledWith('error', 'openapi.yaml');
+        }));
+    });
+    describe('erros and warning handle after lint stage', () => {
+        it('should call printLintTotals and printLintTotals', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            expect(utils_1.printUnusedWarnings).toHaveBeenCalled();
+        }));
+        it('should call exit with 0 if no errors', () => __awaiter(void 0, void 0, void 0, function* () {
+            utils_1.loadConfigAndHandleErrors.mockImplementation(() => {
+                return Object.assign({}, config_1.ConfigFixture);
+            });
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
+            expect(processExitMock).toHaveBeenCalledWith(0);
+        }));
+        it('should exit with 1 if total errors > 0', () => __awaiter(void 0, void 0, void 0, function* () {
+            openapi_core_1.getTotals.mockReturnValueOnce({ errors: 1 });
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            yield (exitCb === null || exitCb === void 0 ? void 0 : exitCb());
+            expect(processExitMock).toHaveBeenCalledWith(1);
+        }));
+        it('should use recommended fallback if no config', () => __awaiter(void 0, void 0, void 0, function* () {
+            openapi_core_1.getMergedConfig.mockImplementation(() => {
+                return {
+                    styleguide: {
+                        recommendedFallback: true,
+                        rules: {},
+                        skipRules: jest.fn(),
+                        skipPreprocessors: jest.fn(),
+                    },
+                };
+            });
+            yield wrapper_1.commandWrapper(lint_1.handleLint)(argvMock);
+            expect(process.stderr.write).toHaveBeenCalledWith(`No configurations were provided -- using built in ${colorette_1.blue('recommended')} configuration by default.\n\n`);
+        }));
+    });
+});

package/lib/__tests__/commands/push-region.test.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const openapi_core_1 = require("@redocly/openapi-core");
 const push_1 = require("../../commands/push");
 const login_1 = require("../../commands/login");
+const config_1 = require("../fixtures/config");
 jest.mock('fs');
 jest.mock('node-fetch', () => ({
     default: jest.fn(() => ({
@@ -34,10 +35,10 @@ describe('push-with-region', () => {
         redoclyClient.domain = 'redoc.ly';
         yield push_1.handlePush({
             upsert: true,
-            entrypoint: 'spec.json',
+            api: 'spec.json',
             destination: '@org/my-api@1.0.0',
             branchName: 'test',
-        });
+        }, config_1.ConfigFixture);
         expect(mockPromptClientToken).toBeCalledTimes(1);
         expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
     }));
@@ -45,10 +46,10 @@ describe('push-with-region', () => {
         redoclyClient.domain = 'eu.redocly.com';
         yield push_1.handlePush({
             upsert: true,
-            entrypoint: 'spec.json',
+            api: 'spec.json',
             destination: '@org/my-api@1.0.0',
             branchName: 'test',
-        });
+        }, config_1.ConfigFixture);
         expect(mockPromptClientToken).toBeCalledTimes(1);
         expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
     }));