Add error codes for project commands (#514)

* Add error codes for project commands

* Change error message

Co-authored-by: Edaena Salinas <[email protected]>
Co-authored-by: Yvonne Radsmikham <[email protected]>
Co-authored-by: Dennis Seah <[email protected]>

Author: 4 people

src/commands/project/create-variable-group.test.ts

@@ -37,6 +37,7 @@ import {
 } from "./create-variable-group";
 import * as createVariableGrp from "./create-variable-group";
 import * as fileutils from "../../lib/fileutils";
+import { getErrorMessage } from "../../lib/errorBuilder";
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -152,7 +153,9 @@ describe("create", () => {
       await create("", "", "", "", "", "", accessOpts);
       expect(true).toBeFalsy();
     } catch (e) {
-      expect(e.message).toBe("Required values were missing");
+      expect(e.message).toBe(
+        getErrorMessage("project-create-variable-group-cmd-err-values-missing")
+      );
     }
   });
 

src/commands/project/create-variable-group.ts

@@ -9,10 +9,7 @@ import {
   exit as exitCmd,
   validateForRequiredValues,
 } from "../../lib/commandBuilder";
-import {
-  PROJECT_INIT_DEPENDENCY_ERROR_MESSAGE,
-  PROJECT_PIPELINE_FILENAME,
-} from "../../lib/constants";
+import { PROJECT_PIPELINE_FILENAME } from "../../lib/constants";
 import { AzureDevOpsOpts } from "../../lib/git";
 import { addVariableGroup } from "../../lib/pipelines/variableGroup";
 import {
@@ -28,6 +25,8 @@ import {
   VariableGroupDataVariable,
 } from "../../types";
 import decorator from "./create-variable-group.decorator.json";
+import { build as buildError, log as logError } from "../../lib/errorBuilder";
+import { errorStatusCode } from "../../lib/errorStatusCode";
 
 // values that we need to pull out from command operator
 interface CommandOptions {
@@ -44,7 +43,10 @@ interface CommandOptions {
 export const checkDependencies = (projectPath: string): void => {
   const fileInfo: BedrockFileInfo = bedrockFileInfo(projectPath);
   if (fileInfo.exist === false) {
-    throw new Error(PROJECT_INIT_DEPENDENCY_ERROR_MESSAGE);
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "project-create-variable-group-cmd-err-dependency"
+    );
   }
 };
 
@@ -84,7 +86,10 @@ export const create = (
     !servicePrincipalPassword ||
     !tenantId
   ) {
-    throw Error("Required values were missing");
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "project-create-variable-group-cmd-err-values-missing"
+    );
   }
 
   const vars: VariableGroupDataVariable = {
@@ -131,10 +136,16 @@ export const setVariableGroupInBedrockFile = (
   variableGroupName: string
 ): void => {
   if (!hasValue(rootProjectPath)) {
-    throw new Error("Project root path is not valid");
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "project-create-variable-group-cmd-err-root-invalid"
+    );
   }
   if (!hasValue(variableGroupName)) {
-    throw new Error("Variable Group Name is not valid");
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "project-create-variable-group-cmd-err-variable-group-invalid"
+    );
   }
 
   const absProjectRoot = path.resolve(rootProjectPath);
@@ -144,7 +155,10 @@ export const setVariableGroupInBedrockFile = (
   const bedrockFile = Bedrock(rootProjectPath);
 
   if (typeof bedrockFile === "undefined") {
-    throw Error(`Bedrock file does not exist.`);
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "project-create-variable-group-cmd-err-bedrock-file-missing"
+    );
   }
 
   logger.verbose(
@@ -170,7 +184,10 @@ export const setVariableGroupInBedrockFile = (
  */
 export const updateLifeCyclePipeline = (rootProjectPath: string): void => {
   if (!hasValue(rootProjectPath)) {
-    throw Error("Project root path is not valid");
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "project-create-variable-group-cmd-err-root-invalid"
+    );
   }
 
   const fileName = PROJECT_PIPELINE_FILENAME;
@@ -183,7 +200,10 @@ export const updateLifeCyclePipeline = (rootProjectPath: string): void => {
   ) as AzurePipelinesYaml;
 
   if (typeof pipelineFile === "undefined") {
-    throw new Error("${fileName} file does not exist in ${absProjectRoot}.");
+    throw buildError(errorStatusCode.VALIDATION_ERR, {
+      errorKey: "project-create-variable-group-cmd-err-file-missing",
+      values: [fileName, absProjectRoot],
+    });
   }
 
   logger.verbose(`${fileName} content: \n ${JSON.stringify(pipelineFile)}`);
@@ -297,8 +317,13 @@ export const execute = async (
     );
     await exitFn(0);
   } catch (err) {
-    logger.error(`Error occurred while creating variable group`);
-    logger.error(err);
+    logError(
+      buildError(
+        errorStatusCode.CMD_EXE_ERR,
+        "project-create-variable-group-cmd-failed",
+        err
+      )
+    );
     await exitFn(1);
   }
 };

src/commands/project/init.ts

@@ -12,6 +12,8 @@ import { exec } from "../../lib/shell";
 import { logger } from "../../logger";
 import { BedrockFile, MaintainersFile } from "../../types";
 import decorator from "./init.decorator.json";
+import { build as buildError, log as logError } from "../../lib/errorBuilder";
+import { errorStatusCode } from "../../lib/errorStatusCode";
 
 // values that we need to pull out from command operator
 interface CommandOptions {
@@ -172,8 +174,9 @@ export const execute = async (
     await initialize(projectPath, { defaultRing });
     await exitFn(0);
   } catch (err) {
-    logger.error(`Error occurred while initializing project ${projectPath}`);
-    logger.error(err);
+    logError(
+      buildError(errorStatusCode.EXE_FLOW_ERR, "project-init-cmd-failed", err)
+    );
     await exitFn(1);
   }
 };

src/lib/i18n.json

@@ -223,6 +223,15 @@
     "variable-group-create-cmd-err-org-missing": "Provide a value for {0}.",
     "variable-group-create-cmd-err-file-missing": "Provide a file with the variable group manifest.",
 
+    "project-create-variable-group-cmd-failed": "Create variable group was not successfully executed.",
+    "project-create-variable-group-cmd-err-root-invalid": "Project root path is not valid. Provide a valid root path.",
+    "project-create-variable-group-cmd-err-variable-group-invalid": "Variable group name is not valid. Provide a valid variable group name.",
+    "project-create-variable-group-cmd-err-bedrock-file-missing": "Bedrock file does not exist. Check that the project directory has been initialized.",
+    "project-create-variable-group-cmd-err-file-missing": "The file '{0}' does not exist in project '{1}'.",
+    "project-create-variable-group-cmd-err-dependency": "Please run `spk project init` command before running this command to initialize the project.",
+    "project-create-variable-group-cmd-err-values-missing": "Required values were missing. Provide values for registry-name, hld-repo-url, service-principal-id, service-principal-password, tenant.",
+    "project-init-cmd-failed": "Project init was not successfully executed.",
+
     "validation-err-missing-vals": "These mandatory options were missing:\n {0}. Provide them.",
     "validation-err-org-name-missing": "Organization name was missing. Provide it.",
     "validation-err-org-name": "Organization name must start with a letter or number, followed by letters, numbers or hyphens, and must end with a letter or number.",