test: [M3-7516] - Cypress tests for Parent → Child account switching flows #10110

jdamore-linode · 2024-01-25T18:24:23Z

Description 📝

Adds Cypress integration tests to cover Parent/Child flows involving account switching from a Parent account to a Child account.

Changes 🔄

Adds tests to cover Parent/Child account switching flows:
- Switch from Parent to Child using Account Billing page
- Switch from Parent to Child using user menu
- Error flows upon fetching child accounts and switching accounts
Adds various utilities to support tests
- Intercept/mock utils for child account API endpoints
- Util to assert local storage values

How to test 🧪

We can rely on automated tests for this, but you can also run the test locally:

Prerequisites

Build and serve Cloud:

yarn && yarn build && yarn start:manager:ci

Verification steps

yarn cy:run -s "cypress/e2e/core/parentChild/account-switching.spec.ts"

As an Author I have considered 🤔

jdamore-linode · 2024-01-25T18:35:58Z

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

+      // TODO Remove the call to `cy.reload()` once Cloud Manager automatically updates itself upon account switching.
+      // TODO Add assertions for toast upon account switch.
+      cy.reload();


cc @jaalah-akamai @mjac0bs -- I think this relates to this discussion in the account switching PR.

Cloud definitely isn't responding as expected upon updating the Local Storage auth values, so a page reload is currently necessary on the Cypress (i.e. user) side to trigger the change. I'm guessing if we want to avoid an automatic page reload, it'll involve at least resetting Cloud's Axios interceptors, resetting React Query, and maybe doing something with our Redux state?

Either way, this test can be used to develop/troubleshoot this functionality without having to wait for anything from the API -- just remove these calls to cy.reload()

github-actions · 2024-01-25T18:47:39Z

Coverage Report: ✅
Base Coverage: 81.24%
Current Coverage: 81.24%

jdamore-linode · 2024-01-25T18:47:49Z

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

+/**
+ * Confirms that expected authentication values are set in Local Storage.
+ *
+ * @param token - Authentication token value to assert.
+ * @param expiry - Authentication expiry value to assert.
+ * @param scopes - Authentication scope value to assert.
+ */
+const assertAuthLocalStorage = (
+  token: string,
+  expiry: string,
+  scopes: string
+) => {
+  assertLocalStorageValue('authentication/token', token);
+  assertLocalStorageValue('authentication/expire', expiry);
+  assertLocalStorageValue('authentication/scopes', scopes);
+};


Question for @jaalah-akamai or @mjac0bs: does the token value returned by the API already include the Bearer prefix, or do we have logic somewhere that prepends it before saving it in Local Storage?

I don't believe it includes the Bearer prefix. It looks like the token first gets set when a session begins and Bearer comes from token_type, which is how it ends up with Bearer in local storage.

And from the API spec:

On a related bearer-in-token-related note, I'm not sure that we're supposed to have Bearer when calling getChildAccountPersonalAccessToken here in the switch account drawer. Maybe it was a oversight or I'm missing something and @jaalah-akamai can clarify.

On a related bearer-in-token-related note, I'm not sure that we're supposed to have Bearer when calling getChildAccountPersonalAccessToken here in the switch account drawer. Maybe it was a oversight or I'm missing something and @jaalah-akamai can clarify.

This is true - left over probably from one of my iterations ✅

Thanks @jaalah-akamai and @mjac0bs -- sorry for the slow follow up here.

If I'm understanding your explanation @mjac0bs, it sounds like we're supposed to have the Bearer prefix in local storage but the token that gets stored during the account switching flow does not contain the prefix.

Is there a ticket for this? I can update this test to expect the Bearer prefix but it will fail in the meantime.

…to Child

jdamore-linode · 2024-01-29T14:54:31Z

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

+      mockGetAccount(mockChildAccount);
+      mockGetProfile(mockParentProfile);
+      mockGetUser(mockParentUser);


Also hoping for an extra set of eyes here -- do these mocks accurately reflect what the account, profile, and user API request will look like in this situation?

I think that mockGetUser is now left over from when we previously had to call */users/:user to retrieve the user_type and it can now be removed.

Otherwise, this seems correct. We'll have the child account once logged in as a proxy user and we'll also need to fetch the parent's username from */profile.

…child

jaalah-akamai · 2024-02-06T14:43:52Z

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

+        mockChildAccountToken.token!,
+        mockChildAccountToken.expiry!,
+        mockChildAccountToken.scopes
+      );


We also want to ensure that parent tokens are being created here too

Good point, the Switch Account drawer does that here.

Going to hold off on this for now -- the Cypress tests deal with a real token, so asserting its value will cause it to be logged and recorded.

jaalah-akamai

This looks good overall - nice tests 🙏

dwiley-akamai

Remote and local tests passed ✅
Changeset ✅

packages/manager/cypress/support/util/local-storage.ts

mjac0bs

Thanks, Joe - looks good overall.

Left a comment about removing some extra mockGetUser calls now that #10102 is merged and a thought about naming.

mjac0bs · 2024-02-06T20:30:06Z

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

+      mockGetAccount(mockChildAccount);
+      mockGetProfile(mockParentProfile);
+      mockGetUser(mockParentUser);


I think that mockGetUser is now left over from when we previously had to call */users/:user to retrieve the user_type and it can now be removed.

