Append variable group to manifest-generation.yaml (#453)

* Add variable group to existing manifest-generation.yaml

* Update integration tests

* Adding files for append variable group

* Add unit test file

* Update test mock function

* Update unit test

* updates

Co-authored-by: Edaena Salinas <[email protected]>
Co-authored-by: Samiya Akhtar <[email protected]>
Co-authored-by: Dennis Seah <[email protected]>

Author: 4 people

docs/commands/data.json

@@ -226,6 +226,11 @@
       }
     ]
   },
+  "hld append-variable-group": {
+    "command": "append-variable-group <variable-group-name>",
+    "alias": "avg",
+    "description": "Appends the name of an existing variable group to the current manifest-generation.yaml file."
+  },
   "hld init": {
     "command": "init",
     "alias": "i",

src/commands/hld/append-variable-group.decorator.json

@@ -0,0 +1,5 @@
+{
+  "command": "append-variable-group <variable-group-name>",
+  "alias": "avg",
+  "description": "Appends the name of an existing variable group to the current manifest-generation.yaml file."
+}

src/commands/hld/append-variable-group.test.ts

@@ -0,0 +1,18 @@
+import { execute } from "./append-variable-group";
+import * as fileutils from "../../lib/fileutils";
+
+describe("Test execute function", () => {
+  it("missing variable group name", async () => {
+    const exitFn = jest.fn();
+    await execute("my-path", "", exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[1]]);
+  });
+  it("appends variable group", async () => {
+    const exitFn = jest.fn();
+    spyOn(fileutils, "appendVariableGroupToPipelineYaml");
+    await execute("my-path", "my-vg", exitFn);
+    expect(exitFn).toBeCalledTimes(1);
+    expect(exitFn.mock.calls).toEqual([[0]]);
+  });
+});

src/commands/hld/append-variable-group.ts

@@ -0,0 +1,52 @@
+import commander from "commander";
+import { build as buildCmd, exit as exitCmd } from "../../lib/commandBuilder";
+import { RENDER_HLD_PIPELINE_FILENAME } from "../../lib/constants";
+import { appendVariableGroupToPipelineYaml } from "../../lib/fileutils";
+import { logger } from "../../logger";
+import decorator from "./append-variable-group.decorator.json";
+
+/**
+ * Executes the command, can call exit function with 0 or 1
+ * when command completed successfully or failed respectively.
+ *
+ * @param hldRepoPath The hld repository path
+ * @param variableGroupName The variable group name
+ * @param exitFn exit function
+ */
+export const execute = async (
+  hldRepoPath: string,
+  variableGroupName: string,
+  exitFn: (status: number) => Promise<void>
+): Promise<void> => {
+  if (!variableGroupName) {
+    logger.error("Variable group name is missing.");
+    await exitFn(1);
+    return;
+  }
+
+  try {
+    appendVariableGroupToPipelineYaml(
+      hldRepoPath,
+      RENDER_HLD_PIPELINE_FILENAME,
+      variableGroupName
+    );
+    await exitFn(0);
+  } catch (err) {
+    logger.error(`Error occurred while appending variable group.`);
+    logger.error(err);
+    await exitFn(1);
+  }
+};
+
+/**
+ * Adds the init command to the commander command object
+ * @param command Commander command object to decorate
+ */
+export const commandDecorator = (command: commander.Command): void => {
+  buildCmd(command, decorator).action(async (variableGroupName: string) => {
+    const hldRepoPath = process.cwd();
+    await execute(hldRepoPath, variableGroupName, async (status: number) => {
+      await exitCmd(logger, process.exit, status);
+    });
+  });
+};

src/commands/hld/index.ts

@@ -1,6 +1,6 @@
 import { Command } from "../command";
 
-const subfolders = ["init", "pipeline", "reconcile"];
+const subfolders = ["init", "pipeline", "reconcile", "append-variable-group"];
 
 export const commandDecorator = Command(
   "hld",

src/lib/fileutils.test.ts

@@ -28,13 +28,15 @@ import { disableVerboseLogging, enableVerboseLogging } from "../logger";
 import {
   createTestComponentYaml,
   createTestHldAzurePipelinesYaml,
+  createTestHldAzurePipelinesYamlWithVariableGroup,
   createTestHldLifecyclePipelineYaml,
   createTestMaintainersYaml,
   createTestServiceBuildAndUpdatePipelineYaml,
 } from "../test/mockFactory";
 import { AccessYaml, AzurePipelinesYaml, MaintainersFile } from "../types";
 import {
   addNewServiceToMaintainersFile,
+  appendVariableGroupToPipelineYaml,
   generateAccessYaml,
   generateDefaultHldComponentYaml,
   generateDockerfile,
@@ -423,6 +425,44 @@ describe("generateHldAzurePipelinesYaml", () => {
   });
 });
 
