@hubspot/cli 6.2.0 → 6.2.2-beta.0

package/commands/project/__tests__/installDeps.test.js

@@ -1,168 +0,0 @@
-jest.mock('../../../lib/projects');
-jest.mock('@hubspot/local-dev-lib/logger');
-jest.mock('../../../lib/dependencyManagement');
-jest.mock('../../../lib/prompts/promptUtils');
-jest.mock('../../../lib/usageTracking');
-jest.mock('../../../lib/commonOpts');
-
-const { getProjectConfig } = require('../../../lib/projects');
-const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { getAccountId } = require('../../../lib/commonOpts');
-const {
-  installPackages,
-  getProjectPackageJsonLocations,
-} = require('../../../lib/dependencyManagement');
-const { promptUser } = require('../../../lib/prompts/promptUtils');
-const {
-  command,
-  describe: installDepsDescribe,
-  builder,
-  handler,
-} = require('../installDeps');
-const path = require('path');
-
-describe('commands/project/installDeps', () => {
-  describe('command', () => {
-    it('should have the correct command string', () => {
-      expect(command).toEqual('install-deps [packages..]');
-    });
-  });
-
-  describe('describe', () => {
-    it('should have the correct description', () => {
-      expect(installDepsDescribe).toEqual(null);
-    });
-  });
-
-  describe('builder', () => {
-    let yargs;
-    beforeEach(() => {
-      yargs = {
-        example: jest.fn().mockImplementation(() => yargs),
-      };
-    });
-
-    it('should add correct examples', () => {
-      builder(yargs);
-      expect(yargs.example).toHaveBeenCalledTimes(1);
-      expect(yargs.example).toHaveBeenCalledWith([
-        ['$0 project install-deps', 'Install the dependencies for the project'],
-        [
-          '$0 project install-deps dependency1 dependency2',
-          'Install the dependencies to one or more project subcomponents',
-        ],
-      ]);
-    });
-  });
-
-  describe('handler', () => {
-    let processExitSpy;
-
-    beforeEach(() => {
-      processExitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {});
-    });
-
-    it('should track the command usage', async () => {
-      const accountId = 999999;
-      getAccountId.mockReturnValue(accountId);
-      await handler({});
-
-      expect(getAccountId).toHaveBeenCalledTimes(1);
-      expect(trackCommandUsage).toHaveBeenCalledTimes(1);
-      expect(trackCommandUsage).toHaveBeenCalledWith(
-        'project-install-deps',
-        null,
-        accountId
-      );
-    });
-
-    it('should handle exceptions', async () => {
-      const error = new Error('Something went super wrong');
-
-      getProjectConfig.mockImplementationOnce(() => {
-        throw error;
-      });
-
-      await handler({});
-
-      expect(logger.debug).toHaveBeenCalledTimes(1);
-      expect(logger.debug).toHaveBeenCalledWith(error);
-
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(error.message);
-
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should log an error and exit when the project config is not defined', async () => {
-      getProjectConfig.mockResolvedValueOnce(null);
-      await handler({});
-
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        'No project detected. Run this command from a project directory.'
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should log an error and exit when the project config has no projectDir', async () => {
-      getProjectConfig.mockResolvedValueOnce({ projectDir: null });
-      await handler({});
-
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        'No project detected. Run this command from a project directory.'
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should prompt for input when packages is defined', async () => {
-      const projectDir = 'src';
-      getProjectConfig.mockResolvedValue({ projectDir });
-      const packageJsonLocation = path.join(projectDir, 'directory1');
-      promptUser.mockResolvedValueOnce(packageJsonLocation);
-      getProjectPackageJsonLocations.mockResolvedValue([packageJsonLocation]);
-      await handler({ packages: ['@hubspot/local-dev-lib'] });
-      expect(getProjectPackageJsonLocations).toHaveBeenCalledTimes(1);
-      expect(promptUser).toHaveBeenCalledTimes(1);
-      expect(promptUser).toHaveBeenCalledWith([
-        {
-          name: 'selectedInstallLocations',
-          type: 'checkbox',
-          when: expect.any(Function),
-          choices: [
-            {
-              name: 'directory1',
-              value: packageJsonLocation,
-            },
-          ],
-          message: 'Choose the project components to install the dependencies:',
-          validate: expect.any(Function),
-        },
-      ]);
-    });
-
-    it('should call installPackages correctly', async () => {
-      const projectDir = 'src';
-      const packageJsonLocation = path.join(projectDir, 'directory1');
-      const installLocations = [packageJsonLocation];
-      const packages = ['@hubspot/local-dev-lib'];
-
-      getProjectConfig.mockResolvedValue({ projectDir });
-      promptUser.mockResolvedValueOnce(packageJsonLocation);
-      getProjectPackageJsonLocations.mockResolvedValue(installLocations);
-      await handler({ packages });
-
-      expect(installPackages).toHaveBeenCalledTimes(1);
-      expect(installPackages).toHaveBeenCalledWith({
-        packages,
-        installLocations,
-      });
-    });
-  });
-});

