Set default ring in spk (#366)

* Set default ring

* Add function to set default ring

* Updates based on feedback

* Remove default ring property

* Update based on feedback

Co-authored-by: Michael Tarng <20913254+mtarng@users.noreply.github.com>

Author: mtarng

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

@@ -39,12 +39,13 @@ describe("test execute function and logic", () => {
       rings: {
         master: {
           isDefault: true
-        }
+        },
+        prod: {}
       },
       services: {},
       variableGroups: ["testvg"]
     });
-    await execute("ring", tmpDir, exitFn);
+    await execute("prod", tmpDir, exitFn);
 
     expect(exitFn).toBeCalledTimes(1);
     expect(exitFn.mock.calls).toEqual([[0]]);

src/commands/ring/set-default.ts

@@ -1,11 +1,14 @@
 import commander from "commander";
-import { fileInfo as bedrockFileInfo } from "../../lib/bedrockYaml";
+import {
+  fileInfo as bedrockFileInfo,
+  read as loadBedrockFile,
+  setDefaultRing
+} 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 { IBedrockFile, IBedrockFileInfo } from "../../types";
 import decorator from "./set-default.decorator.json";
 
 /**
@@ -29,9 +32,9 @@ export const execute = async (
 
     checkDependencies(projectPath);
 
-    // Check if ring exists in bedrock.yaml, if not, warn and exit.
-    // Check if ring is already default, if so, warn and exit.
-    // Set ring as default in bedrock.yaml
+    // Get bedrock.yaml
+    const bedrockFile = loadBedrockFile(projectPath);
+    setDefaultRing(bedrockFile, ringName, projectPath);
 
     logger.info(`Successfully set default ring: ${ringName} for this project!`);
     await exitFn(0);

src/lib/bedrockYaml.test.ts

@@ -9,7 +9,8 @@ import {
   DEFAULT_CONTENT,
   fileInfo,
   isExists,
-  read
+  read,
+  setDefaultRing
 } from "./bedrockYaml";
 
 describe("Creation and Existence test on bedrock.yaml", () => {
@@ -156,3 +157,38 @@ describe("Bedrock file info", () => {
     expect(file.hasVariableGroups).toEqual(true);
   });
 });
+
+describe("Set default ring", () => {
+  it("Should set the default ring", () => {
+    const dir = createTempDir();
+    const data = {
+      rings: {
+        master: { isDefault: false },
+        prod: {}
+      },
+      services: {},
+      variableGroups: [uuid()]
+    };
+    create(dir, data);
+    setDefaultRing(data, "master", dir);
+    const result = read(dir);
+    expect(result.rings.master.isDefault).toBe(true);
+    expect(result.rings.prod.isDefault).toBe(undefined);
+  });
+  it("Should change the default ring", () => {
+    const dir = createTempDir();
+    const data = {
+      rings: {
+        master: { isDefault: false },
+        prod: { isDefault: true }
+      },
+      services: {},
+      variableGroups: [uuid()]
+    };
+    create(dir, data);
+    setDefaultRing(data, "master", dir);
+    const result = read(dir);
+    expect(result.rings.master.isDefault).toBe(true);
+    expect(result.rings.prod.isDefault).toBe(undefined);
+  });
+});

src/lib/bedrockYaml.ts

@@ -105,6 +105,38 @@ export const addNewService = (
   fs.writeFileSync(path.join(absPath, YAML_NAME), asYaml);
 };
 
+/**
+ * Sets the default ring in bedrock.yaml
+ * @param bedrockFile The bedrock.yaml file
+ * @param ringName The name of the ring
+ */
+export const setDefaultRing = (
+  bedrockFile: IBedrockFile,
+  ringName: string,
+  dir: string
+): void => {
+  const rings = Object.keys(bedrockFile.rings);
+  if (!rings.includes(ringName)) {
+    throw new Error(`The ring '${ringName}' is not defined in ${YAML_NAME}`);
+  }
+
+  for (const [name, value] of Object.entries(bedrockFile.rings)) {
+    if (value === null) {
+      bedrockFile.rings[name] = {};
+    }
+    const ring = bedrockFile.rings[name];
+
+    if (name === ringName) {
+      ring.isDefault = true;
+    } else {
+      if (typeof ring.isDefault !== "undefined") {
+        delete ring.isDefault;
+      }
+    }
+  }
+
+  create(dir, bedrockFile);
+};
 /**
  * Update bedrock.yaml with new ring
  *