chore(shared-ini-file-loader): add utility loadSsoSessions (#132)

Author: trivikr

packages/shared-ini-file-loader/src/getSsoSessionData.spec.ts

@@ -0,0 +1,55 @@
+import { getSsoSessionData } from "./getSsoSessionData";
+
+describe(getSsoSessionData.name, () => {
+  it("returns empty for no data", () => {
+    expect(getSsoSessionData({})).toStrictEqual({});
+  });
+
+  it("skips sections without prefix sso-session", () => {
+    const mockInput = { test: { key: "value" } };
+    expect(getSsoSessionData(mockInput)).toStrictEqual({});
+  });
+
+  it("skips sections with different prefix", () => {
+    const mockInput = { "not-sso-session test": { key: "value" } };
+    expect(getSsoSessionData(mockInput)).toStrictEqual({});
+  });
+
+  describe("normalizes sso-session names", () => {
+    const getMockSsoSessionData = (ssoSessionName: string) =>
+      [1, 2, 3]
+        .map((num) => [`key_${ssoSessionName}_${num}`, `value_${ssoSessionName}_${num}`])
+        .reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {});
+
+    const getMockOutput = (ssoSessionNames: string[]) =>
+      ssoSessionNames.reduce((acc, profileName) => ({ ...acc, [profileName]: getMockSsoSessionData(profileName) }), {});
+
+    const getMockInput = (mockOutput: { [key: string]: { [key: string]: string } }) =>
+      Object.entries(mockOutput).reduce((acc, [key, value]) => ({ ...acc, [`sso-session ${key}`]: value }), {});
+
+    it("single sso-session section", () => {
+      const mockOutput = getMockOutput(["one"]);
+      const mockInput = getMockInput(mockOutput);
+      expect(getSsoSessionData(mockInput)).toStrictEqual(mockOutput);
+    });
+
+    it("two sso-session sections", () => {
+      const mockOutput = getMockOutput(["one", "two"]);
+      const mockInput = getMockInput(mockOutput);
+      expect(getSsoSessionData(mockInput)).toStrictEqual(mockOutput);
+    });
+
+    it("three sso-session sections", () => {
+      const mockOutput = getMockOutput(["one", "two", "three"]);
+      const mockInput = getMockInput(mockOutput);
+      expect(getSsoSessionData(mockInput)).toStrictEqual(mockOutput);
+    });
+
+    it("with section without prefix", () => {
+      const sectionWithoutPrefix = { test: { key: "value" } };
+      const mockOutput = getMockOutput(["one"]);
+      const mockInput = getMockInput(mockOutput);
+      expect(getSsoSessionData({ ...sectionWithoutPrefix, ...mockInput })).toStrictEqual(mockOutput);
+    });
+  });
+});

packages/shared-ini-file-loader/src/getSsoSessionData.ts

@@ -0,0 +1,14 @@
+import { ParsedIniData } from "@aws-sdk/types";
+
+const ssoSessionKeyRegex = /^sso-session\s(["'])?([^\1]+)\1$/;
+
+/**
+ * Returns the sso-session data from parsed ini data by reading
+ * ssoSessionName after sso-session prefix including/excluding quotes
+ */
+export const getSsoSessionData = (data: ParsedIniData): ParsedIniData =>
+  Object.entries(data)
+    // filter out non sso-session keys
+    .filter(([key]) => ssoSessionKeyRegex.test(key))
+    // replace sso-session key with sso-session name
+    .reduce((acc, [key, value]) => ({ ...acc, [ssoSessionKeyRegex.exec(key)![2]]: value }), {});

packages/shared-ini-file-loader/src/index.ts

@@ -3,5 +3,6 @@ export * from "./getProfileName";
 export * from "./getSSOTokenFilepath";
 export * from "./getSSOTokenFromFile";
 export * from "./loadSharedConfigFiles";
+export * from "./loadSsoSessionData";
 export * from "./parseKnownFiles";
 export * from "./types";

packages/shared-ini-file-loader/src/loadSsoSessionData.spec.ts

@@ -0,0 +1,60 @@
+import { getConfigFilepath } from "./getConfigFilepath";
+import { getSsoSessionData } from "./getSsoSessionData";
+import { loadSsoSessionData } from "./loadSsoSessionData";
+import { parseIni } from "./parseIni";
+import { slurpFile } from "./slurpFile";
+
+jest.mock("./getConfigFilepath");
+jest.mock("./getSsoSessionData");
+jest.mock("./parseIni");
+jest.mock("./slurpFile");
+
+describe(loadSsoSessionData.name, () => {
+  const mockConfigFilepath = "/mock/file/path/config";
+  const mockSsoSessionData = { test: { key: "value" } };
+
+  beforeEach(() => {
+    (getConfigFilepath as jest.Mock).mockReturnValue(mockConfigFilepath);
+    (parseIni as jest.Mock).mockImplementation((args) => args);
+    (getSsoSessionData as jest.Mock).mockReturnValue(mockSsoSessionData);
+    (slurpFile as jest.Mock).mockImplementation((path) => Promise.resolve(path));
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("returns configFile from default locations", async () => {
+    const ssoSessionData = await loadSsoSessionData();
+    expect(ssoSessionData).toStrictEqual(mockSsoSessionData);
+    expect(getConfigFilepath).toHaveBeenCalledWith();
+  });
+
+  it("returns configFile from init if defined", async () => {
+    const ssoSessionData = await loadSsoSessionData({
+      configFilepath: mockConfigFilepath,
+    });
+    expect(ssoSessionData).toStrictEqual(mockSsoSessionData);
+    expect(getConfigFilepath).not.toHaveBeenCalled();
+  });
+
+  describe("swallows error and returns empty configuration", () => {
+    it("when readFile throws error", async () => {
+      (slurpFile as jest.Mock).mockRejectedValue("error");
+      const ssoSessionData = await loadSsoSessionData();
+      expect(ssoSessionData).toStrictEqual({});
+    });
+
+    it("when parseIni throws error", async () => {
+      (parseIni as jest.Mock).mockRejectedValue("error");
+      const ssoSessionData = await loadSsoSessionData();
+      expect(ssoSessionData).toStrictEqual({});
+    });
+
+    it("when normalizeConfigFile throws error", async () => {
+      (getSsoSessionData as jest.Mock).mockRejectedValue("error");
+      const ssoSessionData = await loadSsoSessionData();
+      expect(ssoSessionData).toStrictEqual({});
+    });
+  });
+});

packages/shared-ini-file-loader/src/loadSsoSessionData.ts

@@ -0,0 +1,23 @@
+import { ParsedIniData } from "@aws-sdk/types";
+
+import { getConfigFilepath } from "./getConfigFilepath";
+import { getSsoSessionData } from "./getSsoSessionData";
+import { parseIni } from "./parseIni";
+import { slurpFile } from "./slurpFile";
+
+export interface SsoSessionInit {
+  /**
+   * The path at which to locate the ini config file. Defaults to the value of
+   * the `AWS_CONFIG_FILE` environment variable (if defined) or
+   * `~/.aws/config` otherwise.
+   */
+  configFilepath?: string;
+}
+
+const swallowError = () => ({});
+
+export const loadSsoSessionData = async (init: SsoSessionInit = {}): Promise<ParsedIniData> =>
+  slurpFile(init.configFilepath ?? getConfigFilepath())
+    .then(parseIni)
+    .then(getSsoSessionData)
+    .catch(swallowError);