[FEATURE] Add error status code to deployment dashboard command (#485)

* [FEATURE] Add error status code to deployment dashboard command

* Update dashboard.test.ts

Co-authored-by: Samiya Akhtar <[email protected]>

Author: dennisseah

src/commands/deployment/dashboard.test.ts

@@ -79,7 +79,7 @@ describe("Test validateValues function", () => {
       expect(true).toBe(false);
     } catch (e) {
       expect(e.message).toBe(
-        "value for port option has to be a valid port number"
+        "introspect-dashboard-cmd-invalid-port: value for port option has to be a valid port number. Enter a valid port number."
       );
     }
   });
@@ -95,7 +95,7 @@ describe("Test validateValues function", () => {
       expect(true).toBe(false);
     } catch (e) {
       expect(e.message).toBe(
-        "You need to specify configuration for your introspection storage account and DevOps pipeline to run this dashboard. Please initialize the spk tool with the right configuration"
+        "introspect-dashboard-cmd-missing-vals: Configuration for storage account and DevOps pipeline were missing. Initialize the spk tool with the right configuration."
       );
     }
   });

src/commands/deployment/dashboard.ts

@@ -9,6 +9,12 @@ import { isPortNumberString, validatePrereqs } from "../../lib/validator";
 import { logger } from "../../logger";
 import { ConfigYaml } from "../../types";
 import decorator from "./dashboard.decorator.json";
