@hubspot/cli 4.0.2-beta.6 → 4.1.0

package/lib/validators/__tests__/TemplateValidator.js

@@ -1,101 +0,0 @@
-const fs = require('fs');
-const templates = require('@hubspot/cli-lib/templates');
-
-const TemplateValidator = require('../marketplaceValidators/theme/TemplateValidator');
-const { VALIDATION_RESULT } = require('../constants');
-const {
-  generateTemplatesList,
-  makeFindError,
-  THEME_PATH,
-} = require('./validatorTestUtils');
-
-jest.mock('fs');
-jest.mock('@hubspot/cli-lib/templates');
-
-const TEMPLATE_LIMIT = 50;
-
-const mockGetAnnotationValue = (templateType, rest) => {
-  templates.buildAnnotationValueGetter.mockImplementation(() => {
-    return key => {
-      if (key === 'templateType') {
-        return templateType;
-      }
-      return rest;
-    };
-  });
-};
-
-const findError = makeFindError('template');
-
-describe('validators/marketplaceValidators/theme/TemplateValidator', () => {
-  beforeEach(() => {
-    TemplateValidator.setAbsolutePath(THEME_PATH);
-    templates.isCodedFile.mockReturnValue(true);
-  });
-
-  it('returns error if template limit is exceeded', async () => {
-    mockGetAnnotationValue('page');
-
-    const validationErrors = TemplateValidator.validate(
-      generateTemplatesList(TEMPLATE_LIMIT + 1)
-    );
-    const limitError = findError(validationErrors, 'limitExceeded');
-    expect(limitError).toBeDefined();
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns no errors if template limit is not exceeded', async () => {
-    mockGetAnnotationValue('page');
-
-    const validationErrors = TemplateValidator.validate(
-      generateTemplatesList(TEMPLATE_LIMIT)
-    );
-    const limitError = findError(validationErrors, 'limitExceeded');
-    expect(limitError).not.toBeDefined();
-  });
-
-  it('returns error if template annotation is missing label and screenshotPath', async () => {
-    fs.readFileSync.mockReturnValue('mock');
-    mockGetAnnotationValue('page');
-
-    const validationErrors = TemplateValidator.validate(['template.html']);
-    expect(validationErrors.length).toBe(2);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if template type is not allowed', async () => {
-    fs.readFileSync.mockReturnValue('mock');
-    mockGetAnnotationValue('starter_landing_pages', 'value');
-
-    const validationErrors = TemplateValidator.validate(['template.html']);
-
-    expect(validationErrors.length).toBe(1);
-  });
-
-  it('returns error if template type is unknown', async () => {
-    fs.readFileSync.mockReturnValue('mock');
-    mockGetAnnotationValue('unknown-type', 'value');
-
-    const validationErrors = TemplateValidator.validate(['template.html']);
-
-    expect(validationErrors.length).toBe(1);
-  });
-
-  it('returns error if template type is not found', async () => {
-    fs.readFileSync.mockReturnValue('mock');
-    mockGetAnnotationValue(null, 'value');
-
-    const validationErrors = TemplateValidator.validate(['template.html']);
-
-    expect(validationErrors.length).toBe(1);
-  });
-
-  it('returns no error if template annotation has label and screenshotPath', async () => {
-    fs.readFileSync.mockReturnValue('mock');
-    mockGetAnnotationValue('page', 'value');
-
-    const validationErrors = TemplateValidator.validate(['template.html']);
-
-    expect(validationErrors.length).toBe(0);
-  });
-});

package/lib/validators/__tests__/ThemeConfigValidator.js

