Scaffolding base spk ring commands (#362)

* Scaffolding base spk ring commands

* disabling ring commands

* add -> create

* removing rings from spk command

Co-authored-by: Dennis Seah <dennis.seah@gmail.com>

Author: mtarng

src/commands/ring/create.decorator.json

@@ -0,0 +1,6 @@
+{
+  "command": "create <ring-name>",
+  "alias": "c",
+  "description": "Create a new ring for the current working directory project repository. This will affect all services within the project repository.",
+  "disabled": true
+}

src/commands/ring/create.md

@@ -0,0 +1,77 @@
+## Description
+
+SPK command to create a ring into an initialized bedrock project.
+
+## Example
+
+For a bedrock.yaml file that looks like this:
+
+```yaml
+rings:
+  dev:
+    isDefault: true
+  qa:
+  prod:
+services:
+  ./:
+    displayName: "fabrikam"
+    helm:
+      chart:
+        branch: master
+        git: "https://dev.azure.com/fabrikam/frontend/_git/charts"
+        path: frontend
+    k8sBackend: "fabrikam-k8s-svc"
+    k8sBackendPort: 80
+    middlewares: []
+    pathPrefix: "fabrikam-service"
+    pathPrefixMajorVersion: "v1"
+variableGroups:
+  - fabrikam-vg
+```
+
+running `spk ring create stage` will result in a few changes:
+
+1. `stage` will be added into `bedrock.yaml` rings component:
+   ```yaml
+   rings:
+   dev:
+     isDefault: true
+   qa:
+   prod:
+   stage:
+   services:
+   ./:
+     displayName: "fabrikam"
+     helm:
+     chart:
+       branch: master
+       git: "https://dev.azure.com/fabrikam/frontend/_git/charts"
+       path: frontend
+     k8sBackend: "fabrikam-k8s-svc"
+     k8sBackendPort: 80
+     middlewares: []
+     pathPrefix: "fabrikam-service"
+     pathPrefixMajorVersion: "v1"
+   variableGroups:
+     - fabrikam-vg
+   ```
+2. Each of the referenced services within `bedrock.yaml` will have their
+   `build-update-hld.yaml` updated to include the new ring, `stage` in their
+   branch triggers:
+
+   ```yaml
+    trigger:
+    branches:
+        include:
+        - dev
+        - qa
+        - prod
+        - stage <-- NEW -->
+    variables:
+    - group: fabrikam-vg
+    …
+   ```
+
+3. Commiting these changes will trigger the project's lifecycle pipeline, which
+   will then scaffold out the newly created ring, along with the appropriate
+   IngressRoutes in the linked HLD repository.

src/commands/ring/create.test.ts

@@ -0,0 +1,52 @@
+import { create as createBedrockYaml } from "../../lib/bedrockYaml";
+import { createTempDir } from "../../lib/ioUtil";
+import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
+
+import { checkDependencies, execute } from "./create";
+
+beforeAll(() => {
+  enableVerboseLogging();
+});
+
+afterAll(() => {
+  disableVerboseLogging();
+});
+
+describe("test valid function", () => {
+  it("negative test", async () => {
+    try {
+      const tmpDir = createBedrockYaml();
+      checkDependencies(tmpDir);
+      expect(true).toBe(false);
+    } catch (e) {
+      expect(e).not.toBeNull();
+    }
+  });
+});
+
+describe("test execute function and logic", () => {
+  it("test execute function: missing project path", async () => {
+    const exitFn = jest.fn();
+    await execute("ring", "", exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[1]]);
+  });
+  it("test execute function: working path with bedrock.yaml", async () => {
+    const exitFn = jest.fn();
+
+    const tmpDir = createTempDir();
+    createBedrockYaml(tmpDir, {
+      rings: {
+        master: {
+          isDefault: true
+        }
+      },
+      services: {},
+      variableGroups: ["testvg"]
+    });
+    await execute("ring", tmpDir, exitFn);
+
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[0]]);
+  });
+});

src/commands/ring/create.ts

