feat: basic push-status command implementation and extended push command

packages/cli/package.json

@@ -59,7 +59,7 @@
     "@types/react": "^17.0.0 || ^18.2.21",
     "@types/react-dom": "^17.0.0 || ^18.2.7",
     "@types/semver": "^7.5.0",
-    "@types/yargs": "17.0.5",
+    "@types/yargs": "17.0.32",
     "typescript": "^5.2.2"
   }
 }

packages/cli/src/cms/__tests__/api-keys.test.ts

@@ -0,0 +1,37 @@
+import { getApiKeys } from '../api-keys';
+import * as fs from 'fs';
+
+describe('getApiKeys()', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should return api key from environment variable', () => {
+    process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
+
+    expect(getApiKeys('test-domain')).toEqual('test-api-key');
+  });
+
+  it('should return api key from credentials file', () => {
+    process.env.REDOCLY_AUTHORIZATION = '';
+
+    jest.spyOn(fs, 'existsSync').mockReturnValue(true);
+    jest.spyOn(fs, 'readFileSync').mockReturnValue(
+      JSON.stringify({
+        ['test-domain']: 'test-api-key-from-credentials-file',
+      })
+    );
+
+    expect(getApiKeys('test-domain')).toEqual('test-api-key-from-credentials-file');
+  });
+
+  it('should throw an error if no api key provided', () => {
+    process.env.REDOCLY_AUTHORIZATION = '';
+
+    jest.spyOn(fs, 'existsSync').mockReturnValue(false);
+
+    expect(() => getApiKeys('test-domain')).toThrowError(
+      'No api key provided, please use environment variable REDOCLY_DOMAIN.'
+    );
+  });
+});

packages/cli/src/cms/__tests__/domains.test.ts

@@ -0,0 +1,15 @@
+import { getDomain } from '../domains';
+
+describe('getDomain()', () => {
+  it('should return the domain from environment variable', () => {
+    process.env.REDOCLY_DOMAIN = 'test-domain';
+
+    expect(getDomain()).toBe('test-domain');
+  });
+
+  it('should return the default domain if no domain provided', () => {
+    process.env.REDOCLY_DOMAIN = '';
+
+    expect(getDomain()).toBe('https://app.beta.redocly.com');
+  });
+});

packages/cli/src/cms/api-keys.ts

@@ -0,0 +1,27 @@
+import { resolve } from 'path';
+import { homedir } from 'os';
+import { existsSync, readFileSync } from 'fs';
+import { isNotEmptyObject } from '@redocly/openapi-core/lib/utils';
+
+const TOKEN_FILENAME = '.redocly-config.json';
+
+function readCredentialsFile(credentialsPath: string) {
+  return existsSync(credentialsPath) ? JSON.parse(readFileSync(credentialsPath, 'utf-8')) : {};
+}
+
+export function getApiKeys(domain: string) {
+  const apiKey = process.env.REDOCLY_AUTHORIZATION;
+
+  if (apiKey) {
+    return apiKey;
+  }
+
+  const credentialsPath = resolve(homedir(), TOKEN_FILENAME);
+  const credentials = readCredentialsFile(credentialsPath);
+
+  if (isNotEmptyObject(credentials) && credentials[domain]) {
+    return credentials[domain];
+  }
+
+  throw new Error('No api key provided, please use environment variable REDOCLY_DOMAIN.');
+}

packages/cli/src/cms/commands/__tests__/push-status.test.ts

@@ -0,0 +1,68 @@
+import { handlePushStatus } from '../push-status';
+import { PushStatusResponse } from '@redocly/openapi-core';
+
+const remotes = {
+  getPushStatus: jest.fn(),
+  getRemotesList: jest.fn(),
+};
+
+jest.mock('@redocly/openapi-core', () => ({
+  ...jest.requireActual('@redocly/openapi-core'),
+  BlueHarvestApiClient: jest.fn().mockImplementation(function (this: any, ...args) {
+    this.remotes = remotes;
+  }),
+}));
+
+// describe('handlePushStatus()', () => {
+//   const pushResponseStub: PushStatusResponse = {
+//     buildUrlLogs: 'https://test-build-url-logs',
+//     deploymentStatus: 'SUCCEEDED',
+//     scorecard: [],
+//     status: 'SUCCEEDED',
+//     url: 'https://test-url',
+//   };
+
+//   beforeEach(() => {
+//     remotes.getRemotesList.mockResolvedValueOnce({ items: [{ id: 'test-remote-id' }] });
+
+//     remotes.getPushStatus.mockResolvedValueOnce(pushResponseStub);
+
+//     jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+//     jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
+//   });
+
+//   it('should return success push status', async () => {
+//     const mockConfig = { apis: {} } as any;
+//     process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
+
+//     await handlePushStatus(
+//       {
+//         domain: 'test-domain',
+//         mountPath: 'test-mount-path',
+//         organization: 'test-org',
+//         project: 'test-project',
+//         pushId: 'test-push-id',
+//         format: 'json',
+//       },
+//       mockConfig
+//     );
+
+//     expect(remotes.getRemotesList).toHaveBeenCalledWith(
+//       'test-org',
+//       'test-project',
+//       'test-mount-path'
+//     );
+//     expect(process.stderr.write).toHaveBeenCalledTimes(2);
+//     expect(process.stdout.write).toHaveBeenCalledWith(
+//       JSON.stringify(
+//         {
+//           status: 'Success',
+//           buildUrlLogs: 'https://test-build-url-logs',
+//           url: 'https://test-url',
+//         },
+//         null,
+//         2
+//       )
+//     );
+//   });
+// });