Add resource config validation (without resource defs) + added better name validation

Author: kevinwang5658

codify-core/src/config-compiler/parser/entities/project.test.ts

@@ -60,6 +60,21 @@ describe('Parser: project entity tests', () => {
       name: 'test-project',
       type: 'project',
     })).to.not.throw;
+
+    expect(() => new ProjectConfig({
+      name: '1',
+      type: 'project',
+    })).to.throw;
+
+    expect(() => new ProjectConfig({
+      name: '##ab',
+      type: 'project',
+    })).to.throw;
+
+    expect(() => new ProjectConfig({
+      name: 'abc12',
+      type: 'project',
+    })).to.not.throw;
   })
 
   it('plugin versions must be semvers', () => {

codify-core/src/config-compiler/parser/entities/project.ts

@@ -1,6 +1,7 @@
 import { RemoveMethods } from '../../../utils/types';
 import {
   validateAllowedObjectKeys,
+  validateNameString,
   validateSemver,
   validateStringEq,
   validateTypeRecordStringString,
@@ -53,8 +54,8 @@ export class ProjectConfig implements ConfigBlock {
       throw new Error('Config is not of type project');
     }
 
-    if (config.name && !validateTypeString(config.name)) {
-      throw new Error('Name is not of type string');
+    if (config.name && !validateNameString(config.name)) {
+      throw new Error('Name must be of type string, start with a letter, and only contain [a-z][0-9]_-');
     }
 
     if (config.plugins && !validateTypeRecordStringString) {

codify-core/src/config-compiler/parser/entities/resource.ts

@@ -1,20 +1,55 @@
 import { RemoveMethods } from '../../../utils/types';
+import { validateNameString, validateStringEq, validateTypeRecordStringUnknown, } from '../../../utils/validator';
 import { ConfigBlock, ConfigBlockType } from './index';
 
+/** Resource JSON supported format
+ * {
+ *   "type": "plugin_name_resource_1",
+ *   "name?": "optional-name"
+ *   "parameter1": {
+ *     "plguin1": "^10.6.2", // From registry
+ *     "https://www.github.com/project": "^10.3.2", // url
+ *   }
+ *   "parameter2": "string",
+ *   "parameter3": 1,
+ * }
+ *
+ * We won't be able to validate the parameters until we get the resource definitions from the plugins
+ */
+
 export class ResourceConfig implements ConfigBlock {
   readonly configType = ConfigBlockType.RESOURCE;
 
-  type!: string;
+  type: string;
   name?: string;
-  parameters!: Record<string, unknown>;
+  parameters: Record<string, unknown>;
   dependencies?: Node[] = [];
 
-  constructor(props: Omit<RemoveMethods<ResourceConfig>, 'configType'>) {
-    Object.assign(this, props);
+  constructor(config: unknown) {
+    if (this.validate(config)) {
+      const { name, type, ...params } = config;
+      this.type = type;
+      this.name = name;
+      this.parameters = params ?? {};
+    }
+
+    throw new Error('Unable to parse resource config');
   }
 
-  validate(config: unknown): void {
-    console.log(config);
+  validate(config: unknown): config is RemoveMethods<ResourceConfig> {
+    if (!validateTypeRecordStringUnknown(config)) {
+      throw new Error('Config is not an object');
+    }
+
+    if (!validateStringEq(config.type, 'project')) {
+      throw new Error('Config is not of type project');
+    }
+
+    if (config.name && !validateNameString(config.name)) {
+      throw new Error('Name must be of type string, start with a letter, and only contain a-z0-9_-');
+    }
+
+    return true;
   }
 
 }

codify-core/src/utils/validator.ts

@@ -5,6 +5,7 @@ import { valid as semverValid } from 'semver';
 //******************
 
 const urlRegex = /[\w#%+.:=@~-]{1,256}\.[\d()a-z]{1,6}\b([\w#%&()+./:=?@~-]*)/gi;
+const nameRegex = /^[$_a-z][\w$]*$/gi;
 
 //*****************
 // Validators
@@ -36,6 +37,10 @@ export function validateStringEq(actual: unknown, expected: string): actual is s
   return actual === expected;
 }
 
+export function validateNameString(actual: unknown): actual is string {
+  return validateTypeString(actual) && actual.match(nameRegex) !== null;
+}
+
 export function validateUrl(actual: unknown): actual is string {
   return validateTypeString(actual) && actual.match(urlRegex) !== null;
 }