@@ -0,0 +1,62 @@
+import commander from "commander";
+import { fileInfo as bedrockFileInfo } from "../../lib/bedrockYaml";
+import { build as buildCmd, exit as exitCmd } from "../../lib/commandBuilder";
+import { PROJECT_INIT_DEPENDENCY_ERROR_MESSAGE } from "../../lib/constants";
+import { hasValue } from "../../lib/validator";
+import { logger } from "../../logger";
+import { IBedrockFileInfo } from "../../types";
+
+import decorator from "./create.decorator.json";
+
+/**
+ * Executes the command.
+ *
+ * @param ringName
+ * @param projectPath
+ */
+export const execute = async (
+  ringName: string,
+  projectPath: string,
+  exitFn: (status: number) => Promise<void>
+) => {
+  if (!hasValue(ringName)) {
+    await exitFn(1);
+    return;
+  }
+
+  try {
+    logger.info(`project path: ${projectPath}`);
+
+    checkDependencies(projectPath);
+
+    // Check if ring already exists, if it does, warn and exit
+    // Add ring to bedrock.yaml
+    // Add ring to all linked service build pipelines' branch triggers
+
+    logger.info(`Successfully created ring: ${ringName} for this project!`);
+    await exitFn(0);
+  } catch (err) {
+    logger.error(`Error occurred while creating ring: ${ringName}`);
+    logger.error(err);
+    await exitFn(1);
+  }
+};
+
+export const commandDecorator = (command: commander.Command): void => {
+  buildCmd(command, decorator).action(async (ringName: string) => {
+    await execute(ringName, process.cwd(), async (status: number) => {
+      await exitCmd(logger, process.exit, status);
+    });
+  });
+};
+
+/**
+ * Check for bedrock.yaml
+ * @param projectPath
+ */
+export const checkDependencies = (projectPath: string) => {
+  const fileInfo: IBedrockFileInfo = bedrockFileInfo(projectPath);
+  if (fileInfo.exist === false) {
+    throw new Error(PROJECT_INIT_DEPENDENCY_ERROR_MESSAGE);
+  }
+};

src/commands/ring/delete.decorator.json

@@ -0,0 +1,6 @@
+{
+  "command": "delete <ring-name>",
+  "alias": "d",
+  "description": "Delete a ring from the current working directory project repository. This will affect all services within the project repository. The default ring cannot be deleted.",
+  "disabled": true
+}

src/commands/ring/delete.md

@@ -0,0 +1,77 @@
+## Description
+
+SPK command to remove a ring from an initialized bedrock project.
+
+_Note:_ A default ring cannot be removed. First set another ring as the default
+via `spk ring set-default` before deleting.
+
+## Example
+
+For a bedrock.yaml file that looks like this:
+
+```yaml
+rings:
+  dev:
+    isDefault: true
+  qa:
+  prod:
+services:
+  ./:
+    displayName: "fabrikam"
+    helm:
+      chart:
+        branch: master
+        git: "https://dev.azure.com/fabrikam/frontend/_git/charts"
+        path: frontend
+    k8sBackend: "fabrikam-k8s-svc"
+    k8sBackendPort: 80
+    middlewares: []
+    pathPrefix: "fabrikam-service"
+    pathPrefixMajorVersion: "v1"
+variableGroups:
+  - fabrikam-vg
+```
+
+running `spk ring delete prod` will result in a few changes:
+
+1. `prod` will be removed from `bedrock.yaml`:
+   ```yaml
+   rings:
+   dev:
+     isDefault: true
+   qa:
+   services:
+   ./:
+     displayName: "fabrikam"
+     helm:
+     chart:
+       branch: master
+       git: "https://dev.azure.com/fabrikam/frontend/_git/charts"
+       path: frontend
+     k8sBackend: "fabrikam-k8s-svc"
+     k8sBackendPort: 80
+     middlewares: []
+     pathPrefix: "fabrikam-service"
+     pathPrefixMajorVersion: "v1"
+   variableGroups:
+     - fabrikam-vg
+   ```
+2. Each of the referenced services within `bedrock.yaml` will have their
+   `build-update-hld.yaml` updated to remove the ring, `prod` in their branch
+   triggers:
+
+   ```yaml
+    trigger:
+    branches:
+        include:
+        - dev
+        - qa
+        # - prod <-- THIS WILL BE DELETED! -->
+    variables:
+    - group: fabrikam-vg
+    …
+   ```
+
+3. Commiting these changes will trigger the project's lifecycle pipeline, which
+   will then remove the ring from linked services in this project,
+   [pending this epic](https://github.com/microsoft/bedrock/issues/858).

src/commands/ring/delete.test.ts

@@ -0,0 +1,52 @@
+import { create as createBedrockYaml } from "../../lib/bedrockYaml";
+import { createTempDir } from "../../lib/ioUtil";
+import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
+
+import { checkDependencies, execute } from "./delete";
+
+beforeAll(() => {
+  enableVerboseLogging();
+});
+
+afterAll(() => {
+  disableVerboseLogging();
+});
+
+describe("test valid function", () => {
+  it("negative test", async () => {
+    try {
+      const tmpDir = createBedrockYaml();
+      checkDependencies(tmpDir);
+      expect(true).toBe(false);
+    } catch (e) {
+      expect(e).not.toBeNull();
+    }
+  });
+});
+
+describe("test execute function and logic", () => {
+  it("test execute function: missing project path", async () => {
+    const exitFn = jest.fn();
+    await execute("ring", "", exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[1]]);
+  });
+  it("test execute function: working path with bedrock.yaml", async () => {
+    const exitFn = jest.fn();
+
+    const tmpDir = createTempDir();
+    createBedrockYaml(tmpDir, {
+      rings: {
+        master: {
+          isDefault: true
+        }
+      },
+      services: {},
+      variableGroups: ["testvg"]
+    });
+    await execute("ring", tmpDir, exitFn);
+
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[0]]);
+  });
+});