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

Jump to bottom

test: [M3-7517 & M3-7519] - Cypress integration tests for Child -> Parent and Child -> Child account switching #10288

Merged
merged 11 commits into from
Mar 21, 2024
Merged

test: [M3-7517 & M3-7519] - Cypress integration tests for Child -> Parent and Child -> Child account switching #10288

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6a3ed65
WIP Add intercept utils, improve mocks, add in-progress test
Mar 7, 2024
deec3ee
Merge branch 'develop' into M3-7517-cypress-account-switching-child-t…
Mar 14, 2024
cf1e699
Improve clarity of test names
Mar 14, 2024
c40fd57
Replace hardcoded expiration string with mock
Mar 14, 2024
69202eb
Assert notice shown when there are no child accounts, assert state of…
Mar 14, 2024
063e6c2
Move Child->Parent tests beneath Parent->Child -- just feels better t…
Mar 14, 2024
4d13b6a
Fix profile and user mocks after switching to Proxy from Parent
Mar 14, 2024
d41a919
Add mocks for alternate child account
Mar 14, 2024
10baee3
Improve comments, add child to child test
Mar 14, 2024
0f448a9
Added changeset: Add Parent/Child account switching UI tests for Chil…
Mar 14, 2024
4b54fd8
Merge branch 'develop' into M3-7517-cypress-account-switching-child-t…
Mar 19, 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
267 changes: 257 additions & 10 deletions packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
import {
accountFactory,
appTokenFactory,
paymentMethodFactory,
profileFactory,
} from '@src/factories';
import { accountUserFactory } from '@src/factories/accountUsers';
import { DateTime } from 'luxon';
import {
interceptGetInvoices,
interceptGetPayments,
interceptGetPaymentMethods,
mockCreateChildAccountToken,
mockCreateChildAccountTokenError,
mockGetAccount,
mockGetChildAccounts,
mockGetChildAccountsError,
mockGetInvoices,
mockGetPaymentMethods,
mockGetPayments,
mockGetUser,
} from 'support/intercepts/account';
import { mockGetEvents, mockGetNotifications } from 'support/intercepts/events';
Expand Down Expand Up @@ -81,7 +88,34 @@ const mockParentUser = accountUserFactory.build({
});

const mockChildAccount = accountFactory.build({
company: 'Child Company',
company: 'Partner Company',
});

// Used for testing flows involving multiple children (e.g. switching child -> child).
const mockAlternateChildAccount = accountFactory.build({
company: 'Other Partner Company',
});

const mockChildAccountProxyUser = accountUserFactory.build({
username: mockParentProfile.username,
user_type: 'proxy',
});

// Used for testing flows involving multiple children (e.g. switching child -> child).
const mockAlternateChildAccountProxyUser = accountUserFactory.build({
username: mockParentProfile.username,
user_type: 'proxy',
});

const mockChildAccountProfile = profileFactory.build({
username: mockChildAccountProxyUser.username,
user_type: 'proxy',
});

// Used for testing flows involving multiple children (e.g. switching child -> child).
const mockAlternateChildAccountProfile = profileFactory.build({
username: mockAlternateChildAccountProxyUser.username,
user_type: 'proxy',
});

