feat: toggles in Cypress API (#1221)

* feat: toggles in Cypress API

* Update cypress.config.ts

wallets/metamask/src/cypress/MetaMask.ts

@@ -4,6 +4,7 @@ import { MetaMask as MetaMaskPlaywright } from '../playwright/MetaMask'
 import { waitFor } from '../playwright/utils/waitFor'
 import HomePageSelectors from '../selectors/pages/HomePage'
 import Selectors from '../selectors/pages/HomePage'
+import type { SettingsSidebarMenus } from '../selectors/pages/HomePage/settings'
 import TransactionPage from '../selectors/pages/NotificationPage/transactionPage'
 import type { GasSettings } from '../type/GasSettings'
 import type { Network } from '../type/Network'
@@ -92,6 +93,12 @@ export default class MetaMask {
     return true
   }
 
+  async resetAccount() {
+    await this.metamaskPlaywright.resetAccount()
+
+    return true
+  }
+
   async switchNetwork({
     networkName,
     isTestnet = false
@@ -235,6 +242,24 @@ export default class MetaMask {
     return true
   }
 
+  // Lock/Unlock
+
+  async lock() {
+    await this.metamaskPlaywright.lock()
+    await expect(
+      this.metamaskExtensionPage.locator(this.metamaskPlaywright.lockPage.selectors.submitButton)
+    ).toBeVisible()
+
+    return true
+  }
+
+  async unlock() {
+    await this.metamaskPlaywright.unlock()
+    await expect(this.metamaskExtensionPage.locator(this.metamaskPlaywright.homePage.selectors.logo)).toBeVisible()
+
+    return true
+  }
+
   // Others
 
   async providePublicEncryptionKey() {
@@ -335,6 +360,18 @@ export default class MetaMask {
       })
   }
 
+  async toggleShowTestNetworks() {
+    await this.metamaskPlaywright.toggleShowTestNetworks()
+
+    return true
+  }
+
+  async toggleDismissSecretRecoveryPhraseReminder() {
+    await this.metamaskPlaywright.toggleDismissSecretRecoveryPhraseReminder()
+
+    return true
+  }
+
   async goBackToHomePage() {
     await this.metamaskPlaywright.openSettings()
 
@@ -343,22 +380,19 @@ export default class MetaMask {
     await this.metamaskPlaywright.goBackToHomePage()
 
     await expect(this.metamaskExtensionPage.locator(HomePageSelectors.copyAccountAddressButton)).toBeVisible()
-  }
 
-  // Lock/Unlock
+    return true
+  }
 
-  async lock() {
-    await this.metamaskPlaywright.lock()
-    await expect(
-      this.metamaskExtensionPage.locator(this.metamaskPlaywright.lockPage.selectors.submitButton)
-    ).toBeVisible()
+  async openSettings() {
+    await this.metamaskPlaywright.openSettings()
 
     return true
   }
 
-  async unlock() {
-    await this.metamaskPlaywright.unlock()
-    await expect(this.metamaskExtensionPage.locator(this.metamaskPlaywright.homePage.selectors.logo)).toBeVisible()
+  async openSidebarMenu(menu: SettingsSidebarMenus) {
+    await this.metamaskPlaywright.openSidebarMenu(menu)
+    await expect(this.metamaskExtensionPage.locator(HomePageSelectors.settings.sidebarMenu(menu))).toBeVisible()
 
     return true
   }

wallets/metamask/src/cypress/configureSynpress.ts

@@ -1,6 +1,7 @@
 import type { BrowserContext, Page } from '@playwright/test'
 import { ensureRdpPort } from '@synthetixio/synpress-core'
 import type { CreateAnvilOptions } from '@viem/anvil'
+import type { SettingsSidebarMenus } from '../selectors/pages/HomePage/settings'
 import type { GasSettings } from '../type/GasSettings'
 import type { Network } from '../type/Network'
 import MetaMask from './MetaMask'
@@ -84,6 +85,7 @@ export default function configureSynpress(
       currentAccountName: string
       newAccountName: string
     }) => metamask?.renameAccount({ currentAccountName, newAccountName }),
+    resetAccount: () => metamask?.resetAccount(),
 
     // Network
     getNetwork: () => metamask?.getNetwork(),
@@ -134,9 +136,14 @@ export default function configureSynpress(
     lock: () => metamask?.lock(),
     unlock: () => metamask?.unlock(),
 
-    // Others
+    // Toggles
+    toggleShowTestNetworks: () => metamask?.toggleShowTestNetworks(),
+    toggleDismissSecretRecoveryPhraseReminder: () => metamask?.toggleDismissSecretRecoveryPhraseReminder(),
 
-    goBackToHomePage: () => metamask?.goBackToHomePage()
+    // Others
+    goBackToHomePage: () => metamask?.goBackToHomePage(),
+    openSettings: () => metamask?.openSettings(),
+    openSidebarMenu: (menu: SettingsSidebarMenus) => metamask?.openSidebarMenu(menu)
   })
 
   return {

wallets/metamask/src/cypress/support/synpressCommands.ts

@@ -10,6 +10,7 @@
 // ***********************************************
 
 import type { Anvil, CreateAnvilOptions } from '@viem/anvil'
+import type { SettingsSidebarMenus } from '../../selectors/pages/HomePage/settings'
 import type { GasSettings } from '../../type/GasSettings'
 import type { Network } from '../../type/Network'
 
@@ -28,6 +29,7 @@ declare global {
       switchAccount(accountName: string): Chainable<void>
       renameAccount(currentAccountName: string, newAccountName: string): Chainable<void>
       getAccountAddress(): Chainable<string>
+      resetAccount(): Chainable<void>
 
       switchNetwork(networkName: string, isTestnet?: boolean): Chainable<void>
       createAnvilNode(options?: CreateAnvilOptions): Chainable<{
@@ -64,7 +66,12 @@ declare global {
       lock(): Chainable<void>
       unlock(): Chainable<void>
 
+      toggleShowTestNetworks(): Chainable<void>
+      toggleDismissSecretRecoveryPhraseReminder(): Chainable<void>
+
       goBackToHomePage(): Chainable<void>
+      openSettings(): Chainable<void>
+      openSidebarMenu(menu: SettingsSidebarMenus): Chainable<void>
     }
   }
 }
@@ -101,6 +108,9 @@ export default function synpressCommands() {
   Cypress.Commands.add('getAccountAddress', () => {
     return cy.task('getAccountAddress')
   })
+  Cypress.Commands.add('resetAccount', () => {
+    return cy.task('resetAccount')
+  })
 
   // Network
 
@@ -181,6 +191,15 @@ export default function synpressCommands() {
     return cy.task('unlock')
   })
 
+  // Toggles
+
+  Cypress.Commands.add('toggleShowTestNetworks', () => {
+    return cy.task('toggleShowTestNetworks')
+  })
+  Cypress.Commands.add('toggleDismissSecretRecoveryPhraseReminder', () => {
+    return cy.task('toggleDismissSecretRecoveryPhraseReminder')
+  })
+
   // Others
 
   Cypress.Commands.add('providePublicEncryptionKey', () => {
@@ -213,4 +232,10 @@ export default function synpressCommands() {
   Cypress.Commands.add('goBackToHomePage', () => {
     return cy.task('goBackToHomePage')
   })
+  Cypress.Commands.add('openSettings', () => {
+    return cy.task('openSettings')
+  })
+  Cypress.Commands.add('openSidebarMenu', (menu: SettingsSidebarMenus) => {
+    return cy.task('openSidebarMenu', menu)
+  })
 }

wallets/metamask/test/cypress/resetAccount.cy.ts

@@ -0,0 +1,13 @@
+import { SettingsSidebarMenus } from '../../src/selectors/pages/HomePage/settings'
+
+describe('reset the account', () => {
+  it('should reset the account', () => {
+    cy.openSettings().then(() => {
+      cy.openSidebarMenu(SettingsSidebarMenus.Advanced).then(() => {
+        cy.resetAccount().then(() => {
+          cy.goBackToHomePage()
+        })
+      })
+    })
+  })
+})