SSP-4252 refactor parse to use regEx & extend unittests

Author: agentschmitt

src/parse.ts

@@ -1,13 +1,23 @@
-export function parseVaultKey(vaultKey: string, prefix = "VaultKey--") {
-    const vaultStr = vaultKey.replace(prefix, "").replace("kv-v2/data/", "");
+export function parseVaultKey(vaultKey: string) {
+    const regex = /(VaultKey--)(kv-v2)\/(data)\/(?<path>.*\/)(?<key>.*)/;
 
-    const parts = vaultStr.split("/");
-    const key = parts.pop();
-    const path = parts.join("/");
+    const match = vaultKey.match(regex);
+
+    if (!match) {
+        throw new Error("VaultKey not valid: " + vaultKey);
+    }
+
+    const secretPath = trimEnd(match.groups["path"]);
+    const secretKey = trimEnd(match.groups["key"]);
 
     return {
         secretMount: "kv-v2",
-        secretPath: path,
-        secretKey: key
+        secretPath,
+        secretKey
     };
 }
+
+function trimEnd(value: string, char = "/") {
+    if (!value) return "";
+    return value.endsWith(char) ? value.slice(0, -1) : value;
+}

tests/parse.spec.ts

@@ -1,7 +1,7 @@
 import { parseVaultKey } from "../src/parse";
 
 describe("parseVaultKey", () => {
-    it("returns ", () => {
+    it("returns secret with sub-path ", () => {
         const result = parseVaultKey("VaultKey--kv-v2/data/global/logstash/Username");
 
         const expected = {
@@ -12,4 +12,24 @@ describe("parseVaultKey", () => {
 
         expect(result).toStrictEqual(expected);
     });
+
+    it("returns secret in root-path", () => {
+        const result = parseVaultKey("VaultKey--kv-v2/data/logstash/Username");
+
+        const expected = {
+            secretMount: "kv-v2",
+            secretPath: "logstash",
+            secretKey: "Username"
+        };
+
+        expect(result).toStrictEqual(expected);
+    });
+
+    it("fails for secret without path", () => {
+        expect(() => parseVaultKey("VaultKey--kv-v2/data/Username")).toThrowError();
+    });
+
+    it("fails for non-secret", () => {
+        expect(() => parseVaultKey("xyz")).toThrowError();
+    });
 });