package/commands/project/__tests__/logs.test.js

@@ -1,304 +0,0 @@
-jest.mock('../../../lib/commonOpts');
-jest.mock('../../../lib/usageTracking');
-jest.mock('../../../lib/validation');
-jest.mock('../../../lib/projectLogsManager');
-jest.mock('../../../lib/prompts/projectsLogsPrompt');
-jest.mock('@hubspot/local-dev-lib/logger');
-jest.mock('../../../lib/ui/table');
-jest.mock('../../../lib/ui');
-jest.mock('../../../lib/errorHandlers');
-
-// Deps where we don't want mocks
-const libUi = jest.requireActual('../../../lib/ui');
-
-const { uiLine, uiLink, uiBetaTag } = require('../../../lib/ui');
-
-uiBetaTag.mockImplementation(libUi.uiBetaTag);
-
-const {
-  addUseEnvironmentOptions,
-  getAccountId,
-} = require('../../../lib/commonOpts');
-const ProjectLogsManager = require('../../../lib/projectLogsManager');
-const {
-  projectLogsPrompt,
-} = require('../../../lib/prompts/projectsLogsPrompt');
-const { getTableContents, getTableHeader } = require('../../../lib/ui/table');
-
-const { trackCommandUsage } = require('../../../lib/usageTracking');
-
-const {
-  handler,
-  describe: logsDescribe,
-  command,
-  builder,
-} = require('../logs');
-const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
-const { logError } = require('../../../lib/errorHandlers');
-
-describe('commands/project/logs', () => {
-  let processExitSpy;
-  beforeEach(() => {
-    processExitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {});
-  });
-
-  describe('command', () => {
-    it('should have the proper command string', async () => {
-      expect(command).toEqual('logs');
-    });
-  });
-
-  describe('describe', () => {
-    it('should contain the beta tag', () => {
-      expect(logsDescribe).toContain('[BETA]');
-    });
-    it('should provide an accurate description of what the command is doing', () => {
-      expect(logsDescribe).toMatch(
-        /Get execution logs for a serverless function within a project/
-      );
-    });
-  });
-
-  describe('builder', () => {
-    let yargsMock = {};
-    beforeEach(() => {
-      yargsMock = {
-        options: jest.fn().mockImplementation(() => yargsMock),
-        conflicts: jest.fn().mockImplementation(() => yargsMock),
-        example: jest.fn().mockImplementation(() => yargsMock),
-      };
-    });
-
-    it('should add all of the options', () => {
-      builder(yargsMock);
-      expect(yargsMock.options).toHaveBeenCalledTimes(1);
-      expect(yargsMock.options).toHaveBeenCalledWith({
-        function: {
-          alias: 'function',
-          requiresArg: true,
-          describe: 'App function name',
-          type: 'string',
-        },
-        latest: {
-          alias: 'l',
-          type: 'boolean',
-          describe: 'Retrieve most recent log only',
-        },
-        compact: {
-          type: 'boolean',
-          describe: 'Output compact logs',
-        },
-        tail: {
-          alias: ['t', 'follow'],
-          describe: 'Tail logs',
-          type: 'boolean',
-        },
-        limit: {
-          type: 'number',
-          describe: 'Limit the number of logs to output',
-        },
-      });
-    });
-
-    it('should add the environment options', () => {
-      builder(yargsMock);
-      expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
-      expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargsMock);
-    });
-
-    it('should set tail and limit as conflicting arguments', () => {
-      builder(yargsMock);
-      expect(yargsMock.conflicts).toHaveBeenCalledTimes(1);
-      expect(yargsMock.conflicts).toHaveBeenCalledWith('tail', 'limit');
-    });
-
-    it('should set examples', () => {
-      builder(yargsMock);
-      expect(yargsMock.example).toHaveBeenCalledTimes(1);
-      expect(yargsMock.example).toHaveBeenCalledWith([
-        [
-          '$0 project logs',
-          'Open the project logs prompt to get logs for a serverless function',
-        ],
-        [
-          '$0 project logs --function=my-function',
-          'Get logs for function named "my-function" within the app named "app" within the project named "my-project"',
-        ],
-      ]);
-    });
-  });
-
-  describe('handler', () => {
-    const accountId = 12345678;
-
-    beforeEach(() => {
-      getAccountId.mockReturnValue(accountId);
-      projectLogsPrompt.mockResolvedValue({ functionName: 'foo' });
-    });
-
-    it('should get the account id', async () => {
-      const options = {
-        foo: 'bar',
-      };
-      await handler(options);
-      expect(getAccountId).toHaveBeenCalledTimes(1);
-      expect(getAccountId).toHaveBeenCalledWith(options);
-    });
-
-    it('should track the command usage', async () => {
-      const options = {
-        foo: 'bar',
-      };
-      await handler(options);
-      expect(trackCommandUsage).toHaveBeenCalledTimes(1);
-      expect(trackCommandUsage).toHaveBeenCalledWith(
-        'project-logs',
-        null,
-        accountId
-      );
-    });
-
-    it('should initialize the ProjectLogsManager', async () => {
-      const options = {
-        foo: 'bar',
-      };
-      await handler(options);
-      expect(ProjectLogsManager.init).toHaveBeenCalledTimes(1);
-      expect(ProjectLogsManager.init).toHaveBeenCalledWith(accountId);
-    });
-
-    it('should prompt the user for input', async () => {
-      const functionNames = ['function1', 'function2'];
-      ProjectLogsManager.getFunctionNames.mockReturnValue(functionNames);
-      const options = {
-        foo: 'bar',
-      };
-      await handler(options);
-      expect(projectLogsPrompt).toHaveBeenCalledTimes(1);
-      expect(projectLogsPrompt).toHaveBeenCalledWith({
-        functionChoices: functionNames,
-        promptOptions: options,
-      });
-    });
-
-    it('should set the function', async () => {
-      const selectedFunction = 'function1';
-      ProjectLogsManager.getFunctionNames.mockReturnValue([
-        selectedFunction,
-        'function2',
-      ]);
-      projectLogsPrompt.mockReturnValue({
-        functionName: selectedFunction,
-      });
-
-      await handler({});
-      expect(ProjectLogsManager.setFunction).toHaveBeenCalledTimes(1);
-      expect(ProjectLogsManager.setFunction).toHaveBeenCalledWith(
-        selectedFunction
-      );
-    });
-
-    it('should log public functions correctly', async () => {
-      const functionNames = ['function1', 'function2'];
-      const selectedFunction = 'function1';
-      ProjectLogsManager.getFunctionNames.mockReturnValue(functionNames);
-      projectLogsPrompt.mockReturnValue({
-        functionName: selectedFunction,
-      });
-
-      const tableHeaders = ['Header 1', 'Header 2'];
-      getTableHeader.mockReturnValue(tableHeaders);
-
-      ProjectLogsManager.isPublicFunction = true;
-      ProjectLogsManager.accountId = accountId;
-      ProjectLogsManager.functionName = selectedFunction;
-      ProjectLogsManager.endpointName = 'my-endpoint';
-      ProjectLogsManager.appId = 123456;
-
-      await handler({});
-      expect(getTableHeader).toHaveBeenCalledTimes(1);
-      expect(getTableHeader).toHaveBeenCalledWith([
-        'Account',
-        'Function',
-        'Endpoint',
-      ]);
-
-      expect(getTableContents).toHaveBeenCalledTimes(1);
-      expect(getTableContents).toHaveBeenCalledWith(
-        [
-          tableHeaders,
-          [
-            ProjectLogsManager.accountId,
-            ProjectLogsManager.functionName,
-            ProjectLogsManager.endpointName,
-          ],
-        ],
-        { border: { bodyLeft: '  ' } }
-      );
-      expect(uiLink).toHaveBeenCalledTimes(1);
-      expect(uiLink).toHaveBeenCalledWith(
-        'View function logs in HubSpot',
-        `https://app.hubspot.com/private-apps/${accountId}/${ProjectLogsManager.appId}/logs/serverlessGatewayExecution?path=${ProjectLogsManager.endpointName}`
-      );
-      expect(uiLine).toHaveBeenCalledTimes(1);
-    });
-
-    it('should log private functions correctly', async () => {
-      const functionNames = ['function1', 'function2'];
-      const selectedFunction = 'function1';
-
-      ProjectLogsManager.getFunctionNames.mockReturnValue(functionNames);
-      projectLogsPrompt.mockReturnValue({
-        functionName: selectedFunction,
-      });
-
-      const tableHeaders = ['Header 1', 'Header 2'];
-      getTableHeader.mockReturnValue(tableHeaders);
-
-      ProjectLogsManager.isPublicFunction = false;
-      ProjectLogsManager.accountId = accountId;
-      ProjectLogsManager.functionName = selectedFunction;
-      ProjectLogsManager.appId = 456789;
-
-      await handler({});
-      expect(getTableHeader).toHaveBeenCalledTimes(1);
-      expect(getTableHeader).toHaveBeenCalledWith(['Account', 'Function']);
-
-      expect(getTableContents).toHaveBeenCalledTimes(1);
-      expect(getTableContents).toHaveBeenCalledWith(
-        [
-          tableHeaders,
-          [ProjectLogsManager.accountId, ProjectLogsManager.functionName],
-        ],
-        { border: { bodyLeft: '  ' } }
-      );
-
-      expect(uiLink).toHaveBeenCalledWith(
-        'View function logs in HubSpot',
-        `https://app.hubspot.com/private-apps/${accountId}/${ProjectLogsManager.appId}/logs/crm?serverlessFunction=${selectedFunction}`
-      );
-
-      expect(uiLine).toHaveBeenCalledTimes(1);
-    });
-
-    it('should handle errors correctly', async () => {
-      const error = new Error('Something went wrong');
-      ProjectLogsManager.init.mockImplementation(() => {
-        throw error;
-      });
-
-      ProjectLogsManager.projectName = 'Super cool project';
-
-      await handler({});
-
-      expect(logError).toHaveBeenCalledTimes(1);
-      expect(logError).toHaveBeenCalledWith(error, {
-        accountId: accountId,
-        projectName: ProjectLogsManager.projectName,
-      });
-
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-  });
-});

