Skip to content

chore(credential-providers): remove dependency on util-credentials #3423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/credential-provider-ini/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
"@aws-sdk/property-provider": "*",
"@aws-sdk/shared-ini-file-loader": "*",
"@aws-sdk/types": "*",
"@aws-sdk/util-credentials": "*",
"tslib": "^2.3.0"
},
"devDependencies": {
Expand Down
16 changes: 7 additions & 9 deletions packages/credential-provider-ini/src/fromIni.spec.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import { AssumeRoleWithWebIdentityParams } from "@aws-sdk/credential-provider-web-identity";
import { CredentialProvider, Credentials } from "@aws-sdk/types";
import { getMasterProfileName, parseKnownFiles } from "@aws-sdk/util-credentials";
import { getProfileName, parseKnownFiles } from "@aws-sdk/shared-ini-file-loader";
import { Credentials } from "@aws-sdk/types";

import { fromIni } from "./fromIni";
import { AssumeRoleParams } from "./resolveAssumeRoleCredentials";
import { resolveProfileData } from "./resolveProfileData";

jest.mock("@aws-sdk/util-credentials");
jest.mock("@aws-sdk/shared-ini-file-loader");
jest.mock("./resolveProfileData");

describe(fromIni.name, () => {
Expand All @@ -17,7 +15,7 @@ describe(fromIni.name, () => {

beforeEach(() => {
(parseKnownFiles as jest.Mock).mockResolvedValue(mockProfiles);
(getMasterProfileName as jest.Mock).mockReturnValue(mockMasterProfileName);
(getProfileName as jest.Mock).mockReturnValue(mockMasterProfileName);
});

afterEach(() => {
Expand All @@ -34,7 +32,7 @@ describe(fromIni.name, () => {
expect(error).toStrictEqual(expectedError);
}
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).not.toHaveBeenCalled();
expect(getProfileName).not.toHaveBeenCalled();
expect(resolveProfileData).not.toHaveBeenCalled();
});

Expand All @@ -48,7 +46,7 @@ describe(fromIni.name, () => {
expect(error).toStrictEqual(expectedError);
}
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).toHaveBeenCalledWith(mockInit);
expect(getProfileName).toHaveBeenCalledWith(mockInit);
expect(resolveProfileData).toHaveBeenCalledWith(mockMasterProfileName, mockProfiles, mockInit);
});

Expand All @@ -61,7 +59,7 @@ describe(fromIni.name, () => {
const receivedCreds = await fromIni(mockInit)();
expect(receivedCreds).toStrictEqual(expectedCreds);
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).toHaveBeenCalledWith(mockInit);
expect(getProfileName).toHaveBeenCalledWith(mockInit);
expect(resolveProfileData).toHaveBeenCalledWith(mockMasterProfileName, mockProfiles, mockInit);
});
});
4 changes: 2 additions & 2 deletions packages/credential-provider-ini/src/fromIni.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AssumeRoleWithWebIdentityParams } from "@aws-sdk/credential-provider-web-identity";
import { getProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/shared-ini-file-loader";
import { CredentialProvider, Credentials } from "@aws-sdk/types";
import { getMasterProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/util-credentials";

import { AssumeRoleParams } from "./resolveAssumeRoleCredentials";
import { resolveProfileData } from "./resolveProfileData";
Expand Down Expand Up @@ -43,5 +43,5 @@ export const fromIni =
(init: FromIniInit = {}): CredentialProvider =>
async () => {
const profiles = await parseKnownFiles(init);
return resolveProfileData(getMasterProfileName(init), profiles, init);
return resolveProfileData(getProfileName(init), profiles, init);
};
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { getMasterProfileName } from "@aws-sdk/util-credentials";
import { getProfileName } from "@aws-sdk/shared-ini-file-loader";

import { isAssumeRoleProfile, resolveAssumeRoleCredentials } from "./resolveAssumeRoleCredentials";
import { resolveCredentialSource } from "./resolveCredentialSource";
import { resolveProfileData } from "./resolveProfileData";

jest.mock("@aws-sdk/util-credentials");
jest.mock("@aws-sdk/shared-ini-file-loader");
jest.mock("./resolveCredentialSource");
jest.mock("./resolveProfileData");

Expand Down Expand Up @@ -112,7 +112,7 @@ describe(resolveAssumeRoleCredentials.name, () => {
});

beforeEach(() => {
(getMasterProfileName as jest.Mock).mockReturnValue(mockProfileName);
(getProfileName as jest.Mock).mockReturnValue(mockProfileName);
(resolveProfileData as jest.Mock).mockResolvedValue(mockSourceCredsFromProfile);
(resolveCredentialSource as jest.Mock).mockReturnValue(() => Promise.resolve(mockSourceCredsFromCredential));
});
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { getProfileName } from "@aws-sdk/shared-ini-file-loader";
import { ParsedIniData, Profile } from "@aws-sdk/types";
import { getMasterProfileName } from "@aws-sdk/util-credentials";

import { FromIniInit } from "./fromIni";
import { resolveCredentialSource } from "./resolveCredentialSource";
Expand Down Expand Up @@ -83,7 +83,7 @@ export const resolveAssumeRoleCredentials = async (
if (source_profile && source_profile in visitedProfiles) {
throw new CredentialsProviderError(
`Detected a cycle attempting to resolve credentials for profile` +
` ${getMasterProfileName(options)}. Profiles visited: ` +
` ${getProfileName(options)}. Profiles visited: ` +
Object.keys(visitedProfiles).join(", "),
false
);
Expand Down
1 change: 0 additions & 1 deletion packages/credential-provider-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
"@aws-sdk/property-provider": "*",
"@aws-sdk/shared-ini-file-loader": "*",
"@aws-sdk/types": "*",
"@aws-sdk/util-credentials": "*",
"tslib": "^2.3.0"
},
"devDependencies": {
Expand Down
13 changes: 5 additions & 8 deletions packages/credential-provider-node/src/defaultProvider.spec.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import { fromEnv } from "@aws-sdk/credential-provider-env";
import { RemoteProviderInit } from "@aws-sdk/credential-provider-imds";
import { fromIni, FromIniInit } from "@aws-sdk/credential-provider-ini";
import { fromProcess, FromProcessInit } from "@aws-sdk/credential-provider-process";
import { fromSSO, FromSSOInit } from "@aws-sdk/credential-provider-sso";
import { fromTokenFile, FromTokenFileInit } from "@aws-sdk/credential-provider-web-identity";
import { fromIni } from "@aws-sdk/credential-provider-ini";
import { fromProcess } from "@aws-sdk/credential-provider-process";
import { fromSSO } from "@aws-sdk/credential-provider-sso";
import { fromTokenFile } from "@aws-sdk/credential-provider-web-identity";
import { chain, CredentialsProviderError, memoize } from "@aws-sdk/property-provider";
import { loadSharedConfigFiles } from "@aws-sdk/shared-ini-file-loader";
import { CredentialProvider } from "@aws-sdk/types";
import { ENV_PROFILE } from "@aws-sdk/util-credentials";
import { ENV_PROFILE, loadSharedConfigFiles } from "@aws-sdk/shared-ini-file-loader";

import { defaultProvider } from "./defaultProvider";
import { remoteProvider } from "./remoteProvider";
Expand Down
3 changes: 1 addition & 2 deletions packages/credential-provider-node/src/defaultProvider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ import { fromProcess, FromProcessInit } from "@aws-sdk/credential-provider-proce
import { fromSSO, FromSSOInit } from "@aws-sdk/credential-provider-sso";
import { fromTokenFile, FromTokenFileInit } from "@aws-sdk/credential-provider-web-identity";
import { chain, CredentialsProviderError, memoize } from "@aws-sdk/property-provider";
import { loadSharedConfigFiles } from "@aws-sdk/shared-ini-file-loader";
import { ENV_PROFILE, loadSharedConfigFiles } from "@aws-sdk/shared-ini-file-loader";
import { CredentialProvider } from "@aws-sdk/types";
import { ENV_PROFILE } from "@aws-sdk/util-credentials";

import { remoteProvider } from "./remoteProvider";

Expand Down
1 change: 0 additions & 1 deletion packages/credential-provider-process/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"@aws-sdk/property-provider": "*",
"@aws-sdk/shared-ini-file-loader": "*",
"@aws-sdk/types": "*",
"@aws-sdk/util-credentials": "*",
"tslib": "^2.3.0"
},
"devDependencies": {
Expand Down
12 changes: 6 additions & 6 deletions packages/credential-provider-process/src/fromProcess.spec.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { getProfileName, parseKnownFiles } from "@aws-sdk/shared-ini-file-loader";
import { Credentials } from "@aws-sdk/types";
import { getMasterProfileName, parseKnownFiles } from "@aws-sdk/util-credentials";

import { fromProcess } from "./fromProcess";
import { resolveProcessCredentials } from "./resolveProcessCredentials";

jest.mock("@aws-sdk/util-credentials");
jest.mock("@aws-sdk/shared-ini-file-loader");
jest.mock("./resolveProcessCredentials");

describe(fromProcess.name, () => {
Expand All @@ -15,7 +15,7 @@ describe(fromProcess.name, () => {

beforeEach(() => {
(parseKnownFiles as jest.Mock).mockResolvedValue(mockProfiles);
(getMasterProfileName as jest.Mock).mockReturnValue(mockMasterProfileName);
(getProfileName as jest.Mock).mockReturnValue(mockMasterProfileName);
});

afterEach(() => {
Expand All @@ -32,7 +32,7 @@ describe(fromProcess.name, () => {
expect(error).toStrictEqual(expectedError);
}
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).not.toHaveBeenCalled();
expect(getProfileName).not.toHaveBeenCalled();
expect(resolveProcessCredentials).not.toHaveBeenCalled();
});

Expand All @@ -46,7 +46,7 @@ describe(fromProcess.name, () => {
expect(error).toStrictEqual(expectedError);
}
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).toHaveBeenCalledWith(mockInit);
expect(getProfileName).toHaveBeenCalledWith(mockInit);
expect(resolveProcessCredentials).toHaveBeenCalledWith(mockMasterProfileName, mockProfiles);
});

Expand All @@ -59,7 +59,7 @@ describe(fromProcess.name, () => {
const receivedCreds = await fromProcess(mockInit)();
expect(receivedCreds).toStrictEqual(expectedCreds);
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).toHaveBeenCalledWith(mockInit);
expect(getProfileName).toHaveBeenCalledWith(mockInit);
expect(resolveProcessCredentials).toHaveBeenCalledWith(mockMasterProfileName, mockProfiles);
});
});
4 changes: 2 additions & 2 deletions packages/credential-provider-process/src/fromProcess.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { getProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/shared-ini-file-loader";
import { CredentialProvider } from "@aws-sdk/types";
import { getMasterProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/util-credentials";

import { resolveProcessCredentials } from "./resolveProcessCredentials";

Expand All @@ -13,5 +13,5 @@ export const fromProcess =
(init: FromProcessInit = {}): CredentialProvider =>
async () => {
const profiles = await parseKnownFiles(init);
return resolveProcessCredentials(getMasterProfileName(init), profiles);
return resolveProcessCredentials(getProfileName(init), profiles);
};
1 change: 0 additions & 1 deletion packages/credential-provider-sso/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"@aws-sdk/property-provider": "*",
"@aws-sdk/shared-ini-file-loader": "*",
"@aws-sdk/types": "*",
"@aws-sdk/util-credentials": "*",
"tslib": "^2.3.0"
},
"devDependencies": {
Expand Down
8 changes: 4 additions & 4 deletions packages/credential-provider-sso/src/fromSSO.spec.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { SSOClient } from "@aws-sdk/client-sso";
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { getMasterProfileName, parseKnownFiles } from "@aws-sdk/util-credentials";
import { getProfileName, parseKnownFiles } from "@aws-sdk/shared-ini-file-loader";

import { fromSSO } from "./fromSSO";
import { isSsoProfile } from "./isSsoProfile";
import { resolveSSOCredentials } from "./resolveSSOCredentials";
import { validateSsoProfile } from "./validateSsoProfile";

jest.mock("@aws-sdk/util-credentials");
jest.mock("@aws-sdk/shared-ini-file-loader");
jest.mock("./isSsoProfile");
jest.mock("./resolveSSOCredentials");
jest.mock("./validateSsoProfile");
Expand Down Expand Up @@ -42,13 +42,13 @@ describe(fromSSO.name, () => {

beforeEach(() => {
(parseKnownFiles as jest.Mock).mockResolvedValue(mockProfiles);
(getMasterProfileName as jest.Mock).mockReturnValue(mockProfileName);
(getProfileName as jest.Mock).mockReturnValue(mockProfileName);
(isSsoProfile as unknown as jest.Mock).mockReturnValue(true);
});

afterEach(() => {
expect(parseKnownFiles).toHaveBeenCalledWith(mockInit);
expect(getMasterProfileName).toHaveBeenCalledWith(mockInit);
expect(getProfileName).toHaveBeenCalledWith(mockInit);
expect(isSsoProfile).toHaveBeenCalledWith(mockSsoProfile);
});

Expand Down
4 changes: 2 additions & 2 deletions packages/credential-provider-sso/src/fromSSO.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { SSOClient } from "@aws-sdk/client-sso";
import { CredentialsProviderError } from "@aws-sdk/property-provider";
import { getProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/shared-ini-file-loader";
import { CredentialProvider } from "@aws-sdk/types";
import { getMasterProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/util-credentials";

import { isSsoProfile } from "./isSsoProfile";
import { resolveSSOCredentials } from "./resolveSSOCredentials";
Expand Down Expand Up @@ -44,7 +44,7 @@ export const fromSSO =
if (!ssoStartUrl && !ssoAccountId && !ssoRegion && !ssoRoleName) {
// Load the SSO config from shared AWS config file.
const profiles = await parseKnownFiles(init);
const profileName = getMasterProfileName(init);
const profileName = getProfileName(init);
const profile = profiles[profileName];

if (!isSsoProfile(profile)) {
Expand Down
1 change: 0 additions & 1 deletion packages/credential-providers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
"@aws-sdk/property-provider": "*",
"@aws-sdk/shared-ini-file-loader": "*",
"@aws-sdk/types": "*",
"@aws-sdk/util-credentials": "*",
"tslib": "^2.3.0"
},
"devDependencies": {
Expand Down