Local testing for functions using hs functions test command

packages/cli-lib/__tests__/__snapshots__/schema.js.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`cms-lib/schema cleanSchema() cleans a full schema 1`] = `
+exports[`cli-lib/schema cleanSchema() cleans a full schema 1`] = `
 Object {
   "associatedObjects": undefined,
   "labels": Object {
@@ -42,7 +42,7 @@ Object {
 }
 `;
 
-exports[`cms-lib/schema cleanSchema() cleans multiple schema 1`] = `
+exports[`cli-lib/schema cleanSchema() cleans multiple schema 1`] = `
 Array [
   Object {
     "associatedObjects": undefined,
@@ -173,15 +173,15 @@ Array [
 ]
 `;
 
-exports[`cms-lib/schema logSchemas() logs schemas 1`] = `
+exports[`cli-lib/schema logSchemas() logs schemas 1`] = `
 "╔════════╤════════╤══════════════╗
 ║ Label  │ Name   │ objectTypeId ║
 ║ Schema │ schema │              ║
 ╚════════╧════════╧══════════════╝
 "
 `;
 
-exports[`cms-lib/schema writeSchemaToDisk() writes schema to disk 1`] = `
+exports[`cli-lib/schema writeSchemaToDisk() writes schema to disk 1`] = `
 "{
   \\"name\\": \\"schema\\",
   \\"labels\\": { \\"singular\\": \\"Schema\\", \\"plural\\": \\"Schemas\\" },

packages/cli-lib/__tests__/errorHandlers.js

@@ -72,7 +72,7 @@ const fileSystemErrorContext = Object.freeze({
   filepath: 'x/y/z.html',
 });
 
-describe('cms-lib/errorHandlers', () => {
+describe('cli-lib/errorHandlers', () => {
   beforeEach(() => {
     logger.clear();
   });

packages/cli-lib/__tests__/fileMapper.js

@@ -49,7 +49,7 @@ function testPathDeterminationFunction(name, pathType, fn, truthy, falsey) {
   });
 }
 
-describe('cms-lib/fileMapper', () => {
+describe('cli-lib/fileMapper', () => {
   testPathDeterminationFunction(
     'isPathToFile',
     'file',

packages/cli-lib/__tests__/hubdb.js

@@ -13,7 +13,7 @@ const hubdbPublishTableResponse = require('./fixtures/hubdb/hubdbPublishTableRes
 jest.mock('../path');
 jest.mock('../api/hubdb');
 
-describe('cms-lib/hubdb', () => {
+describe('cli-lib/hubdb', () => {
   it('downloads hubdb table', async () => {
     const accountId = 123;
     const tableId = 456;

packages/cli-lib/__tests__/index.js

@@ -1,4 +1,4 @@
-describe('cms-lib', () => {
+describe('cli-lib', () => {
   it('works', () => {
     expect(true).toBe(true);
   });

packages/cli-lib/__tests__/modules.js

@@ -16,7 +16,7 @@ const isHubSpot = true;
 // ca. 2016 https://github.com/facebook/jest/issues/335#issuecomment-250400941
 jest.mock('../lib/walk', () => require('../lib/__mocks__/walk'));
 
-describe('cms-lib/modules', () => {
+describe('cli-lib/modules', () => {
   describe('isModuleFolder()', () => {
     it('should throw on invalid input', () => {
       expect(() => isModuleFolder('foo')).toThrow();

packages/cli-lib/__tests__/path.js

@@ -1,7 +1,7 @@
 const path = require('path');
 const { splitHubSpotPath, splitLocalPath } = require('../path');
 
-describe('cms-lib/path', () => {
+describe('cli-lib/path', () => {
   describe('splitHubSpotPath()', () => {
     const testSplit = (filepath, expectedParts, joined) => {
       test(filepath, () => {

packages/cli-lib/__tests__/schema.js

@@ -7,7 +7,7 @@ const basic = require('./fixtures/schema/basic.json');
 const full = require('./fixtures/schema/full.json');
 const multiple = require('./fixtures/schema/multiple.json');
 
-describe('cms-lib/schema', () => {
+describe('cli-lib/schema', () => {
   describe('cleanSchema()', () => {
     it('cleans a basic schema', () => {
       expect(cleanSchema(basic)).toEqual(basic);

packages/cli-lib/api/__tests__/fileMapper.js

@@ -1,7 +1,7 @@
 const fileStreamResponse = require('./fixtures/fileStreamResponse');
 const { createFileMapperNodeFromStreamResponse } = require('../fileMapper');
 
-describe('cms-lib/api/fileMapper', () => {
+describe('cli-lib/api/fileMapper', () => {
   describe('createFileMapperNodeFromStreamResponse()', () => {
     const src = '1234/test.html';
     it('should return request#tranform to create a FileMapperNode from the octet-stream response', () => {

packages/cli-lib/api/fileMapper.js

@@ -53,6 +53,7 @@ function createFileMapperNodeFromStreamResponse(filePath, response) {
  * @returns {Promise}
  */
 async function upload(accountId, src, dest, options = {}) {
+  console.log('upload: ', fs.createReadStream(path.resolve(getCwd(), src)));
   return http.post(accountId, {
     uri: `${FILE_MAPPER_API_PATH}/upload/${encodeURIComponent(dest)}`,
     formData: {
@@ -160,7 +161,7 @@ async function deleteFile(accountId, filePath, options = {}) {
  */
 async function deleteFolder(accountId, folderPath, options = {}) {
   logger.warn(
-    '`cms-lib/api/fileMapper#deleteFolder()` is deprecated. Use `cms-lib/api/fileMapper#deleteFile()` instead.'
+    '`cli-lib/api/fileMapper#deleteFolder()` is deprecated. Use `cli-lib/api/fileMapper#deleteFile()` instead.'
   );
   return http.delete(accountId, {
     uri: `${FILE_MAPPER_API_PATH}/delete/folder/${folderPath}`,

packages/cli-lib/ignoreRules.js

@@ -10,6 +10,7 @@ const ignoreList = [
   '.*', // hidden files/folders
   '*.log', // Error log for npm
   '*.swp', // Swap file for vim state
+  '.env', // Dotenv file
 
   // # macOS
   'Icon\\r', // Custom Finder icon: http://superuser.com/questions/298785/icon-file-on-os-x-desktop

packages/cli-lib/lib/logs.js

@@ -14,27 +14,31 @@ const formatError = log => {
 };
 
 const logHandler = {
-  UNHANDLED_ERROR: (log, { compact }) => {
-    return `${formatLogHeader(log)}${compact ? '' : `\n${formatError(log)}`}`;
+  UNHANDLED_ERROR: (log, options) => {
+    return `${formatLogHeader(log, options)}${
+      options.compact ? '' : `\n${formatError(log)}`
+    }`;
   },
-  HANDLED_ERROR: (log, { compact }) => {
-    return `${formatLogHeader(log)}${compact ? '' : `\n${formatError(log)}`}`;
+  HANDLED_ERROR: (log, options) => {
+    return `${formatLogHeader(log, options)}${
+      options.compact ? '' : `\n${formatError(log)}`
+    }`;
   },
-  SUCCESS: (log, { compact }) => {
-    return `${formatLogHeader(log)}${compact ? '' : `\n${formatLog(log)}`}`;
+  SUCCESS: (log, options) => {
+    return `${formatLogHeader(log, options)}${
+      options.compact ? '' : `\n${log.log}`
+    }`;
   },
 };
 
-const formatLogHeader = log => {
+const formatLogHeader = (log, options) => {
   const color = LOG_STATUS_COLORS[log.status];
+  const headerInsertion =
+    options && options.insertions && options.insertions.header;
 
-  return `${formatTimestamp(log)}${SEPARATOR}${color(
-    log.status
-  )}${SEPARATOR}${formatExecutionTime(log)}`;
-};
-
-const formatLog = log => {
-  return `${log.log}`;
+  return `${formatTimestamp(log)}${SEPARATOR}${color(log.status)}${
+    headerInsertion ? `${SEPARATOR}${headerInsertion}` : ''
+  }${SEPARATOR}${formatExecutionTime(log)}`;
 };
 
 const formatStackTrace = log => {

packages/cli/commands/functions.js

@@ -5,6 +5,7 @@ const {
 } = require('../lib/commonOpts');
 const list = require('./functions/list');
 const deploy = require('./functions/deploy');
+const test = require('./functions/test');
 
 exports.command = 'functions';
 exports.describe = 'Commands for working with functions';
@@ -20,6 +21,7 @@ exports.builder = yargs => {
       aliases: 'ls',
     })
     .command(deploy)
+    .command(test)
     .demandCommand(1, '');
 
   return yargs;

packages/cli/commands/functions/test.js

@@ -0,0 +1,86 @@
+const {
+  addAccountOptions,
+  addConfigOptions,
+  setLogLevel,
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { logDebugInfo } = require('../../lib/debugInfo');
+const {
+  loadConfig,
+  validateConfig,
+  checkAndWarnGitInclusion,
+} = require('@hubspot/cli-lib');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { start: startTestServer } = require('@hubspot/serverless-dev-runtime');
+const { validateAccount } = require('../../lib/validation');
+
+const loadAndValidateOptions = async options => {
+  setLogLevel(options);
+  logDebugInfo(options);
+  const { config: configPath } = options;
+  loadConfig(configPath, options);
+  checkAndWarnGitInclusion();
+
+  if (!(validateConfig() && (await validateAccount(options)))) {
+    process.exit(1);
+  }
+};
+
+exports.command = 'test <path>';
+exports.describe = false;
+
+exports.handler = async options => {
+  loadAndValidateOptions(options);
+
+  const { path: functionPath } = options;
+  const accountId = getAccountId(options);
+
+  trackCommandUsage('functions-test', { functionPath }, accountId);
+
+  logger.debug(
+    `Starting test server for .functions folder with path: ${functionPath}`
+  );
+
+  startTestServer({
+    accountId,
+    ...options,
+  });
+};
+
+exports.builder = yargs => {
+  yargs.positional('path', {
+    describe: 'Path to local .functions folder',
+    type: 'string',
+  });
+  yargs.option('port', {
+    describe: 'port to run the test server on',
+    type: 'string',
+    default: 5432,
+  });
+  yargs.option('contact', {
+    describe: 'pass contact data to the test function',
+    type: 'boolean',
+    default: true,
+  });
+  yargs.option('watch', {
+    describe:
+      'watch the specified .functions folder for changes and restart the server',
+    type: 'boolean',
+    default: true,
+  });
+
+  yargs.example([
+    [
+      '$0 functions test ./tmp/myFunctionFolder.functions',
+      'Run a local function test server.',
+    ],
+  ]);
+
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};

packages/cli/jest.config.js

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

packages/cli/package.json

@@ -10,7 +10,6 @@
   "dependencies": {
     "@hubspot/cli-lib": "^2.2.3-beta.3",
     "chalk": "^4.1.0",
-    "express": "^4.17.1",
     "inquirer": "^6.3.1",
     "open": "^7.0.3",
     "ora": "^4.0.3",

packages/serverless-dev-runtime/README.md

@@ -0,0 +1,67 @@
+# @hubspot/serverless-dev-runtime
+
+A serverless function development runtime that can be used to test CMS serverless functions. This is intended for use with the [CMS CLI](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cms-cli).
+
+## Getting started
+
+For more information on using these tools, see [Local Development Tooling: Getting Started](https://designers.hubspot.com/tutorials/getting-started-with-local-development)
+
+### Installation
+
+#### Using `yarn`
+
+```bash
+yarn add @hubspot/cms-cli --dev
+```
+
+#### Using `npm`
+
+```bash
+npm install @hubspot/cms-cli
+```
+
+### Usage
+
+#### CLI Command
+To run the CLI command to test a local serverless function run...
+```bash
+hs functions <localDotFunctionsFolderPath>
+```
+
+#### Importing
+To start the server, the `start` method can be imported from the `@hubspot/serverless-dev-runtime` package and run with settings like so...
+
+```bash
+const { start } = require('@hubspot/serverless-dev-runtime');
+
+start({
+  accountId: <portalId/accountId>,                                                  // default: 123456
+  contact: <booleanValueToSpecifyIfContactDataShouldBePassedToServerlessFunction>,  // default: true
+  path: <pathToLocalDotFunctionsFolder>,                                            // required
+  port: <customPortToRunServerOn>                                                   // default: 5432
+});
+```
+
+### Mocked Data
+Some of the data that is passed to the serverless function context is mocked. Specifically the `contact` and `limits` properties. It is possible
+to modify the mocked data by setting values for specific variables within a `.env` file within the `.functions` folder.
+
+The variables used to modify the data are:
+
+```
+HUBSPOT_LIMITS_TIME_REMAINING       // default: 600000
+HUBSPOT_LIMITS_EXECUTIONS_REMAINING // default: 60
+HUBSPOT_CONTACT_VID                 // default: 123
+HUBSPOT_CONTACT_IS_LOGGED_IN        // default: false
+HUBSPOT_CONTACT_LIST_MEMBERSHIPS    // default: []
+```
+
+Usage example `.env`:
+
+```
+HUBSPOT_LIMITS_TIME_REMAINING=1000
+HUBSPOT_LIMITS_EXECUTIONS_REMAINING=2
+HUBSPOT_CONTACT_VID=456
+HUBSPOT_CONTACT_IS_LOGGED_IN=true
+HUBSPOT_CONTACT_LIST_MEMBERSHIPS="some, memberships"
+```

packages/serverless-dev-runtime/index.js

@@ -0,0 +1,5 @@
+const { start } = require('./lib/server');
+
+module.exports = {
+  start,
+};