@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/README.md

@@ -1,154 +0,0 @@
-# @hubspot/cli
-
-Provides an `hs` command for interacting with HubSpot. [Learn more about building on HubSpot](https://developers.hubspot.com).
-
-## Getting started
-
-For more information on using these tools, see [Local Development Tooling: Getting Started](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development)
-
-### Installation
-
-```bash
-npm install -g @hubspot/cli
-```
-
-### Configuring
-
-Once the `@hubspot/cli` has been added to a project, a config file named [hubspot.config.yml](../../docs/HubspotConfigFile.md) will also be needed. It is recommended that the config file is kept in your `$HOME` directory.
-
-```bash
-cd ~
-hs init
-```
-
-#### Auto Completion
-
-You can set up command autocompletion by running
-
-```bash
-hs completion
-```
-
-and copying the output to either your `.bashrc` or `.zshrc`, and then sourcing that file `source ~/.bashrc` `source ~/.zshrc` or restarting your terminal.
-
-## Commands
-
-A full breakdown of the commands can be found on the [local development tools reference page](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cli).
-
-**Note:** When `@hubspot/cli` is installed local to a project, the commands need to be prefixed with either `yarn` if using `yarn` or `npx` if using `npm`.
-
-Initialize the CLI and create a config file
-
-```bash
-hs init
-```
-
-Show all commands
-
-```bash
-hs help
-```
-
-Upload a file or directory to the Design Manager
-
-```bash
-hs upload --account=DEV [src] [dest]
-```
-
-Fetch a file or directory by path from the Design Manager
-
-```bash
-hs fetch --account=DEV [path] [dest]
-
-# Overwrite existing files
-hs fetch --account=DEV --overwrite [path] [dest]
-```
-
-Watch a directory of files and automatically upload changes to the Design Manager
-
-```bash
-hs watch --account=DEV [src] [dest]
-```
-
-Create a new asset locally
-
-```bash
-hs create [type] [dest]
-```
-
-Delete a file or directory from the Design Manager
-
-```bash
-hs remove --account=DEV [path]
-```
-
-Authenticate against an account using either `personalaccesskey` or `oauth2`
-
-```bash
-hs auth personalaccesskey
-```
-
-### File Manager Commands
-
-Upload a file or directory to the File Manager
-
-```bash
-hs filemanager upload --account=DEV [src] [dest]
-```
-
-Fetch a file or directory from the File Manager
-
-```bash
-hs filemanager fetch --account=DEV [src] [dest]
-
-# Overwrite existing files
-hs filemanager fetch --account=DEV --overwrite [path] [dest]
-```
-
-### HubDB Commands
-
-Create a new HubDB table
-
-```bash
-hs hubdb create <src>
-```
-
-Fetch a HubDB table
-
-```bash
-hs hubdb fetch <id or name> <src>
-```
-
-Clear all rows in a HubDB table
-
-```bash
-hs hubdb clear <id or name>
-```
-
-Delete a HubDB table
-
-```bash
-hs hubdb delete <id or name>
-```
-
-## Authentication
-
-There are two ways that the tools can authenticate with HubSpot.
-
-### Personal Access Key (recommended)
-
-1. Run `hs init` or `hs auth personalaccesskey` and follow the instructions
-
-### OAuth2
-
-1. [Create a developer app](https://developers.hubspot.com/docs/faq/how-do-i-create-an-app-in-hubspot)
-2. Run `hs auth oauth2`
-3. Select `OAuth2` and follow the steps
-
-_**Note:** The Account ID used should be the Test Account ID (not the developer app ID). Client ID and Client Secret are from the developer app._
-### Exit Codes
-
-The CLI will exit with one of the following exit codes:
-- `0`: A successful run
-- `1`: There was a config problem or an internal error
-- `2`: There are warnings or validation issues

package/commands/__tests__/projects.test.js

@@ -1,105 +0,0 @@
-const { command, describe: projectDescribe, builder } = require('../project');
-
-jest.mock('../project/deploy');
-jest.mock('../project/create');
-jest.mock('../project/upload');
-jest.mock('../project/listBuilds');
-jest.mock('../project/logs');
-jest.mock('../project/watch');
-jest.mock('../project/download');
-jest.mock('../project/open');
-jest.mock('../project/dev');
-jest.mock('../project/add');
-jest.mock('../project/migrateApp');
-jest.mock('../project/cloneApp');
-jest.mock('../project/installDeps');
-jest.mock('../../lib/commonOpts');
-
-const deploy = require('../project/deploy');
-const create = require('../project/create');
-const upload = require('../project/upload');
-const listBuilds = require('../project/listBuilds');
-const logs = require('../project/logs');
-const watch = require('../project/watch');
-const download = require('../project/download');
-const open = require('../project/open');
-const dev = require('../project/dev');
-const add = require('../project/add');
-const migrateApp = require('../project/migrateApp');
-const cloneApp = require('../project/cloneApp');
-const installDeps = require('../project/installDeps');
-const { addConfigOptions, addAccountOptions } = require('../../lib/commonOpts');
-
-describe('commands/projects', () => {
-  describe('command', () => {
-    it('should have the correct command structure', () => {
-      expect(command).toEqual('project');
-    });
-  });
-
-  describe('describe', () => {
-    it('should contain the beta tag', () => {
-      expect(projectDescribe).toContain('[BETA]');
-    });
-    it('should provide an accurate description of what the command is doing', () => {
-      expect(projectDescribe).toContain(
-        'Commands for working with projects. For more information, visit our documentation: https://developers.hubspot.com/docs/platform/build-and-deploy-using-hubspot-projects'
-      );
-    });
-  });
-
-  describe('builder', () => {
-    let yargs;
-
-    const subcommands = [
-      ['create', create],
-      ['add', add],
-      ['watch', watch],
-      ['dev', dev],
-      ['upload', upload],
-      ['deploy', deploy],
-      ['logs', logs],
-      ['listBuilds', listBuilds],
-      ['download', download],
-      ['open', open],
-      ['migrateApp', migrateApp],
-      ['cloneApp', cloneApp],
-      ['installDeps', installDeps],
-    ];
-
-    beforeEach(() => {
-      yargs = {
-        command: jest.fn().mockImplementation(() => yargs),
-        demandCommand: jest.fn().mockImplementation(() => yargs),
-      };
-    });
-
-    it('should add the config options', () => {
-      builder(yargs);
-      expect(addConfigOptions).toHaveBeenCalledTimes(1);
-      expect(addConfigOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should add the account options', () => {
-      builder(yargs);
-      expect(addAccountOptions).toHaveBeenCalledTimes(1);
-      expect(addAccountOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should add the correct number of sub commands', () => {
-      builder(yargs);
-      expect(yargs.command).toHaveBeenCalledTimes(subcommands.length);
-    });
-
-    it.each(subcommands)('should attach the %s subcommand', (name, module) => {
-      builder(yargs);
-      expect(yargs.command).toHaveBeenCalledWith(module);
-    });
-
-    it('should demand the command takes one positional argument', () => {
-      builder(yargs);
-      expect(yargs.demandCommand).toHaveBeenCalledTimes(1);
-      expect(yargs.demandCommand).toHaveBeenCalledWith(1, '');
-    });
-  });
-});

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

@@ -1,443 +0,0 @@
-jest.mock('../../../lib/commonOpts');
-jest.mock('yargs');
-jest.mock('@hubspot/local-dev-lib/logger');
-jest.mock('@hubspot/local-dev-lib/api/projects');
-jest.mock('../../../lib/validation');
-jest.mock('../../../lib/projects');
-jest.mock('../../../lib/prompts/projectNamePrompt');
-jest.mock('../../../lib/prompts/deployBuildIdPrompt');
-jest.mock('@hubspot/local-dev-lib/config');
-jest.mock('../../../lib/usageTracking');
-jest.mock('../../../lib/ui');
-
-const libUi = jest.requireActual('../../../lib/ui');
-const {
-  uiCommandReference,
-  uiAccountDescription,
-  uiBetaTag,
-  uiLink,
-} = require('../../../lib/ui');
-
-uiBetaTag.mockImplementation(libUi.uiBetaTag);
-
-const {
-  handler,
-  describe: deployDescribe,
-  command,
-  builder,
-} = require('../deploy');
-
-const {
-  addAccountOptions,
-  addConfigOptions,
-  getAccountId,
-  addUseEnvironmentOptions,
-} = require('../../../lib/commonOpts');
-
-const {
-  deployProject,
-  fetchProject,
-} = require('@hubspot/local-dev-lib/api/projects');
-const { loadAndValidateOptions } = require('../../../lib/validation');
-const {
-  getProjectConfig,
-  pollDeployStatus,
-  getProjectDetailUrl,
-} = require('../../../lib/projects');
-const { projectNamePrompt } = require('../../../lib/prompts/projectNamePrompt');
-const {
-  deployBuildIdPrompt,
-} = require('../../../lib/prompts/deployBuildIdPrompt');
-const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
-
-const yargs = require('yargs');
-const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
-const { AxiosError, HttpStatusCode } = require('axios');
-
-const chalk = require('chalk');
-const {
-  HubSpotHttpError,
-} = require('@hubspot/local-dev-lib/models/HubSpotHttpError');
-
-describe('commands/project/deploy', () => {
-  const projectFlag = 'project';
-  const buildFlag = 'build';
-  const buildAliases = ['buildId'];
-
-  describe('describe', () => {
-    it('should contain the beta tag', () => {
-      expect(deployDescribe).toContain('[BETA]');
-    });
-    it('should provide an accurate description of what the command is doing', () => {
-      expect(deployDescribe).toMatch(/Deploy a project build/);
-    });
-  });
-
-  describe('command', () => {
-    it('should the correct command structure', () => {
-      expect(command).toEqual('deploy');
-    });
-  });
-
-  describe('builder', () => {
-    it('should add the correct options', () => {
-      builder(yargs);
-      expect(yargs.options).toHaveBeenCalledTimes(1);
-      expect(yargs.options).toHaveBeenCalledWith({
-        [projectFlag]: {
-          describe: 'Project name',
-          type: 'string',
-        },
-        [buildFlag]: {
-          alias: buildAliases,
-          describe: 'Project build ID to be deployed',
-          type: 'number',
-        },
-      });
-    });
-
-    it('should add the correct examples', () => {
-      builder(yargs);
-      expect(yargs.example).toHaveBeenCalledTimes(1);
-      expect(yargs.example).toHaveBeenCalledWith([
-        ['$0 project deploy', 'Deploy the latest build of the current project'],
-        [
-          `$0 project deploy --${projectFlag}="my-project" --${buildFlag}=5`,
-          'Deploy build 5 of the project my-project',
-        ],
-      ]);
-    });
-
-    it('should add the config options', () => {
-      builder(yargs);
-      expect(addConfigOptions).toHaveBeenCalledTimes(1);
-      expect(addConfigOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should add the account options', () => {
-      builder(yargs);
-      expect(addAccountOptions).toHaveBeenCalledTimes(1);
-      expect(addAccountOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should add the environment options', () => {
-      builder(yargs);
-      expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
-      expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should the yargs object it is passed', () => {
-      expect(builder(yargs)).toEqual(yargs);
-    });
-  });
-
-  describe('handler', () => {
-    let projectConfig;
-    let processExitSpy;
-    const accountId = 1234567890;
-    const accountType = 'STANDARD';
-    let options;
-    const projectDetails = {
-      latestBuild: { buildId: 8 },
-      deployedBuildId: 1,
-    };
-    const deployDetails = {
-      id: 123,
-    };
-    const projectDetailUrl = 'http://project-details-page-url.com';
-    const viewProjectsInHubSpot = 'View project builds in HubSpot';
-
-    beforeEach(() => {
-      options = {
-        project: 'project name from options',
-        buildId: 2,
-        accountId,
-      };
-      projectConfig = {
-        name: 'project name from config',
-      };
-      getProjectConfig.mockResolvedValue({ projectConfig });
-      projectNamePrompt.mockResolvedValue({ projectName: 'fooo' });
-      getProjectDetailUrl.mockReturnValue(projectDetailUrl);
-      uiLink.mockImplementation(text => {
-        return text;
-      });
-      getAccountId.mockReturnValue(accountId);
-      getAccountConfig.mockReturnValue({ accountType });
-      fetchProject.mockResolvedValue({ data: projectDetails });
-      deployProject.mockResolvedValue({ data: deployDetails });
-      deployBuildIdPrompt.mockResolvedValue({
-        buildId: projectDetails.latestBuild.buildId,
-      });
-
-      // Spy on process.exit so our tests don't close when it's called
-      processExitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {});
-    });
-
-    it('should load and validate the options', async () => {
-      await handler(options);
-      expect(loadAndValidateOptions).toHaveBeenCalledTimes(1);
-      expect(loadAndValidateOptions).toHaveBeenCalledWith(options);
-    });
-
-    it('should get the account id from the options', async () => {
-      await handler(options);
-      expect(getAccountId).toHaveBeenCalledTimes(1);
-      expect(getAccountId).toHaveBeenCalledWith(options);
-    });
-
-    it('should load the account config for the correct account id', async () => {
-      await handler(options);
-      expect(getAccountConfig).toHaveBeenCalledTimes(1);
-      expect(getAccountConfig).toHaveBeenCalledWith(accountId);
-    });
-
-    it('should track the command usage', async () => {
-      await handler(options);
-      expect(trackCommandUsage).toHaveBeenCalledTimes(1);
-      expect(trackCommandUsage).toHaveBeenCalledWith(
-        'project-deploy',
-        { type: accountType },
-        accountId
-      );
-    });
-
-    it('should load the project config', async () => {
-      await handler(options);
-      expect(getProjectConfig).toHaveBeenCalledTimes(1);
-      expect(getProjectConfig).toHaveBeenCalledWith();
-    });
-
-    it('should load the project config', async () => {
-      await handler(options);
-      expect(getProjectConfig).toHaveBeenCalledTimes(1);
-      expect(getProjectConfig).toHaveBeenCalledWith();
-    });
-
-    it('should prompt for the project name', async () => {
-      await handler(options);
-      expect(projectNamePrompt).toHaveBeenCalledTimes(1);
-      expect(projectNamePrompt).toHaveBeenCalledWith(accountId, {
-        project: options.project,
-      });
-    });
-
-    it('should use the project name from the config is a project options is not provided', async () => {
-      delete options.project;
-      await handler(options);
-      expect(projectNamePrompt).toHaveBeenCalledTimes(1);
-      expect(projectNamePrompt).toHaveBeenCalledWith(accountId, {
-        project: projectConfig.name,
-      });
-    });
-
-    it('should fetch the project details', async () => {
-      await handler(options);
-      expect(fetchProject).toHaveBeenCalledTimes(1);
-      expect(fetchProject).toHaveBeenCalledWith(accountId, options.project);
-    });
-
-    it('should use the name from the prompt if no others are defined', async () => {
-      delete options.project;
-      const promptProjectName = 'project name from the prompt';
-      projectNamePrompt.mockReturnValue({ projectName: promptProjectName });
-      getProjectConfig.mockResolvedValue({});
-
-      await handler(options);
-
-      expect(projectNamePrompt).toHaveBeenCalledTimes(1);
-      expect(projectNamePrompt).toHaveBeenCalledWith(accountId, {});
-      expect(fetchProject).toHaveBeenCalledTimes(1);
-      expect(fetchProject).toHaveBeenCalledWith(accountId, promptProjectName);
-    });
-
-    it('should log an error and exit when latest build is not defined', async () => {
-      fetchProject.mockResolvedValue({ data: {} });
-      await handler(options);
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        'Deploy error: no builds for this project were found.'
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should log an error and exit when buildId option is not a valid build', async () => {
-      options.buildId = projectDetails.latestBuild.buildId + 1;
-      await handler(options);
-      expect(uiLink).toHaveBeenCalledTimes(1);
-      expect(uiLink).toHaveBeenCalledWith(
-        viewProjectsInHubSpot,
-        projectDetailUrl
-      );
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        `Build ${options.buildId} does not exist for project ${options.project}. ${viewProjectsInHubSpot}`
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should log an error and exit when buildId option is already deployed', async () => {
-      options.buildId = projectDetails.deployedBuildId;
-      await handler(options);
-      expect(uiLink).toHaveBeenCalledTimes(1);
-      expect(uiLink).toHaveBeenCalledWith(
-        viewProjectsInHubSpot,
-        projectDetailUrl
-      );
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        `Build ${options.buildId} is already deployed. ${viewProjectsInHubSpot}`
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should prompt for build id if no option is provided', async () => {
-      delete options.buildId;
-      await handler(options);
-      expect(deployBuildIdPrompt).toHaveBeenCalledTimes(1);
-      expect(deployBuildIdPrompt).toHaveBeenCalledWith(
-        projectDetails.latestBuild.buildId,
-        projectDetails.deployedBuildId,
-        expect.any(Function)
-      );
-    });
-
-    it('should log an error and exit if the prompted value is invalid', async () => {
-      delete options.buildId;
-      deployBuildIdPrompt.mockReturnValue({});
-
-      await handler(options);
-
-      expect(deployBuildIdPrompt).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        'You must specify a build to deploy'
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should deploy the project', async () => {
-      await handler(options);
-      expect(deployProject).toHaveBeenCalledTimes(1);
-      expect(deployProject).toHaveBeenCalledWith(
-        accountId,
-        options.project,
-        options.buildId
-      );
-    });
-
-    it('should log an error and exit when the deploy fails', async () => {
-      const errorMessage = `Just wasn't feeling it`;
-      deployProject.mockResolvedValue({
-        data: {
-          error: { message: errorMessage },
-        },
-      });
-
-      await handler(options);
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        `Deploy error: ${errorMessage}`
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('should poll the deploy status', async () => {
-      await handler(options);
-      expect(pollDeployStatus).toHaveBeenCalledTimes(1);
-      expect(pollDeployStatus).toHaveBeenCalledWith(
-        accountId,
-        options.project,
-        deployDetails.id,
-        options.buildId
-      );
-    });
-
-    it('log an error and exit if a 404 status is returned', async () => {
-      const commandReference = 'hs project upload';
-      const accountDescription = 'SuperCoolTestAccount';
-      uiCommandReference.mockReturnValue(commandReference);
-      uiAccountDescription.mockReturnValue(accountDescription);
-      fetchProject.mockImplementation(() => {
-        throw new HubSpotHttpError('OH NO', {
-          cause: new AxiosError(
-            'OH NO',
-            '',
-            {},
-            {},
-            { status: HttpStatusCode.NotFound }
-          ),
-        });
-      });
-      await handler(options);
-
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        `The project ${chalk.bold(
-          options.project
-        )} does not exist in account ${accountDescription}. Run ${commandReference} to upload your project files to HubSpot.`
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('log an error and exit if a 400 status is returned', async () => {
-      const commandReference = 'hs project upload';
-      const accountDescription = 'SuperCoolTestAccount';
-      uiCommandReference.mockReturnValue(commandReference);
-      uiAccountDescription.mockReturnValue(accountDescription);
-      const errorMessage = 'Something bad happened';
-      fetchProject.mockImplementation(() => {
-        throw new HubSpotHttpError(errorMessage, {
-          cause: new AxiosError(
-            errorMessage,
-            '',
-            {},
-            {},
-            { status: HttpStatusCode.BadRequest }
-          ),
-        });
-      });
-      await handler(options);
-
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith('The request was bad.');
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-
-    it('log an error another unexpected status code is returned', async () => {
-      const commandReference = 'hs project upload';
-      const accountDescription = 'SuperCoolTestAccount';
-      uiCommandReference.mockReturnValue(commandReference);
-      uiAccountDescription.mockReturnValue(accountDescription);
-      const errorMessage = 'Something bad happened';
-      fetchProject.mockImplementation(() => {
-        throw new HubSpotHttpError('OH NO', {
-          cause: new AxiosError(
-            errorMessage,
-            '',
-            {},
-            {},
-            { status: HttpStatusCode.MethodNotAllowed }
-          ),
-        });
-      });
-      await handler(options);
-
-      expect(logger.error).toHaveBeenCalledTimes(1);
-      expect(logger.error).toHaveBeenCalledWith(
-        `The request for 'project deploy' in account ${accountId} failed due to a client error.`
-      );
-      expect(processExitSpy).toHaveBeenCalledTimes(1);
-      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-    });
-  });
-});