[FEATURE] Add lifecycle and build pipelines in spk setup command (#420)

* [FEATURE] scaffold app and helm repo in spk setup command

* [FEATURE] lifecycle and build pipeline in spk setup command

* fix eslint error

* fixed unit test

* making acr name configurable that's not hardcode it

* added code to check if acr name is between 5 and 50 chars long

* Changes to get build pipeline working in branch issue1113x (#402)

* Changes to get build pipeline working

* Updated spelling

* minor fixes

* fix test

* fix lint

* fix tests

* adding tests and prompt for subscriptionId before creating sp

* rebase

* fix eslint

* Delete tslint.json

* Update subscriptionService.test.ts

* fixing labels and messages

Co-authored-by: Andre Briggs <[email protected]>
Co-authored-by: Nate <[email protected]>

Author: 3 people

package.json

@@ -52,8 +52,7 @@
     "webpack-cli": "^3.3.9"
   },
   "prettier": {
-    "proseWrap": "always",
-    "quote-props": "preserve"
+    "proseWrap": "always"
   },
   "husky": {
     "hooks": {

src/commands/deployment/dashboard.test.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/camelcase */
 jest.mock("open");
 import open from "open";
 jest.mock("../../config");
@@ -31,18 +30,18 @@ afterAll(() => {
 
 const mockConfig = (): void => {
   (Config as jest.Mock).mockReturnValueOnce({
-    azure_devops: {
-      access_token: uuid(),
+    "azure_devops": {
+      "access_token": uuid(),
       org: uuid(),
       project: uuid()
     },
     introspection: {
       azure: {
-        account_name: uuid(),
+        "account_name": uuid(),
         key: uuid(),
-        partition_key: uuid(),
-        source_repo_access_token: "test_token",
-        table_name: uuid()
+        "partition_key": uuid(),
+        "source_repo_access_token": "test_token",
+        "table_name": uuid()
       }
     }
   });
@@ -209,8 +208,8 @@ describe("Fallback to azure devops access token", () => {
 describe("Extract manifest repository information", () => {
   test("Manifest repository information is successfully extracted", () => {
     (Config as jest.Mock).mockReturnValue({
-      azure_devops: {
-        manifest_repository:
+      "azure_devops": {
+        "manifest_repository":
           "https://dev.azure.com/bhnook/fabrikam/_git/materialized"
       }
     });

src/commands/deployment/validate.test.ts

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/camelcase */
-// imports
 import uuid from "uuid/v4";
 import * as deploymenttable from "../../lib/azure/deploymenttable";
 import {

src/commands/infra/generate.ts

@@ -336,14 +336,14 @@ export const generateConfigWithParentEqProjectPath = async (
     writeTfvarsFile(spkTfvarsObject, parentDirectory, SPK_TFVARS);
     await copyTfTemplate(templatePath, parentDirectory, true);
   } else {
-    logger.warning(`Variables are not defined in the definition.yaml`);
+    logger.warn(`Variables are not defined in the definition.yaml`);
   }
   if (parentInfraConfig.backend) {
     const backendTfvarsObject = generateTfvars(parentInfraConfig.backend);
     checkTfvars(parentDirectory, BACKEND_TFVARS);
     writeTfvarsFile(backendTfvarsObject, parentDirectory, BACKEND_TFVARS);
   } else {
-    logger.warning(
+    logger.warn(
       `A remote backend configuration is not defined in the definition.yaml`
     );
   }

src/commands/setup.md

@@ -16,11 +16,9 @@ for a few questions
 4. To create a sample application Repo
    1. If Yes, a Azure Service Principal is needed. You have 2 options
       1. have the command line tool to create it. Azure command line tool shall
-         be used
-      2. provide the Service Principal Id, Password and Tenant Id.
-   2. Subscription Id is automatically retrieved with the Service Principal
-      credential. In case, there are two or more subscriptions, you will be
-      prompt to select one of them.
+         be used. You will be prompted to select a subscription identifier.
+      2. Provide the Service Principal Id, Password, and Tenant Id. From this
+         information, the tool will retrieve the subscription identifier.
 
 It can also run in a non interactive mode by providing a file that contains
 answers to the above questions.
@@ -40,6 +38,8 @@ az_create_sp=<true to have command line to create service principal>
 az_sp_id=<sevice principal Id need if az_create_app=true and az_create_sp=false>
 az_sp_password=<sevice principal password need if az_create_app=true and az_create_sp=false>
 az_sp_tenant=<sevice principal tenant Id need if az_create_app=true and az_create_sp=false>
+az_subscription_id=<subscription id>
+az_acr_name=<name of azure container registry>
 ```
 
 `azdo_project_name` is optional and default value is `BedrockRocks`.
@@ -64,6 +64,8 @@ The followings shall be created
       already exists.
    5. A Git Repo, `quick-start-app`, it shall be deleted and recreated if is
       already exists.
+   6. A Lifecycle pipeline.
+   7. A Build pipeline.
 
 ## Setup log
 

src/commands/setup.test.ts

@@ -16,7 +16,12 @@ import * as scaffold from "../lib/setup/scaffold";
 import * as setupLog from "../lib/setup/setupLog";
 import { deepClone } from "../lib/util";
 import { ConfigYaml } from "../types";
-import { createSPKConfig, execute, getErrorMessage } from "./setup";
+import {
+  createAppRepoTasks,
+  createSPKConfig,
+  execute,
+  getErrorMessage
+} from "./setup";
 import * as setup from "./setup";
 
 const mockRequestContext: RequestContext = {
@@ -83,11 +88,9 @@ const testExecuteFunc = async (
   jest.spyOn(fsUtil, "createDirectory").mockReturnValueOnce();
   jest.spyOn(scaffold, "hldRepo").mockResolvedValueOnce();
   jest.spyOn(scaffold, "manifestRepo").mockResolvedValueOnce();
-  jest.spyOn(scaffold, "helmRepo").mockResolvedValueOnce();
-  jest.spyOn(scaffold, "appRepo").mockResolvedValueOnce();
   jest
     .spyOn(pipelineService, "createHLDtoManifestPipeline")
-    .mockReturnValueOnce(Promise.resolve());
+    .mockResolvedValueOnce();
   jest.spyOn(resourceService, "create").mockResolvedValue(true);
   jest.spyOn(azureContainerRegistryService, "create").mockResolvedValue(true);
   jest.spyOn(setupLog, "create").mockReturnValueOnce();
@@ -309,3 +312,50 @@ describe("test getErrorMessage function", () => {
     );
   });
 });
+
+const testCreateAppRepoTasks = async (prApproved = true): Promise<void> => {
+  const mockRc: RequestContext = {
+    orgName: "org",
+    projectName: "project",
+    accessToken: "pat",
+    toCreateAppRepo: true,
+    servicePrincipalId: "fakeId",
+    servicePrincipalPassword: "fakePassword",
+    servicePrincipalTenantId: "tenant",
+    subscriptionId: "12344",
+    acrName: "acr",
+    workspace: "dummy"
+  };
+
+  jest.spyOn(resourceService, "create").mockResolvedValueOnce(true);
+  jest
+    .spyOn(azureContainerRegistryService, "create")
+    .mockResolvedValueOnce(true);
+  jest.spyOn(scaffold, "helmRepo").mockResolvedValueOnce();
+  jest.spyOn(scaffold, "appRepo").mockResolvedValueOnce();
+  jest
+    .spyOn(pipelineService, "createLifecyclePipeline")
+    .mockResolvedValueOnce();
+  jest
+    .spyOn(promptInstance, "promptForApprovingHLDPullRequest")
+    .mockResolvedValueOnce(prApproved);
+  if (prApproved) {
+    jest.spyOn(pipelineService, "createBuildPipeline").mockResolvedValueOnce();
+  }
+
+  const res = await createAppRepoTasks(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    {} as any, // gitAPI
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    {} as any, // buildAPI
+    mockRc
+  );
+  expect(res).toBe(prApproved);
+};
+
+describe("test createAppRepoTasks function", () => {
+  it("positive test", async () => {
+    await testCreateAppRepoTasks();
+    await testCreateAppRepoTasks(false);
+  });
+});

src/commands/setup.ts

@@ -1,4 +1,6 @@
 /* eslint-disable @typescript-eslint/camelcase */
+import { IBuildApi } from "azure-devops-node-api/BuildApi";
+import { IGitApi } from "azure-devops-node-api/GitApi";
 import commander from "commander";
 import fs from "fs";
 import yaml from "js-yaml";
@@ -15,9 +17,17 @@ import {
 } from "../lib/setup/constants";
 import { createDirectory } from "../lib/setup/fsUtil";
 import { getGitApi } from "../lib/setup/gitService";
-import { createHLDtoManifestPipeline } from "../lib/setup/pipelineService";
+import {
+  createBuildPipeline,
+  createHLDtoManifestPipeline,
+  createLifecyclePipeline
+} from "../lib/setup/pipelineService";
 import { createProjectIfNotExist } from "../lib/setup/projectService";
-import { getAnswerFromFile, prompt } from "../lib/setup/prompt";
+import {
+  getAnswerFromFile,
+  prompt,
+  promptForApprovingHLDPullRequest
+} from "../lib/setup/prompt";
 import {
   appRepo,
   helmRepo,
@@ -27,7 +37,6 @@ import {
 import { create as createSetupLog } from "../lib/setup/setupLog";
 import { logger } from "../logger";
 import decorator from "./setup.decorator.json";
-import { IGitApi } from "azure-devops-node-api/GitApi";
 
 interface CommandOptions {
   file: string | undefined;
@@ -87,8 +96,9 @@ export const getErrorMessage = (
 
 export const createAppRepoTasks = async (
   gitAPI: IGitApi,
+  buildAPI: IBuildApi,
   rc: RequestContext
-): Promise<void> => {
+): Promise<boolean> => {
   if (
     rc.toCreateAppRepo &&
     rc.servicePrincipalId &&
@@ -116,6 +126,18 @@ export const createAppRepoTasks = async (
     );
     await helmRepo(gitAPI, rc);
     await appRepo(gitAPI, rc);
+    await createLifecyclePipeline(buildAPI, rc);
+    const approved = await promptForApprovingHLDPullRequest(rc);
+
+    if (approved) {
+      await createBuildPipeline(buildAPI, rc);
+      return true;
+    }
+
+    logger.warn("HLD Pull Request is not approved.");
+    return false;
+  } else {
+    return false;
   }
 };
 
@@ -134,21 +156,23 @@ export const execute = async (
 
   try {
     requestContext = opts.file ? getAnswerFromFile(opts.file) : await prompt();
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const rc = requestContext!;
     createDirectory(WORKSPACE, true);
-    createSPKConfig(requestContext);
+    createSPKConfig(rc);
 
     const webAPI = await getWebApi();
     const coreAPI = await webAPI.getCoreApi();
     const gitAPI = await getGitApi(webAPI);
     const buildAPI = await getBuildApi();
 
-    await createProjectIfNotExist(coreAPI, requestContext);
-    await hldRepo(gitAPI, requestContext);
-    await manifestRepo(gitAPI, requestContext);
-    await createHLDtoManifestPipeline(buildAPI, requestContext);
-    await createAppRepoTasks(gitAPI, requestContext);
+    await createProjectIfNotExist(coreAPI, rc);
+    await hldRepo(gitAPI, rc);
+    await manifestRepo(gitAPI, rc);
+    await createHLDtoManifestPipeline(buildAPI, rc);
+    await createAppRepoTasks(gitAPI, buildAPI, rc);
 
-    createSetupLog(requestContext);
+    createSetupLog(rc);
     await exitFn(0);
   } catch (err) {
     const msg = getErrorMessage(requestContext, err);

src/lib/azure/containerRegistryService.test.ts

@@ -7,6 +7,7 @@ import * as restAuth from "@azure/ms-rest-nodeauth";
 import {
   create,
   getContainerRegistries,
+  getContainerRegistry,
   isExist
 } from "./containerRegistryService";
 import * as containerRegistryService from "./containerRegistryService";
@@ -109,7 +110,6 @@ describe("test container registries function", () => {
       servicePrincipalPassword,
       servicePrincipalTenantId,
       subscriptionId,
-      RESOURCE_GROUP,
       "test"
     );
     expect(res).toBeTruthy();
@@ -123,7 +123,6 @@ describe("test container registries function", () => {
       servicePrincipalPassword,
       servicePrincipalTenantId,
       subscriptionId,
-      RESOURCE_GROUP,
       "test"
     );
     expect(res).toBeFalsy();
@@ -143,7 +142,6 @@ describe("test container registries function", () => {
       servicePrincipalPassword,
       servicePrincipalTenantId,
       subscriptionId,
-      RESOURCE_GROUP,
       "test"
     );
     expect(res).toBeFalsy();
@@ -177,3 +175,40 @@ describe("test container registries function", () => {
     expect(created).toBeTruthy();
   });
 });
+
+describe("test getContainerRegistry function", () => {
+  it("match", async () => {
+    const entry = {
+      id:
+        "/subscriptions/dd831253-787f-4dc8-8eb0-ac9d052177d9/resourceGroups/quick-start-rg/providers/Microsoft.ContainerRegistry/registries/quickStartACR",
+      name: "quickStartACR",
+      resourceGroup: "quick-start-rg"
+    };
+    jest
+      .spyOn(containerRegistryService, "getContainerRegistries")
+      .mockResolvedValueOnce([entry]);
+    const reg = await getContainerRegistry(
+      servicePrincipalId,
+      servicePrincipalPassword,
+      servicePrincipalTenantId,
+      subscriptionId,
+      RESOURCE_GROUP,
+      "quickStartACR"
+    );
+    expect(reg).toStrictEqual(entry);
+  });
+  it("no matches", async () => {
+    jest
+      .spyOn(containerRegistryService, "getContainerRegistries")
+      .mockResolvedValueOnce([]);
+    const reg = await getContainerRegistry(
+      servicePrincipalId,
+      servicePrincipalPassword,
+      servicePrincipalTenantId,
+      subscriptionId,
+      RESOURCE_GROUP,
+      "quickStartACR"
+    );
+    expect(reg).toBeUndefined();
+  });
+});