refactor to have config code in config.ts

Author: evanlouie

.gitignore

@@ -3,6 +3,7 @@ dist
 package-lock.json
 .DS_Store
 .bedrock
+.idea
 
 # Logs
 logs

src/commands/command.ts

@@ -1,6 +1,5 @@
 import commander from "commander";
 import { enableVerboseLogging, logger } from "../logger";
-import { loadConfiguration } from "./init";
 
 /**
  * General interface to encapsulate a sub-command.
@@ -107,10 +106,15 @@ export const executeCommand = (cmd: ICommand, argv: string[]): void => {
   if (targetCommandName && targetCommand) {
     // If command is a sub-command, it needs to load configuration before
     // sub-command can be executed.
-    loadConfiguration();
     executeCommand(targetCommand, decrementArgv(argv));
   } else {
-    argv.length <= 2 ? cmd.command.outputHelp() : cmd.command.parse(argv);
+    // Top level try/catch. If an error occurs, log it and exit with code 1
+    try {
+      argv.length <= 2 ? cmd.command.outputHelp() : cmd.command.parse(argv);
+    } catch (err) {
+      logger.error(err);
+      process.exit(1);
+    }
   }
 };
 

src/commands/deployment/dashboard.test.ts

@@ -1,12 +1,12 @@
 import * as path from "path";
+import { Config, loadConfiguration } from "../../config";
 import { exec } from "../../lib/shell";
 import {
   disableVerboseLogging,
   enableVerboseLogging,
   logger
 } from "../../logger";
-import { validatePrereqs } from "../infra/vaildate";
-import { config, loadConfiguration } from "./../init";
+import { validatePrereqs } from "../infra/validate";
 import { launchDashboard } from "./dashboard";
 
 beforeAll(() => {
@@ -31,7 +31,7 @@ describe("Validate dashboard container pull", () => {
         const dockerId = await exec("docker", [
           "images",
           "-q",
-          config.introspection!.dashboard!.image!
+          Config().introspection!.dashboard!.image!
         ]);
         expect(dockerId).toBeDefined();
         expect(dashboardContainerId).not.toBe("");

src/commands/deployment/dashboard.ts

@@ -1,10 +1,9 @@
 import commander from "commander";
 import open = require("open");
-import { env } from "shelljs";
+import { Config } from "../../config";
 import { exec } from "../../lib/shell";
 import { logger } from "../../logger";
-import { validatePrereqs } from "../infra/vaildate";
-import { config } from "../init";
+import { validatePrereqs } from "../infra/validate";
 
 /**
  * Adds the onboard command to the commander command object
@@ -17,6 +16,7 @@ export const dashboardCommandDecorator = (command: commander.Command): void => {
     .description("Launch the service introspection dashboard")
     .option("-p, --port <port>", "Port to launch the dashboard on", 4040)
     .action(async opts => {
+      const config = Config();
       if (
         !config.introspection ||
         !config.azure_devops ||
@@ -44,6 +44,7 @@ export const launchDashboard = async (port: number): Promise<string> => {
     if (!(await validatePrereqs(["docker"], false))) {
       return "";
     }
+    const config = Config();
     const dockerRepository = config.introspection!.dashboard!.image!;
     logger.info("Pulling dashboard docker image");
     await exec("docker", ["pull", dockerRepository]);
@@ -65,6 +66,7 @@ export const launchDashboard = async (port: number): Promise<string> => {
 };
 
 const getEnvVars = (): string[] => {
+  const config = Config();
   const envVars = [];
   envVars.push("-e");
   envVars.push("REACT_APP_PIPELINE_ORG=" + config.azure_devops!.org!);

src/commands/deployment/get.ts

@@ -3,8 +3,8 @@ import commander from "commander";
 import Deployment from "spektate/lib/Deployment";
 import AzureDevOpsPipeline from "spektate/lib/pipeline/AzureDevOpsPipeline";
 import IPipeline from "spektate/lib/pipeline/Pipeline";
+import { Config } from "../../config";
 import { logger } from "../../logger";
-import { config } from "../init";
 export let hldPipeline: IPipeline;
 export let clusterPipeline: IPipeline;
 export let srcPipeline: IPipeline;
@@ -123,6 +123,7 @@ export const getDeployments = (
   service?: string,
   deploymentId?: string
 ): Promise<Deployment[]> => {
+  const config = Config();
   return Deployment.getDeploymentsBasedOnFilters(
     config.introspection!.azure!.account_name!,
     config.introspection!.azure!.key!,
@@ -151,6 +152,8 @@ export const getDeployments = (
  * Initializes the pipelines assuming that the configuration has been loaded
  */
 const initialize = () => {
+  const config = Config();
+
   if (
     !config.introspection ||
     !config.azure_devops ||

src/commands/deployment/validate.test.ts

@@ -1,5 +1,5 @@
 import * as path from "path";
-import { config, loadConfiguration } from "./../init";
+import { Config, loadConfiguration } from "../../config";
 import { isValidConfig, isValidStorageAccount } from "./validate";
 
 import { StorageManagementClient } from "@azure/arm-storage";
@@ -55,7 +55,7 @@ describe("Validate deployment configuration", () => {
 
 describe("Validate missing deployment configuration", () => {
   test("no deployment configuration", async () => {
-    config.introspection = undefined;
+    Config().introspection = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -64,7 +64,7 @@ describe("Validate missing deployment configuration", () => {
 
 describe("Validate missing deployment.storage configuration", () => {
   test("missing deployment.storage", async () => {
-    config.introspection!.azure = undefined;
+    Config().introspection!.azure = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -73,7 +73,7 @@ describe("Validate missing deployment.storage configuration", () => {
 
 describe("Validate missing deployment.storage configuration", () => {
   test("missing deployment.storage.account_name configuration", async () => {
-    config.introspection!.azure!.account_name = undefined;
+    Config().introspection!.azure!.account_name = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -82,7 +82,7 @@ describe("Validate missing deployment.storage configuration", () => {
 
 describe("Validate missing deployment.storage configuration", () => {
   test("missing deployment.storage.table_name configuration", async () => {
-    config.introspection!.azure!.table_name = undefined;
+    Config().introspection!.azure!.table_name = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -91,7 +91,7 @@ describe("Validate missing deployment.storage configuration", () => {
 
 describe("Validate missing deployment.storage configuration", () => {
   test("missing deployment.storage.partition_key configuration", async () => {
-    config.introspection!.azure!.partition_key = undefined;
+    Config().introspection!.azure!.partition_key = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -100,7 +100,7 @@ describe("Validate missing deployment.storage configuration", () => {
 
 describe("Validate missing deployment.storage configuration", () => {
   test("missing deployment.storage.key configuration", async () => {
-    config.introspection!.azure!.key = undefined;
+    Config().introspection!.azure!.key = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -109,7 +109,7 @@ describe("Validate missing deployment.storage configuration", () => {
 
 describe("Validate missing deployment.pipeline configuration", () => {
   test("missing deployment.pipeline configuration", async () => {
-    config.azure_devops = undefined;
+    Config().azure_devops = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -118,7 +118,7 @@ describe("Validate missing deployment.pipeline configuration", () => {
 
 describe("Validate missing deployment.pipeline configuration", () => {
   test("missing deployment.pipeline.org configuration", async () => {
-    config.azure_devops!.org = undefined;
+    Config().azure_devops!.org = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -127,7 +127,7 @@ describe("Validate missing deployment.pipeline configuration", () => {
 
 describe("Validate missing deployment.pipeline configuration", () => {
   test("missing deployment.pipeline.project configuration", async () => {
-    config.azure_devops!.project = undefined;
+    Config().azure_devops!.project = undefined;
     const isValid = isValidConfig();
 
     expect(isValid).toBe(false);
@@ -136,30 +136,30 @@ describe("Validate missing deployment.pipeline configuration", () => {
 
 describe("Validate storage account", () => {
   test("non-existing storage account", async () => {
-    config.introspection!.azure!.account_name = "non-existing-account-name";
+    Config().introspection!.azure!.account_name = "non-existing-account-name";
     const isValid = await isValidStorageAccount();
 
     expect(isValid).toBe(false);
   });
 
   test("existing storage account no keys", async () => {
-    config.introspection!.azure!.account_name = "epi-test-no-keys";
+    Config().introspection!.azure!.account_name = "epi-test-no-keys";
     const isValid = await isValidStorageAccount();
 
     expect(isValid).toBe(false);
   });
 
   test("existing storage account with valid key", async () => {
-    config.introspection!.azure!.account_name = "epi-test";
-    config.introspection!.azure!.key = "mock access key2";
+    Config().introspection!.azure!.account_name = "epi-test";
+    Config().introspection!.azure!.key = "mock access key2";
     const isValid = await isValidStorageAccount();
 
     expect(isValid).toBe(true);
   });
 
   test("existing storage account with invalid key", async () => {
-    config.introspection!.azure!.account_name = "epi-test";
-    config.introspection!.azure!.key = "mock access key3";
+    Config().introspection!.azure!.account_name = "epi-test";
+    Config().introspection!.azure!.key = "mock access key3";
     const isValid = await isValidStorageAccount();
 
     expect(isValid).toBe(false);

src/commands/deployment/validate.ts

@@ -1,7 +1,7 @@
 import commander from "commander";
+import { Config } from "../../config";
 import { storageAccountExists } from "../../lib/azure/storage";
 import { logger } from "../../logger";
-import { config } from "../init";
 
 /**
  * Adds the validate command to the commander command object
@@ -23,7 +23,7 @@ export const validateCommandDecorator = (command: commander.Command): void => {
  */
 export const isValidConfig = (): boolean => {
   const missingConfig = [];
-
+  const config = Config();
   if (!config.introspection) {
     missingConfig.push("introspection");
   } else {
@@ -69,6 +69,7 @@ export const isValidConfig = (): boolean => {
  * Check is the configured storage account is valid
  */
 export const isValidStorageAccount = async (): Promise<boolean> => {
+  const config = Config();
   const isValid = await storageAccountExists(
     config.introspection!.azure!.resource_group!,
     config.introspection!.azure!.account_name!,

src/commands/hld/pipeline.ts

@@ -1,22 +1,18 @@
-import commander from "commander";
-
 import { IBuildApi } from "azure-devops-node-api/BuildApi";
-import { logger } from "../../logger";
-
-import { config, loadConfiguration } from "../init";
-
+import {
+  BuildDefinition,
+  BuildDefinitionVariable
+} from "azure-devops-node-api/interfaces/BuildInterfaces";
+import commander from "commander";
+import { Config } from "../../config";
 import {
   createPipelineForDefinition,
   definitionForAzureRepoPipeline,
   getBuildApiClient,
   IAzureRepoPipelineConfig,
   queueBuild
 } from "../../lib/pipelines/pipelines";
-
-import {
-  BuildDefinition,
-  BuildDefinitionVariable
-} from "azure-devops-node-api/interfaces/BuildInterfaces";
+import { logger } from "../../logger";
 
 export const installHldToManifestPipelineDecorator = (
   command: commander.Command
@@ -28,7 +24,7 @@ export const installHldToManifestPipelineDecorator = (
       "Install the manifest generation pipeline to your Azure DevOps instance"
     )
     .action(async () => {
-      loadConfiguration();
+      const config = Config();
 
       if (!config) {
         logger.error("Config failed to load");

src/commands/infra/index.ts

@@ -1,7 +1,7 @@
 import { Command } from "../command";
 import { createCommandDecorator } from "./create";
 import { scaffoldCommandDecorator } from "./scaffold";
-import { validateCommandDecorator } from "./vaildate";
+import { validateCommandDecorator } from "./validate";
 
 export const infraCommand = Command(
   "infra",

src/commands/infra/validate.test.ts

@@ -1,12 +1,17 @@
 import child_process from "child_process";
 import * as path from "path";
-import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
-import { config, loadConfiguration } from "../init";
+import { promisify } from "util";
+import { Config, loadConfiguration } from "../../config";
+import {
+  disableVerboseLogging,
+  enableVerboseLogging,
+  logger
+} from "../../logger";
 import {
   validateAzure,
   validateEnvVariables,
   validatePrereqs
-} from "./vaildate";
+} from "./validate";
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -37,16 +42,18 @@ describe("Validating executable prerequisites in spk-config", () => {
     loadConfiguration(filename);
     const fakeBinaries: string[] = ["ydawgie"];
     await validatePrereqs(fakeBinaries, true);
-    expect(config.infra!).toBeDefined();
-    expect(config.infra!.checks!).toBeDefined();
-    expect(config.infra!.checks!.ydawgie!).toBe(false);
+    expect(Config().infra!).toBeDefined();
+    expect(Config().infra!.checks!).toBeDefined();
+    expect(Config().infra!.checks!.ydawgie!).toBe(false);
   });
 });
 
 describe("Validating Azure authentication", () => {
   test("Validate that a logged out user produces a force fail", async () => {
     // Produce an error that requires user to login
-    child_process.exec("az logout");
+    await promisify(child_process.exec)("az logout").catch(err => {
+      logger.warn(err);
+    });
     const value = await validateAzure(false);
     expect(value).toBe(false);
   });
@@ -61,9 +68,9 @@ describe("Validating Azure login in spk-config", () => {
     process.env.test_key = "my_storage_key";
     loadConfiguration(filename);
     await validateAzure(true);
-    expect(config.infra!).toBeDefined();
-    expect(config.infra!.checks!).toBeDefined();
-    expect(config.infra!.checks!.az_login_check!).toBe(false);
+    expect(Config().infra!).toBeDefined();
+    expect(Config().infra!.checks!).toBeDefined();
+    expect(Config().infra!.checks!.az_login_check!).toBe(false);
   });
 });
 
@@ -87,8 +94,8 @@ describe("Validating environment variables in spk-config", () => {
     process.env.test_key = "my_storage_key";
     loadConfiguration(filename);
     await validateEnvVariables(variables, true);
-    expect(config.infra!).toBeDefined();
-    expect(config.infra!.checks!).toBeDefined();
-    expect(config.infra!.checks!.env_var_check!).toBe(false);
+    expect(Config().infra!).toBeDefined();
+    expect(Config().infra!.checks!).toBeDefined();
+    expect(Config().infra!.checks!.env_var_check!).toBe(false);
   });
 });