+describe("appendVariableGroupToHldAzurePipelinesYaml", () => {
+  const targetDirectory = "hld-repository";
+  const writeSpy = jest.spyOn(fs, "writeFileSync");
+  const appendSpy = jest.spyOn(fs, "appendFileSync");
+  beforeEach(() => {
+    mockFs({
+      "hld-repository": {},
+    });
+  });
+  afterEach(() => {
+    mockFs.restore();
+  });
+  it("should append a variable group", () => {
+    const absTargetPath = path.resolve(targetDirectory);
+    const expectedFilePath = `${absTargetPath}/${RENDER_HLD_PIPELINE_FILENAME}`;
+
+    const mockFsOptions = {
+      [`${targetDirectory}/${RENDER_HLD_PIPELINE_FILENAME}`]: createTestHldAzurePipelinesYaml() as string,
+    };
+    mockFs(mockFsOptions);
+
+    appendVariableGroupToPipelineYaml(
+      absTargetPath,
+      RENDER_HLD_PIPELINE_FILENAME,
+      "my-vg"
+    );
+    expect(writeSpy).toBeCalledWith(
+      expectedFilePath,
+      `${getVersionMessage()}\n`,
+      "utf8"
+    );
+    expect(appendSpy).toBeCalledWith(
+      expectedFilePath,
+      createTestHldAzurePipelinesYamlWithVariableGroup()
+    );
+  });
+});
+
 describe("generateDefaultHldComponentYaml", () => {
   const targetDirectory = "hld-repository";
   const writeSpy = jest.spyOn(fs, "writeFileSync");

src/lib/fileutils.ts

@@ -19,6 +19,7 @@ import {
   MaintainersFile,
   User,
 } from "../types";
+import { readYaml, write } from "../config";
 
 /**
  * Read given pipeline file as json object.
@@ -470,6 +471,29 @@ export const updateTriggerBranchesForServiceBuildAndUpdatePipeline = (
   );
 };
 
+/**
+ * Appends a variable group an Azure pipeline yaml
+ * @param dir The directory where the pipeline yaml file is
+ * @param pipelineFile The name of the pipeline yaml file
+ * @param variableGroupName The name of the variable group to be added
+ */
+export const appendVariableGroupToPipelineYaml = (
+  dir: string,
+  fileName: string,
+  variableGroupName: string
+): void => {
+  const pipelineFile = readYaml(path.join(dir, fileName)) as AzurePipelinesYaml;
+
+  if (!pipelineFile.variables) {
+    pipelineFile.variables = [];
+  }
+
+  pipelineFile.variables.push({ group: variableGroupName });
+
+  logger.info(`Updating '${dir}/${fileName}'.`);
+  write(pipelineFile, dir, fileName);
+};
+
 /**
  * Returns a the Manifest Generation Pipeline as defined here: https://github.com/microsoft/bedrock/blob/master/gitops/azure-devops/ManifestGeneration.md#add-azure-pipelines-build-yaml
  */
@@ -481,6 +505,7 @@ const manifestGenerationPipelineYaml = (): string => {
         include: ["master"],
       },
     },
+    variables: [],
     pool: {
       vmImage: VM_IMAGE,
     },

src/test/mockFactory.ts

@@ -413,6 +413,7 @@ export const createTestHldAzurePipelinesYaml = (
         include: ["master"],
       },
     },
+    variables: [],
     pool: {
       vmImage: VM_IMAGE,
     },
@@ -509,6 +510,19 @@ export const createTestHldAzurePipelinesYaml = (
     : data;
 };
 
+export const createTestHldAzurePipelinesYamlWithVariableGroup = (
+  asString = true
+): AzurePipelinesYaml | string => {
+  const data: AzurePipelinesYaml = createTestHldAzurePipelinesYaml(
+    false
+  ) as AzurePipelinesYaml;
+  data.variables = [{ group: "my-vg" }];
+
+  return asString
+    ? yaml.safeDump(data, { lineWidth: Number.MAX_SAFE_INTEGER })
+    : data;
+};
+
 export const createTestComponentYaml = (
   asString = true
 ): ComponentYaml | string => {

tests/validations.sh

@@ -153,7 +153,7 @@ spk hld install-manifest-pipeline --org-name $AZDO_ORG -d $AZDO_PROJECT --person
 # Will no longer be needed once install-manifest-pipeline supports adding a VG
 ##################################
 cd $hld_dir
-printf "variables:\n  - group: $vg_name\n" | cat - manifest-generation.yaml > temp && mv temp manifest-generation.yaml
+spk hld append-variable-group $vg_name
 git add .
 git commit -m "Adding variable group $vg_name to pipeline"
 git push origin master