Skip to content

Commit

Permalink
Remove xxxProfileManager.saveProfile and updateProfile
Browse files Browse the repository at this point in the history 
Signed-off-by: Gene Johnston <[email protected]>
  • Loading branch information
@gejohnston
gejohnston committed Feb 5, 2024
1 parent 44f33c1 commit 3a18010
Show file tree
Hide file tree
Showing 27 changed files with 78 additions and 2,564 deletions.
6 changes: 0 additions & 6 deletions packages/core/src/constants/Core.constants.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -402,12 +402,6 @@ export class ProfileConstants {
description: "Create a zosmf profile called 'base4' to connect to default port 443 and allow self-signed certificates, " +
"not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command"
}
],
updateProfileExamples: [
{
options: "base1 --user newuser --password newp4ss",
description: "Update a base profile named 'base1' with a new username and password"
}
]
};
}
22 changes: 19 additions & 3 deletions packages/imperative/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,35 @@ All notable changes to the Imperative package will be documented in this file.
## Recent Changes

- LTS Breaking:
- Removed the following functions:
- Removed the following obsolete V1 profile interfaces:
- ICommandProfileTypeConfiguration.updateProfileExamples
- ICommandProfileTypeConfiguration.updateProfileFromArgumentsHandler
- IProfileSaved
- ISaveProfile
- ISaveProfileFromCliArgs
- IUpdateProfile
- IUpdateProfileFromCliArgs

- Removed the following obsolete V1 profile functions:
- AbstractProfileManager.save
- AbstractProfileManager.saveProfile
- AbstractProfileManager.update
- BasicProfileManager.saveProfile
- BasicProfileManager.updateProfile
- CliProfileManager.saveProfile
- CliProfileManager.updateProfile
- CommandProfiles.getMeta
- CommandProfiles.getAll
- Annotated the following items as @internal:
- CommandProfiles.get
- IHandlerParameters.profiles
- Removed the following obsolete constants from the ProfilesConstants class:
- Removed the following obsolete V1 profile constants from the ProfilesConstants class:
- DEPRECATE_TO_CONFIG_EDIT
- DEPRECATE_TO_CONFIG_INIT
- DEPRECATE_TO_CONFIG_LIST
- DEPRECATE_TO_CONFIG_SET
- PROFILES_COMMAND_TYPE_KEY
- Removed the following obsolete constants from the CoreMessages class:
- Removed the following obsolete V1 profile constants from the CoreMessages class:
- createProfileCommandSummary
- createProfileDisableDefaultsDesc
- createProfileOptionDesc
Expand Down
6 changes: 0 additions & 6 deletions packages/imperative/__tests__/src/example_clis/with_profiles/ProfileExampleConfiguration.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,6 @@ const config: IImperativeConfig = {
options: "--animal doggy",
description: "Create a profile-a profile with a doggy as the animal"
}
],
updateProfileExamples: [
{
options: "--animal froggy",
description: "Update a profile-a profile to use froggy as the animal"
}
]
},
{
Expand Down
274 changes: 3 additions & 271 deletions packages/imperative/src/cmd/__tests__/profiles/CliProfileManager.credentials.unit.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
} from "../../../profiles/__tests__/TestConstants";
import { CredentialManagerFactory, DefaultCredentialManager } from "../../../security";
import { BasicProfileManager } from "../../../profiles/src/BasicProfileManager";
import { ProfilesConstants, ISaveProfile, IProfileSaved } from "../../../profiles";
import { ProfilesConstants } from "../../../profiles";

jest.mock("../../../profiles/src/utils/ProfileIO");
jest.mock("../../../security/src/DefaultCredentialManager");
Expand Down Expand Up @@ -87,275 +87,6 @@ describe("Cli Profile Manager", () => {
prof.setDefault = jest.fn();
});

