@redocly/cli 1.18.1 → 1.20.0

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

@@ -14,21 +14,21 @@ describe('handleJoin', () => {
   colloreteYellowMock.mockImplementation((string: string) => string);
 
   it('should call exitWithError because only one entrypoint', async () => {
-    await handleJoin({ apis: ['first.yaml'] }, {} as any, 'cli-version');
+    await handleJoin({ argv: { apis: ['first.yaml'] }, config: {} as any, version: 'cli-version' });
     expect(exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided.`);
   });
 
   it('should call exitWithError because passed all 3 options for tags', async () => {
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
         'prefix-tags-with-info-prop': 'something',
         'without-x-tag-groups': true,
         'prefix-tags-with-filename': true,
       },
-      {} as any,
-      'cli-version'
-    );
+      config: {} as any,
+      version: '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!`
@@ -36,15 +36,15 @@ describe('handleJoin', () => {
   });
 
   it('should call exitWithError because passed all 2 options for tags', async () => {
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
         'without-x-tag-groups': true,
         'prefix-tags-with-filename': true,
       },
-      {} as any,
-      'cli-version'
-    );
+      config: {} as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toHaveBeenCalledWith(
       `You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one!`
@@ -52,13 +52,13 @@ describe('handleJoin', () => {
   });
 
   it('should call exitWithError because Only OpenAPI 3.0 and OpenAPI 3.1 are supported', async () => {
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
     expect(exitWithError).toHaveBeenCalledWith(
       'Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined.'
     );
@@ -68,13 +68,13 @@ describe('handleJoin', () => {
     (detectSpec as jest.Mock)
       .mockImplementationOnce(() => 'oas3_0')
       .mockImplementationOnce(() => 'oas3_1');
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toHaveBeenCalledWith(
       'All APIs must use the same OpenAPI version: undefined.'
@@ -83,13 +83,13 @@ describe('handleJoin', () => {
 
   it('should call writeToFileByExtension function', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(writeToFileByExtension).toHaveBeenCalledWith(
       expect.any(Object),
@@ -100,13 +100,13 @@ describe('handleJoin', () => {
 
   it('should call writeToFileByExtension function for OpenAPI 3.1', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_1');
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(writeToFileByExtension).toHaveBeenCalledWith(
       expect.any(Object),
@@ -117,14 +117,14 @@ describe('handleJoin', () => {
 
   it('should call writeToFileByExtension function with custom output file', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
         output: 'output.yml',
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(writeToFileByExtension).toHaveBeenCalledWith(
       expect.any(Object),
@@ -135,13 +135,13 @@ describe('handleJoin', () => {
 
   it('should call writeToFileByExtension function with json file extension', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.json', 'second.yaml'],
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(writeToFileByExtension).toHaveBeenCalledWith(
       expect.any(Object),
@@ -152,13 +152,13 @@ describe('handleJoin', () => {
 
   it('should call skipDecorators and skipPreprocessors', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml'],
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     const config = loadConfig();
     expect(config.styleguide.skipDecorators).toHaveBeenCalled();
@@ -168,15 +168,15 @@ describe('handleJoin', () => {
   it('should handle join with prefix-components-with-info-prop and null values', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
 
-    await handleJoin(
-      {
+    await handleJoin({
+      argv: {
         apis: ['first.yaml', 'second.yaml', 'third.yaml'],
         'prefix-components-with-info-prop': 'title',
         output: 'join-result.yaml',
       },
-      ConfigFixture as any,
-      'cli-version'
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(writeToFileByExtension).toHaveBeenCalledWith(
       {

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

@@ -28,30 +28,32 @@ describe('push-with-region', () => {
 
   it('should call login with default domain when region is US', async () => {
     redoclyClient.domain = 'redoc.ly';
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
         branchName: 'test',
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
     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(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
         branchName: 'test',
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
     expect(mockPromptClientToken).toBeCalledTimes(1);
     expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
   });

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

@@ -25,8 +25,8 @@ describe('push', () => {
   });
 
   it('pushes definition', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
@@ -35,8 +35,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(1);
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
@@ -55,8 +56,8 @@ describe('push', () => {
   });
 
   it('fails if jobId value is an empty string', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
@@ -65,15 +66,16 @@ describe('push', () => {
         'job-id': ' ',
         'batch-size': 2,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
   });
 
   it('fails if batchSize value is less than 2', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
@@ -82,8 +84,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 1,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
   });
@@ -95,16 +98,17 @@ describe('push', () => {
       return { isDirectory: () => false, size: 10 };
     });
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: '@org/my-api@1.0.0',
         public: true,
         files: ['./resouces/1.md', './resouces/2.md'],
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
       filePaths: ['filePath', 'filePath', 'filePath'],
@@ -119,8 +123,8 @@ describe('push', () => {
   });
 
   it('push should fail if organization not provided', async () => {
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: 'test@v1',
@@ -129,8 +133,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      ConfigFixture as any
-    );
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
     expect(exitWithError).toBeCalledWith(
@@ -140,8 +145,8 @@ describe('push', () => {
 
   it('push should work with organization in config', async () => {
     const mockConfig = { ...ConfigFixture, organization: 'test_org' } as any;
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'spec.json',
         destination: 'my-api@1.0.0',
@@ -150,8 +155,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
     expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
@@ -175,16 +181,17 @@ describe('push', () => {
       apis: { 'my-api@1.0.0': { root: 'path' } },
     } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         branchName: 'test',
         public: true,
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
   });
@@ -192,16 +199,17 @@ describe('push', () => {
   it('push should fail if apis not provided', async () => {
     const mockConfig = { organization: 'test_org', apis: {} } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         branchName: 'test',
         public: true,
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
     expect(exitWithError).toHaveBeenLastCalledWith(
@@ -212,8 +220,8 @@ describe('push', () => {
   it('push should fail if destination not provided', async () => {
     const mockConfig = { organization: 'test_org', apis: {} } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         api: 'api.yaml',
         branchName: 'test',
@@ -221,8 +229,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toBeCalledTimes(1);
     expect(exitWithError).toHaveBeenLastCalledWith(
@@ -233,8 +242,8 @@ describe('push', () => {
   it('push should fail if destination format is not valid', async () => {
     const mockConfig = { organization: 'test_org', apis: {} } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         destination: 'name/v1',
         branchName: 'test',
@@ -242,8 +251,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(exitWithError).toHaveBeenCalledWith(
       `Destination argument value is not valid, please use the right format: ${yellow(
@@ -261,8 +271,8 @@ describe('push', () => {
       apis: { 'my test api@v1': { root: 'path' } },
     } as any;
 
-    await handlePush(
-      {
+    await handlePush({
+      argv: {
         upsert: true,
         destination: 'my test api@v1',
         branchName: 'test',
@@ -270,8 +280,9 @@ describe('push', () => {
         'job-id': '123',
         'batch-size': 2,
       },
-      mockConfig
-    );
+      config: mockConfig,
+      version: 'cli-version',
+    });
 
     expect(encodeURIComponentSpy).toHaveReturnedWith('my%20test%20api');
     expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
@@ -281,130 +292,144 @@ describe('push', () => {
 describe('transformPush', () => {
   it('should adapt the existing syntax', () => {
     const cb = jest.fn();
-    transformPush(cb)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['openapi.yaml', '@testing_org/main@v1'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
         branch: 'priority-branch',
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['main@v1'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['test.yaml'],
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)(
-      {
+    transformPush(cb)({
+      argv: {
         apis: ['test.yaml', 'test@v1'],
         destination: 'main@v1',
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)(
-      {
+    transformPush(cb)({
+      argv: {
         'batch-id': 'b-123',
         'job-id': 'j-123',
         apis: ['test'],
         branch: 'test',
         destination: 'main@v1',
       },
-      {} as any
-    );
-    expect(cb).toBeCalledWith(
-      {
+      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)({}, {} as any);
-    expect(cb).toBeCalledWith({}, {});
+    transformPush(cb)({ argv: {}, config: {} as any, version: 'cli-version' });
+    expect(cb).toBeCalledWith({ argv: {}, config: {}, version: 'cli-version' });
   });
 });