Skip to content
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.

Sign up for GitHub

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

fix: logout confirmation messages #923

Merged
merged 2 commits into from
Jan 29, 2024
Merged

fix: logout confirmation messages #923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30c5383
fix: correct logout confirmation message for single-org
mshanemc Jan 27, 2024
dd286ce
test: ut for single-org prompt message
mshanemc Jan 27, 2024
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
8 changes: 6 additions & 2 deletions src/commands/org/logout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,14 @@ const promptForOrgsToRemove = async (orgAuths: OrgAuthorization[], all: boolean)
loop: true,
});

const getOrgConfirmationMessage = (selectedOrgs: OrgAuthorization[], originalOrgCount: number): string =>
selectedOrgs.length === originalOrgCount
const getOrgConfirmationMessage = (selectedOrgs: OrgAuthorization[], originalOrgCount: number): string => {
if (selectedOrgs.length === 1) {
return messages.getMessage('prompt.confirm.single', [selectedOrgs[0].username]);
}
return selectedOrgs.length === originalOrgCount
? messages.getMessage('prompt.confirm-all')
: messages.getMessage('prompt.confirm', [selectedOrgs.length, selectedOrgs.length > 1 ? 's' : '']);
};

/** A whole bunch of custom formatting to make the list look nicer */
const buildChoices = (orgAuths: OrgAuthorization[], all: boolean): Array<Choice | Separator> => {
Expand Down
34 changes: 24 additions & 10 deletions test/commands/org/logout.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/

import { AuthRemover, ConfigContents, Global, Mode } from '@salesforce/core';
import { AuthRemover, ConfigContents, Global, Mode, Messages } from '@salesforce/core';
import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup.js';
import { expect } from 'chai';
import { Config } from '@oclif/core';
import { SfCommand } from '@salesforce/sf-plugins-core';
import { stubPrompter } from '@salesforce/sf-plugins-core';
import Logout from '../../../src/commands/org/logout.js';

Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-auth', 'logout');

interface Options {
authFiles?: string[];
'target-org'?: string;
Expand All @@ -28,12 +31,12 @@ describe('org:logout', () => {
const testOrg1 = new MockTestOrgData();
const testOrg2 = new MockTestOrgData();
const testOrg3 = new MockTestOrgData();

let promptStub: ReturnType<typeof stubPrompter>;
let authRemoverSpy: sinon.SinonSpy;

async function prepareStubs(options: Options = {}): Promise<ConfigContents> {
const authInfo = await testOrg1.getConfig();

promptStub = stubPrompter($$.SANDBOX);
authRemoverSpy = $$.SANDBOX.spy(AuthRemover.prototype, 'removeAuth');

if (!options.authInfoConfigDoesNotExist) {
Expand Down Expand Up @@ -110,12 +113,23 @@ describe('org:logout', () => {
}
});

it('should do nothing when prompt is answered with no', async () => {
await prepareStubs();
$$.SANDBOX.stub(SfCommand.prototype, 'confirm').resolves(false);
const logout = new Logout(['-o', testOrg1.username], {} as Config);
const response = await logout.run();
expect(response).to.deep.equal([]);
describe('prompts', () => {
it('shows correct prompt for single org', async () => {
await prepareStubs();
promptStub.confirm.resolves(false);
const logout = new Logout(['-o', testOrg1.username], {} as Config);
await logout.run();
expect(promptStub.confirm.args[0][0].message).to.equal(
messages.getMessage('prompt.confirm.single', [testOrg1.username])
);
});
it('should do nothing when prompt is answered with no', async () => {
await prepareStubs();
promptStub.confirm.resolves(false);
const logout = new Logout(['-o', testOrg1.username], {} as Config);
const response = await logout.run();
expect(response).to.deep.equal([]);
});
});

it('should remove auth when alias is specified', async () => {
Expand Down
Loading