+import {
+  build as buildError,
+  log as logError,
+  build,
+} from "../../lib/errorBuilder";
+import { errorStatusCode } from "../../lib/errorStatusCode";
 
 export interface IntrospectionManifest {
   githubUsername?: string;
@@ -49,7 +55,10 @@ export const validateValues = (
 ): DashboardConfig => {
   if (opts.port) {
     if (!isPortNumberString(opts.port)) {
-      throw new Error("value for port option has to be a valid port number");
+      throw buildError(
+        errorStatusCode.VALIDATION_ERR,
+        "introspect-dashboard-cmd-invalid-port"
+      );
     }
   }
 
@@ -66,8 +75,9 @@ export const validateValues = (
     !config.introspection.dashboard ||
     !config.introspection.dashboard.image
   ) {
-    throw new Error(
-      "You need to specify configuration for your introspection storage account and DevOps pipeline to run this dashboard. Please initialize the spk tool with the right configuration"
+    throw buildError(
+      errorStatusCode.VALIDATION_ERR,
+      "introspect-dashboard-cmd-missing-vals"
     );
   }
 
@@ -92,21 +102,29 @@ export const validateValues = (
 export const cleanDashboardContainers = async (
   config: DashboardConfig
 ): Promise<void> => {
-  let dockerOutput = await exec("docker", [
-    "ps",
-    "-a",
-    "-q",
-    "--filter",
-    "ancestor=" + config.image,
-    '--format="{{.ID}}"',
-  ]);
-  if (dockerOutput.length > 0) {
-    dockerOutput = dockerOutput.replace(/\n/g, " ");
-    dockerOutput = dockerOutput.replace(/"/g, "");
-    const containerIds = dockerOutput.split(" ");
-    const args = ["kill", ...containerIds];
+  try {
+    let dockerOutput = await exec("docker", [
+      "ps",
+      "-a",
+      "-q",
+      "--filter",
+      "ancestor=" + config.image,
+      '--format="{{.ID}}"',
+    ]);
+    if (dockerOutput.length > 0) {
+      dockerOutput = dockerOutput.replace(/\n/g, " ");
+      dockerOutput = dockerOutput.replace(/"/g, "");
+      const containerIds = dockerOutput.split(" ");
+      const args = ["kill", ...containerIds];
 
-    await exec("docker", args);
+      await exec("docker", args);
+    }
+  } catch (err) {
+    throw buildError(
+      errorStatusCode.DOCKER_ERR,
+      "introspect-dashboard-cmd-kill-docker-container",
+      err
+    );
   }
 };
 
@@ -143,60 +161,70 @@ export const extractManifestRepositoryInformation = (
 export const getEnvVars = async (
   config: DashboardConfig
 ): Promise<string[]> => {
-  const envVars = [
-    "-e",
-    `REACT_APP_PIPELINE_ORG=${config.org}`,
-    "-e",
-    `REACT_APP_PIPELINE_PROJECT=${config.project}`,
-    "-e",
-    `REACT_APP_STORAGE_ACCOUNT_NAME=${config.accountName}`,
-    "-e",
-    `REACT_APP_STORAGE_PARTITION_KEY=${config.partitionKey}`,
-    "-e",
-    `REACT_APP_STORAGE_TABLE_NAME=${config.tableName}`,
-    "-e",
-    `REACT_APP_STORAGE_ACCESS_KEY=${config.key}`,
-  ];
+  try {
+    const envVars = [
+      "-e",
+      `REACT_APP_PIPELINE_ORG=${config.org}`,
+      "-e",
+      `REACT_APP_PIPELINE_PROJECT=${config.project}`,
+      "-e",
+      `REACT_APP_STORAGE_ACCOUNT_NAME=${config.accountName}`,
+      "-e",
+      `REACT_APP_STORAGE_PARTITION_KEY=${config.partitionKey}`,
+      "-e",
+      `REACT_APP_STORAGE_TABLE_NAME=${config.tableName}`,
+      "-e",
+      `REACT_APP_STORAGE_ACCESS_KEY=${config.key}`,
+    ];
 
-  if (config.accessToken) {
-    envVars.push("-e");
-    envVars.push(`REACT_APP_PIPELINE_ACCESS_TOKEN=${config.accessToken}`);
+    if (config.accessToken) {
+      envVars.push("-e");
+      envVars.push(`REACT_APP_PIPELINE_ACCESS_TOKEN=${config.accessToken}`);
 
-    if (!config.sourceRepoAccessToken) {
+      if (!config.sourceRepoAccessToken) {
+        envVars.push("-e");
+        envVars.push(
+          `REACT_APP_SOURCE_REPO_ACCESS_TOKEN=${config.accessToken}`
+        );
+        envVars.push("-e");
+        envVars.push(`REACT_APP_MANIFEST_ACCESS_TOKEN=${config.accessToken}`);
+      }
+    } else {
+      logger.warn(
+        "Pipeline access token was not specified during init, dashboard may show empty results if pipelines are private"
+      );
+    }
+    if (config.sourceRepoAccessToken) {
       envVars.push("-e");
-      envVars.push(`REACT_APP_SOURCE_REPO_ACCESS_TOKEN=${config.accessToken}`);
+      envVars.push(
+        `REACT_APP_SOURCE_REPO_ACCESS_TOKEN=${config.sourceRepoAccessToken}`
+      );
       envVars.push("-e");
-      envVars.push(`REACT_APP_MANIFEST_ACCESS_TOKEN=${config.accessToken}`);
+      envVars.push(
+        `REACT_APP_MANIFEST_ACCESS_TOKEN=${config.sourceRepoAccessToken}`
+      );
     }
-  } else {
-    logger.warn(
-      "Pipeline access token was not specified during init, dashboard may show empty results if pipelines are private"
-    );
-  }
-  if (config.sourceRepoAccessToken) {
-    envVars.push("-e");
-    envVars.push(
-      `REACT_APP_SOURCE_REPO_ACCESS_TOKEN=${config.sourceRepoAccessToken}`
-    );
-    envVars.push("-e");
-    envVars.push(
-      `REACT_APP_MANIFEST_ACCESS_TOKEN=${config.sourceRepoAccessToken}`
-    );
-  }
 
-  const manifestRepo = extractManifestRepositoryInformation(config);
-  if (manifestRepo) {
-    envVars.push("-e");
-    envVars.push(`REACT_APP_MANIFEST=${manifestRepo.manifestRepoName}`);
-    if (manifestRepo.githubUsername) {
+    const manifestRepo = extractManifestRepositoryInformation(config);
+    if (manifestRepo) {
       envVars.push("-e");
-      envVars.push(
-        `REACT_APP_GITHUB_MANIFEST_USERNAME=${manifestRepo.githubUsername}`
-      );
+      envVars.push(`REACT_APP_MANIFEST=${manifestRepo.manifestRepoName}`);
+      if (manifestRepo.githubUsername) {
+        envVars.push("-e");
+        envVars.push(
+          `REACT_APP_GITHUB_MANIFEST_USERNAME=${manifestRepo.githubUsername}`
+        );
+      }
     }
-  }
 
-  return envVars;
+    return envVars;
+  } catch (err) {
+    throw buildError(
+      errorStatusCode.ENV_SETTING_ERR,
+      "introspect-dashboard-cmd-get-env",
+      err
+    );
+  }
 };
 
 /**
@@ -211,7 +239,10 @@ export const launchDashboard = async (
 ): Promise<string> => {
   try {
     if (!validatePrereqs(["docker"], false)) {
-      throw new Error("Requirements to launch dashboard are not met");
+      throw buildError(
+        errorStatusCode.DOCKER_ERR,
+        "introspect-dashboard-cmd-launch-pre-req-err"
+      );
     }
 
     if (removeAll) {
@@ -233,8 +264,11 @@ export const launchDashboard = async (
     ]);
     return containerId;
   } catch (err) {
-    logger.error(`Error occurred while launching dashboard ${err}`);
-    throw err;
+    throw buildError(
+      errorStatusCode.DOCKER_ERR,
+      "introspect-dashboard-cmd-launch-err",
+      err
+    );
   }
 };
 
@@ -257,7 +291,13 @@ export const execute = async (
     }
     await exitFn(0);
   } catch (err) {
-    logger.error(err);
+    logError(
+      buildError(
+        errorStatusCode.CMD_EXE_ERR,
+        "introspect-dashboard-cmd-failed",
+        err
+      )
+    );
     await exitFn(1);
   }
 };

src/lib/errorStatusCode.ts

@@ -10,4 +10,5 @@ export enum errorStatusCode {
   INCORRECT_DEFINITION = 1012,
   GIT_OPS_ERR = 1100,
   AZURE_STORAGE_OP_ERR = 2000,
+  DOCKER_ERR = 3000,
 }

src/lib/i18n.json

@@ -78,6 +78,14 @@
     "introspect-create-cmd-cmd-p1-missing-values": "Values for image-tag, commit-id and service options were missing. They are required for updating the details of source pipeline. Provide them.",
     "introspect-create-cmd-cmd-p2-missing-values": "Values for p2, hld-commit-id, image-tag and env options were missing. They are required For updating the details of image tag release pipeline. Provide them.",
 
+    "introspect-dashboard-cmd-failed": "Deployment dashboard command was not successfully executed.",
+    "introspect-dashboard-cmd-invalid-port": "value for port option has to be a valid port number. Enter a valid port number.",
+    "introspect-dashboard-cmd-missing-vals": "Configuration for storage account and DevOps pipeline were missing. Initialize the spk tool with the right configuration.",
+    "introspect-dashboard-cmd-kill-docker-container": "Could not kill dashboard docker containers.",
+    "introspect-dashboard-cmd-get-env": "Could not get environment parameters.",
+    "introspect-dashboard-cmd-launch-pre-req-err": "Requirements to launch dashboard were not met",
+    "introspect-dashboard-cmd-launch-err": "Could not launch dashboard docker container.",
+
     "deployment-table-update-hld-manifest-pipeline-failed": "Could not update HLD to manifest pipeline.",
     "deployment-table-update-manifest-commit-id-failed": "Could not update manifest commit Id.",
     "deployment-table-update-manifest-commit-id-failed-no-generation": "No manifest generation found to update manifest commit {0}."