describe("Save operation", () => {
it("should save credentials and store a profile with a constant string value for secure properties", async () => {
const dummyManager = new DefaultCredentialManager("dummy");
dummyManager.save = jest.fn();
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});
Object.defineProperty(CredentialManagerFactory, "initialized", {get: jest.fn().mockReturnValue(true)});

const tempProf: any = {
username: user,
password: undefined,
secureBox: {
myCode: securelyStored,
myFlag: securelyStored,
myMiniBox: securelyStored,
myPhone: securelyStored,
myPhrase: securelyStored,
mySet: securelyStored,
myEmptyMiniBox: null,
}
};

jest.spyOn(BasicProfileManager.prototype, "saveProfile" as any).mockImplementation((tParms: ISaveProfile | any) => {
return {
overwritten: tParms.overwrite,
profile: tParms.profile
};
});

const result = await prof.save(parms);

// Parms should be successfully deleted form memory
expect(parms.args).toBeUndefined();

// BasicProfileManager should be called to save the profile with the given options
expect((BasicProfileManager.prototype as any).saveProfile).toHaveBeenCalledWith({
name,
type: "secure-orange",
overwrite: false,
profile: tempProf
});

// Should have saved every secure property as a constant string
expect(result.profile).toMatchObject(tempProf);

// writtenProfile === undefined since BasicProfileManager gets mocked and doesn't call ProfileIO.writeProfile
expect(writtenProfile).toBeUndefined();

(BasicProfileManager.prototype as any).saveProfile.mockRestore();
});

it("should not invoke the credential manager if it has not been initialized", async () => {
// We'll use a dummy credential manager in the test - but set initialized to "false" - this way we can use
// Jest expect.toHaveBeenCalledTimes(0)
const dummyManager = new DefaultCredentialManager("dummy");
dummyManager.save = jest.fn();
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});
Object.defineProperty(CredentialManagerFactory, "initialized", {get: jest.fn().mockReturnValue(false)});

const tempProf: any = {
username: user,
password: null,
secureBox: {
myCode: securelyStored,
myFlag: securelyStored,
myMiniBox: securelyStored,
myPhone: securelyStored,
myPhrase: securelyStored,
mySet: securelyStored,
myEmptyMiniBox: null,
}
};

jest.spyOn(BasicProfileManager.prototype, "saveProfile" as any).mockImplementation((tParms: ISaveProfile | any) => {
return {
overwritten: tParms.overwrite,
profile: tParms.profile
};
});

await prof.save(parms);

// Parms should be successfully deleted form memory
expect(parms.args).toBeUndefined();

// writtenProfile === undefined since BasicProfileManager gets mocked and doesn't call ProfileIO.writeProfile
expect(writtenProfile).toBeUndefined();

// Expect the credential manager save to have NOT been called
expect(dummyManager.save).toHaveBeenCalledTimes(0);

(BasicProfileManager.prototype as any).saveProfile.mockRestore();
});

it("should save credentials without erroring the credential manager if there are no secure credentials to save", async () => {
// We'll use a dummy credential manager in the test - but set initialized to "false" - this way we can use
// Jest expect.toHaveBeenCalledTimes(0)
const dummyManager = new DefaultCredentialManager("dummy");
dummyManager.save = jest.fn();
dummyManager.delete = jest.fn(() => {
throw new Error("This is a dummy error that is thrown");
});
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});
Object.defineProperty(CredentialManagerFactory, "initialized", {get: jest.fn().mockReturnValue(true)});

const tempProf: any = {
username: user,
password: undefined,
secureBox: {
myCode: undefined,
myFlag: undefined,
myMiniBox: null,
myPhone: undefined,
myPhrase: undefined,
mySet: undefined,
myEmptyMiniBox: null,
}
};

parms.args.phone = undefined;
parms.args.code = undefined;
parms.args.phrase = undefined;
parms.args.set = undefined;
parms.args.flag = undefined;
parms.args.minime = undefined;

jest.spyOn(BasicProfileManager.prototype, "saveProfile" as any).mockImplementation((tParms: ISaveProfile | any) => {
return {
overwritten: tParms.overwrite,
profile: tParms.profile
};
});

let result: IProfileSaved;
let errorMessage: string;
try {
result = await prof.save(parms);
} catch (err) {
errorMessage = err.message;
}
// Parms should be successfully deleted from memory
expect(parms.args).toBeUndefined();
expect(errorMessage).toBeUndefined();

// BasicProfileManager should be called to save the profile with the given options
expect((BasicProfileManager.prototype as any).saveProfile).toHaveBeenCalledWith({
name,
type: "secure-orange",
overwrite: false,
profile: tempProf
});

// Should have saved every secure property as a constant string
expect(result.profile).toMatchObject(tempProf);

