chore(shared-ini-file-loader): add utility fn to get file paths (#3572)

Author: trivikr

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

@@ -0,0 +1,39 @@
+import { join } from "path";
+
+import { ENV_CONFIG_PATH, getConfigFilepath } from "./getConfigFilepath";
+import { getHomeDir } from "./getHomeDir";
+
+jest.mock("path");
+jest.mock("./getHomeDir");
+
+describe(getConfigFilepath.name, () => {
+  const mockSeparator = "/";
+  const mockHomeDir = "/mock/home/dir";
+
+  const mockConfigFilepath = "/mock/file/path/config";
+  const defaultConfigFilepath = `${mockHomeDir}/.aws/config`;
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("returns configFilePath from default locations", () => {
+    (join as jest.Mock).mockImplementation((...args) => args.join(mockSeparator));
+    (getHomeDir as jest.Mock).mockReturnValue(mockHomeDir);
+    expect(getConfigFilepath()).toStrictEqual(defaultConfigFilepath);
+    expect(getHomeDir).toHaveBeenCalledWith();
+    expect(join).toHaveBeenCalledWith(mockHomeDir, ".aws", "config");
+  });
+
+  it("returns configFile from location defined in environment", () => {
+    const OLD_ENV = process.env;
+    process.env = {
+      ...OLD_ENV,
+      [ENV_CONFIG_PATH]: mockConfigFilepath,
+    };
+    expect(getConfigFilepath()).toStrictEqual(mockConfigFilepath);
+    expect(getHomeDir).not.toHaveBeenCalled();
+    expect(join).not.toHaveBeenCalled();
+    process.env = OLD_ENV;
+  });
+});

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

@@ -0,0 +1,7 @@
+import { join } from "path";
+
+import { getHomeDir } from "./getHomeDir";
+
+export const ENV_CONFIG_PATH = "AWS_CONFIG_FILE";
+
+export const getConfigFilepath = () => process.env[ENV_CONFIG_PATH] || join(getHomeDir(), ".aws", "config");

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

@@ -0,0 +1,39 @@
+import { join } from "path";
+
+import { ENV_CREDENTIALS_PATH, getCredentialsFilepath } from "./getCredentialsFilepath";
+import { getHomeDir } from "./getHomeDir";
+
+jest.mock("path");
+jest.mock("./getHomeDir");
+
+describe(getCredentialsFilepath.name, () => {
+  const mockSeparator = "/";
+  const mockHomeDir = "/mock/home/dir";
+
+  const mockConfigFilepath = "/mock/file/path/credentials";
+  const defaultConfigFilepath = `${mockHomeDir}/.aws/credentials`;
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("returns configFilePath from default locations", () => {
+    (join as jest.Mock).mockImplementation((...args) => args.join(mockSeparator));
+    (getHomeDir as jest.Mock).mockReturnValue(mockHomeDir);
+    expect(getCredentialsFilepath()).toStrictEqual(defaultConfigFilepath);
+    expect(getHomeDir).toHaveBeenCalledWith();
+    expect(join).toHaveBeenCalledWith(mockHomeDir, ".aws", "credentials");
+  });
+
+  it("returns configFile from location defined in environment", () => {
+    const OLD_ENV = process.env;
+    process.env = {
+      ...OLD_ENV,
+      [ENV_CREDENTIALS_PATH]: mockConfigFilepath,
+    };
+    expect(getCredentialsFilepath()).toStrictEqual(mockConfigFilepath);
+    expect(getHomeDir).not.toHaveBeenCalled();
+    expect(join).not.toHaveBeenCalled();
+    process.env = OLD_ENV;
+  });
+});

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

@@ -0,0 +1,8 @@
+import { join } from "path";
+
+import { getHomeDir } from "./getHomeDir";
+
+export const ENV_CREDENTIALS_PATH = "AWS_SHARED_CREDENTIALS_FILE";
+
+export const getCredentialsFilepath = () =>
+  process.env[ENV_CREDENTIALS_PATH] || join(getHomeDir(), ".aws", "credentials");

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

@@ -1,38 +1,27 @@
-import { join } from "path";
-
-import { getHomeDir } from "./getHomeDir";
+import { getConfigFilepath } from "./getConfigFilepath";
+import { getCredentialsFilepath } from "./getCredentialsFilepath";
 import { getProfileData } from "./getProfileData";
-import { ENV_CONFIG_PATH, ENV_CREDENTIALS_PATH, loadSharedConfigFiles } from "./loadSharedConfigFiles";
+import { loadSharedConfigFiles } from "./loadSharedConfigFiles";
 import { parseIni } from "./parseIni";
 import { slurpFile } from "./slurpFile";
 
-jest.mock("path");
-jest.mock("./getHomeDir");
+jest.mock("./getConfigFilepath");
+jest.mock("./getCredentialsFilepath");
 jest.mock("./getProfileData");
 jest.mock("./parseIni");
 jest.mock("./slurpFile");
 
 describe("loadSharedConfigFiles", () => {
-  const mockSeparator = "/";
-  const mockHomeDir = "/mock/home/dir";
-
   const mockConfigFilepath = "/mock/file/path/config";
   const mockCredsFilepath = "/mock/file/path/credentials";
-  const mockCustomSharedConfigFiles = {
+  const mockSharedConfigFiles = {
     configFile: mockConfigFilepath,
     credentialsFile: mockCredsFilepath,
   };
 
-  const defaultConfigFilepath = `${mockHomeDir}/.aws/config`;
-  const defaultCredsFilepath = `${mockHomeDir}/.aws/credentials`;
-  const mockDefaultSharedConfigFiles = {
-    configFile: defaultConfigFilepath,
-    credentialsFile: defaultCredsFilepath,
-  };
-
   beforeEach(() => {
-    (join as jest.Mock).mockImplementation((...args) => args.join(mockSeparator));
-    (getHomeDir as jest.Mock).mockReturnValue(mockHomeDir);
+    (getConfigFilepath as jest.Mock).mockReturnValue(mockConfigFilepath);
+    (getCredentialsFilepath as jest.Mock).mockReturnValue(mockCredsFilepath);
     (parseIni as jest.Mock).mockImplementation((args) => args);
     (getProfileData as jest.Mock).mockImplementation((args) => args);
     (slurpFile as jest.Mock).mockImplementation((path) => Promise.resolve(path));
@@ -45,27 +34,19 @@ describe("loadSharedConfigFiles", () => {
 
   it("returns configFile and credentialsFile from default locations", async () => {
     const sharedConfigFiles = await loadSharedConfigFiles();
-    expect(sharedConfigFiles).toStrictEqual(mockDefaultSharedConfigFiles);
-  });
-
-  it("returns configFile and credentialsFile from locations defined in environment", async () => {
-    const OLD_ENV = process.env;
-    process.env = {
-      ...OLD_ENV,
-      [ENV_CONFIG_PATH]: mockConfigFilepath,
-      [ENV_CREDENTIALS_PATH]: mockCredsFilepath,
-    };
-    const sharedConfigFiles = await loadSharedConfigFiles({});
-    expect(sharedConfigFiles).toStrictEqual(mockCustomSharedConfigFiles);
-    process.env = OLD_ENV;
+    expect(sharedConfigFiles).toStrictEqual(mockSharedConfigFiles);
+    expect(getConfigFilepath).toHaveBeenCalledWith();
+    expect(getCredentialsFilepath).toHaveBeenCalledWith();
   });
 
   it("returns configFile and credentialsFile from init if defined", async () => {
     const sharedConfigFiles = await loadSharedConfigFiles({
       filepath: mockCredsFilepath,
       configFilepath: mockConfigFilepath,
     });
-    expect(sharedConfigFiles).toStrictEqual(mockCustomSharedConfigFiles);
+    expect(sharedConfigFiles).toStrictEqual(mockSharedConfigFiles);
+    expect(getConfigFilepath).not.toHaveBeenCalled();
+    expect(getCredentialsFilepath).not.toHaveBeenCalled();
   });
 
   describe("swallows error and returns empty configuration", () => {
@@ -86,7 +67,7 @@ describe("loadSharedConfigFiles", () => {
       const sharedConfigFiles = await loadSharedConfigFiles();
       expect(sharedConfigFiles).toStrictEqual({
         configFile: {},
-        credentialsFile: defaultCredsFilepath,
+        credentialsFile: mockCredsFilepath,
       });
     });
   });

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

@@ -1,14 +1,11 @@
 import { SharedConfigFiles } from "@aws-sdk/types";
-import { join } from "path";
 
-import { getHomeDir } from "./getHomeDir";
+import { getConfigFilepath } from "./getConfigFilepath";
+import { getCredentialsFilepath } from "./getCredentialsFilepath";
 import { getProfileData } from "./getProfileData";
 import { parseIni } from "./parseIni";
 import { slurpFile } from "./slurpFile";
 
-export const ENV_CREDENTIALS_PATH = "AWS_SHARED_CREDENTIALS_FILE";
-export const ENV_CONFIG_PATH = "AWS_CONFIG_FILE";
-
 export interface SharedConfigInit {
   /**
    * The path at which to locate the ini credentials file. Defaults to the
@@ -28,10 +25,7 @@ export interface SharedConfigInit {
 const swallowError = () => ({});
 
 export const loadSharedConfigFiles = async (init: SharedConfigInit = {}): Promise<SharedConfigFiles> => {
-  const {
-    filepath = process.env[ENV_CREDENTIALS_PATH] || join(getHomeDir(), ".aws", "credentials"),
-    configFilepath = process.env[ENV_CONFIG_PATH] || join(getHomeDir(), ".aws", "config"),
-  } = init;
+  const { filepath = getCredentialsFilepath(), configFilepath = getConfigFilepath() } = init;
 
   const parsedFiles = await Promise.all([
     slurpFile(configFilepath).then(parseIni).then(getProfileData).catch(swallowError),