Closes microsoft/bedrock#1082 (#423)

Author: sarath-p

src/commands/hld/reconcile.test.ts

@@ -431,7 +431,8 @@ describe("reconcile tests", () => {
           k8sBackend: "cool-service",
           k8sBackendPort: 1337
         }
-      }
+      },
+      version: "1.0"
     };
   });
 
@@ -498,7 +499,8 @@ describe("reconcile tests", () => {
           },
           k8sBackendPort: 1337
         }
-      }
+      },
+      version: "1.0"
     };
 
     await reconcileHld(

src/commands/project/create-variable-group.test.ts

@@ -224,7 +224,8 @@ describe("setVariableGroupInBedrockFile", () => {
     const bedrockFileData: BedrockFile = {
       rings: {}, // rings is optional but necessary to create a bedrock file in config.write method
       services: {}, // service property is not optional so set it to null
-      variableGroups: [prevariableGroupName]
+      variableGroups: [prevariableGroupName],
+      version: ""
     };
 
     const randomTmpDir = createBedrockYaml("", bedrockFileData);

src/commands/project/init.test.ts

@@ -1,3 +1,5 @@
+import fs from "fs";
+import path from "path";
 import uuid from "uuid/v4";
 import { Bedrock, Maintainers, write } from "../../config";
 import {
@@ -8,6 +10,7 @@ import { createTempDir, getMissingFilenames } from "../../lib/ioUtil";
 import { BedrockFile, MaintainersFile } from "../../types";
 import { execute, initialize } from "./init";
 import * as init from "./init";
+import { getVersionMessage } from "../../lib/fileutils";
 
 const CREATED_FILES = [
   ".gitignore",
@@ -17,10 +20,18 @@ const CREATED_FILES = [
 ];
 
 describe("Initializing a blank/new bedrock repository", () => {
+  const writeSpy = jest.spyOn(fs, "writeFileSync");
   test("all standard files get generated in the project root on init", async () => {
     const randomTmpDir = createTempDir();
     await initialize(randomTmpDir);
 
+    const expectedFilePath = path.join(randomTmpDir, "bedrock.yaml");
+    expect(writeSpy).toBeCalledWith(
+      expectedFilePath,
+      `${getVersionMessage()}\n`,
+      "utf8"
+    );
+
     // bedrock.yaml, maintainers.yaml should be in a the root for a 'standard' project
     const missing = getMissingFilenames(randomTmpDir, CREATED_FILES);
     expect(missing.length).toBe(0); // no files are missing hence length 0
@@ -58,7 +69,8 @@ describe("initializing an existing file does not modify it", () => {
           },
           k8sBackendPort: 1337
         }
-      }
+      },
+      version: "1.0"
     };
     write(bedrockFile, randomDir);
     await initialize(randomDir);

src/commands/project/init.ts

@@ -5,7 +5,8 @@ import { Bedrock, write } from "../../config";
 import { build as buildCmd, exit as exitCmd } from "../../lib/commandBuilder";
 import {
   generateGitIgnoreFile,
-  generateHldLifecyclePipelineYaml
+  generateHldLifecyclePipelineYaml,
+  getVersion
 } from "../../lib/fileutils";
 import { exec } from "../../lib/shell";
 import { logger } from "../../logger";
@@ -37,7 +38,8 @@ const generateBedrockFile = (
       },
       {}
     ),
-    services: {}
+    services: {},
+    version: getVersion()
   };
 
   // Check if a bedrock.yaml already exists; skip write if present

src/commands/project/pipeline.test.ts

@@ -115,7 +115,8 @@ describe("installLifecyclePipeline and execute tests", () => {
     createBedrockYaml(tmpDir, {
       rings: {},
       services: {},
-      variableGroups: ["test"]
+      variableGroups: ["test"],
+      version: "1.0"
     });
     await execute(mockValues, tmpDir, exitFn);
 

src/commands/ring/create.test.ts

@@ -33,7 +33,8 @@ describe("checkDependencies", () => {
         }
       },
       services: {},
-      variableGroups: ["testvg"]
+      variableGroups: ["testvg"],
+      version: "1.0"
     });
     checkDependencies(tmpDir, "not-master");
     // No errors thrown, this is a pass for the function.
@@ -46,7 +47,8 @@ describe("checkDependencies", () => {
         }
       },
       services: {},
-      variableGroups: ["testvg"]
+      variableGroups: ["testvg"],
+      version: "1.0"
     });
     expect(() => {
       checkDependencies(tmpDir, "master");
@@ -104,7 +106,8 @@ describe("test execute function and logic", () => {
           k8sBackendPort: 80
         }
       },
-      variableGroups: ["testvg"]
+      variableGroups: ["testvg"],
+      version: "1.0"
     });
 
     const newRingName = "my-new-ring";

src/commands/ring/set-default.test.ts

@@ -42,7 +42,8 @@ describe("test execute function and logic", () => {
         prod: {}
       },
       services: {},
-      variableGroups: ["testvg"]
+      variableGroups: ["testvg"],
+      version: "1.0"
     });
     await execute("prod", tmpDir, exitFn);
 

src/commands/service/create-revision.test.ts

@@ -65,7 +65,8 @@ describe("Default rings", () => {
           pathPrefix: "servicepath",
           pathPrefixMajorVersion: "v1"
         }
-      }
+      },
+      version: "1.0"
     };
 
     write(validBedrockYaml, randomTmpDir);