package/hubspot.sample.config.yml

@@ -1,28 +0,0 @@
-defaultPortal: DEV
-
-# Optionally set the default mode for all accounts
-defaultMode: publish
-
-# Override default HTTP timeout in milliseconds
-httpTimeout: 30000
-
-# Disable usage tracking
-allowUsageTracking: false
-
-# List of accounts that are intended to be used
-portals:
-  # Account set up to use OAuth2
-  - name: PROD
-    portalId: 456
-    authType: oauth2
-    auth:
-      clientId: d996372f-2b53-30d3-9c3b-4fdde4bce3a2
-      clientSecret: f90a6248-fbc0-3b03-b0db-ec58c95e791
-      scopes:
-        - content
-      tokenInfo:
-        expiresAt: '2019-05-02T02:52:05.233Z'
-        refreshToken: 84d22710-4cb7-5581-ba05-35f9945e5e8e
-        accessToken: >-
-          CJDVnLanLRICEQIYyLu8LyDh9E4opf1GMhkAxGuU5XN_O2O2QhX0khw7cwIkPkBRHye-OfIADgLBAAADAIADAAAAAAAAAAJCGQC8a5TlhtSU8T-2mVLxOBpxS18aM42oGKk
-

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  testPathIgnorePatterns: ['commands/functions/test.js'],
-  clearMocks: true,
-};

