[REFACTORING] Refactor infra validate ts (#237)

dennisseah · web-flow · commit b5f712418897 · 2020-02-03T09:18:51.000-08:00
* [REFACTOR] infra validate.ts

* corrected incorrect inclusion of decorator json
diff --git a/src/commands/infra/index.ts b/src/commands/infra/index.ts
@@ -1,7 +1,7 @@
 import { Command } from "../command";
 import { commandDecorator as generateCommandDecorator } from "./generate";
 import { commandDecorator as scaffoldCommandDecorator } from "./scaffold";
-import { validateCommandDecorator } from "./validate";
+import { commandDecorator as validateCommandDecorator } from "./validate";
 
 export const infraCommand = Command(
   "infra",
diff --git a/src/commands/infra/validate.decorator.json b/src/commands/infra/validate.decorator.json
@@ -0,0 +1,6 @@
+{
+  "command": "validate",
+  "alias": "v",
+  "description": "Validate will verify that all infrastructure deployment prerequisites have been correctly installed.",
+  "options": []
+}
diff --git a/src/commands/infra/validate.test.ts b/src/commands/infra/validate.test.ts
@@ -1,7 +1,6 @@
 import child_process from "child_process";
 import fs from "fs";
 import yaml from "js-yaml";
-import os from "os";
 import * as path from "path";
 import { promisify } from "util";
 import { Config, defaultConfigFile, loadConfiguration } from "../../config";
@@ -11,10 +10,12 @@ import {
   logger
 } from "../../logger";
 import {
+  execute,
   validateAzure,
   validateEnvVariables,
   validatePrereqs
 } from "./validate";
+import * as validate from "./validate";
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -26,6 +27,39 @@ afterAll(() => {
   jest.setTimeout(5000);
 });
 
+beforeEach(() => {
+  jest.clearAllMocks();
+  jest.restoreAllMocks();
+});
+
+describe("test execute function", () => {
+  it("positive tests", async () => {
+    const exitFn = jest.fn();
+    const validatePrereqsMock = jest.spyOn(validate, "validatePrereqs");
+    validatePrereqsMock.mockImplementation(() => true);
+    const validateAzureMock = jest.spyOn(validate, "validateAzure");
+    validateAzureMock.mockImplementation(() => Promise.resolve(true));
+    const validateEnvVariablesMock = jest.spyOn(
+      validate,
+      "validateEnvVariables"
+    );
+    validateEnvVariablesMock.mockImplementation(() => true);
+    await execute(exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[0]]);
+  });
+  it("negative tests", async () => {
+    const exitFn = jest.fn();
+    const validatePrereqsMock = jest.spyOn(validate, "validatePrereqs");
+    validatePrereqsMock.mockImplementation(() => {
+      throw new Error("dummy");
+    });
+    await execute(exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[1]]);
+  });
+});
+
 describe("Validating executable prerequisites", () => {
   test("Validate that array of executables do not exists in PATH", async () => {
     // Iterate through an array of non-existent binaries to create a force fail. If fails, then test pass
@@ -39,7 +73,7 @@ describe("Validating executable prerequisites", () => {
     fs.writeFileSync(defaultConfigFile(), yaml.safeDump(data));
 
     const fakeBinaries: string[] = ["ydawgie"];
-    const value = await validatePrereqs(fakeBinaries, false);
+    const value = validatePrereqs(fakeBinaries, false);
     expect(value).toBe(false);
   });
 });
@@ -53,7 +87,8 @@ describe("Validating executable prerequisites in spk-config", () => {
     process.env.test_key = "my_storage_key";
     loadConfiguration(filename);
     const fakeBinaries: string[] = ["ydawgie"];
-    await validatePrereqs(fakeBinaries, true);
+    validatePrereqs(fakeBinaries, true);
+
     expect(Config().infra!).toBeDefined();
     expect(Config().infra!.checks!).toBeDefined();
     expect(Config().infra!.checks!.ydawgie!).toBe(false);
diff --git a/src/commands/infra/validate.ts b/src/commands/infra/validate.ts
@@ -4,7 +4,10 @@ import emoji from "node-emoji";
 import shelljs from "shelljs";
 import { promisify } from "util";
 import { Config } from "../../config";
+import { build as buildCmd, exit as exitCmd } from "../../lib/commandBuilder";
 import { logger } from "../../logger";
+import { IConfigYaml } from "../../types";
+import decorator from "./validate.decorator.json";
 
 const binaries: string[] = ["terraform", "git", "az", "helm"];
 const envVar: string[] = [
@@ -14,62 +17,54 @@ const envVar: string[] = [
   "ARM_TENANT_ID"
 ];
 
-/**
- * Adds the validate command to the commander command object
- *
- * @param command Commander command object to decorate
- */
-export const validateCommandDecorator = (command: commander.Command): void => {
-  command
-    .command("validate")
-    .alias("v")
-    .description(
-      "Validate will verify that all infrastructure deployment prerequisites have been correctly installed."
-    )
-    .action(async opts => {
-      try {
-        if (await validatePrereqs(binaries, false)) {
+export const execute = async (exitFn: (status: number) => Promise<void>) => {
+  try {
+    if (validatePrereqs(binaries, false)) {
+      logger.info(
+        emoji.emojify(
+          "Installation of Prerequisites verified: :white_check_mark:"
+        )
+      );
+      if (await validateAzure(false)) {
+        logger.info(
+          emoji.emojify("Azure account verified: :white_check_mark:")
+        );
+        if (validateEnvVariables(envVar, false)) {
           logger.info(
-            emoji.emojify(
-              "Installation of Prerequisites verified: :white_check_mark:"
-            )
+            emoji.emojify("Environment variables verified: :white_check_mark:")
           );
-          if (await validateAzure(false)) {
-            logger.info(
-              emoji.emojify("Azure account verified: :white_check_mark:")
-            );
-            if (await validateEnvVariables(envVar, false)) {
-              logger.info(
-                emoji.emojify(
-                  "Environment variables verified: :white_check_mark:"
-                )
-              );
-            }
-          }
         }
-      } catch (err) {
-        logger.error(`Error validating init prerequisites`);
-        logger.error(err);
       }
+    }
+    await exitFn(0);
+  } catch (err) {
+    logger.error(`Error validating init prerequisites`);
+    logger.error(err);
+    await exitFn(1);
+  }
+};
+
+export const commandDecorator = (command: commander.Command): void => {
+  buildCmd(command, decorator).action(async () => {
+    execute(async (status: number) => {
+      await exitCmd(logger, process.exit, status);
     });
+  });
 };
 
 /**
  * Validates that prerequisites are installed
  *
  * @param executables Array of exectuables to check for in PATH
  */
-export const validatePrereqs = async (
+export const validatePrereqs = (
   executables: string[],
   globalInit: boolean
-): Promise<boolean> => {
+): boolean => {
   const config = Config();
-  if (!config.infra) {
-    config.infra = {};
-  }
-  if (!config.infra.checks) {
-    config.infra.checks = {};
-  }
+  config.infra = config.infra || {};
+  config.infra.checks = config.infra.checks || {};
+
   // Validate executables in PATH
   for (const i of executables) {
     if (!shelljs.which(i)) {
@@ -94,13 +89,9 @@ export const validatePrereqs = async (
  */
 export const validateAzure = async (globalInit: boolean): Promise<boolean> => {
   const config = Config();
-  // Validate authentication with Azure
-  if (!config.infra) {
-    config.infra = {};
-  }
-  if (!config.infra.checks) {
-    config.infra.checks = {};
-  }
+  config.infra = config.infra || {};
+  config.infra.checks = config.infra.checks || {};
+
   try {
     await promisify(child_process.exec)("az account show -o none");
   } catch (err) {
@@ -123,18 +114,14 @@ export const validateAzure = async (globalInit: boolean): Promise<boolean> => {
  *
  * @param variables Array of environment vairables to check for
  */
-export const validateEnvVariables = async (
+export const validateEnvVariables = (
   variables: string[],
   globalInit: boolean
-): Promise<boolean> => {
+): boolean => {
   const config = Config();
+  config.infra = config.infra || {};
+  config.infra.checks = config.infra.checks || {};
 
-  if (!config.infra) {
-    config.infra = {};
-  }
-  if (!config.infra.checks) {
-    config.infra.checks = {};
-  }
   // Validate environment variables
   for (const i of variables) {
     if (!process.env[i]) {
diff --git a/src/lib/commandBuilder.test.ts b/src/lib/commandBuilder.test.ts
@@ -14,6 +14,19 @@ interface ICommandOption {
 }
 
 describe("Tests Command Builder's build function", () => {
+  it("Declaration with no options", () => {
+    const descriptor: ICommandBuildElements = {
+      alias: "cbt",
+      command: "command-build-test",
+      description: "description of command"
+    };
+
+    const cmd = build(new commander.Command(), descriptor);
+
+    expect(cmd.description()).toBe("description of command");
+    expect(cmd.alias()).toBe("cbt");
+    expect(cmd.options.length).toBe(0);
+  });
   it("Sanity tests", () => {
     const descriptor: ICommandBuildElements = {
       alias: "cbt",
@@ -56,7 +69,7 @@ describe("Tests Command Builder's build function", () => {
     expect(cmd.alias()).toBe("cbt");
 
     cmd.options.forEach((opt: ICommandOption, i: number) => {
-      const declared = descriptor.options[i];
+      const declared = (descriptor.options || [])[i];
       expect(opt.flags).toBe(declared.arg);
       expect(opt.description).toBe(declared.description);
 
@@ -68,6 +81,17 @@ describe("Tests Command Builder's build function", () => {
 });
 
 describe("Tests Command Builder's validation function", () => {
+  it("Validation tests", () => {
+    const descriptor: ICommandBuildElements = {
+      alias: "cbt",
+      command: "command-build-test",
+      description: "description of command"
+    };
+
+    const errors = validateForRequiredValues(descriptor, {});
+
+    expect(errors.length).toBe(0);
+  });
   it("Validation tests", () => {
     const descriptor: ICommandBuildElements = {
       alias: "cbt",
diff --git a/src/lib/commandBuilder.ts b/src/lib/commandBuilder.ts
@@ -20,7 +20,7 @@ export interface ICommandBuildElements {
   command: string;
   alias: string;
   description: string;
-  options: ICommandOption[];
+  options?: ICommandOption[];
 }
 
 interface ICommandVariableName2Opt {
@@ -44,7 +44,7 @@ export const build = (
     .alias(decorator.alias)
     .description(decorator.description);
 
-  decorator.options.forEach(opt => {
+  (decorator.options || []).forEach(opt => {
     if (opt.defaultValue !== undefined) {
       cmd.option(opt.arg, opt.description, opt.defaultValue);
     } else {
@@ -68,7 +68,12 @@ export const validateForRequiredValues = (
   values: { [key: string]: string | undefined }
 ): string[] => {
   // gather the required options
-  const requireds = decorator.options.filter(opt => opt.required === true);
+  const requireds = (decorator.options || []).filter(opt => opt.required);
+
+  // no required variables hence return empty error array
+  if (requireds.length === 0) {
+    return [];
+  }
 
   // opt name to variable name mapping
   // example --org-name is orgName