@@ -96,7 +97,8 @@ describe("Default rings", () => {
           pathPrefix: "servicepath",
           pathPrefixMajorVersion: "v1"
         }
-      }
+      },
+      version: "1.0"
     };
 
     write(validBedrockYaml, randomTmpDir);

src/config.test.ts

@@ -1,5 +1,6 @@
 import os from "os";
 import path from "path";
+import fs from "fs";
 import shell from "shelljs";
 import uuid from "uuid/v4";
 import {
@@ -14,6 +15,7 @@ import {
 import { createTempDir } from "./lib/ioUtil";
 import { disableVerboseLogging, enableVerboseLogging } from "./logger";
 import { BedrockFile } from "./types";
+import { getVersionMessage } from "./lib/fileutils";
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -51,6 +53,7 @@ describe("Test updateVariableWithLocalEnv function", () => {
 });
 
 describe("Bedrock", () => {
+  const writeSpy = jest.spyOn(fs, "writeFileSync");
   test("valid helm configuration passes", () => {
     const randomTmpDir = path.join(os.tmpdir(), uuid());
     shell.mkdir("-p", randomTmpDir);
@@ -82,9 +85,16 @@ describe("Bedrock", () => {
           pathPrefix: "servicepath",
           pathPrefixMajorVersion: "v1"
         }
-      }
+      },
+      version: "1.0"
     };
     write(validBedrockYaml, randomTmpDir);
+    const expectedFilePath = path.join(randomTmpDir, "bedrock.yaml");
+    expect(writeSpy).toBeCalledWith(
+      expectedFilePath,
+      `${getVersionMessage()}\n`,
+      "utf8"
+    );
 
     const bedrockConfig = Bedrock(randomTmpDir);
     expect(bedrockConfig).toBeTruthy();
@@ -113,10 +123,18 @@ describe("Bedrock", () => {
             }
           }
         }
-      }
+      },
+      version: "1.0"
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } as any;
     write(validBedrockYaml, randomTmpDir);
+    const expectedFilePath = path.join(randomTmpDir, "bedrock.yaml");
+    expect(writeSpy).toBeCalledWith(
+      expectedFilePath,
+      `${getVersionMessage()}\n`,
+      "utf8"
+    );
+
     expect(() => {
       Bedrock(randomTmpDir);
     }).toThrow();

src/config.ts