package/lib/__tests__/commonOpts.test.js

@@ -1,83 +0,0 @@
-const {
-  MODE,
-  DEFAULT_MODE,
-} = require('@hubspot/local-dev-lib/constants/files');
-const {
-  getAndLoadConfigIfNeeded,
-  getAccountId,
-  getAccountConfig,
-  loadConfigFromEnvironment,
-} = require('@hubspot/local-dev-lib/config');
-const { getMode } = require('../commonOpts');
-
-jest.mock('@hubspot/local-dev-lib/config');
-jest.mock('@hubspot/local-dev-lib/logger');
-
-describe('@hubspot/cli/lib/commonOpts', () => {
-  describe('getMode()', () => {
-    const accounts = {
-      PROD: 123,
-      DEV: 456,
-    };
-    const devAccountConfig = {
-      accountId: accounts.DEV,
-      name: 'DEV',
-      defaultMode: MODE.draft,
-    };
-    const prodAccountConfig = {
-      accountId: accounts.PROD,
-      name: 'PROD',
-    };
-    const config = {
-      defaultAccount: 'DEV',
-      accounts: [devAccountConfig, prodAccountConfig],
-    };
-    const configWithDefaultMode = {
-      ...config,
-      defaultMode: MODE.draft,
-    };
-
-    afterEach(() => {
-      getAndLoadConfigIfNeeded.mockReset();
-      getAccountId.mockReset();
-      getAccountConfig.mockReset();
-      loadConfigFromEnvironment.mockReset();
-    });
-
-    describe('mode option precedence', () => {
-      describe('1. --mode', () => {
-        it('should return the mode specified by the command option if present.', () => {
-          getAndLoadConfigIfNeeded.mockReturnValue(configWithDefaultMode);
-          getAccountConfig.mockReturnValue(devAccountConfig);
-          expect(getMode({ mode: MODE.draft })).toBe(MODE.draft);
-          expect(getMode({ mode: MODE.publish })).toBe(MODE.publish);
-          expect(getMode({ mode: 'undefined-mode' })).toBe('undefined-mode');
-        });
-      });
-      describe('2. hubspot.config.yml -> config.accounts[x].defaultMode', () => {
-        it('should return the defaultMode specified by the account specific config if present.', () => {
-          getAndLoadConfigIfNeeded.mockReturnValue(configWithDefaultMode);
-          getAccountId.mockReturnValue(accounts.DEV);
-          getAccountConfig.mockReturnValue(devAccountConfig);
-          loadConfigFromEnvironment.mockReturnValue(undefined);
-          expect(getMode({ account: accounts.DEV })).toBe(MODE.draft);
-        });
-      });
-      describe('3. hubspot.config.yml -> config.defaultMode', () => {
-        it('should return the defaultMode specified by the config if present.', () => {
-          getAndLoadConfigIfNeeded.mockReturnValue(configWithDefaultMode);
-          getAccountId.mockReturnValue(accounts.PROD);
-          getAccountConfig.mockReturnValue(prodAccountConfig);
-          loadConfigFromEnvironment.mockReturnValue(undefined);
-          expect(getMode({ account: accounts.PROD })).toBe(MODE.draft);
-        });
-      });
-      describe('4. DEFAULT_MODE', () => {
-        it('should return the defaultMode specified by the config if present.', () => {
-          loadConfigFromEnvironment.mockReturnValue(undefined);
-          expect(getMode({ account: 'xxxxx' })).toBe(DEFAULT_MODE);
-        });
-      });
-    });
-  });
-});