@redocly/cli 1.34.4 → 2.0.0-next.0

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

@@ -1,553 +0,0 @@
-import * as fs from 'fs';
-import { Config, getMergedConfig } from '@redocly/openapi-core';
-import { exitWithError } from '../../utils/miscellaneous';
-import { getApiRoot, getDestinationProps, handlePush, transformPush } from '../../commands/push';
-import { ConfigFixture } from '../fixtures/config';
-import { yellow } from 'colorette';
-import { Readable } from 'node:stream';
-
-// Mock fs operations
-jest.mock('fs', () => ({
-  ...jest.requireActual('fs'),
-  createReadStream: jest.fn(() => {
-    const readable = new Readable();
-    readable.push('test data');
-    readable.push(null);
-    return readable;
-  }),
-  statSync: jest.fn(() => ({ isDirectory: () => false, size: 10 })),
-  readFileSync: jest.fn(() => Buffer.from('test data')),
-  existsSync: jest.fn(() => false),
-  readdirSync: jest.fn(() => []),
-}));
-
-jest.mock('@redocly/openapi-core');
-jest.mock('../../utils/miscellaneous');
-
-// Mock fetch
-const mockFetch = jest.fn(() =>
-  Promise.resolve({
-    ok: true,
-    status: 200,
-    json: () => Promise.resolve({}),
-    headers: new Headers(),
-    statusText: 'OK',
-    redirected: false,
-    type: 'default',
-    url: '',
-    clone: () => ({} as Response),
-    body: null,
-    bodyUsed: false,
-    arrayBuffer: async () => new ArrayBuffer(0),
-    blob: async () => new Blob(),
-    formData: async () => new FormData(),
-    text: async () => '',
-  } as Response)
-);
-
-const originalFetch = global.fetch;
-
-(getMergedConfig as jest.Mock).mockImplementation((config) => config);
-
-describe('push', () => {
-  const redoclyClient = require('@redocly/openapi-core').__redoclyClient;
-
-  beforeAll(() => {
-    global.fetch = mockFetch;
-  });
-
-  beforeEach(() => {
-    jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
-  });
-
-  afterAll(() => {
-    global.fetch = originalFetch;
-  });
-
-  it('pushes definition', async () => {
-    await handlePush({
-      argv: {
-        upsert: true,
-        api: 'spec.json',
-        destination: '@org/my-api@1.0.0',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: ConfigFixture as any,
-      version: 'cli-version',
-    });
-
-    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 jobId value is an empty string', async () => {
-    await handlePush({
-      argv: {
-        upsert: true,
-        api: 'spec.json',
-        destination: '@org/my-api@1.0.0',
-        branchName: 'test',
-        public: true,
-        'job-id': ' ',
-        'batch-size': 2,
-      },
-      config: ConfigFixture as any,
-      version: 'cli-version',
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-  });
-
-  it('fails if batchSize value is less than 2', async () => {
-    await handlePush({
-      argv: {
-        upsert: true,
-        api: 'spec.json',
-        destination: '@org/my-api@1.0.0',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 1,
-      },
-      config: ConfigFixture as any,
-      version: 'cli-version',
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-  });
-
-  it('push with --files', async () => {
-    const mockConfig = { ...ConfigFixture, files: ['./resouces/1.md', './resouces/2.md'] } as any;
-
-    (fs.statSync as jest.Mock).mockImplementation(() => {
-      return { isDirectory: () => false, size: 10 };
-    });
-
-    await handlePush({
-      argv: {
-        upsert: true,
-        api: 'spec.json',
-        destination: '@org/my-api@1.0.0',
-        public: true,
-        files: ['./resouces/1.md', './resouces/2.md'],
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    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({
-      argv: {
-        upsert: true,
-        api: 'spec.json',
-        destination: 'test@v1',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: ConfigFixture as any,
-      version: 'cli-version',
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-    expect(exitWithError).toBeCalledWith(
-      `No organization provided, please use --organization option or specify the 'organization' field in the config file.`
-    );
-  });
-
-  it('push should work with organization in config', async () => {
-    const mockConfig = { ...ConfigFixture, organization: 'test_org' } as any;
-    await handlePush({
-      argv: {
-        upsert: true,
-        api: 'spec.json',
-        destination: 'my-api@1.0.0',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    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 but api in config is provided', async () => {
-    const mockConfig = {
-      ...ConfigFixture,
-      organization: 'test_org',
-      apis: { 'my-api@1.0.0': { root: 'path' } },
-    } as any;
-
-    await handlePush({
-      argv: {
-        upsert: true,
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-  });
-
-  it('push should fail if apis not provided', async () => {
-    const mockConfig = { organization: 'test_org', apis: {} } as any;
-
-    await handlePush({
-      argv: {
-        upsert: true,
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-    expect(exitWithError).toHaveBeenLastCalledWith(
-      'Api not found. Please make sure you have provided the correct data in the config file.'
-    );
-  });
-
-  it('push should fail if destination not provided', async () => {
-    const mockConfig = { organization: 'test_org', apis: {} } as any;
-
-    await handlePush({
-      argv: {
-        upsert: true,
-        api: 'api.yaml',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    expect(exitWithError).toBeCalledTimes(1);
-    expect(exitWithError).toHaveBeenLastCalledWith(
-      'No destination provided, please use --destination option to provide destination.'
-    );
-  });
-
-  it('push should fail if destination format is not valid', async () => {
-    const mockConfig = { organization: 'test_org', apis: {} } as any;
-
-    await handlePush({
-      argv: {
-        upsert: true,
-        destination: 'name/v1',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    expect(exitWithError).toHaveBeenCalledWith(
-      `Destination argument value is not valid, please use the right format: ${yellow(
-        '<api-name@api-version>'
-      )}.`
-    );
-  });
-
-  it('push should work and encode name with spaces', async () => {
-    const encodeURIComponentSpy = jest.spyOn(global, 'encodeURIComponent');
-
-    const mockConfig = {
-      ...ConfigFixture,
-      organization: 'test_org',
-      apis: { 'my test api@v1': { root: 'path' } },
-    } as any;
-
-    await handlePush({
-      argv: {
-        upsert: true,
-        destination: 'my test api@v1',
-        branchName: 'test',
-        public: true,
-        'job-id': '123',
-        'batch-size': 2,
-      },
-      config: mockConfig,
-      version: 'cli-version',
-    });
-
-    expect(encodeURIComponentSpy).toHaveReturnedWith('my%20test%20api');
-    expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-  });
-});
-
-describe('transformPush', () => {
-  it('should adapt the existing syntax', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        apis: ['openapi.yaml', '@testing_org/main@v1'],
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        api: 'openapi.yaml',
-        destination: '@testing_org/main@v1',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-  it('should adapt the existing syntax (including branchName)', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        api: 'openapi.yaml',
-        destination: '@testing_org/main@v1',
-        branchName: 'other',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-  it('should use --branch option firstly', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
-        branch: 'priority-branch',
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        api: 'openapi.yaml',
-        destination: '@testing_org/main@v1',
-        branchName: 'priority-branch',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-  it('should work for a destination only', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        apis: ['main@v1'],
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        destination: 'main@v1',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-  it('should work for a api only', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        apis: ['test.yaml'],
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        api: 'test.yaml',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-
-  it('should use destination from option', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        apis: ['test.yaml', 'test@v1'],
-        destination: 'main@v1',
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        destination: 'main@v1',
-        api: 'test.yaml',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-
-  it('should use --job-id option firstly', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      argv: {
-        'batch-id': 'b-123',
-        'job-id': 'j-123',
-        apis: ['test'],
-        branch: 'test',
-        destination: 'main@v1',
-      },
-      config: {} as any,
-      version: 'cli-version',
-    });
-    expect(cb).toBeCalledWith({
-      argv: {
-        'job-id': 'j-123',
-        api: 'test',
-        branchName: 'test',
-        destination: 'main@v1',
-      },
-      config: {},
-      version: 'cli-version',
-    });
-  });
-  it('should accept no arguments at all', () => {
-    const cb = jest.fn();
-    transformPush(cb)({ argv: {}, config: {} as any, version: 'cli-version' });
-    expect(cb).toBeCalledWith({ argv: {}, config: {}, version: 'cli-version' });
-  });
-});
-
-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__/fetch-with-timeout.test.ts

@@ -1,81 +0,0 @@
-import AbortController from 'abort-controller';
-import fetchWithTimeout from '../utils/fetch-with-timeout';
-import { getProxyAgent } from '@redocly/openapi-core';
-import { HttpsProxyAgent } from 'https-proxy-agent';
-
-jest.mock('@redocly/openapi-core');
-
-const signalInstance = new AbortController().signal;
-
-const mockFetch = jest.fn(() =>
-  Promise.resolve({
-    ok: true,
-    status: 200,
-    json: () => Promise.resolve({}),
-    headers: new Headers(),
-    statusText: 'OK',
-    redirected: false,
-    type: 'default',
-    url: '',
-    clone: () => ({} as Response),
-    body: null,
-    bodyUsed: false,
-    arrayBuffer: async () => new ArrayBuffer(0),
-    blob: async () => new Blob(),
-    formData: async () => new FormData(),
-    text: async () => '',
-    signal: signalInstance,
-    dispatcher: undefined,
-  } as Response)
-);
-
-const originalFetch = global.fetch;
-global.fetch = mockFetch;
-
-describe('fetchWithTimeout', () => {
-  beforeAll(() => {
-    // @ts-ignore
-    global.setTimeout = jest.fn();
-    global.clearTimeout = jest.fn();
-  });
-
-  beforeEach(() => {
-    (getProxyAgent as jest.Mock).mockReturnValueOnce(undefined);
-  });
-
-  afterAll(() => {
-    global.fetch = originalFetch;
-  });
-
-  it('should call fetch with signal', async () => {
-    await fetchWithTimeout('url', { timeout: 1000 });
-
-    expect(global.setTimeout).toHaveBeenCalledTimes(1);
-    expect(global.fetch).toHaveBeenCalledWith(
-      'url',
-      expect.objectContaining({
-        signal: expect.any(AbortSignal),
-        dispatcher: undefined,
-      })
-    );
-    expect(global.clearTimeout).toHaveBeenCalledTimes(1);
-  });
-
-  it('should call fetch with proxy agent', async () => {
-    (getProxyAgent as jest.Mock).mockRestore();
-    const proxyAgent = new HttpsProxyAgent('http://localhost');
-    (getProxyAgent as jest.Mock).mockReturnValueOnce(proxyAgent);
-
-    await fetchWithTimeout('url');
-
-    expect(global.fetch).toHaveBeenCalledWith('url', { dispatcher: proxyAgent });
-  });
-
-  it('should call fetch without signal when timeout is not passed', async () => {
-    await fetchWithTimeout('url');
-
-    expect(global.setTimeout).not.toHaveBeenCalled();
-    expect(global.fetch).toHaveBeenCalledWith('url', { agent: undefined });
-    expect(global.clearTimeout).not.toHaveBeenCalled();
-  });
-});

package/src/__tests__/fixtures/config.ts

@@ -1,21 +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,
-    decorators: {
-      oas2: {},
-      oas3_0: {},
-      oas3_1: {},
-    },
-    preprocessors: {
-      oas2: {},
-      oas3_0: {},
-      oas3_1: {},
-    },
-  },
-};

package/src/__tests__/spinner.test.ts

@@ -1,51 +0,0 @@
-import { Spinner } from '../utils/spinner';
-import * as process from 'process';
-
-jest.useFakeTimers();
-
-describe('Spinner', () => {
-  const IS_TTY = process.stdout.isTTY;
-
-  let writeMock: jest.SpyInstance;
-  let spinner: Spinner;
-
-  beforeEach(() => {
-    process.stdout.isTTY = true;
-    writeMock = jest.spyOn(process.stdout, 'write').mockImplementation(jest.fn());
-    spinner = new Spinner();
-  });
-
-  afterEach(() => {
-    writeMock.mockRestore();
-    jest.clearAllTimers();
-  });
-
-  afterAll(() => {
-    process.stdout.isTTY = IS_TTY;
-  });
-
-  it('starts the spinner', () => {
-    spinner.start('Loading');
-    jest.advanceTimersByTime(100);
-    expect(writeMock).toHaveBeenCalledWith('\r⠋ Loading');
-  });
-
-  it('stops the spinner', () => {
-    spinner.start('Loading');
-    spinner.stop();
-    expect(writeMock).toHaveBeenCalledWith('\r');
-  });
-
-  it('should write 3 frames', () => {
-    spinner.start('Loading');
-    jest.advanceTimersByTime(300);
-    expect(writeMock).toHaveBeenCalledTimes(3);
-  });
-
-  it('should call write 1 times if CI set to true', () => {
-    process.stdout.isTTY = false;
-    spinner.start('Loading');
-    jest.advanceTimersByTime(300);
-    expect(writeMock).toHaveBeenCalledTimes(1);
-  });
-});