Skip to content

Commit

Permalink
Fix broken unit test cases
Browse files Browse the repository at this point in the history 
Signed-off-by: Santhoshi Boyina <Santhoshi.Boyina1@ibm.com>
  • Loading branch information
@SanthoshiBoyina1
SanthoshiBoyina1 committed Jul 11, 2024
1 parent 8d29f0e commit 116ad2d
Show file tree
Hide file tree
Showing 3 changed files with 204 additions and 37 deletions.
191 changes: 183 additions & 8 deletions packages/zowe-explorer/__tests__/__unit__/Profiles.extended.unit.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1687,7 +1687,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
);
});

it("To switch from Basic to Token-based authentication with Base Profile", async () => {
it("To switch from Basic to Token-based authentication using Base Profile", async () => {
jest.spyOn(utils.ProfilesUtils, "isProfileUsingBasicAuth").mockReturnValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
Expand All @@ -1704,6 +1704,22 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
},
},
],
mergeArgsForProfile: jest.fn().mockReturnValue({
knownArgs: [
{
argName: "user",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
{
argName: "password",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
],
}),
} as any);
testNode.profile.profile = {
type: "zosmf",
Expand All @@ -1729,6 +1745,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
tokenValue: "12345",
secure: ["tokenType"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "apimlAuthenticationToken",
} as never);
Expand All @@ -1744,7 +1761,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(testNode.profile.profile.password).toBeUndefined();
});

it("To check login fail's when switching from Basic to Token-based authentication with Base Profile", async () => {
it("To check login fail's when trying to switch from Basic to Token-based authentication using Base Profile", async () => {
jest.spyOn(utils.ProfilesUtils, "isProfileUsingBasicAuth").mockReturnValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
Expand Down Expand Up @@ -1786,6 +1803,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
tokenValue: undefined,
secure: ["user", "password"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(Gui, "errorMessage").mockImplementation();
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "apimlAuthenticationToken",
Expand All @@ -1802,7 +1820,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(testNode.profile.profile.tokenValue).toBeUndefined();
});

it("To switch from Basic to Token-based authentication with Regular Profile", async () => {
it("To switch from Basic to Token-based authentication using Regular Profile", async () => {
jest.spyOn(utils.ProfilesUtils, "isProfileUsingBasicAuth").mockReturnValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
Expand All @@ -1819,6 +1837,22 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
},
},
],
mergeArgsForProfile: jest.fn().mockReturnValue({
knownArgs: [
{
argName: "user",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
{
argName: "password",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
],
}),
} as any);
testNode.profile.profile = {
type: "zosmf",
Expand All @@ -1844,6 +1878,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
tokenValue: "12345",
secure: ["tokenType"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "jwtToken",
} as never);
Expand All @@ -1858,7 +1893,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(testNode.profile.profile.password).toBeUndefined();
});

it("To check login fail's when switching from Basic to Token-based authentication with Regular Profile", async () => {
it("To check login fail's when trying to switch from Basic to Token-based authentication using Regular Profile", async () => {
jest.spyOn(utils.ProfilesUtils, "isProfileUsingBasicAuth").mockReturnValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
Expand Down Expand Up @@ -1900,6 +1935,8 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
tokenValue: undefined,
secure: ["user", "password"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(Gui, "errorMessage").mockImplementation();
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "jwtToken",
} as never);
Expand All @@ -1914,7 +1951,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(testNode.profile.profile.tokenValue).toBeUndefined();
});

it("To switch from Token-based to Basic authentication when cred values are passed", async () => {
it("To switch from Token-based to Basic authentication when cred values are passed involving base profile", async () => {
jest.spyOn(utils.ProfilesUtils, "isUsingTokenAuth").mockResolvedValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
Expand All @@ -1931,6 +1968,22 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
},
},
],
mergeArgsForProfile: jest.fn().mockReturnValue({
knownArgs: [
{
argName: "user",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
{
argName: "password",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
],
}),
} as any);
testNode.profile.profile = {
type: "zosmf",
Expand All @@ -1956,6 +2009,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
tokenValue: undefined,
secure: ["user", "password"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "apimlAuthenticationToken",
} as never);
Expand All @@ -1971,7 +2025,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(testNode.profile.profile.tokenValue).toBeUndefined();
});

it("To switch from Token-based to Basic authentication when cred values are not passed", async () => {
it("To switch from Token-based to Basic authentication when cred values are passed involving regular profile", async () => {
jest.spyOn(utils.ProfilesUtils, "isUsingTokenAuth").mockResolvedValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
Expand All @@ -1988,6 +2042,22 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
},
},
],
mergeArgsForProfile: jest.fn().mockReturnValue({
knownArgs: [
{
argName: "user",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
{
argName: "password",
dataType: "string",
argValue: "fake",
argLoc: { jsonLoc: "jsonLoc" },
},
],
}),
} as any);
testNode.profile.profile = {
type: "zosmf",
Expand All @@ -2002,6 +2072,52 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
secure: ["tokenType"],
};
modifiedTestNode.profile.profile = {
type: "zosmf",
host: "test",
port: 1443,
name: "base",
rejectUnauthorized: false,
user: "testUser",
password: "6789",
tokenType: undefined,
tokenValue: undefined,
secure: ["user", "password"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "jwtToken",
} as never);
jest.spyOn(Profiles.getInstance(), "promptCredentials").mockResolvedValue(["testUser", "6789"]);
await Profiles.getInstance().handleSwitchAuthentication(testNode);
expect(Gui.showMessage).toBeCalled();
expect(Gui.showMessage).toBeCalled();
expect(testNode.profile.profile.tokenType).toBe(modifiedTestNode.profile.profile.tokenType);
expect(testNode.profile.profile.tokenValue).toBe(modifiedTestNode.profile.profile.tokenValue);
expect(testNode.profile.profile.secure.length).toBe(modifiedTestNode.profile.profile.secure.length);
expect(testNode.profile.profile.secure).toEqual(modifiedTestNode.profile.profile.secure);
expect(testNode.profile.profile.tokenType).toBeUndefined();
expect(testNode.profile.profile.tokenValue).toBeUndefined();
});