Otherwise, this seems correct. We'll have the child account once logged in as a proxy user and we'll also need to fetch the parent's username from */profile.

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

mjac0bs · 2024-02-06T20:37:44Z

packages/manager/cypress/e2e/core/parentChild/account-switching.spec.ts

+        mockChildAccountToken.token!,
+        mockChildAccountToken.expiry!,
+        mockChildAccountToken.scopes
+      );


Good point, the Switch Account drawer does that here.

Fix doc comment typo Co-authored-by: Dajahi Wiley <114682940+dwiley-akamai@users.noreply.github.com>

…g.spec.ts Update test title to be more accurate re: "child" vs "proxy" Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

…child

…switch

Joe D'Amore added 7 commits January 24, 2024 16:09

Add mock util to mock all APIv4 requests

a8a5046

Add local storage assertion util

7004b21

Add mock utils for child account endpoints

051133c

Add WIP account switching test

9bca651

Add account switching API error mock utils

463a15a

Add account switching from billing page test, error flow test

bd63002

Improve test explanation comments

9fd9b39

jdamore-linode added Ready for Review Missing Changeset Parent / Child Account labels Jan 25, 2024

jdamore-linode requested review from mjac0bs and jaalah-akamai January 25, 2024 18:24

jdamore-linode self-assigned this Jan 25, 2024

jdamore-linode requested a review from a team as a code owner January 25, 2024 18:24

jdamore-linode requested review from cliu-akamai and removed request for a team January 25, 2024 18:24

jdamore-linode commented Jan 25, 2024

View reviewed changes

Added changeset: Add Cypress tests for account switching from Parent …

2c48a53

…to Child

jdamore-linode requested a review from a team as a code owner January 25, 2024 18:50

jdamore-linode requested review from dwiley-akamai and bnussman-akamai and removed request for a team January 25, 2024 18:50

jdamore-linode removed the Missing Changeset label Jan 25, 2024

jdamore-linode commented Jan 29, 2024

View reviewed changes

mjac0bs mentioned this pull request Feb 1, 2024

fix: [M3-7728] - Token issues when account switching #10138

Merged

12 tasks

Joe D'Amore added 2 commits February 5, 2024 14:55

Merge branch 'develop' into M3-7516-cypress-account-switch-parent-to-…

fe71427

…child

Use non-null assertion to satisfy TS error

c57737b

jaalah-akamai reviewed Feb 6, 2024

View reviewed changes

jaalah-akamai approved these changes Feb 6, 2024

View reviewed changes

dwiley-akamai approved these changes Feb 6, 2024

View reviewed changes

packages/manager/cypress/support/util/local-storage.ts Outdated Show resolved Hide resolved

mjac0bs approved these changes Feb 6, 2024

View reviewed changes

mjac0bs added Approved Multiple approvals and ready to merge! and removed Ready for Review labels Feb 6, 2024

jdamore-linode and others added 6 commits February 14, 2024 10:08

Update packages/manager/cypress/support/util/local-storage.ts

6a1eb9f

Fix doc comment typo Co-authored-by: Dajahi Wiley <114682940+dwiley-akamai@users.noreply.github.com>

Update packages/manager/cypress/e2e/core/parentChild/account-switchin…

ab83c02

…g.spec.ts Update test title to be more accurate re: "child" vs "proxy" Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com>

Merge branch 'develop' into M3-7516-cypress-account-switch-parent-to-…

5c8f557

…child

Remove unneeded mock

af70d4a

Merge branch 'develop' into M3-7516-cypress-account-switch-parent-to-…

e37aec8

…child

Add event and notification mocks to prevent Cloud crash upon account …

08d7b30

…switch

jdamore-linode merged commit f08b57c into linode:develop Feb 22, 2024
18 checks passed

This was referenced Mar 1, 2024

Release v1.114.0 - release → staging #10246

Merged

Release v1.114.0 - staging → master #10253

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: [M3-7516] - Cypress tests for Parent → Child account switching flows #10110

test: [M3-7516] - Cypress tests for Parent → Child account switching flows #10110

jdamore-linode commented Jan 25, 2024

jdamore-linode Jan 25, 2024 •

edited

Loading

github-actions bot commented Jan 25, 2024 •

edited

Loading

jdamore-linode Jan 25, 2024

mjac0bs Jan 25, 2024

jaalah-akamai Feb 1, 2024

jdamore-linode Feb 20, 2024

jdamore-linode Jan 29, 2024

mjac0bs Feb 6, 2024

jaalah-akamai Feb 6, 2024

mjac0bs Feb 6, 2024

jdamore-linode Feb 20, 2024

jaalah-akamai left a comment

dwiley-akamai left a comment

mjac0bs left a comment

mjac0bs Feb 6, 2024

mjac0bs Feb 6, 2024

test: [M3-7516] - Cypress tests for Parent → Child account switching flows #10110

test: [M3-7516] - Cypress tests for Parent → Child account switching flows #10110

Conversation

jdamore-linode commented Jan 25, 2024

Description 📝

Changes 🔄

How to test 🧪

Prerequisites

Verification steps

As an Author I have considered 🤔

jdamore-linode Jan 25, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaalah-akamai left a comment

Choose a reason for hiding this comment

dwiley-akamai left a comment

Choose a reason for hiding this comment

mjac0bs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdamore-linode Jan 25, 2024 •

edited

Loading

github-actions bot commented Jan 25, 2024 •

edited

Loading