@@ -1,70 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const ThemeConfigValidator = require('../../validators/marketplaceValidators/theme/ThemeConfigValidator');
-const { VALIDATION_RESULT } = require('../../validators/constants');
-const { THEME_PATH } = require('./validatorTestUtils');
-
-jest.mock('fs');
-jest.mock('path');
-
-describe('validators/marketplaceValidators/theme/ThemeConfigValidator', () => {
-  beforeEach(() => {
-    ThemeConfigValidator.setAbsolutePath(THEME_PATH);
-  });
-
-  it('returns error if no theme.json file exists', async () => {
-    const validationErrors = ThemeConfigValidator.validate(['someFile.html']);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if theme.json file has invalid json', async () => {
-    fs.readFileSync.mockReturnValue('{} bad json }');
-
-    const validationErrors = ThemeConfigValidator.validate(['theme.json']);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if theme.json file is missing a label field', async () => {
-    fs.readFileSync.mockReturnValue('{ "screenshot_path": "./relative/path" }');
-
-    const validationErrors = ThemeConfigValidator.validate(['theme.json']);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if theme.json has screenshot path that is non-relative', async () => {
-    fs.readFileSync.mockReturnValue(
-      '{ "label": "yay", "screenshot_path": "/absolute/path" }'
-    );
-
-    const validationErrors = ThemeConfigValidator.validate(['theme.json']);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if theme.json has screenshot path that does not resolve', async () => {
-    fs.readFileSync.mockReturnValue(
-      '{ "label": "yay", "screenshot_path": "/absolute/path" }'
-    );
-    path.relative.mockReturnValue('theme.json');
-    fs.existsSync.mockReturnValue(false);
-
-    const validationErrors = ThemeConfigValidator.validate(['theme.json']);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns no error if theme.json file exists and has all required fields', async () => {
-    fs.readFileSync.mockReturnValue(
-      '{ "label": "yay", "screenshot_path": "./relative/path" }'
-    );
-    path.relative.mockReturnValue('theme.json');
-    fs.existsSync.mockReturnValue(true);
-
-    const validationErrors = ThemeConfigValidator.validate(['theme.json']);
-    expect(validationErrors.length).toBe(0);
-  });
-});

package/lib/validators/__tests__/ThemeDependencyValidator.js

@@ -1,89 +0,0 @@
-const fs = require('fs-extra');
-const marketplace = require('@hubspot/cli-lib/api/marketplace');
-
-const ThemeDependencyValidator = require('../marketplaceValidators/theme/ThemeDependencyValidator');
-const { VALIDATION_RESULT } = require('../constants');
-const { THEME_PATH } = require('./validatorTestUtils');
-
-jest.mock('fs-extra');
-jest.mock('@hubspot/cli-lib/api/marketplace');
-
-const getMockDependencyResult = (customPaths = []) => {
-  const result = {
-    dependencies: ['./relative/file-2.js', ...customPaths],
-  };
-  return Promise.resolve(result);
-};
-
-describe('validators/marketplaceValidators/theme/ThemeDependencyValidator', () => {
-  beforeEach(() => {
-    ThemeDependencyValidator.setAbsolutePath(THEME_PATH);
-  });
-
-  describe('isExternalDep', () => {
-    beforeEach(() => {
-      ThemeDependencyValidator.setAbsolutePath(THEME_PATH);
-    });
-
-    it('returns true if dep is external to the provided absolute path', () => {
-      const absoluteFilePath = `${THEME_PATH}/file.js`;
-      const relativeDepPath = '../external/dep/path/file2.js';
-      const isExternal = ThemeDependencyValidator.isExternalDep(
-        absoluteFilePath,
-        relativeDepPath
-      );
-      expect(isExternal).toBe(true);
-    });
-
-    it('returns false if dep is not external to the provided absolute path', () => {
-      const absoluteFilePath = `${THEME_PATH}/file.js`;
-      const relativeDepPath = './internal/dep/path/file2.js';
-      const isExternal = ThemeDependencyValidator.isExternalDep(
-        absoluteFilePath,
-        relativeDepPath
-      );
-      expect(isExternal).toBe(false);
-    });
-  });
-
-  describe('validate', () => {
-    beforeEach(() => {
-      fs.readFile.mockImplementation(() => Promise.resolve('source'));
-    });
-
-    it('returns error if any referenced path is absolute', async () => {
-      marketplace.fetchTemplateDependencies.mockReturnValue(
-        getMockDependencyResult(['/absolute/file-3.js'])
-      );
-      const validationErrors = await ThemeDependencyValidator.validate([
-        `${THEME_PATH}/template.html`,
-      ]);
-
-      expect(validationErrors.length).toBe(1);
-      expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-    });
-
-    it('returns error if any referenced path is external to the theme', async () => {
-      marketplace.fetchTemplateDependencies.mockReturnValue(
-        getMockDependencyResult(['../../external/file-3.js'])
-      );
-      const validationErrors = await ThemeDependencyValidator.validate([
-        `${THEME_PATH}/template.html`,
-      ]);
-
-      expect(validationErrors.length).toBe(1);
-      expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-    });
-
-    it('returns no errors if paths are relative and internal', async () => {
-      marketplace.fetchTemplateDependencies.mockReturnValue(
-        getMockDependencyResult()
-      );
-      const validationErrors = await ThemeDependencyValidator.validate([
-        `${THEME_PATH}/template.html`,
-      ]);
-
-      expect(validationErrors.length).toBe(0);
-    });
-  });
-});