const childAccountAccessGrantEnabled = grantsFactory.build({
Expand All @@ -95,21 +129,33 @@ const childAccountAccessGrantDisabled = grantsFactory.build({
const mockChildAccountToken = appTokenFactory.build({
id: randomNumber(),
created: DateTime.now().toISO(),
expiry: DateTime.now().plus({ hours: 1 }).toISO(),
expiry: DateTime.now().plus({ minutes: 15 }).toISO(),
label: `${mockChildAccount.company}_proxy`,
scopes: '*',
token: randomString(32),
website: undefined,
thumbnail_url: undefined,
});

// Used for testing flows involving multiple children (e.g. switching child -> child).
const mockAlternateChildAccountToken = appTokenFactory.build({
id: randomNumber(),
created: DateTime.now().toISO(),
expiry: DateTime.now().plus({ minutes: 15 }).toISO(),
label: `${mockAlternateChildAccount.company}_proxy`,
scopes: '*',
token: randomString(32),
website: undefined,
thumbnail_url: undefined,
});

const mockErrorMessage = 'An unknown error has occurred.';

describe('Parent/Child account switching', () => {
/*
* Tests to confirm that Parent account users can switch to Child accounts as expected.
*/
describe('From Parent to Proxy', () => {
describe('From Parent to Child', () => {
beforeEach(() => {
// @TODO M3-7554, M3-7559: Remove feature flag mocks after feature launch and clean-up.
mockAppendFeatureFlags({
Expand All @@ -123,13 +169,17 @@ describe('Parent/Child account switching', () => {
* - Confirms that Child account information is displayed in user menu button after switch.
* - Confirms that Cloud updates local storage auth values upon account switch.
*/
it('can switch from Parent account to Child account from Billing page', () => {
it('can switch from Parent account user to Proxy account user from Billing page', () => {
mockGetProfile(mockParentProfile);
mockGetAccount(mockParentAccount);
mockGetChildAccounts([mockChildAccount]);
mockGetUser(mockParentUser);
interceptGetPayments().as('getPayments');
interceptGetPaymentMethods().as('getPaymentMethods');
interceptGetInvoices().as('getInvoices');

cy.visitWithLogin('/account/billing');
cy.wait(['@getPayments', '@getInvoices', '@getPaymentMethods']);

// Confirm that "Switch Account" button is present, then click it.
ui.button
Expand All @@ -150,8 +200,11 @@ describe('Parent/Child account switching', () => {
mockGetEvents([]);
mockGetNotifications([]);
mockGetAccount(mockChildAccount);
mockGetProfile(mockParentProfile);
mockGetUser(mockParentUser);
mockGetProfile(mockChildAccountProfile);
mockGetUser(mockChildAccountProxyUser);
mockGetPaymentMethods(paymentMethodFactory.buildList(1));
mockGetInvoices([]);
mockGetPayments([]);

// Mock the account switch itself -- we have to do this after the mocks above
// to ensure that it is applied.
Expand All @@ -178,9 +231,13 @@ describe('Parent/Child account switching', () => {

// Confirm expected username and company are shown in user menu button.
assertUserMenuButton(
mockParentProfile.username,
mockChildAccountProxyUser.username,
mockChildAccount.company
);

ui.toast.assertMessage(
`Account switched to ${mockChildAccount.company}.`
);
});

/*
Expand All @@ -189,7 +246,7 @@ describe('Parent/Child account switching', () => {
* - Confirms that Child account information is displayed in user menu button after switch.
* - Confirms that Cloud updates local storage auth values upon account switch.
*/
it('can switch from Parent account to Child account using user menu', () => {
it('can switch from Parent account user to Proxy account user using user menu', () => {
mockGetProfile(mockParentProfile);
mockGetAccount(mockParentAccount);
mockGetChildAccounts([mockChildAccount]);
Expand Down Expand Up @@ -228,8 +285,8 @@ describe('Parent/Child account switching', () => {
mockGetEvents([]);
mockGetNotifications([]);
mockGetAccount(mockChildAccount);
mockGetProfile(mockParentProfile);
mockGetUser(mockParentUser);
mockGetProfile(mockChildAccountProfile);
mockGetUser(mockChildAccountProxyUser);

// Click mock company name in "Switch Account" drawer.
mockCreateChildAccountToken(mockChildAccount, mockChildAccountToken).as(
Expand Down Expand Up @@ -261,6 +318,196 @@ describe('Parent/Child account switching', () => {
});
});

/**
* Tests to confirm that Parent account users can switch back from Child accounts as expected.
*/
describe('From Child to Parent', () => {
beforeEach(() => {
mockAppendFeatureFlags({
parentChildAccountAccess: makeFeatureFlagData(true),
});
mockGetFeatureFlagClientstream();
});

/*
* - Confirms that a Child account Proxy user can switch back to a Parent account from Billing page.
* - Confirms that Parent account information is displayed in user menu button after switch.
* - Confirms that Cloud updates local storage auth values upon account switch.
*/
it('can switch from Proxy user back to Parent account user from Billing page', () => {
const mockParentToken = randomString(32);
const mockParentExpiration = DateTime.now().plus({ minutes: 15 }).toISO();

mockGetAccount(mockChildAccount);
mockGetProfile(mockChildAccountProfile);
mockGetChildAccounts([]);
mockGetUser(mockChildAccountProxyUser);
interceptGetPayments().as('getPayments');
interceptGetPaymentMethods().as('getPaymentMethods');
interceptGetInvoices().as('getInvoices');

// Visit billing page with `authentication/parent_token/*` local storage
// data set to mock values.
cy.visitWithLogin('/account/billing', {
localStorageOverrides: {
proxy_user: true,
'authentication/parent_token/token': `Bearer ${mockParentToken}`,
'authentication/parent_token/expire': mockParentExpiration,
'authentication/parent_token/scopes': '*',
},
});

// Wait for page to finish loading before proceeding with account switch.
cy.wait(['@getPayments', '@getPaymentMethods', '@getInvoices']);

ui.button
.findByTitle('Switch Account')
.should('be.visible')
.should('be.enabled')
.click();

// Prepare mocks in advance of the account switch. As soon as the switch back link is clicked,
// Cloud will replace its stored token with the token provided by the API and then reload.
// From that point forward, we will not have a valid test account token stored in local storage,
// so all non-intercepted API requests will respond with a 401 status code and we will get booted to login.
// We'll mitigate this by broadly mocking ALL API-v4 requests, then applying more specific mocks to the
// individual requests as needed.
mockAllApiRequests();
mockGetLinodes([]);
mockGetRegions([]);
mockGetEvents([]);
mockGetNotifications([]);
mockGetAccount(mockParentAccount);
mockGetProfile(mockParentProfile);
mockGetUser(mockParentUser);
mockGetPaymentMethods(paymentMethodFactory.buildList(1)).as(
'getPaymentMethods'
);
mockGetInvoices([]).as('getInvoices');
mockGetPayments([]).as('getPayments');

ui.drawer
.findByTitle('Switch Account')
.should('be.visible')
.within(() => {
cy.findByText('There are no indirect customer accounts.').should(
'be.visible'
);
cy.findByText('switch back to your account')
.should('be.visible')
.click();
});

// Allow page to load before asserting user menu, ensuring no app crash, etc.
cy.wait(['@getInvoices', '@getPayments', '@getPaymentMethods']);

assertUserMenuButton(
mockParentProfile.username,
mockParentAccount.company
);

assertAuthLocalStorage(mockParentToken, mockParentExpiration, '*');
});
});

/**
* Tests to confirm that Proxy users can switch to other Child accounts as expected.
*/
describe('From Child to Child', () => {
/*
* - Confirms that a Child account Proxy user can switch to another Child account from Billing page.
* - Confirms that alternate Child account information is displayed in user menu button after switch.
* - Confirms that Cloud updates local storage auth values upon account switch.
*/
it('can switch to another Child account as a Proxy user', () => {
const mockParentToken = randomString(32);
const mockParentExpiration = DateTime.now().plus({ minutes: 15 }).toISO();

mockGetAccount(mockChildAccount);
mockGetProfile(mockChildAccountProfile);
mockGetChildAccounts([mockAlternateChildAccount]);
mockGetUser(mockChildAccountProxyUser);
interceptGetPayments().as('getPayments');
interceptGetPaymentMethods().as('getPaymentMethods');
interceptGetInvoices().as('getInvoices');

// Visit billing page with `authentication/parent_token/*` local storage
// data set to mock values.
cy.visitWithLogin('/account/billing', {
localStorageOverrides: {
proxy_user: true,
'authentication/parent_token/token': `Bearer ${mockParentToken}`,
'authentication/parent_token/expire': mockParentExpiration,
'authentication/parent_token/scopes': '*',
},
});

// Wait for page to finish loading before proceeding with account switch.
cy.wait(['@getPayments', '@getPaymentMethods', '@getInvoices']);

ui.button
.findByTitle('Switch Account')
.should('be.visible')
.should('be.enabled')
.click();

// Prepare mocks in advance of the account switch. As soon as the child account is clicked,
// Cloud will replace its stored token with the token provided by the API and then reload.
// From that point forward, we will not have a valid test account token stored in local storage,
// so all non-intercepted API requests will respond with a 401 status code and we will get booted to login.
// We'll mitigate this by broadly mocking ALL API-v4 requests, then applying more specific mocks to the
// individual requests as needed.
mockAllApiRequests();
mockGetLinodes([]);
mockGetRegions([]);
mockGetEvents([]);
mockGetNotifications([]);
mockGetAccount(mockAlternateChildAccount);
mockGetProfile(mockAlternateChildAccountProfile);
mockGetUser(mockAlternateChildAccountProxyUser);
mockGetPaymentMethods(paymentMethodFactory.buildList(1)).as(
'getPaymentMethods'
);
mockGetInvoices([]).as('getInvoices');
mockGetPayments([]).as('getPayments');

// Set up account switch mock.
mockCreateChildAccountToken(
mockAlternateChildAccount,
mockAlternateChildAccountToken
).as('switchAccount');

// Click mock company name in "Switch Account" drawer.
ui.drawer
.findByTitle('Switch Account')
.should('be.visible')
.within(() => {
cy.findByText(mockAlternateChildAccount.company)
.should('be.visible')
.click();
});

// Allow page to load before asserting user menu, ensuring no app crash, etc.
cy.wait('@switchAccount');
cy.wait(['@getInvoices', '@getPayments', '@getPaymentMethods']);

assertUserMenuButton(
mockAlternateChildAccountProfile.username,
mockAlternateChildAccount.company
);

assertAuthLocalStorage(
mockAlternateChildAccountToken.token!,
mockAlternateChildAccountToken.expiry!,
mockAlternateChildAccountToken.scopes
);
// TODO Confirm whether toast is intended here.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wanted to call this out: do we expect a toast notification to appear when switching from a Child account to another Child account? Seems like proxy_user doesn't get reset in local storage

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jdamore-linode Yea that's a good callout. I'll track this in a new ticket!

// ui.toast.assertMessage(
// `Account switched to ${mockAlternateChildAccount.company}.`
// );
});
});

describe('Child Account Access', () => {
/*
* - Smoke test to confirm that restricted parent users with the child_account_access grant can switch accounts.
Expand Down
Loading
Loading