@redocly/cli 1.0.0-beta.125 → 1.0.0-beta.127

package/src/__tests__/commands/join.test.ts

@@ -1,83 +0,0 @@
-import { handleJoin } from '../../commands/join';
-import { exitWithError, writeYaml } from '../../utils';
-import { yellow } from 'colorette';
-import { detectOpenAPI } from '@redocly/openapi-core';
-
-jest.mock('../../utils');
-jest.mock('colorette');
-
-describe('handleJoin fails', () => {
-  const colloreteYellowMock = yellow as jest.Mock<any, any>;
-  colloreteYellowMock.mockImplementation((string: string) => string);
-
-  it('should call exitWithError because only one entrypoint', async () => {
-    await handleJoin({ apis: ['first.yaml'] }, 'cli-version');
-    expect(exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
-  });
-
-  it('should call exitWithError because passed all 3 options for tags', async () => {
-    await 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(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', async () => {
-    await handleJoin(
-      {
-        apis: ['first.yaml', 'second.yaml'],
-        'without-x-tag-groups': true,
-        'prefix-tags-with-filename': true,
-      },
-      'cli-version'
-    );
-
-    expect(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', async () => {
-    await handleJoin(
-      {
-        apis: ['first.yaml', 'second.yaml'],
-      },
-      'cli-version'
-    );
-    expect(exitWithError).toHaveBeenCalledWith('Only OpenAPI 3 is supported: undefined \n\n');
-  });
-
-  it('should call writeYaml function', async () => {
-    (detectOpenAPI as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
-        apis: ['first.yaml', 'second.yaml'],
-      },
-      'cli-version'
-    );
-
-    expect(writeYaml).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
-  });
-
-  it('should call writeYaml function with custom output file', async () => {
-    (detectOpenAPI as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
-        apis: ['first.yaml', 'second.yaml'],
-        output: 'output.yml',
-      },
-      'cli-version'
-    );
-
-    expect(writeYaml).toHaveBeenCalledWith(expect.any(Object), 'output.yml', expect.any(Boolean));
-  });
-});

package/src/__tests__/commands/lint.test.ts

@@ -1,154 +0,0 @@
-import { handleLint, LintOptions } from '../../commands/lint';
-import {
-  getMergedConfig,
-  lint,
-  getTotals,
-  formatProblems,
-  doesYamlFileExist,
-} from '@redocly/openapi-core';
-import {
-  getFallbackApisOrExit,
-  getExecutionTime,
-  printUnusedWarnings,
-  handleError,
-  exitWithError,
-  loadConfigAndHandleErrors,
-} from '../../utils';
-import { ConfigFixture } from '../fixtures/config';
-import { performance } from 'perf_hooks';
-
-jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
-jest.mock('perf_hooks');
-
-const argvMock: LintOptions = {
-  apis: ['openapi.yaml'],
-  'lint-config': 'off',
-  format: 'codeframe',
-};
-
-const versionMock = '1.0.0';
-
-describe('handleLint', () => {
-  let processExitMock: jest.SpyInstance;
-  let exitCb: any;
-  const getMergedConfigMock = getMergedConfig as jest.Mock<any, any>;
-
-  beforeEach(() => {
-    jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-    (performance.now as jest.Mock<any, any>).mockImplementation(() => 42);
-    processExitMock = jest.spyOn(process, 'exit').mockImplementation();
-    jest.spyOn(process, 'once').mockImplementation((_e, cb) => {
-      exitCb = cb;
-      return process.on(_e, cb);
-    });
-    getMergedConfigMock.mockReturnValue(ConfigFixture);
-    (doesYamlFileExist as jest.Mock<any, any>).mockImplementation(
-      (path) => path === 'redocly.yaml'
-    );
-  });
-
-  afterEach(() => {
-    getMergedConfigMock.mockReset();
-  });
-
-  describe('loadConfig and getEnrtypoints stage', () => {
-    it('should fail if config file does not exist', async () => {
-      await handleLint({ ...argvMock, config: 'config.yaml' }, versionMock);
-      expect(exitWithError).toHaveBeenCalledWith(
-        'Please, provide valid path to the configuration file'
-      );
-      expect(loadConfigAndHandleErrors).toHaveBeenCalledTimes(0);
-    });
-
-    it('should call loadConfigAndHandleErrors and getFallbackApisOrExit', async () => {
-      await handleLint(argvMock, versionMock);
-      expect(loadConfigAndHandleErrors).toHaveBeenCalledWith({
-        configPath: undefined,
-        customExtends: undefined,
-        processRawConfig: undefined,
-      });
-      expect(getFallbackApisOrExit).toHaveBeenCalled();
-    });
-
-    it('should call loadConfig with args if such exist', async () => {
-      await handleLint(
-        { ...argvMock, config: 'redocly.yaml', extends: ['some/path'] },
-        versionMock
-      );
-      expect(loadConfigAndHandleErrors).toHaveBeenCalledWith({
-        configPath: 'redocly.yaml',
-        customExtends: ['some/path'],
-        processRawConfig: undefined,
-      });
-    });
-
-    it('should call mergedConfig with clear ignore if `generate-ignore-file` argv', async () => {
-      await handleLint({ ...argvMock, 'generate-ignore-file': true }, versionMock);
-      expect(getMergedConfigMock).toHaveBeenCalled();
-    });
-  });
-
-  describe('loop through entrypints and lint stage', () => {
-    it('should call getMergedConfig and lint ', async () => {
-      await handleLint(argvMock, versionMock);
-      expect(performance.now).toHaveBeenCalled();
-      expect(getMergedConfigMock).toHaveBeenCalled();
-      expect(lint).toHaveBeenCalled();
-    });
-
-    it('should call skipRules,skipPreprocessors and addIgnore with argv', async () => {
-      (lint as jest.Mock<any, any>).mockResolvedValueOnce(['problem']);
-      await handleLint(
-        {
-          ...argvMock,
-          'skip-preprocessor': ['preprocessor'],
-          'skip-rule': ['rule'],
-          'generate-ignore-file': true,
-        },
-        versionMock
-      );
-      expect(ConfigFixture.styleguide.skipRules).toHaveBeenCalledWith(['rule']);
-      expect(ConfigFixture.styleguide.skipPreprocessors).toHaveBeenCalledWith(['preprocessor']);
-    });
-
-    it('should call formatProblems and getExecutionTime with argv', async () => {
-      (lint as jest.Mock<any, any>).mockResolvedValueOnce(['problem']);
-      await handleLint({ ...argvMock, 'max-problems': 2, format: 'stylish' }, versionMock);
-      expect(getTotals).toHaveBeenCalledWith(['problem']);
-      expect(formatProblems).toHaveBeenCalledWith(['problem'], {
-        format: 'stylish',
-        maxProblems: 2,
-        totals: { errors: 0 },
-        version: versionMock,
-      });
-      expect(getExecutionTime).toHaveBeenCalledWith(42);
-    });
-
-    it('should catch error in handleError if something fails', async () => {
-      (lint as jest.Mock<any, any>).mockRejectedValueOnce('error');
-      await handleLint(argvMock, versionMock);
-      expect(handleError).toHaveBeenCalledWith('error', 'openapi.yaml');
-    });
-  });
-
-  describe('erros and warning handle after lint stage', () => {
-    it('should call printLintTotals and printLintTotals', async () => {
-      await handleLint(argvMock, versionMock);
-      expect(printUnusedWarnings).toHaveBeenCalled();
-    });
-
-    it('should call exit with 0 if no errors', async () => {
-      await handleLint(argvMock, versionMock);
-      exitCb?.();
-      expect(processExitMock).toHaveBeenCalledWith(0);
-    });
-
-    it('should exit with 1 if tootals error > 0', async () => {
-      (getTotals as jest.Mock<any, any>).mockReturnValueOnce({ errors: 1 });
-      await handleLint(argvMock, versionMock);
-      exitCb?.();
-      expect(processExitMock).toHaveBeenCalledWith(1);
-    });
-  });
-});

package/src/__tests__/commands/push-region.test.ts

@@ -1,51 +0,0 @@
-import { getMergedConfig } from '@redocly/openapi-core';
-import { handlePush } from '../../commands/push';
-import { promptClientToken } from '../../commands/login';
-
-jest.mock('fs');
-jest.mock('node-fetch', () => ({
-  default: jest.fn(() => ({
-    ok: true,
-    json: jest.fn().mockResolvedValue({}),
-  })),
-}));
-jest.mock('@redocly/openapi-core');
-jest.mock('../../commands/login');
-jest.mock('../../utils');
-
-(getMergedConfig as jest.Mock).mockImplementation((config) => config);
-
-const mockPromptClientToken = promptClientToken as jest.MockedFunction<typeof promptClientToken>;
-
-describe('push-with-region', () => {
-  const redoclyClient = require('@redocly/openapi-core').__redoclyClient;
-  redoclyClient.isAuthorizedWithRedoclyByRegion = jest.fn().mockResolvedValue(false);
-
-  beforeAll(() => {
-    jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
-  });
-
-  it('should call login with default domain when region is US', async () => {
-    redoclyClient.domain = 'redoc.ly';
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-    });
-    expect(mockPromptClientToken).toBeCalledTimes(1);
-    expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
-  });
-
-  it('should call login with EU domain when region is EU', async () => {
-    redoclyClient.domain = 'eu.redocly.com';
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-    });
-    expect(mockPromptClientToken).toBeCalledTimes(1);
-    expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
-  });
-});

