[FEATURE] spk setup command: added scaffold HLD and Manifest repos (#358)

* [HOUSEKEEPING] refactor spk setup command

* remove unused imports

* reset default project name

* added code to create HLD and manifest repo

1. added a request context object to capture all valid input values and status of execution (.e.g is project created, what are the repo created).
2. added `spk setup` as one of the commands.
3. added file operation supports for creating folder, change directory, etc.
4. added git operation supports
5. modified project service to have the right value for `templateTypeId` and `sourceControlType`
6. added scaffold operation supports
7. added code to create setup.log file

main feature added: scaffold HLD and Manifest repos

* typo

* fix gramatical error

* added more test code for gitService

* improve setupLog test

* added code to poll project existence after creation

* remove input file

* incorporate feedback from review

Co-authored-by: Andre Briggs <andrebriggs@users.noreply.github.com>
Co-authored-by: Yvonne Radsmikham <yvonne.radsmikham@gmail.com>

Author: 3 people

src/commands/setup.decorator.json

@@ -2,7 +2,6 @@
   "command": "setup",
   "alias": "s",
   "description": "An interactive command to setup resources in azure and azure dev-ops",
-  "disabled": true,
   "options": [
     {
       "arg": "-f, --file <config-file-path>",

src/commands/setup.md

@@ -12,6 +12,7 @@ for a few questions
 2. Azure DevOps Project Name, the project to be created.
 3. Azure DevOps Personal Access Token. The token needs to have these permissions
    1. Read and write projects.
+   2. Read and write codes.
 
 It can also run in a non interactive mode by providing a file that contains
 answers to the above questions.
@@ -28,4 +29,21 @@ azdo_project_name=<Azure DevOps Project Name>
 azdo_pat=<Azure DevOps Personal Access Token>
 ```
 
-azdo_project_name is optional and default value is `BedrockRocks`
+`azdo_project_name` is optional and default value is `BedrockRocks`.
+
+The followings shall be created
+
+1. A working directory, `quick-start-env`
+2. Project shall not be created if it already exists.
+3. A Git Repo, `quick-start-hld`, it shall be deleted and recreated if it
+   already exists.
+   1. And initial commit shall be made to this repo
+4. A Git Repo, `quick-start-manifest`, it shall be deleted and recreated if it
+   already exists.
+   1. And initial commit shall be made to this repo
+
+## Setup log
+
+A `setup.log` file is created after running this command. This file contains
+information about what are created and the execution status (completed or
+incomplete). This file will not be created if input validation failed.

src/commands/setup.test.ts

@@ -3,22 +3,29 @@ import { readYaml } from "../config";
 import * as config from "../config";
 import * as azdoClient from "../lib/azdoClient";
 import { createTempDir } from "../lib/ioUtil";
+import { WORKSPACE } from "../lib/setup/constants";
+import * as fsUtil from "../lib/setup/fsUtil";
+import * as gitService from "../lib/setup/gitService";
 import * as projectService from "../lib/setup/projectService";
 import * as promptInstance from "../lib/setup/prompt";
+import * as scaffold from "../lib/setup/scaffold";
+import * as setupLog from "../lib/setup/setupLog";
 import { IConfigYaml } from "../types";
-import { createSPKConfig, execute } from "./setup";
+import { createSPKConfig, execute, getErrorMessage } from "./setup";
 import * as setup from "./setup";
 
+const mockRequestContext = {
+  accessToken: "pat",
+  orgName: "orgname",
+  projectName: "project",
+  workspace: WORKSPACE
+};
+
 describe("test createSPKConfig function", () => {
   it("positive test", () => {
     const tmpFile = path.join(createTempDir(), "config.yaml");
     jest.spyOn(config, "defaultConfigFile").mockReturnValueOnce(tmpFile);
-    const input = {
-      azdo_org_name: "orgname",
-      azdo_pat: "pat",
-      azdo_project_name: "project"
-    };
-    createSPKConfig(input);
+    createSPKConfig(mockRequestContext);
     const data = readYaml<IConfigYaml>(tmpFile);
     expect(data.azure_devops).toStrictEqual({
       access_token: "pat",
@@ -29,22 +36,24 @@ describe("test createSPKConfig function", () => {
 });
 
 const testExecuteFunc = async (usePrompt = true, hasProject = true) => {
+  jest
+    .spyOn(gitService, "getGitApi")
+    .mockReturnValueOnce(Promise.resolve({} as any));
+  jest.spyOn(fsUtil, "createDirectory").mockReturnValueOnce();
+  jest.spyOn(scaffold, "hldRepo").mockReturnValueOnce(Promise.resolve());
+  jest.spyOn(scaffold, "manifestRepo").mockReturnValueOnce(Promise.resolve());
+  jest.spyOn(setupLog, "create").mockReturnValueOnce();
+
   const exitFn = jest.fn();
 
   if (usePrompt) {
-    jest.spyOn(promptInstance, "prompt").mockReturnValueOnce(
-      Promise.resolve({
-        azdo_org_name: "orgname",
-        azdo_pat: "pat",
-        azdo_project_name: "project"
-      })
-    );
+    jest
+      .spyOn(promptInstance, "prompt")
+      .mockReturnValueOnce(Promise.resolve(mockRequestContext));
   } else {
-    jest.spyOn(promptInstance, "getAnswerFromFile").mockReturnValueOnce({
-      azdo_org_name: "orgname",
-      azdo_pat: "pat",
-      azdo_project_name: "project"
-    });
+    jest
+      .spyOn(promptInstance, "getAnswerFromFile")
+      .mockReturnValueOnce(mockRequestContext);
   }
   jest.spyOn(setup, "createSPKConfig").mockReturnValueOnce();
   jest.spyOn(azdoClient, "getWebApi").mockReturnValueOnce(
@@ -109,13 +118,9 @@ describe("test execute function", () => {
   it("negative test: 401 status code", async () => {
     const exitFn = jest.fn();
 
-    jest.spyOn(promptInstance, "prompt").mockReturnValueOnce(
-      Promise.resolve({
-        azdo_org_name: "orgname",
-        azdo_pat: "pat",
-        azdo_project_name: "project"
-      })
-    );
+    jest
+      .spyOn(promptInstance, "prompt")
+      .mockReturnValueOnce(Promise.resolve(mockRequestContext));
     jest.spyOn(setup, "createSPKConfig").mockReturnValueOnce();
     jest.spyOn(azdoClient, "getWebApi").mockReturnValueOnce(
       Promise.resolve({
@@ -127,6 +132,8 @@ describe("test execute function", () => {
         }
       } as any)
     );
+    jest.spyOn(setupLog, "create").mockReturnValueOnce();
+
     await execute(
       {
         file: undefined
@@ -140,13 +147,9 @@ describe("test execute function", () => {
   it("negative test: VS402392 error", async () => {
     const exitFn = jest.fn();
 
-    jest.spyOn(promptInstance, "prompt").mockReturnValueOnce(
-      Promise.resolve({
-        azdo_org_name: "orgname",
-        azdo_pat: "pat",
-        azdo_project_name: "project"
-      })
-    );
+    jest
+      .spyOn(promptInstance, "prompt")
+      .mockReturnValueOnce(Promise.resolve(mockRequestContext));
     jest.spyOn(setup, "createSPKConfig").mockReturnValueOnce();
     jest.spyOn(azdoClient, "getWebApi").mockReturnValueOnce(
       Promise.resolve({
@@ -157,6 +160,8 @@ describe("test execute function", () => {
         }
       } as any)
     );
+    jest.spyOn(setupLog, "create").mockReturnValueOnce();
+
     await execute(
       {
         file: undefined
@@ -170,13 +175,37 @@ describe("test execute function", () => {
   it("negative test: other error", async () => {
     const exitFn = jest.fn();
 
-    jest.spyOn(promptInstance, "prompt").mockReturnValueOnce(
+    jest
+      .spyOn(promptInstance, "prompt")
+      .mockReturnValueOnce(Promise.resolve(mockRequestContext));
+    jest.spyOn(setup, "createSPKConfig").mockReturnValueOnce();
+    jest.spyOn(azdoClient, "getWebApi").mockReturnValueOnce(
       Promise.resolve({
-        azdo_org_name: "orgname",
-        azdo_pat: "pat",
-        azdo_project_name: "project"
-      })
+        getCoreApi: () => {
+          throw {
+            message: "other error"
+          };
+        }
+      } as any)
     );
+    jest.spyOn(setupLog, "create").mockReturnValueOnce();
+
+    await execute(
+      {
+        file: undefined
+      },
+      exitFn
+    );
+
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[1]]);
+  });
+  it("negative test: other error", async () => {
+    const exitFn = jest.fn();
+
+    jest
+      .spyOn(promptInstance, "prompt")
+      .mockReturnValueOnce(Promise.resolve(mockRequestContext));
     jest.spyOn(setup, "createSPKConfig").mockReturnValueOnce();
     jest.spyOn(azdoClient, "getWebApi").mockReturnValueOnce(
       Promise.resolve({
@@ -198,3 +227,27 @@ describe("test execute function", () => {
     expect(exitFn.mock.calls).toEqual([[1]]);
   });
 });
+
+describe("test getErrorMessage function", () => {
+  it("without request context", () => {
+    const res = getErrorMessage(undefined, new Error("test"));
+    expect(res).toBe("Error: test");
+  });
+  it("with VS402392 error", () => {
+    const res = getErrorMessage(
+      {
+        accessToken: "pat",
+        orgName: "orgName",
+        projectName: "projectName",
+        workspace: WORKSPACE
+      },
+      {
+        message: "VS402392: ",
+        statusCode: 400
+      }
+    );
+    expect(res).toBe(
+      "Project, projectName might have been deleted less than 28 days ago. Choose a different project name."
+    );
+  });
+});

src/commands/setup.ts

@@ -4,36 +4,58 @@ import yaml from "js-yaml";
 import { defaultConfigFile } from "../config";
 import { getWebApi } from "../lib/azdoClient";
 import { build as buildCmd, exit as exitCmd } from "../lib/commandBuilder";
+import { IRequestContext, WORKSPACE } from "../lib/setup/constants";
+import { createDirectory } from "../lib/setup/fsUtil";
+import { getGitApi } from "../lib/setup/gitService";
 import { createProjectIfNotExist } from "../lib/setup/projectService";
-import {
-  DEFAULT_PROJECT_NAME,
-  getAnswerFromFile,
-  IAnswer,
-  prompt
-} from "../lib/setup/prompt";
+import { getAnswerFromFile, prompt } from "../lib/setup/prompt";
+import { hldRepo, manifestRepo } from "../lib/setup/scaffold";
+import { create as createSetupLog } from "../lib/setup/setupLog";
 import { logger } from "../logger";
 import decorator from "./setup.decorator.json";
 
 interface ICommandOptions {
   file: string | undefined;
 }
 
+interface IAPIError {
+  message: string;
+  statusCode: number;
+}
+
 /**
  * Creates SPK config file under `user-home/.spk` folder
  *
  * @param answers Answers provided to the commander
  */
-export const createSPKConfig = (answers: IAnswer) => {
+export const createSPKConfig = (rc: IRequestContext) => {
   const data = yaml.safeDump({
     azure_devops: {
-      access_token: answers.azdo_pat,
-      org: answers.azdo_org_name,
-      project: answers.azdo_project_name
+      access_token: rc.accessToken,
+      org: rc.orgName,
+      project: rc.projectName
     }
   });
   fs.writeFileSync(defaultConfigFile(), data);
 };
 
+export const getErrorMessage = (
+  rc: IRequestContext | undefined,
+  err: Error | IAPIError
+) => {
+  if (rc) {
+    if (err.message && err.message.indexOf("VS402392") !== -1) {
+      return `Project, ${
+        rc!.projectName
+      } might have been deleted less than 28 days ago. Choose a different project name.`;
+    }
+    if (!(err instanceof Error) && err.statusCode && err.statusCode === 401) {
+      return `Authentication Failed. Make sure that the organization name and access token are correct; or your access token may have expired.`;
+    }
+  }
+  return err.toString();
+};
+
 /**
  * Executes the command, can all exit function with 0 or 1
  * when command completed successfully or failed respectively.
@@ -45,27 +67,34 @@ export const execute = async (
   opts: ICommandOptions,
   exitFn: (status: number) => Promise<void>
 ) => {
+  // tslint:disable-next-line: no-unnecessary-initializer
+  let requestContext: IRequestContext | undefined = undefined;
+
   try {
-    const answers = opts.file ? getAnswerFromFile(opts.file) : await prompt();
+    requestContext = opts.file ? getAnswerFromFile(opts.file) : await prompt();
+    createDirectory(WORKSPACE, true);
 
-    createSPKConfig(answers!);
+    createSPKConfig(requestContext!);
     const webAPI = await getWebApi();
     const coreAPI = await webAPI.getCoreApi();
+    const gitAPI = await getGitApi(webAPI);
 
-    await createProjectIfNotExist(coreAPI, answers);
+    await createProjectIfNotExist(coreAPI, requestContext);
+    await hldRepo(gitAPI, requestContext);
+    await manifestRepo(gitAPI, requestContext);
+
+    createSetupLog(requestContext);
     await exitFn(0);
   } catch (err) {
-    if (err.statusCode === 401) {
-      logger.error(
-        `Authentication Failed. Make sure that the organization name and access token are correct; or your access token may have expired.`
-      );
-    } else if (err.message && err.message.indexOf("VS402392") !== -1) {
-      logger.error(
-        `Project, ${DEFAULT_PROJECT_NAME} might be deleted less than 28 days ago. Choose a different project name.`
-      );
-    } else {
-      logger.error(err);
+    const msg = getErrorMessage(requestContext, err);
+
+    // requestContext will not be created if input validation failed
+    if (requestContext) {
+      requestContext.error = msg;
     }
+    createSetupLog(requestContext!);
+
+    logger.error(msg);
     await exitFn(1);
   }
 };

src/index.ts

@@ -45,8 +45,8 @@ const commandModules = [
       c => {
         c.version(require("../package.json").version);
       },
-      initCommandDecorator
-      // setupCommandDecorator
+      initCommandDecorator,
+      setupCommandDecorator
     ],
     cmds
   );

src/lib/setup/constants.ts

@@ -0,0 +1,24 @@
+export interface IRequestContext {
+  orgName: string;
+  projectName: string;
+  accessToken: string;
+  workspace: string;
+  createdProject?: boolean;
+  scaffoldHLD?: boolean;
+  scaffoldManifest?: boolean;
+  error?: string;
+}
+
+export const MANIFEST_REPO = "quick-start-manifest";
+export const HLD_REPO = "quick-start-hld";
+export const APP_REPO = "quick-start-app";
+export const DEFAULT_PROJECT_NAME = "BedrockRocks";
+export const APP_REPO_LIFECYCLE = "quick-start-lifecycle";
+export const WORKSPACE = "quick-start-env";
+export const SP_USER_NAME = "service_account";
+export const SETUP_LOG = "setup.log";
+
+export const HLD_DEFAULT_GIT_URL =
+  "https://github.com/microsoft/fabrikate-definitions.git";
+export const HLD_DEFAULT_COMPONENT_NAME = "traefik2";
+export const HLD_DEFAULT_DEF_PATH = "definitions/traefik2";