[FEATURE] added error code to hld install-manifest-pipeline command (#526)

* [FEATURE] added error code to hld install-manifest-pipeline command

* correct error identifier

Author: dennisseah

src/commands/hld/pipeline.test.ts

@@ -182,7 +182,15 @@ describe("test populateValues function", () => {
         pipelineName: "",
         yamlFileBranch: "",
       })
-    ).toThrow(`GitHub repos are not supported`);
+    ).toThrow(
+      getErrorMessage({
+        errorKey: "hld-install-manifest-pipeline-cmd-validate-repo-err",
+        values: [
+          "https://github.com/fabrikam/hld",
+          "https://github.com/fabrikam/materialized",
+        ],
+      })
+    );
   });
   it("negative tests: missing and invalid org name", () => {
     orgNameTest(false);

src/commands/hld/pipeline.ts

@@ -16,6 +16,8 @@ import {
   BUILD_SCRIPT_URL,
   RENDER_HLD_PIPELINE_FILENAME,
 } from "../../lib/constants";
+import { build as buildError, log as logError } from "../../lib/errorBuilder";
+import { errorStatusCode } from "../../lib/errorStatusCode";
 import { AzureDevOpsOpts } from "../../lib/git";
 import { getRepositoryName, isGitHubUrl } from "../../lib/gitutils";
 import {
@@ -52,7 +54,10 @@ const validateRepos = (hldRepoUrl: string, manifestRepoUrl: string): void => {
   const hldGitUrlType = isGitHubUrl(hldRepoUrl);
   const manifestGitUrlType = isGitHubUrl(manifestRepoUrl);
   if (hldGitUrlType || manifestGitUrlType) {
-    throw Error(`GitHub repos are not supported`);
+    throw buildError(errorStatusCode.GIT_OPS_ERR, {
+      errorKey: "hld-install-manifest-pipeline-cmd-validate-repo-err",
+      values: [hldRepoUrl, manifestRepoUrl],
+    });
   }
 };
 
@@ -122,8 +127,6 @@ export const requiredPipelineVariables = (
 export const installHldToManifestPipeline = async (
   values: CommandOptions
 ): Promise<void> => {
-  let builtDefinition;
-
   const devopsClient = await getBuildApiClient(
     values.orgName,
     values.personalAccessToken
@@ -149,34 +152,22 @@ export const installHldToManifestPipeline = async (
     `Attempting to create new pipeline: ${values.pipelineName} defined in repository:${values.hldUrl}, branch: ${values.yamlFileBranch}, filePath: ${RENDER_HLD_PIPELINE_FILENAME}`
   );
 
-  try {
-    builtDefinition = await createPipelineForDefinition(
-      devopsClient as IBuildApi,
-      values.devopsProject,
-      definition
-    );
-  } catch (err) {
-    logger.error(
-      `Error occurred during pipeline creation for ${values.pipelineName}`
-    );
-    throw err; // caller will catch and exit
-  }
+  // createPipelineForDefinition is already throwing error code.
+  const builtDefinition = await createPipelineForDefinition(
+    devopsClient as IBuildApi,
+    values.devopsProject,
+    definition
+  );
 
   logger.info(`Created pipeline for ${values.pipelineName}`);
   logger.info(`Pipeline ID: ${(builtDefinition as BuildDefinition).id}`);
 
-  try {
-    await queueBuild(
-      devopsClient as IBuildApi,
-      values.devopsProject,
-      builtDefinition.id as number
-    );
-  } catch (err) {
-    logger.error(
-      `Error occurred when queueing build for ${values.pipelineName}`
-    );
-    throw err; // caller will catch and exit
-  }
+  // queueBuild is already throwing error code.
+  await queueBuild(
+    devopsClient as IBuildApi,
+    values.devopsProject,
+    builtDefinition.id as number
+  );
 };
 
 export const execute = async (
@@ -202,9 +193,7 @@ export const execute = async (
     await installHldToManifestPipeline(opts);
     await exitFn(0);
   } catch (err) {
-    logger.error(
-      `Error occurred installing pipeline for HLD to Manifest pipeline`
-    );
+    logError(buildError(errorStatusCode.CMD_EXE_ERR, "", err));
     logger.error(err);
     await exitFn(1);
   }

src/lib/i18n.json

@@ -30,7 +30,7 @@
     "bedrock-config-invalid": "Invalid helm configuration found in {0}.",
     "config-file-not-defined": "Pipeline yaml file name is undefined.",
 
-    "hld-init-cmd-failed": "Hld init command was not successfully executed.",
+    "hld-init-cmd-failed": "hld init command was not successfully executed.",
     "hld-init-cmd-project-path-missing": "Value for project path was not provided. Provide it.",
 
     "hld-reconcile-err-repo-create": "Error creating repository component '{0}' in path '{1}'.",
@@ -45,6 +45,9 @@
     "hld-reconcile-err-cmd-exe": "An error occurred while reconciling HLD.",
     "hld-reconcile-err-purge-repo-comps": "Could not purge hld repository component {0} in path {1}.",
 
+    "hld-install-manifest-pipeline-cmd-failed": "hld install-manifest-pipeline command was not successfully executed.",
+    "hld-install-manifest-pipeline-cmd-validate-repo-err": "Could not validate repositories. {0} and/or {1} may not be supported.",
+
     "infra-scaffold-cmd-failed": "Infra scaffold command was not successfully executed.",
     "infra-scaffold-cmd-src-missing": "Value for source is required because it cannot be constructed with properties in spk-config.yaml. Provide value for source.",
     "infra-scaffold-cmd-values-missing": "Values for name, version and/or 'template were missing. Provide value for values for them.",