package/src/__tests__/commands/push.test.ts

@@ -1,342 +0,0 @@
-import * as fs from 'fs';
-import { Config, getMergedConfig } from '@redocly/openapi-core';
-import { exitWithError, loadConfigAndHandleErrors } from '../../utils';
-import { getApiRoot, getDestinationProps, handlePush, transformPush } from '../../commands/push';
-import { ConfigFixture } from '../fixtures/config';
-import { yellow } from 'colorette';
-
-jest.mock('fs');
-jest.mock('node-fetch', () => ({
-  default: jest.fn(() => ({
-    ok: true,
-    json: jest.fn().mockResolvedValue({}),
-  })),
-}));
-jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
-
-(getMergedConfig as jest.Mock).mockImplementation((config) => config);
-
-describe('push', () => {
-  const redoclyClient = require('@redocly/openapi-core').__redoclyClient;
-
-  beforeEach(() => {
-    jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
-  });
-
-  it('pushes definition', async () => {
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-      public: true,
-      'batch-id': '123',
-      'batch-size': 2,
-    });
-
-    expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(1);
-    expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-    expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
-      branch: 'test',
-      filePaths: ['filePath'],
-      isUpsert: true,
-      isPublic: true,
-      name: 'my-api',
-      organizationId: 'org',
-      rootFilePath: 'filePath',
-      version: '1.0.0',
-      batchId: '123',
-      batchSize: 2,
-    });
-  });
-
-  it('fails if batchId value is an empty string', async () => {
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-      public: true,
-      'batch-id': ' ',
-      'batch-size': 2,
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-  });
-
-  it('fails if batchSize value is less than 2', async () => {
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-      public: true,
-      'batch-id': '123',
-      'batch-size': 1,
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-  });
-
-  it('push with --files', async () => {
-    (loadConfigAndHandleErrors as jest.Mock).mockImplementation(({ files }) => {
-      return { ...ConfigFixture, files };
-    });
-
-    //@ts-ignore
-    fs.statSync.mockImplementation(() => {
-      return { isDirectory: () => false, size: 10 };
-    });
-
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      public: true,
-      files: ['./resouces/1.md', './resouces/2.md'],
-    });
-
-    expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
-      filePaths: ['filePath', 'filePath', 'filePath'],
-      isUpsert: true,
-      isPublic: true,
-      name: 'my-api',
-      organizationId: 'org',
-      rootFilePath: 'filePath',
-      version: '1.0.0',
-    });
-    expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(3);
-  });
-
-  it('push should fail if organization not provided', async () => {
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: 'test@v1',
-      branchName: 'test',
-      public: true,
-      'batch-id': '123',
-      'batch-size': 2,
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-    expect(exitWithError).toBeCalledWith(
-      `No organization provided, please use the right format: ${yellow(
-        '<@organization-id/api-name@api-version>'
-      )} or specify the 'organization' field in the config file.`
-    );
-  });
-
-  it('push should work with organization in config', async () => {
-    (loadConfigAndHandleErrors as jest.Mock).mockImplementation(() => {
-      return { ...ConfigFixture, organization: 'test_org' };
-    });
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      destination: 'my-api@1.0.0',
-      branchName: 'test',
-      public: true,
-      'batch-id': '123',
-      'batch-size': 2,
-    });
-
-    expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-    expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
-      branch: 'test',
-      filePaths: ['filePath'],
-      isUpsert: true,
-      isPublic: true,
-      name: 'my-api',
-      organizationId: 'test_org',
-      rootFilePath: 'filePath',
-      version: '1.0.0',
-      batchId: '123',
-      batchSize: 2,
-    });
-  });
-
-  it('push should work if destination not provided and api in config is provided', async () => {
-    (loadConfigAndHandleErrors as jest.Mock).mockImplementation(() => {
-      return {
-        ...ConfigFixture,
-        organization: 'test_org',
-        apis: { 'my-api@1.0.0': { root: 'path' } },
-      };
-    });
-    await handlePush({
-      upsert: true,
-      api: 'spec.json',
-      branchName: 'test',
-      public: true,
-      'batch-id': '123',
-      'batch-size': 2,
-    });
-
-    expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-  });
-
-  it('push should fail if destination and apis not provided', async () => {
-    (loadConfigAndHandleErrors as jest.Mock).mockImplementation(() => {
-      return { organization: 'test_org', apis: {} };
-    });
-    await handlePush({
-      upsert: true,
-      branchName: 'test',
-      public: true,
-      'batch-id': '123',
-      'batch-size': 2,
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-    expect(exitWithError).toHaveBeenLastCalledWith(
-      'Api not found. Please make sure you have provided the correct data in the config file.'
-    );
-  });
-});
-
-describe('transformPush', () => {
-  it('should adapt the existing syntax', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeApiOrDestination: 'openapi.yaml',
-      maybeDestination: '@testing_org/main@v1',
-    });
-    expect(cb).toBeCalledWith({
-      api: 'openapi.yaml',
-      destination: '@testing_org/main@v1',
-    });
-  });
-  it('should adapt the existing syntax (including branchName)', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeApiOrDestination: 'openapi.yaml',
-      maybeDestination: '@testing_org/main@v1',
-      maybeBranchName: 'other',
-    });
-    expect(cb).toBeCalledWith({
-      api: 'openapi.yaml',
-      destination: '@testing_org/main@v1',
-      branchName: 'other',
-    });
-  });
-  it('should use --branch option firstly', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeApiOrDestination: 'openapi.yaml',
-      maybeDestination: '@testing_org/main@v1',
-      maybeBranchName: 'other',
-      branch: 'priority-branch',
-    });
-    expect(cb).toBeCalledWith({
-      api: 'openapi.yaml',
-      destination: '@testing_org/main@v1',
-      branchName: 'priority-branch',
-    });
-  });
-  it('should work for a destination only', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeApiOrDestination: '@testing_org/main@v1',
-    });
-    expect(cb).toBeCalledWith({
-      destination: '@testing_org/main@v1',
-    });
-  });
-  it('should accept aliases for the old syntax', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeApiOrDestination: 'alias',
-      maybeDestination: '@testing_org/main@v1',
-    });
-    expect(cb).toBeCalledWith({
-      destination: '@testing_org/main@v1',
-      api: 'alias',
-    });
-  });
-  it('should accept no arguments at all', () => {
-    const cb = jest.fn();
-    transformPush(cb)({});
-    expect(cb).toBeCalledWith({});
-  });
-});
-
-describe('getDestinationProps', () => {
-  it('should get valid destination props for the full destination syntax', () => {
-    expect(getDestinationProps('@testing_org/main@v1', 'org-from-config')).toEqual({
-      organizationId: 'testing_org',
-      name: 'main',
-      version: 'v1',
-    });
-  });
-  it('should fallback the organizationId from a config for the short destination syntax', () => {
-    expect(getDestinationProps('main@v1', 'org-from-config')).toEqual({
-      organizationId: 'org-from-config',
-      name: 'main',
-      version: 'v1',
-    });
-  });
-  it('should fallback the organizationId from a config if no destination provided', () => {
-    expect(getDestinationProps(undefined, 'org-from-config')).toEqual({
-      organizationId: 'org-from-config',
-    });
-  });
-  it('should return empty organizationId if there is no one found', () => {
-    expect(getDestinationProps('main@v1', undefined)).toEqual({
-      organizationId: undefined,
-      name: 'main',
-      version: 'v1',
-    });
-  });
-  it('should return organizationId from destination string', () => {
-    expect(getDestinationProps('@test-org/main@main-v1', undefined)).toEqual({
-      organizationId: 'test-org',
-      name: 'main',
-      version: 'main-v1',
-    });
-  });
-
-  it('should return organizationId, version and empty name from destination string', () => {
-    expect(getDestinationProps('@test_org/@main_v1', undefined)).toEqual({
-      organizationId: 'test_org',
-      name: '',
-      version: 'main_v1',
-    });
-  });
-
-  it('should validate organizationId with space and version with dot', () => {
-    expect(getDestinationProps('@test org/simple_name@main.v1', undefined)).toEqual({
-      organizationId: 'test org',
-      name: 'simple_name',
-      version: 'main.v1',
-    });
-  });
-
-  it('should not work with "@" in destination name', () => {
-    expect(getDestinationProps('@test org/simple@name@main.v1', undefined)).toEqual({
-      organizationId: undefined,
-      name: undefined,
-      version: undefined,
-    });
-  });
-});
-
-describe('getApiRoot', () => {
-  let config: Config = {
-    apis: {
-      'main@v1': {
-        root: 'openapi.yaml',
-      },
-      main: {
-        root: 'latest.yaml',
-      },
-    },
-  } as unknown as Config;
-  it('should resolve the correct api for a valid name & version', () => {
-    expect(getApiRoot({ name: 'main', version: 'v1', config })).toEqual('openapi.yaml');
-  });
-  it('should resolve the latest version of api if there is no matching version', () => {
-    expect(getApiRoot({ name: 'main', version: 'latest', config })).toEqual('latest.yaml');
-  });
-});

package/src/__tests__/fixtures/config.ts

@@ -1,11 +0,0 @@
-export const ConfigFixture = {
-  configFile: null,
-  styleguide: {
-    addIgnore: jest.fn(),
-    skipRules: jest.fn(),
-    skipPreprocessors: jest.fn(),
-    saveIgnore: jest.fn(),
-    skipDecorators: jest.fn(),
-    ignore: null,
-  },
-};