package/lib/validators/__tests__/ThemeModuleValidator.js

@@ -1,84 +0,0 @@
-const fs = require('fs');
-const ThemeModuleValidator = require('../marketplaceValidators/theme/ThemeModuleValidator');
-const { VALIDATION_RESULT } = require('../constants');
-const {
-  generateModulesList,
-  makeFindError,
-  THEME_PATH,
-} = require('./validatorTestUtils');
-
-jest.mock('fs');
-
-const MODULE_LIMIT = 50;
-
-const findError = makeFindError('themeModule');
-
-describe('validators/marketplaceValidators/theme/ThemeModuleValidator', () => {
-  beforeEach(() => {
-    ThemeModuleValidator.setAbsolutePath(THEME_PATH);
-  });
-
-  it('returns error if module limit is exceeded', async () => {
-    const validationErrors = ThemeModuleValidator.validate(
-      generateModulesList(MODULE_LIMIT + 1)
-    );
-    const limitError = findError(validationErrors, 'limitExceeded');
-    expect(limitError).toBeDefined();
-    expect(limitError.result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns no limit error if module limit is not exceeded', async () => {
-    const validationErrors = ThemeModuleValidator.validate(
-      generateModulesList(MODULE_LIMIT)
-    );
-    const limitError = findError(validationErrors, 'limitExceeded');
-    expect(limitError).not.toBeDefined();
-  });
-
-  it('returns error if no module meta.json file exists', async () => {
-    const validationErrors = ThemeModuleValidator.validate([
-      'module.module/module.html',
-    ]);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if module meta.json file has invalid json', async () => {
-    fs.readFileSync.mockReturnValue('{} bad json }');
-
-    const validationErrors = ThemeModuleValidator.validate([
-      'module.module/meta.json',
-    ]);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if module meta.json file is missing a label field', async () => {
-    fs.readFileSync.mockReturnValue('{ "icon": "woo" }');
-
-    const validationErrors = ThemeModuleValidator.validate([
-      'module.module/meta.json',
-    ]);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns error if module meta.json file is missing an icon field', async () => {
-    fs.readFileSync.mockReturnValue('{ "label": "yay" }');
-
-    const validationErrors = ThemeModuleValidator.validate([
-      'module.module/meta.json',
-    ]);
-    expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-  });
-
-  it('returns no error if module meta.json file exists and has all required fields', async () => {
-    fs.readFileSync.mockReturnValue('{ "label": "yay", "icon": "woo" }');
-
-    const validationErrors = ThemeModuleValidator.validate([
-      'module.module/meta.json',
-    ]);
-    expect(validationErrors.length).toBe(0);
-  });
-});

package/lib/validators/marketplaceValidators/AbsoluteValidator.js

@@ -1,50 +0,0 @@
-const path = require('path');
-
-const { VALIDATION_RESULT } = require('../constants');
-
-class AbsoluteValidator {
-  constructor({ name, key }) {
-    this.name = name;
-    this.key = key;
-  }
-
-  clearAbsolutePath() {
-    this._absolutePath = null;
-  }
-
-  setAbsolutePath(path) {
-    this._absolutePath = path;
-  }
-
-  getRelativePath(filePath) {
-    return this._absolutePath
-      ? path.relative(this._absolutePath, filePath)
-      : filePath;
-  }
-
-  getSuccess() {
-    return {
-      validatorKey: this.key,
-      validatorName: this.name,
-      result: VALIDATION_RESULT.SUCCESS,
-    };
-  }
-
-  getError(errorObj, file, extraContext = {}) {
-    const relativeFilePath = file ? this.getRelativePath(file) : null;
-    const context = {
-      filePath: relativeFilePath,
-      ...extraContext,
-    };
-    return {
-      validatorKey: this.key,
-      validatorName: this.name,
-      error: errorObj.getCopy(context),
-      result: errorObj.severity || VALIDATION_RESULT.FATAL,
-      key: `${this.key}.${errorObj.key}`,
-      context,
-    };
-  }
-}
-
-module.exports = AbsoluteValidator;

package/lib/validators/marketplaceValidators/theme/SectionValidator.js

@@ -1,96 +0,0 @@
-const {
-  ANNOTATION_KEYS,
-  buildAnnotationValueGetter,
-} = require('@hubspot/cli-lib/templates');
-const AbsoluteValidator = require('../AbsoluteValidator');
-const { VALIDATOR_KEYS } = require('../../constants');
-
-const SECTION_LIMIT = 50;
-
-class SectionValidator extends AbsoluteValidator {
-  constructor(options) {
-    super(options);
-
-    this.errors = {
-      LIMIT_EXCEEDED: {
-        key: 'limitExceeded',
-        getCopy: ({ limit, total }) =>
-          `Section limit exceeded. Themes can only have ${limit} sections, but this theme has ${total}`,
-      },
-      MISSING_LABEL: {
-        key: 'missingLabel',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The section is missing the "label" property`,
-      },
-      MISSING_SCREENSHOT_PATH: {
-        key: 'missingScreenshotPath',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The section is missing the "screenshotPath" property`,
-      },
-      MISSING_DESCRIPTION: {
-        key: 'missingDescription',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The section is missing the "description" property`,
-      },
-    };
-  }
-
-  // Validates:
-  // - All sections have a "description" annotation
-  // - All sections have a "label" annotation
-  // - All sections have a "screenshotPath" annotation
-  // - Theme does not have more than SECTION_LIMIT sections
-
-  validate(files) {
-    let validationErrors = [];
-    let sectionCount = 0;
-
-    files.forEach(file => {
-      if (file) {
-        const getAnnotationValue = buildAnnotationValueGetter(file);
-        const templateType = getAnnotationValue(ANNOTATION_KEYS.templateType);
-
-        if (templateType !== 'section') {
-          return;
-        }
-        sectionCount++;
-
-        const description = getAnnotationValue(ANNOTATION_KEYS.description);
-        const label = getAnnotationValue(ANNOTATION_KEYS.label);
-        const screenshotPath = getAnnotationValue(
-          ANNOTATION_KEYS.screenshotPath
-        );
-
-        if (!description) {
-          validationErrors.push(
-            this.getError(this.errors.MISSING_DESCRIPTION, file)
-          );
-        }
-        if (!label) {
-          validationErrors.push(this.getError(this.errors.MISSING_LABEL, file));
-        }
-        if (!screenshotPath) {
-          validationErrors.push(
-            this.getError(this.errors.MISSING_SCREENSHOT_PATH, file)
-          );
-        }
-      }
-    });
-
-    if (sectionCount > SECTION_LIMIT) {
-      validationErrors.push(
-        this.getError(this.errors.LIMIT_EXCEEDED, null, {
-          limit: SECTION_LIMIT,
-          total: sectionCount,
-        })
-      );
-    }
-
-    return validationErrors;
-  }
-}
-
-module.exports = new SectionValidator({
-  name: 'Section',
-  key: VALIDATOR_KEYS.section,
-});

package/lib/validators/marketplaceValidators/theme/TemplateValidator.js

@@ -1,175 +0,0 @@
-const {
-  ANNOTATION_KEYS,
-  buildAnnotationValueGetter,
-  isCodedFile,
-} = require('@hubspot/cli-lib/templates');
-const AbsoluteValidator = require('../AbsoluteValidator');
-const { VALIDATOR_KEYS } = require('../../constants');
-
-const TEMPLATE_LIMIT = 50;
-const TEMPLATE_IGNORE_LIST = ['section'];
-const TEMPLATE_COUNT_IGNORE_LIST = ['global_partial', 'section', 'none'];
-const VALIDATIONS_BY_TYPE = {
-  page: { allowed: true, label: true, screenshot: true },
-  starter_landing_pages: { allowed: false },
-  email: { allowed: false },
-  blog: { allowed: false },
-  none: { allowed: true, label: false, screenshot: false },
-  error_page: { allowed: true, label: true, screenshot: false },
-  password_prompt_page: { allowed: true, label: true, screenshot: false },
-  email_subscription_preferences_page: {
-    allowed: true,
-    label: true,
-    screenshot: false,
-  },
-  email_backup_unsubscribe_page: {
-    allowed: true,
-    label: true,
-    screenshot: false,
-  },
-  email_subscriptions_confirmation_page: {
-    allowed: true,
-    label: true,
-    screenshot: false,
-  },
-  search_results_page: { allowed: true, label: true, screenshot: false },
-  membership_login_page: { allowed: true, label: true, screenshot: false },
-  membership_register_page: { allowed: true, label: true, screenshot: false },
-  membership_reset_page: { allowed: true, label: true, screenshot: false },
-  membership_reset_request_page: {
-    allowed: true,
-    label: true,
-    screenshot: false,
-  },
-  membership_email_page: { allowed: true, label: true, screenshot: false },
-  global_partial: { allowed: true, label: true, screenshot: false },
-  knowledge_article: { allowed: false },
-  drag_drop_email: { allowed: false },
-  proposal: { allowed: false },
-  blog_listing: { allowed: true, label: true, screenshot: true },
-  blog_post: { allowed: true, label: true, screenshot: true },
-};
-
-class TemplateValidator extends AbsoluteValidator {
-  constructor(options) {
-    super(options);
-
-    this.errors = {
-      LIMIT_EXCEEDED: {
-        key: 'limitExceeded',
-        getCopy: ({ limit, total }) =>
-          `Template limit exceeded. Themes can only have ${limit} templates, but this theme has ${total}`,
-      },
-      MISSING_TEMPLATE_TYPE: {
-        key: 'missingTemplateType',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The template is missing the "templateType" property`,
-      },
-      UNKNOWN_TEMPLATE_TYPE: {
-        key: 'unknownTemplateType',
-        getCopy: ({ filePath, templateType }) =>
-          `Template ${filePath} has an unknown template type  of ${templateType}`,
-      },
-      RESTRICTED_TEMPLATE_TYPE: {
-        key: 'restrictedTemplateType',
-        getCopy: ({ filePath, templateType }) =>
-          `Template ${filePath} has a restricted template type of ${templateType}`,
-      },
-      MISSING_LABEL: {
-        key: 'missingLabel',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The template is missing the "label" property`,
-      },
-      MISSING_SCREENSHOT_PATH: {
-        key: 'missingScreenshotPath',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The template is missing the "screenshotPath" property`,
-      },
-    };
-  }
-
-  // Validates:
-  // - Theme does not contain more than TEMPLATE_LIMIT templates
-  // - All templates have valid template types
-  // - All templates that require a label have a "label" annotation
-  // - All templates that require a screenshot have a "screenshotPath" annotation
-  validate(files) {
-    let validationErrors = [];
-    let templateCount = 0;
-
-    files.forEach(file => {
-      if (isCodedFile(file)) {
-        const getAnnotationValue = buildAnnotationValueGetter(file);
-        const isAvailableForNewContent = getAnnotationValue(
-          ANNOTATION_KEYS.isAvailableForNewContent
-        );
-
-        if (isAvailableForNewContent !== 'false') {
-          const templateType = getAnnotationValue(ANNOTATION_KEYS.templateType);
-
-          if (TEMPLATE_IGNORE_LIST.includes(templateType)) {
-            return;
-          }
-
-          if (templateType) {
-            const label = getAnnotationValue(ANNOTATION_KEYS.label);
-            const screenshotPath = getAnnotationValue(
-              ANNOTATION_KEYS.screenshotPath
-            );
-
-            // Ignore global partials, sections, and templates with type of none in count
-            if (!TEMPLATE_COUNT_IGNORE_LIST.includes(templateType)) {
-              templateCount++;
-            }
-
-            const validations = VALIDATIONS_BY_TYPE[templateType];
-
-            if (validations) {
-              if (!validations.allowed) {
-                validationErrors.push(
-                  this.getError(this.errors.RESTRICTED_TEMPLATE_TYPE, file, {
-                    templateType,
-                  })
-                );
-              }
-              if (validations.label && !label) {
-                validationErrors.push(
-                  this.getError(this.errors.MISSING_LABEL, file)
-                );
-              }
-              if (validations.screenshot && !screenshotPath) {
-                validationErrors.push(
-                  this.getError(this.errors.MISSING_SCREENSHOT_PATH, file)
-                );
-              }
-            } else {
-              validationErrors.push(
-                this.getError(this.errors.UNKNOWN_TEMPLATE_TYPE, file)
-              );
-            }
-          } else {
-            validationErrors.push(
-              this.getError(this.errors.MISSING_TEMPLATE_TYPE, file)
-            );
-          }
-        }
-      }
-    });
-
-    if (templateCount > TEMPLATE_LIMIT) {
-      validationErrors.push(
-        this.getError(this.errors.LIMIT_EXCEEDED, null, {
-          limit: TEMPLATE_LIMIT,
-          total: templateCount,
-        })
-      );
-    }
-
-    return validationErrors;
-  }
-}
-
-module.exports = new TemplateValidator({
-  name: 'Template',
-  key: VALIDATOR_KEYS.template,
-});