@@ -237,13 +237,14 @@ export const write = (
   const asYaml = yaml.safeDump(file, { lineWidth: Number.MAX_SAFE_INTEGER });
   if ("rings" in file) {
     // Is bedrock.yaml
-    return fs.writeFileSync(path.join(targetDirectory, "bedrock.yaml"), asYaml);
+    fileName = "bedrock.yaml";
+    writeVersion(path.join(targetDirectory, fileName));
+    return fs.appendFileSync(path.join(targetDirectory, fileName), asYaml);
   } else if ("services" in file) {
     // Is maintainers file
-    return fs.writeFileSync(
-      path.join(targetDirectory, "maintainers.yaml"),
-      asYaml
-    );
+    fileName = "maintainers.yaml";
+    writeVersion(path.join(targetDirectory, fileName));
+    return fs.appendFileSync(path.join(targetDirectory, fileName), asYaml);
   } else {
     // Is azure pipelines yaml file
     if (typeof fileName === "undefined") {

src/lib/bedrockYaml.test.ts

@@ -30,7 +30,8 @@ describe("Creation and Existence test on bedrock.yaml", () => {
     const dir = createTempDir();
     const data = {
       rings: {},
-      services: {}
+      services: {},
+      version: "1.0"
     };
     create(dir, data);
     expect(isExists(dir)).toBe(true);
@@ -90,7 +91,8 @@ describe("Adding a new service to a Bedrock file", () => {
           pathPrefixMajorVersion
         }
       },
-      variableGroups: []
+      variableGroups: [],
+      version: defaultBedrockFileObject.version
     };
 
     expect(read(dir)).toEqual(expected);
@@ -118,7 +120,8 @@ describe("Adding a new ring to an existing bedrock.yaml", () => {
       services: {
         ...(defaultBedrockFileObject as BedrockFile).services
       },
-      variableGroups: []
+      variableGroups: [],
+      version: defaultBedrockFileObject.version
     };
 
     expect(read(dir)).toEqual(expected);
@@ -146,7 +149,8 @@ describe("Bedrock file info", () => {
     const data = {
       rings: {},
       services: {},
-      variableGroups: [uuid()]
+      variableGroups: [uuid()],
+      version: "1.0"
     };
     create(dir, data);
     const file = fileInfo(dir);
@@ -164,7 +168,8 @@ describe("Set default ring", () => {
         prod: {}
       },
       services: {},
-      variableGroups: [uuid()]
+      variableGroups: [uuid()],
+      version: "1.0"
     };
     create(dir, data);
     setDefaultRing(data, "master", dir);
@@ -180,7 +185,8 @@ describe("Set default ring", () => {
         prod: { isDefault: true }
       },
       services: {},
-      variableGroups: [uuid()]
+      variableGroups: [uuid()],
+      version: "1.0"
     };
     create(dir, data);
     setDefaultRing(data, "master", dir);

src/lib/bedrockYaml.ts

@@ -4,13 +4,15 @@ import path from "path";
 import { createTempDir } from "../lib/ioUtil";
 import { logger } from "../logger";
 import { BedrockFile, BedrockFileInfo, HelmConfig, Rings } from "../types";
+import { writeVersion, getVersion } from "./fileutils";
 
 export const YAML_NAME = "bedrock.yaml";
 
 export const DEFAULT_CONTENT: BedrockFile = {
   rings: {},
   services: {},
-  variableGroups: []
+  variableGroups: [],
+  version: getVersion()
 };
 
 /**
@@ -30,7 +32,8 @@ export const create = (dir?: string, data?: BedrockFile): string => {
   const asYaml = yaml.safeDump(data, {
     lineWidth: Number.MAX_SAFE_INTEGER
   });
-  fs.writeFileSync(path.join(absPath, YAML_NAME), asYaml);
+  writeVersion(path.join(absPath, YAML_NAME));
+  fs.appendFileSync(path.join(absPath, YAML_NAME), asYaml);
   return absPath;
 };
 

src/lib/fileutils.ts

@@ -351,11 +351,18 @@ export const serviceBuildAndUpdatePipeline = (
   return pipelineYaml;
 };
 
+/**
+ * Gets the spk version
+ */
+export const getVersion = (): string => {
+  return require("../../package.json").version;
+};
+
 /**
  * Gets the spk version message
  */
 export const getVersionMessage = (): string => {
-  return VERSION_MESSAGE + require("../../package.json").version;
+  return VERSION_MESSAGE + getVersion();
 };
 
 /**

src/test/mockFactory.ts

@@ -301,7 +301,8 @@ export const createTestBedrockYaml = (
         k8sBackendPort: 80
       }
     },
-    variableGroups: []
+    variableGroups: [],
+    version: "1.0"
   };
 
   return asString ? yaml.dump(data) : data;

src/types.d.ts

@@ -57,6 +57,7 @@ export interface BedrockFile {
     [relativeDirectory: string]: BedrockServiceConfig;
   };
   variableGroups?: string[];
+  version: string;
 }
 
 export interface BedrockServiceConfig {