// Expect the credential manager save to not have been called
// and delete to have been called a few (6) times, but still work
// even if it threw an error.
expect(dummyManager.save).toHaveBeenCalledTimes(0);
expect(dummyManager.delete).toHaveBeenCalledTimes(6);

(BasicProfileManager.prototype as any).saveProfile.mockRestore();
});

it("should fail if the Credential Manager throws an error", async () => {
const dummyManager = new DefaultCredentialManager("dummy");
dummyManager.save = jest.fn(() => {
throw new Error("dummy error");
});
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});
Object.defineProperty(CredentialManagerFactory, "initialized", {get: jest.fn().mockReturnValue(true)});


let errorMessage = "";
try {
await prof.save(parms);
} catch (err) {
errorMessage = err.message;
}

expect(errorMessage).toMatch(credentialManagerErrorMessage);
});
});

describe("Update operation", () => {
const tempProf: any = {
description,
username: user,
password: undefined,
secureBox: {
myCode: securelyStored,
myFlag: securelyStored,
myMiniBox: securelyStored,
myPhone: securelyStored,
myPhrase: securelyStored,
mySet: securelyStored,
myEmptyMiniBox: null,
}
};

it("should update credentials and store a profile with a constant string value for secure properties", async () => {
const dummyManager = new DefaultCredentialManager("dummy");
const mockDeleteCreds = jest.fn();
dummyManager.delete = mockDeleteCreds;
dummyManager.save = jest.fn();
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});

jest.spyOn(BasicProfileManager.prototype, "saveProfile" as any).mockImplementation((tParms: ISaveProfile | any) => {
return {
overwritten: tParms.overwrite,
profile: tParms.profile
};
});

jest.spyOn(CliProfileManager.prototype, "loadProfile" as any).mockReturnValue({
profile: tempProf
});

const result = await prof.update(parms);

// Parms should be successfully deleted form memory
expect(parms.args).toBeUndefined();

// BasicProfileManager should be called to save the profile with the given options
expect((BasicProfileManager.prototype as any).saveProfile).toHaveBeenCalledWith({
name,
type: "secure-orange",
overwrite: true,
profile: tempProf,
updateDefault: false
});

// Should have updated every secure property as a constant string
expect(result.profile).toMatchObject(tempProf);

// writtenProfile === undefined since BasicProfileManager gets mocked and doesn't call ProfileIO.writeProfile
expect(writtenProfile).toBeUndefined();

// Should have deleted credentials for password in case it was defined previously
expect(mockDeleteCreds).toHaveBeenCalledTimes(1);
expect(mockDeleteCreds.mock.calls[0][0]).toContain("password");

(CliProfileManager.prototype as any).loadProfile.mockRestore();
(BasicProfileManager.prototype as any).saveProfile.mockRestore();
});

it("should fail if the Credential Manager throws an error", async () => {
const dummyManager = new DefaultCredentialManager("dummy");
dummyManager.save = jest.fn(() => {
throw new Error("dummy error");
});
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});

jest.spyOn(CliProfileManager.prototype, "loadProfile" as any).mockReturnValue({
profile: tempProf
});

let errorMessage = "";
try {
await prof.update(parms);
} catch (err) {
errorMessage = err.message;
}

expect(errorMessage).toMatch(credentialManagerErrorMessage);

(CliProfileManager.prototype as any).loadProfile.mockRestore();
});
});

describe("Load operation", () => {
const tempProf: any = {
name,
Expand Down Expand Up @@ -393,6 +124,7 @@ describe("Cli Profile Manager", () => {
return JSON.stringify(ret);
});
Object.defineProperty(CredentialManagerFactory, "manager", {get: jest.fn().mockReturnValue(dummyManager)});
Object.defineProperty(CredentialManagerFactory, "initialized", { get: jest.fn().mockReturnValue(true) });

// same object but with real values
const copyTempProf = JSON.parse(JSON.stringify(tempProf));
Expand All @@ -412,7 +144,7 @@ describe("Cli Profile Manager", () => {

const result = await prof.load({name});

// BasicProfileManager should be called to save the profile with the given options
// BasicProfileManager should be called to load the profile with the given options
expect((BasicProfileManager.prototype as any).loadProfile).toHaveBeenCalledWith(
{name, failNotFound: true, loadDefault: false, loadDependencies: true}
);
Expand Down
Loading

0 comments on commit 3a18010

Please sign in to comment.