chore: [M3-6777] - Rename Cypress functions and variables related to …

…secrets (#9350) * Rename functions and variables related to secrets, improve object storage mock utils * Fix failing access key revoke test * Fix mismatched error variable name in prebuild script
linode · Jul 5, 2023 · 8755aad · 8755aad
1 parent 11276e7
commit 8755aad
Show file tree

Hide file tree

Showing 9 changed files with 101 additions and 141 deletions.
diff --git a/packages/manager/cypress/e2e/core/account/add-oauth-app.spec.ts b/packages/manager/cypress/e2e/core/account/add-oauth-app.spec.ts
@@ -7,7 +7,7 @@ import {
   mockGetOAuthApps,
 } from 'support/intercepts/profile';
 import { ui } from 'support/ui';
-import { randomLabel, randomSecret } from 'support/util/random';
+import { randomLabel, randomHex } from 'support/util/random';
 import { OAuthClient } from '@linode/api-v4/types';
 
 /**
@@ -128,14 +128,20 @@ describe('Add OAuth Apps', () => {
    * - Confirms that the oauth app is listed correctly on OAuth Apps landing page.
    */
   it('Adds an OAuth App', () => {
-    const oauthApps = oauthClientFactory.buildList(2);
+    const oauthApps = [
+      oauthClientFactory.build({
+        label: randomLabel(),
+        secret: randomHex(64),
+      }),
+      oauthClientFactory.build({
+        label: randomLabel(),
+        secret: randomHex(64),
+        public: true,
+      }),
+    ];
+
     const privateOauthApp = oauthApps[0];
-    privateOauthApp.label = randomLabel(5);
-    privateOauthApp.secret = randomSecret(64);
     const publicOauthApp = oauthApps[1];
-    publicOauthApp.label = randomLabel(5);
-    publicOauthApp.public = true;
-    publicOauthApp.secret = randomSecret(64);
 
     interceptGetProfile().as('getProfile');
     cy.visitWithLogin('/profile/clients');

diff --git a/packages/manager/cypress/e2e/core/account/personal-access-tokens.spec.ts b/packages/manager/cypress/e2e/core/account/personal-access-tokens.spec.ts
@@ -23,11 +23,9 @@ describe('Personal access tokens', () => {
    * - Confirms that user can open and close "View Scopes" drawer
    */
   it('can create personal access tokens', () => {
-    const tokenLabel = randomLabel();
-    const tokenSecret = randomString(64);
     const token = appTokenFactory.build({
-      label: tokenLabel,
-      token: tokenSecret,
+      label: randomLabel(),
+      token: randomString(64),
     });
 
     mockGetPersonalAccessTokens([]).as('getTokens');
@@ -80,7 +78,7 @@ describe('Personal access tokens', () => {
           .should('be.visible')
           .should('be.enabled')
           .click()
-          .type(tokenLabel);
+          .type(token.label);
 
         ui.buttonGroup
           .findButtonByTitle('Create Token')
@@ -108,7 +106,7 @@ describe('Personal access tokens', () => {
         // Confirm that PAT is shown.
         cy.get('[data-testid="textfield-input"]')
           .should('be.visible')
-          .should('have.attr', 'value', tokenSecret);
+          .should('have.attr', 'value', token.token);
 
         ui.button
           .findByTitle('I Have Saved My Personal Access Token')
@@ -119,7 +117,7 @@ describe('Personal access tokens', () => {
 
     // Confirm that new PAT is shown in list and "View Scopes" drawer works.
     cy.wait('@getTokens');
-    cy.findByText(tokenLabel)
+    cy.findByText(token.label)
       .should('be.visible')
       .closest('tr')
       .within(() => {
@@ -131,7 +129,7 @@ describe('Personal access tokens', () => {
       });
 
     ui.drawer
-      .findByTitle(tokenLabel)
+      .findByTitle(token.label)
       .should('be.visible')
       .within(() => {
         ui.drawerCloseButton.find().click();
@@ -144,17 +142,14 @@ describe('Personal access tokens', () => {
    * - Confirms that token is removed from list after revoking it
    */
   it('can rename and revoke personal access tokens', () => {
-    const tokenOldLabel = randomLabel();
-    const tokenNewLabel = randomLabel();
-
     const oldToken: Token = appTokenFactory.build({
-      label: tokenOldLabel,
+      label: randomLabel(),
       token: randomString(64),
     });
 
     const newToken: Token = {
       ...oldToken,
-      label: tokenNewLabel,
+      label: randomLabel(),
     };
 
     mockGetPersonalAccessTokens([oldToken]).as('getTokens');
@@ -166,7 +161,7 @@ describe('Personal access tokens', () => {
     cy.wait(['@getTokens', '@getAppTokens']);
 
     // Find token in list, click "Rename", and fill out and submit form.
-    cy.findByText(tokenOldLabel)
+    cy.findByText(oldToken.label)
       .should('be.visible')
       .closest('tr')
       .within(() => {
@@ -185,7 +180,7 @@ describe('Personal access tokens', () => {
           .should('be.visible')
           .click()
           .clear()
-          .type(tokenNewLabel);
+          .type(newToken.label);
 
         ui.buttonGroup
           .findButtonByTitle('Save')
@@ -196,7 +191,7 @@ describe('Personal access tokens', () => {
 
     // Confirm that token has been renamed, initiate revocation.
     cy.wait('@updateToken');
-    cy.findByText(tokenNewLabel)
+    cy.findByText(newToken.label)
       .should('be.visible')
       .closest('tr')
       .within(() => {
@@ -209,7 +204,7 @@ describe('Personal access tokens', () => {
 
     mockGetPersonalAccessTokens([]).as('getTokens');
     ui.dialog
-      .findByTitle(`Revoke ${tokenNewLabel}?`)
+      .findByTitle(`Revoke ${newToken.label}?`)
       .should('be.visible')
       .within(() => {
         ui.buttonGroup
@@ -221,11 +216,11 @@ describe('Personal access tokens', () => {
 
     // Confirm that token is removed from list after revoking.
     cy.wait(['@revokeToken', '@getTokens']);
-    ui.toast.assertMessage(`Successfully revoked ${tokenNewLabel}`);
+    ui.toast.assertMessage(`Successfully revoked ${newToken.label}`);
     cy.findByLabelText('List of Personal Access Tokens')
       .should('be.visible')
       .within(() => {
-        cy.findByText(tokenNewLabel).should('not.exist');
+        cy.findByText(newToken.label).should('not.exist');
         cy.findByText('No items to display.').should('be.visible');
       });
   });

diff --git a/packages/manager/cypress/e2e/core/account/reset-oauth-app.spec.ts b/packages/manager/cypress/e2e/core/account/reset-oauth-app.spec.ts
@@ -1,4 +1,4 @@
-import { fbtVisible, fbtClick, fbltClick } from 'support/helpers';
+import { fbtVisible, fbtClick } from 'support/helpers';
 import { oauthClientFactory } from '@src/factories';
 import 'cypress-file-upload';
 import {
@@ -7,7 +7,7 @@ import {
   mockResetOAuthApps,
 } from 'support/intercepts/profile';
 import { ui } from 'support/ui';
-import { randomLabel, randomSecret } from 'support/util/random';
+import { randomLabel, randomHex } from 'support/util/random';
 
 describe('Reset OAuth Apps', () => {
   /*
@@ -16,15 +16,13 @@ describe('Reset OAuth Apps', () => {
    * - Confirms that the oauth app is reset correctly on OAuth Apps landing page.
    */
   it('Resets an OAuth App', () => {
-    const oauthApps = oauthClientFactory.buildList(2);
-    const privateOauthApp = oauthApps[0];
-    privateOauthApp.label = randomLabel(5);
-    const publicOauApp = oauthApps[1];
-    publicOauApp.label = randomLabel(5);
-    publicOauApp.public = true;
+    const privateOauthApp = oauthClientFactory.build({
+      label: randomLabel(5),
+      secret: randomHex(64),
+    });
 
     interceptGetProfile().as('getProfile');
-    mockGetOAuthApps(oauthApps).as('getOAuthApps');
+    mockGetOAuthApps([privateOauthApp]).as('getOAuthApps');
     cy.visitWithLogin('/profile/clients');
     cy.wait('@getProfile');
     cy.wait('@getOAuthApps');
@@ -57,7 +55,7 @@ describe('Reset OAuth Apps', () => {
         fbtVisible('Reset');
         fbtClick('Reset');
       });
-    privateOauthApp['secret'] = randomSecret(64);
+
     mockResetOAuthApps(privateOauthApp.id, privateOauthApp).as('resetOAuthApp');
     ui.dialog
       .findByTitle(`Reset secret for ${privateOauthApp.label}?`)

diff --git a/packages/manager/cypress/e2e/core/account/third-party-access-tokens.spec.ts b/packages/manager/cypress/e2e/core/account/third-party-access-tokens.spec.ts
@@ -14,16 +14,12 @@ import { authenticate } from 'support/api/authentication';
 
 authenticate();
 describe('Third party access tokens', () => {
-  let tokenLabel: string;
-  let tokenSecret: string;
   let token: Token;
 
   beforeEach(() => {
-    tokenLabel = randomLabel();
-    tokenSecret = randomString(64);
     token = appTokenFactory.build({
-      label: tokenLabel,
-      token: tokenSecret,
+      label: randomLabel(),
+      token: randomString(64),
     });
 
     mockGetPersonalAccessTokens([]).as('getTokens');
@@ -38,10 +34,10 @@ describe('Third party access tokens', () => {
    * - Confirms that third party apps are listed with expected information.
    */
   it('Third party access tokens are listed with expected information', () => {
-    cy.findByText(tokenLabel)
+    cy.findByText(token.label)
       .closest('tr')
       .within(() => {
-        cy.findByText(tokenLabel).should('be.visible');
+        cy.findByText(token.label).should('be.visible');
         cy.defer(getProfile()).then((profile: Profile) => {
           const dateFormatOptions = { timezone: profile.timezone };
           cy.findByText(formatDate(token.created, dateFormatOptions)).should(
@@ -61,13 +57,13 @@ describe('Third party access tokens', () => {
       Linodes: 2,
     });
 
-    cy.findByText(tokenLabel)
+    cy.findByText(token.label)
       .closest('tr')
       .within(() => {
         ui.button.findByTitle('View Scopes').should('be.visible').click();
       });
     ui.drawer
-      .findByTitle(tokenLabel)
+      .findByTitle(token.label)
       .should('be.visible')
       .within(() => {
         Object.keys(access).forEach((key) => {
@@ -88,13 +84,13 @@ describe('Third party access tokens', () => {
    */
   it('Revokes a third party access token', () => {
     // Cancelling will keep the list unchanged.
-    cy.findByText(tokenLabel)
+    cy.findByText(token.label)
       .closest('tr')
       .within(() => {
         ui.button.findByTitle('Revoke').should('be.visible').click();
       });
     ui.dialog
-      .findByTitle(`Revoke ${tokenLabel}?`)
+      .findByTitle(`Revoke ${token.label}?`)
       .should('be.visible')
       .within(() => {
         ui.buttonGroup
@@ -106,13 +102,13 @@ describe('Third party access tokens', () => {
 
     // Confirms revoke will remove the third party app.
     mockRevokeAppToken(token.id).as('deleteAppToken');
-    cy.findByText(tokenLabel)
+    cy.findByText(token.label)
       .closest('tr')
       .within(() => {
         ui.button.findByTitle('Revoke').should('be.visible').click();
       });
     ui.dialog
-      .findByTitle(`Revoke ${tokenLabel}?`)
+      .findByTitle(`Revoke ${token.label}?`)
       .should('be.visible')
       .within(() => {
         ui.buttonGroup
@@ -127,6 +123,6 @@ describe('Third party access tokens', () => {
     mockGetAppTokens([]).as('getAppTokens');
     cy.visitWithLogin('/profile/tokens');
     cy.wait(['@getTokens', '@getAppTokens']);
-    cy.findByText(tokenLabel).should('not.exist');
+    cy.findByText(token.label).should('not.exist');
   });
 });
diff --git a/packages/manager/cypress/e2e/core/account/two-factor-auth.spec.ts b/packages/manager/cypress/e2e/core/account/two-factor-auth.spec.ts
@@ -15,7 +15,12 @@ import {
   mockGetSecurityQuestions,
 } from 'support/intercepts/profile';
 import { ui } from 'support/ui';
-import { randomNumber, randomLabel, randomString } from 'support/util/random';
+import {
+  randomNumber,
+  randomLabel,
+  randomString,
+  randomHex,
+} from 'support/util/random';
 
 /**
  * Returns a Cypress chainable for the "Two-Factor Authentication".
@@ -26,23 +31,6 @@ const getTwoFactorSection = (): Cypress.Chainable => {
   return cy.contains('h3', 'Two-Factor Authentication (2FA)').parent();
 };
 
-/**
- * Generates a random 2FA secret key for mocking.
- *
- * @returns 2FA secret key.
- */
-const randomSecret = (): string => {
-  const randomSecretOptions = {
-    lowercase: false,
-    uppercase: true,
-    numbers: true,
-    symbols: false,
-    spaces: false,
-  };
-
-  return randomString(16, randomSecretOptions);
-};
-
 /**
  * Generates a random 2FA scratch code for mocking.
  *
@@ -155,7 +143,7 @@ describe('Two-factor authentication', () => {
   it('can enable two factor auth', () => {
     const invalidToken = randomToken();
     const validToken = randomToken();
-    const mockedSecret = randomSecret();
+    const mockedKey = randomHex(16);
     const mockedScratchCode = randomScratchCode();
 
     // Mock profile data to ensure that 2FA is disabled.
@@ -168,7 +156,7 @@ describe('Two-factor authentication', () => {
     cy.wait('@getSecurityQuestions');
 
     getTwoFactorSection().within(() => {
-      mockEnableTwoFactorAuth(mockedSecret).as('enableTwoFactorAuth');
+      mockEnableTwoFactorAuth(mockedKey).as('enableTwoFactorAuth');
 
       ui.toggle
         .find()
@@ -181,7 +169,7 @@ describe('Two-factor authentication', () => {
 
       cy.findByLabelText('Secret Key')
         .should('be.visible')
-        .should('have.value', mockedSecret);
+        .should('have.value', mockedKey);
 
       // Type an invalid token first, confirm that error message appears as expected.
       cy.findByLabelText('Token').should('be.visible').type(invalidToken);
@@ -312,7 +300,7 @@ describe('Two-factor authentication', () => {
     cy.wait('@getSecurityQuestions');
 
     getTwoFactorSection().within(() => {
-      mockEnableTwoFactorAuth(randomSecret()).as('resetTwoFactorAuth');
+      mockEnableTwoFactorAuth(randomHex(16)).as('resetTwoFactorAuth');
 
       // Confirm that reset link is present, click on it.
       cy.findByText('Reset two-factor authentication')