it("To not switch from Token-based to Basic authentication when cred values are not passed", async () => {
jest.spyOn(utils.ProfilesUtils, "isUsingTokenAuth").mockResolvedValueOnce(true);
jest.spyOn(Profiles.getInstance(), "getProfileInfo").mockResolvedValue({
getTeamConfig: () => ({
properties: jest.fn(),
set: jest.fn(),
delete: jest.fn(),
save: jest.fn(),
}),
getAllProfiles: () => [
{
profName: "sestest",
profLoc: {
osLoc: ["test"],
},
},
],
} as any);
testNode.profile.profile = {
type: "zosmf",
host: "test",
port: 1443,
Expand All @@ -2013,6 +2129,19 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
tokenValue: "12345",
secure: ["tokenType"],
};
modifiedTestNode.profile.profile = {
type: "zosmf",
host: "test",
port: 1443,
name: "base",
rejectUnauthorized: false,
user: undefined,
password: undefined,
tokenType: "testTokenType",
tokenValue: "12345",
secure: ["tokenType"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => "apimlAuthenticationToken",
} as never);
Expand All @@ -2028,8 +2157,10 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(testNode.profile.profile.password).toBeUndefined();
});

it("To check authentication switch for a profile which does not support token-based authentication", async () => {
it("To not perform switching the authentication for a profile which does not support token-based authentication", async () => {
jest.spyOn(utils.ProfilesUtils, "isProfileUsingBasicAuth").mockReturnValueOnce(true);
jest.spyOn(Gui, "errorMessage").mockImplementation();
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
getTokenTypeName: () => {
throw new Error("test error.");
Expand All @@ -2039,7 +2170,9 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
expect(Gui.errorMessage).toBeCalled();
});

it("When authentication method is unknown", async () => {
it("To not perform switching the authentication when authentication method is unknown", async () => {
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "Yes" } as vscode.QuickPickItem);
jest.spyOn(Gui, "errorMessage").mockImplementation();
jest.spyOn(utils.ProfilesUtils, "isProfileUsingBasicAuth").mockReturnValueOnce(false);
jest.spyOn(utils.ProfilesUtils, "isUsingTokenAuth").mockResolvedValueOnce(false);
jest.spyOn(ZoweExplorerApiRegister.getInstance(), "getCommonApi").mockReturnValue({
Expand All @@ -2048,6 +2181,48 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
await Profiles.getInstance().handleSwitchAuthentication(testNode);
expect(Gui.errorMessage).toBeCalled();
});

it("To not perform switching the authentication when user wants to cancel the authentication switch", async () => {
testNode.profile.profile = {
type: "zosmf",
host: "test",
port: 1443,
name: "base",
rejectUnauthorized: false,
user: undefined,
password: undefined,
tokenType: "testTokenType",
tokenValue: "12345",
secure: ["tokenType"],
};
modifiedTestNode.profile.profile = {
type: "zosmf",
host: "test",
port: 1443,
name: "base",
rejectUnauthorized: false,
user: undefined,
password: undefined,
tokenType: "testTokenType",
tokenValue: "12345",
secure: ["tokenType"],
};
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue({ label: "No" } as vscode.QuickPickItem);
await Profiles.getInstance().handleSwitchAuthentication(testNode);
expect(testNode.profile.profile.tokenType).toBe(modifiedTestNode.profile.profile.tokenType);
expect(testNode.profile.profile.tokenValue).toBe(modifiedTestNode.profile.profile.tokenValue);
expect(testNode.profile.profile.secure.length).toBe(modifiedTestNode.profile.profile.secure.length);
expect(testNode.profile.profile.secure).toEqual(modifiedTestNode.profile.profile.secure);
expect(testNode.profile.profile.user).toBeUndefined();
expect(testNode.profile.profile.password).toBeUndefined();
});

it("To not perform switching the authentication when user wants escapes the quick pick of authentication switch", async () => {
jest.spyOn(Gui, "resolveQuickPick").mockResolvedValue(undefined);
jest.spyOn(Gui, "infoMessage").mockImplementation();
await Profiles.getInstance().handleSwitchAuthentication(testNode);
expect(Gui.infoMessage).toBeCalled();
});
});

describe("Profiles Unit Tests - function ssoLogout", () => {
Expand Down
9 changes: 5 additions & 4 deletions packages/zowe-explorer/i18n/sample/src/Profiles.i18n.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,12 @@
"ssoLogin.tokenType.error": "Error getting supported tokenType value for profile {0}",
"ssoLogin.successful": "Login to authentication service was successful.",
"ssoLogin.error": "Unable to log in with {0}. {1}",
"Profiles.getSwitchAuthenticationQpItems.yesLbl": "Yes",
"ProfileManagement.getSwitchAuthenticationQpItems.yesDesc": "To change the authentication",
"Profiles.getSwitchAuthenticationQpItems.noLbl": "No",
"Profiles.getSwitchAuthenticationQpItems.noDesc": "To continue in current authentication",
"Profiles.switchAuthenticationQuickPick.yesLbl": "Yes",
"ProfileManagement.switchAuthenticationQuickPick.yesDesc": "To change the authentication",
"Profiles.switchAuthenticationQuickPick.noLbl": "No",
"Profiles.switchAuthenticationQuickPick.noDesc": "To continue in current authentication",
"Profiles.switchAuthenticationQuickPick.qpConfirmation": "Do you wish to change the Authentication",
"Profiles.getSwitchAuthenticationQpItems.noLbl": "No",
"handleSwitchAuthentication.getTokenTypeName.error": "Cannot switch to Token-based Authentication for profile {0}.",
"handleSwitchAuthentication.switchFromBasicToTokenAuth.successful": "Login using token-based authentication service was successful for profile {0}.",
"handleSwitchAuthentication.switchFromBasicToTokenAuth.error": "Unable to switch to Token-based authentication for profile {0}.",
Expand Down
Loading

0 comments on commit 116ad2d

Please sign in to comment.