[REFACTOR] HLD pipeline command (#239)

dennisseah · web-flow · commit 7ffaca94a8c1 · 2020-02-03T10:08:31.000-08:00
diff --git a/src/commands/hld/index.ts b/src/commands/hld/index.ts
@@ -1,6 +1,6 @@
 import { Command } from "../command";
 import { commandDecorator as initCommandDecorator } from "./init";
-import { installHldToManifestPipelineDecorator } from "./pipeline";
+import { commandDecorator as installHldToManifestPipelineDecorator } from "./pipeline";
 import { reconcileHldDecorator } from "./reconcile";
 export const hldCommand = Command(
   "hld",
diff --git a/src/commands/hld/pipeline.decorator.json b/src/commands/hld/pipeline.decorator.json
@@ -0,0 +1,47 @@
+{
+  "command": "install-manifest-pipeline",
+  "alias": "p",
+  "description": "Install the manifest generation pipeline to your Azure DevOps instance. Default values are set in spk-config.yaml and can be loaded via spk init or overriden via option flags.",
+  "options": [
+    {
+      "arg": "-n, --pipeline-name <pipeline-name>",
+      "description": "Name of the pipeline to be created",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-p, --personal-access-token <personal-access-token>",
+      "description": "Personal Access Token",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-o, --org-name <org-name>",
+      "description": "Organization Name for Azure DevOps",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-r, --hld-name <hld-name>",
+      "description": "HLD Repository Name in Azure DevOps",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-u, --hld-url <hld-url>",
+      "description": "HLD Repository URL",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-m, --manifest-url <manifest-url>",
+      "description": "Manifest Repository URL",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-d, --devops-project <devops-project>",
+      "description": "Azure DevOps Project",
+      "defaultValue": ""
+    },
+    {
+      "arg": "-b, --build-script-url <build-script-url>",
+      "description": "Build Script URL. By default it is 'https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh'.",
+      "defaultValue": "https://raw.githubusercontent.com/Microsoft/bedrock/master/gitops/azure-devops/build.sh"
+    }
+  ]
+}
diff --git a/src/commands/hld/pipeline.test.ts b/src/commands/hld/pipeline.test.ts
@@ -1,3 +1,7 @@
+import { Config, loadConfiguration } from "../../config";
+import * as config from "../../config";
+import { BUILD_SCRIPT_URL } from "../../lib/constants";
+import { getRepositoryName } from "../../lib/gitutils";
 import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
 
 jest.mock("../../lib/pipelines/pipelines");
@@ -7,12 +11,43 @@ import {
   getBuildApiClient,
   queueBuild
 } from "../../lib/pipelines/pipelines";
+import { IConfigYaml } from "../../types";
 
 import {
+  emptyStringIfUndefined,
+  execute,
+  ICommandOptions,
   installHldToManifestPipeline,
-  isValidConfig,
+  populateValues,
   requiredPipelineVariables
 } from "./pipeline";
+import * as pipeline from "./pipeline";
+
+const MOCKED_VALUES: ICommandOptions = {
+  buildScriptUrl: "buildScriptUrl",
+  devopsProject: "project",
+  hldName: "hldName",
+  hldUrl: "https://dev.azure.com/test/fabrikam/_git/hld",
+  manifestUrl: "https://dev.azure.com/test/fabrikam/_git/materialized",
+  orgName: "orgName",
+  personalAccessToken: "personalAccessToken",
+  pipelineName: "pipelineName"
+};
+
+const MOCKED_CONFIG = {
+  azure_devops: {
+    access_token: "mocked_access_token",
+    hld_repository: "https://dev.azure.com/mocked/fabrikam/_git/hld",
+    manifest_repository:
+      "https://dev.azure.com/mocked/fabrikam/_git/materialized",
+    org: "mocked_org",
+    project: "mocked_project"
+  }
+};
+
+const getMockObject = (): ICommandOptions => {
+  return JSON.parse(JSON.stringify(MOCKED_VALUES));
+};
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -22,6 +57,90 @@ afterAll(() => {
   disableVerboseLogging();
 });
 
+describe("test emptyStringIfUndefined function", () => {
+  it("pass in undefined", () => {
+    expect(emptyStringIfUndefined(undefined)).toBe("");
+  });
+  it("send in empty string", () => {
+    expect(emptyStringIfUndefined("")).toBe("");
+  });
+  it("send in string", () => {
+    expect(emptyStringIfUndefined("test")).toBe("test");
+  });
+});
+
+describe("test populateValues function", () => {
+  it("with all values in command opts", () => {
+    jest.spyOn(config, "Config").mockImplementationOnce(
+      (): IConfigYaml => {
+        return MOCKED_CONFIG;
+      }
+    );
+    const mockedObject = getMockObject();
+    expect(populateValues(mockedObject)).toEqual(mockedObject);
+  });
+  it("without any values in command opts", () => {
+    jest.spyOn(config, "Config").mockImplementationOnce(
+      (): IConfigYaml => {
+        return MOCKED_CONFIG;
+      }
+    );
+    const values = populateValues({
+      buildScriptUrl: "",
+      devopsProject: "",
+      hldName: "",
+      hldUrl: "",
+      manifestUrl: "",
+      orgName: "",
+      personalAccessToken: "",
+      pipelineName: ""
+    });
+
+    expect(values.buildScriptUrl).toBe(BUILD_SCRIPT_URL);
+    expect(values.devopsProject).toBe(MOCKED_CONFIG.azure_devops.project);
+    expect(values.hldName).toBe(
+      getRepositoryName(MOCKED_CONFIG.azure_devops.hld_repository)
+    );
+    expect(values.hldUrl).toBe(MOCKED_CONFIG.azure_devops.hld_repository);
+    expect(values.manifestUrl).toBe(
+      MOCKED_CONFIG.azure_devops.manifest_repository
+    );
+    expect(values.orgName).toBe(MOCKED_CONFIG.azure_devops.org);
+    expect(values.personalAccessToken).toBe(
+      MOCKED_CONFIG.azure_devops.access_token
+    );
+    expect(values.pipelineName).toBe(
+      getRepositoryName(MOCKED_CONFIG.azure_devops.hld_repository) +
+        "-to-" +
+        getRepositoryName(MOCKED_CONFIG.azure_devops.manifest_repository)
+    );
+  });
+});
+
+describe("test execute function", () => {
+  it("positive test", async () => {
+    jest.spyOn(config, "Config").mockImplementationOnce(
+      (): IConfigYaml => {
+        return MOCKED_CONFIG;
+      }
+    );
+    const exitFn = jest.fn();
+    jest
+      .spyOn(pipeline, "installHldToManifestPipeline")
+      .mockReturnValueOnce(Promise.resolve());
+
+    await execute(MOCKED_VALUES, exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[0]]);
+  });
+  it("negative test", async () => {
+    const exitFn = jest.fn();
+    await execute(MOCKED_VALUES, exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[1]]);
+  });
+});
+
 describe("required pipeline variables", () => {
   it("should use have the proper pipeline vars vars", () => {
     const variables = requiredPipelineVariables(
@@ -46,113 +165,45 @@ describe("required pipeline variables", () => {
   });
 });
 
-describe("validate pipeline config", () => {
-  const configValues: any[] = [
-    "testOrg",
-    "testDevopsProject",
-    "testPipeline",
-    "https://manifestulr",
-    "testHld",
-    "https://hldurl",
-    "https://buildscript",
-    "af8e99c1234ef93e8c4365b1dc9bd8d9ba987d3"
-  ];
-
-  it("config is valid", () => {
-    expect(isValidConfig.apply(undefined, configValues as any)).toBe(true);
-  });
-
-  it("undefined values", () => {
-    for (const i of configValues.keys()) {
-      const configValuesWithInvalidValue = configValues.map((value, j) =>
-        i === j ? undefined : value
-      );
-      expect(
-        isValidConfig.apply(undefined, configValuesWithInvalidValue as any)
-      ).toBe(false);
-    }
-  });
-});
-
 describe("create hld to manifest pipeline test", () => {
   it("should create a pipeline", async () => {
     (createPipelineForDefinition as jest.Mock).mockReturnValue({ id: 10 });
-
-    const exitFn = jest.fn();
-    await installHldToManifestPipeline(
-      "orgName",
-      "personalAccessToken",
-      "hldRepoName",
-      "hldRepoUrl",
-      "manifestRepoUrl",
-      "project",
-      "pipelineName",
-      "buildScriptUrl",
-      exitFn
-    );
-
-    expect(exitFn).toBeCalledTimes(0);
+    await installHldToManifestPipeline(getMockObject());
   });
 
   it("should fail if the build client cant be instantiated", async () => {
-    (getBuildApiClient as jest.Mock).mockReturnValue(Promise.reject());
-
-    const exitFn = jest.fn();
-    await installHldToManifestPipeline(
-      "orgName",
-      "personalAccessToken",
-      "hldRepoName",
-      "hldRepoUrl",
-      "manifestRepoUrl",
-      "project",
-      "pipelineName",
-      "buildScriptUrl",
-      exitFn
-    );
-
-    expect(exitFn).toBeCalledTimes(1);
+    (getBuildApiClient as jest.Mock).mockReturnValue(Promise.reject("Error"));
+    try {
+      await installHldToManifestPipeline(getMockObject());
+      expect(true).toBe(false);
+    } catch (err) {
+      expect(err).toBeDefined();
+    }
   });
 
   it("should fail if the pipeline definition cannot be created", async () => {
     (getBuildApiClient as jest.Mock).mockReturnValue({});
     (createPipelineForDefinition as jest.Mock).mockReturnValue(
-      Promise.reject()
+      Promise.reject("Error")
     );
-
-    const exitFn = jest.fn();
-    await installHldToManifestPipeline(
-      "orgName",
-      "personalAccessToken",
-      "hldRepoName",
-      "hldRepoUrl",
-      "manifestRepoUrl",
-      "project",
-      "pipelineName",
-      "buildScriptUrl",
-      exitFn
-    );
-
-    expect(exitFn).toBeCalledTimes(1);
+    try {
+      await installHldToManifestPipeline(getMockObject());
+      expect(true).toBe(false);
+    } catch (err) {
+      expect(err).toBeDefined();
+    }
   });
 
   it("should fail if a build cannot be queued on the pipeline", async () => {
     (getBuildApiClient as jest.Mock).mockReturnValue({});
     (createPipelineForDefinition as jest.Mock).mockReturnValue({ id: 10 });
-    (queueBuild as jest.Mock).mockReturnValue(Promise.reject());
+    (queueBuild as jest.Mock).mockReturnValue(Promise.reject("Error"));
 
-    const exitFn = jest.fn();
-    await installHldToManifestPipeline(
-      "orgName",
-      "personalAccessToken",
-      "hldRepoName",
-      "hldRepoUrl",
-      "manifestRepoUrl",
-      "project",
-      "pipelineName",
-      "buildScriptUrl",
-      exitFn
-    );
-
-    expect(exitFn).toBeCalledTimes(1);
+    try {
+      await installHldToManifestPipeline(getMockObject());
+      expect(true).toBe(false);
+    } catch (err) {
+      expect(err).toBeDefined();
+    }
   });
 });
diff --git a/src/commands/hld/pipeline.ts b/src/commands/hld/pipeline.ts
