From 044949f8e1a0c3fb8ef8430e07df78ededd1415d Mon Sep 17 00:00:00 2001
From: Niranjana Binoy <43930900+NiranjanaBinoy@users.noreply.github.com>
Date: Fri, 2 Apr 2021 22:40:53 -0400
Subject: [PATCH] Refactoring address-book.spec.js to use fixtures (#10804)

---
 test/e2e/address-book.spec.js              | 323 ---------------------
 test/e2e/fixtures/address-entry/state.json | 136 +++++++++
 test/e2e/run-all.sh                        |   7 -
 test/e2e/tests/address-book.spec.js        | 148 ++++++++++
 4 files changed, 284 insertions(+), 330 deletions(-)
 delete mode 100644 test/e2e/address-book.spec.js
 create mode 100644 test/e2e/fixtures/address-entry/state.json
 create mode 100644 test/e2e/tests/address-book.spec.js

diff --git a/test/e2e/address-book.spec.js b/test/e2e/address-book.spec.js
deleted file mode 100644
index 4ac0d1722..000000000
--- a/test/e2e/address-book.spec.js
+++ /dev/null
@@ -1,323 +0,0 @@
-const assert = require('assert');
-const { By, until } = require('selenium-webdriver');
-
-const enLocaleMessages = require('../../app/_locales/en/messages.json');
-const { tinyDelayMs, regularDelayMs, largeDelayMs } = require('./helpers');
-const { buildWebDriver } = require('./webdriver');
-const Ganache = require('./ganache');
-
-const ganacheServer = new Ganache();
-
-describe('MetaMask', function () {
-  let driver;
-
-  const testSeedPhrase =
-    'forum vessel pink push lonely enact gentle tail admit parrot grunt dress';
-
-  this.timeout(0);
-  this.bail(true);
-
-  before(async function () {
-    await ganacheServer.start({
-      accounts: [
-        {
-          secretKey:
-            '0x53CB0AB5226EEBF4D872113D98332C1555DC304443BEE1CF759D15798D3C55A9',
-          balance: 25000000000000000000,
-        },
-      ],
-    });
-    const result = await buildWebDriver();
-    driver = result.driver;
-    await driver.navigate();
-  });
-
-  afterEach(async function () {
-    if (process.env.SELENIUM_BROWSER === 'chrome') {
-      const errors = await driver.checkBrowserForConsoleErrors();
-      if (errors.length) {
-        const errorReports = errors.map((err) => err.message);
-        const errorMessage = `Errors found in browser console:\n${errorReports.join(
-          '\n',
-        )}`;
-        console.error(new Error(errorMessage));
-      }
-    }
-    if (this.currentTest.state === 'failed') {
-      await driver.verboseReportOnFailure(this.currentTest.title);
-    }
-  });
-
-  after(async function () {
-    await ganacheServer.quit();
-    await driver.quit();
-  });
-
-  describe('Going through the first time flow', function () {
-    it('clicks the continue button on the welcome screen', async function () {
-      await driver.findElement(By.css('.welcome-page__header'));
-      await driver.clickElement(
-        By.xpath(
-          `//button[contains(text(), '${enLocaleMessages.getStarted.message}')]`,
-        ),
-      );
-      await driver.delay(largeDelayMs);
-    });
-
-    it('clicks the "Create New Wallet" option', async function () {
-      await driver.clickElement(
-        By.xpath(`//button[contains(text(), 'Create a Wallet')]`),
-      );
-      await driver.delay(largeDelayMs);
-    });
-
-    it('clicks the "No thanks" option on the metametrics opt-in screen', async function () {
-      await driver.clickElement(By.css('.btn-default'));
-      await driver.delay(largeDelayMs);
-    });
-
-    it('accepts a secure password', async function () {
-      const passwordBox = await driver.findElement(
-        By.css('.first-time-flow__form #create-password'),
-      );
-      const passwordBoxConfirm = await driver.findElement(
-        By.css('.first-time-flow__form #confirm-password'),
-      );
-
-      await passwordBox.sendKeys('correct horse battery staple');
-      await passwordBoxConfirm.sendKeys('correct horse battery staple');
-
-      await driver.clickElement(By.css('.first-time-flow__checkbox'));
-      await driver.clickElement(By.css('.first-time-flow__form button'));
-      await driver.delay(regularDelayMs);
-    });
-
-    let seedPhrase;
-
-    it('reveals the seed phrase', async function () {
-      const byRevealButton = By.css(
-        '.reveal-seed-phrase__secret-blocker .reveal-seed-phrase__reveal-button',
-      );
-      await driver.clickElement(byRevealButton);
-      await driver.delay(regularDelayMs);
-
-      const revealedSeedPhrase = await driver.findElement(
-        By.css('.reveal-seed-phrase__secret-words'),
-      );
-      seedPhrase = await revealedSeedPhrase.getText();
-      assert.equal(seedPhrase.split(' ').length, 12);
-      await driver.delay(regularDelayMs);
-
-      await driver.clickElement(
-        By.xpath(
-          `//button[contains(text(), '${enLocaleMessages.next.message}')]`,
-        ),
-      );
-      await driver.delay(regularDelayMs);
-    });
-
-    async function clickWordAndWait(word) {
-      await driver.clickElement(
-        By.css(
-          `[data-testid="seed-phrase-sorted"] [data-testid="draggable-seed-${word}"]`,
-        ),
-      );
-      await driver.delay(tinyDelayMs);
-    }
-
-    it('can retype the seed phrase', async function () {
-      const words = seedPhrase.split(' ');
-
-      for (const word of words) {
-        await clickWordAndWait(word);
-      }
-
-      await driver.clickElement(
-        By.xpath(`//button[contains(text(), 'Confirm')]`),
-      );
-      await driver.delay(regularDelayMs);
-    });
-
-    it('clicks through the success screen', async function () {
-      await driver.findElement(
-        By.xpath(`//div[contains(text(), 'Congratulations')]`),
-      );
-      await driver.clickElement(
-        By.xpath(
-          `//button[contains(text(), '${enLocaleMessages.endOfFlowMessage10.message}')]`,
-        ),
-      );
-      await driver.delay(regularDelayMs);
-    });
-  });
-
-  describe('Import seed phrase', function () {
-    it('logs out of the vault', async function () {
-      await driver.clickElement(By.css('.account-menu__icon'));
-      await driver.delay(regularDelayMs);
-
-      const lockButton = await driver.findClickableElement(
-        By.css('.account-menu__lock-button'),
-      );
-      assert.equal(await lockButton.getText(), 'Lock');
-      await lockButton.click();
-      await driver.delay(regularDelayMs);
-    });
-
-    it('imports seed phrase', async function () {
-      const restoreSeedLink = await driver.findClickableElement(
-        By.css('.unlock-page__link--import'),
-      );
-      assert.equal(
-        await restoreSeedLink.getText(),
-        'Import using account seed phrase',
-      );
-      await restoreSeedLink.click();
-      await driver.delay(regularDelayMs);
-
-      await driver.clickElement(By.css('.import-account__checkbox-container'));
-
-      const seedTextArea = await driver.findElement(By.css('textarea'));
-      await seedTextArea.sendKeys(testSeedPhrase);
-      await driver.delay(regularDelayMs);
-
-      const passwordInputs = await driver.findElements(By.css('input'));
-      await driver.delay(regularDelayMs);
-
-      await passwordInputs[0].sendKeys('correct horse battery staple');
-      await passwordInputs[1].sendKeys('correct horse battery staple');
-      await driver.clickElement(
-        By.xpath(
-          `//button[contains(text(), '${enLocaleMessages.restore.message}')]`,
-        ),
-      );
-      await driver.delay(regularDelayMs);
-    });
-
-    it('balance renders', async function () {
-      const balance = await driver.findElement(
-        By.css('[data-testid="wallet-balance"] .list-item__heading'),
-      );
-      await driver.wait(until.elementTextMatches(balance, /25\s*ETH/u));
-      await driver.delay(regularDelayMs);
-    });
-  });
-
-  describe('Adds an entry to the address book and sends eth to that address', function () {
-    it('starts a send transaction', async function () {
-      await driver.clickElement(By.css('[data-testid="eth-overview-send"]'));
-      await driver.delay(regularDelayMs);
-
-      const inputAddress = await driver.findElement(
-        By.css('input[placeholder="Search, public address (0x), or ENS"]'),
-      );
-      await inputAddress.sendKeys('0x2f318C334780961FB129D2a6c30D0763d9a5C970');
-      await driver.delay(regularDelayMs);
-
-      await driver.clickElement(By.css('.dialog.send__dialog.dialog--message'));
-
-      const addressBookAddModal = await driver.findElement(
-        By.css('span .modal'),
-      );
-      await driver.findElement(By.css('.add-to-address-book-modal'));
-      const addressBookInput = await driver.findElement(
-        By.css('.add-to-address-book-modal__input'),
-      );
-      await addressBookInput.sendKeys('Test Name 1');
-      await driver.delay(tinyDelayMs);
-      await driver.clickElement(
-        By.css('.add-to-address-book-modal__footer .btn-primary'),
-      );
-
-      await driver.wait(until.stalenessOf(addressBookAddModal));
-
-      const inputAmount = await driver.findElement(
-        By.css('.unit-input__input'),
-      );
-      await inputAmount.sendKeys('1');
-
-      const inputValue = await inputAmount.getAttribute('value');
-      assert.equal(inputValue, '1');
-      await driver.delay(regularDelayMs);
-
-      // Continue to next screen
-      await driver.clickElement(By.xpath(`//button[contains(text(), 'Next')]`));
-      await driver.delay(regularDelayMs);
-    });
-
-    it('confirms the transaction', async function () {
-      await driver.clickElement(
-        By.xpath(`//button[contains(text(), 'Confirm')]`),
-      );
-      await driver.delay(largeDelayMs * 2);
-    });
-
-    it('finds the transaction in the transactions list', async function () {
-      await driver.clickElement(By.css('[data-testid="home__activity-tab"]'));
-      await driver.wait(async () => {
-        const confirmedTxes = await driver.findElements(
-          By.css(
-            '.transaction-list__completed-transactions .transaction-list-item',
-          ),
-        );
-        return confirmedTxes.length === 1;
-      }, 10000);
-
-      const txValues = await driver.findElement(
-        By.css('.transaction-list-item__primary-currency'),
-      );
-      await driver.wait(until.elementTextMatches(txValues, /-1\s*ETH/u), 10000);
-    });
-  });
-
-  describe('Sends to an address book entry', function () {
-    it('starts a send transaction by clicking address book entry', async function () {
-      await driver.clickElement(By.css('[data-testid="eth-overview-send"]'));
-      await driver.delay(regularDelayMs);
-
-      const recipientRowTitle = await driver.findElement(
-        By.css('.send__select-recipient-wrapper__group-item__title'),
-      );
-      const recipientRowTitleString = await recipientRowTitle.getText();
-      assert.equal(recipientRowTitleString, 'Test Name 1');
-
-      await driver.clickElement(
-        By.css('.send__select-recipient-wrapper__group-item'),
-      );
-
-      await driver.delay(regularDelayMs);
-      const inputAmount = await driver.findElement(
-        By.css('.unit-input__input'),
-      );
-      await inputAmount.sendKeys('2');
-      await driver.delay(regularDelayMs);
-
-      // Continue to next screen
-      await driver.clickElement(By.xpath(`//button[contains(text(), 'Next')]`));
-      await driver.delay(regularDelayMs);
-    });
-
-    it('confirms the transaction', async function () {
-      await driver.clickElement(
-        By.xpath(`//button[contains(text(), 'Confirm')]`),
-      );
-      await driver.delay(largeDelayMs * 2);
-    });
-
-    it('finds the transaction in the transactions list', async function () {
-      await driver.wait(async () => {
-        const confirmedTxes = await driver.findElements(
-          By.css(
-            '.transaction-list__completed-transactions .transaction-list-item',
-          ),
-        );
-        return confirmedTxes.length === 2;
-      }, 10000);
-
-      const txValues = await driver.findElement(
-        By.css('.transaction-list-item__primary-currency'),
-      );
-      await driver.wait(until.elementTextMatches(txValues, /-2\s*ETH/u), 10000);
-    });
-  });
-});
diff --git a/test/e2e/fixtures/address-entry/state.json b/test/e2e/fixtures/address-entry/state.json
new file mode 100644
index 000000000..26da39502
--- /dev/null
+++ b/test/e2e/fixtures/address-entry/state.json
@@ -0,0 +1,136 @@
+{
+  "data": {
+    "AddressBookController": {
+      "addressBook": {
+        "0x539": {
+          "0x2f318C334780961FB129D2a6c30D0763d9a5C970": {
+            "address": "0x2f318C334780961FB129D2a6c30D0763d9a5C970",
+            "chainId": "0x539",
+            "isEns": false,
+            "memo": "",
+            "name": "Test Name 1"
+          }
+        }
+      }
+    },
+    "AppStateController": {
+      "mkrMigrationReminderTimestamp": null,
+      "swapsWelcomeMessageHasBeenShown": true
+    },
+    "CachedBalancesController": {
+      "cachedBalances": {
+        "4": {}
+      }
+    },
+    "CurrencyController": {
+      "conversionDate": 1575697244.188,
+      "conversionRate": 149.61,
+      "currentCurrency": "usd",
+      "nativeCurrency": "ETH"
+    },
+    "IncomingTransactionsController": {
+      "incomingTransactions": {},
+      "incomingTxLastFetchedBlocksByNetwork": {
+        "goerli": null,
+        "kovan": null,
+        "mainnet": null,
+        "rinkeby": 5570536
+      }
+    },
+    "KeyringController": {
+      "vault": "{\"data\":\"s6TpYjlUNsn7ifhEFTkuDGBUM1GyOlPrim7JSjtfIxgTt8/6MiXgiR/CtFfR4dWW2xhq85/NGIBYEeWrZThGdKGarBzeIqBfLFhw9n509jprzJ0zc2Rf+9HVFGLw+xxC4xPxgCS0IIWeAJQ+XtGcHmn0UZXriXm8Ja4kdlow6SWinB7sr/WM3R0+frYs4WgllkwggDf2/Tv6VHygvLnhtzp6hIJFyTjh+l/KnyJTyZW1TkZhDaNDzX3SCOHT\",\"iv\":\"FbeHDAW5afeWNORfNJBR0Q==\",\"salt\":\"TxZ+WbCW6891C9LK/hbMAoUsSEW1E8pyGLVBU6x5KR8=\"}"
+    },
+    "NetworkController": {
+      "network": "1337",
+      "provider": {
+        "nickname": "Localhost 8545",
+        "rpcUrl": "http://localhost:8545",
+        "chainId": "0x539",
+        "ticker": "ETH",
+        "type": "rpc"
+      }
+    },
+    "OnboardingController": {
+      "onboardingTabs": {},
+      "seedPhraseBackedUp": false
+    },
+    "PermissionsMetadata": {
+      "domainMetadata": {
+        "metamask.github.io": {
+          "icon": null,
+          "name": "M E T A M A S K M E S H T E S T"
+        }
+      },
+      "permissionsHistory": {},
+      "permissionsLog": [
+        {
+          "id": 746677923,
+          "method": "eth_accounts",
+          "methodType": "restricted",
+          "origin": "metamask.github.io",
+          "request": {
+            "id": 746677923,
+            "jsonrpc": "2.0",
+            "method": "eth_accounts",
+            "origin": "metamask.github.io",
+            "params": []
+          },
+          "requestTime": 1575697241368,
+          "response": {
+            "id": 746677923,
+            "jsonrpc": "2.0",
+            "result": []
+          },
+          "responseTime": 1575697241370,
+          "success": true
+        }
+      ]
+    },
+    "PreferencesController": {
+      "accountTokens": {
+        "0x5cfe73b6021e818b776b421b1c4db2474086a7e1": {
+          "rinkeby": [],
+          "ropsten": []
+        }
+      },
+      "assetImages": {},
+      "completedOnboarding": true,
+      "currentLocale": "en",
+      "featureFlags": {
+        "showIncomingTransactions": true,
+        "transactionTime": false
+      },
+      "firstTimeFlowType": "create",
+      "forgottenPassword": false,
+      "frequentRpcListDetail": [],
+      "identities": {
+        "0x5cfe73b6021e818b776b421b1c4db2474086a7e1": {
+          "address": "0x5cfe73b6021e818b776b421b1c4db2474086a7e1",
+          "name": "Account 1"
+        }
+      },
+      "knownMethodData": {},
+      "lostIdentities": {},
+      "metaMetricsId": null,
+      "metaMetricsSendCount": 0,
+      "participateInMetaMetrics": false,
+      "preferences": {
+        "useNativeCurrencyAsPrimaryCurrency": true
+      },
+      "selectedAddress": "0x5cfe73b6021e818b776b421b1c4db2474086a7e1",
+      "suggestedTokens": {},
+      "tokens": [],
+      "useBlockie": false,
+      "useNonceField": false,
+      "usePhishDetect": true
+    },
+    "config": {},
+    "firstTimeInfo": {
+      "date": 1575697234195,
+      "version": "7.7.0"
+    }
+  },
+  "meta": {
+    "version": 40
+  }
+}
diff --git a/test/e2e/run-all.sh b/test/e2e/run-all.sh
index 2428208cb..393847ac6 100755
--- a/test/e2e/run-all.sh
+++ b/test/e2e/run-all.sh
@@ -75,13 +75,6 @@ retry concurrently --kill-others \
   'yarn sendwithprivatedapp' \
   'mocha test/e2e/incremental-security.spec'
 
-retry concurrently --kill-others \
-  --names 'dapp,e2e' \
-  --prefix '[{time}][{name}]' \
-  --success first \
-  'yarn dapp' \
-  'mocha test/e2e/address-book.spec'
-
 retry concurrently --kill-others \
   --names '3box,dapp,e2e' \
   --prefix '[{time}][{name}]' \
diff --git a/test/e2e/tests/address-book.spec.js b/test/e2e/tests/address-book.spec.js
new file mode 100644
index 000000000..98574d40d
--- /dev/null
+++ b/test/e2e/tests/address-book.spec.js
@@ -0,0 +1,148 @@
+const { strict: assert } = require('assert');
+const { By, Key, until } = require('selenium-webdriver');
+const { withFixtures } = require('../helpers');
+
+describe('Address Book', function () {
+  const ganacheOptions = {
+    accounts: [
+      {
+        secretKey:
+          '0x7C9529A67102755B7E6102D6D950AC5D5863C98713805CEC576B945B15B71EAC',
+        balance: 25000000000000000000,
+      },
+    ],
+  };
+  it('Adds an entry to the address book and sends eth to that address', async function () {
+    await withFixtures(
+      {
+        dapp: true,
+        fixtures: 'imported-account',
+        ganacheOptions,
+        title: this.test.title,
+      },
+      async ({ driver }) => {
+        await driver.navigate();
+        const passwordField = await driver.findElement(By.css('#password'));
+        await passwordField.sendKeys('correct horse battery staple');
+        await passwordField.sendKeys(Key.ENTER);
+
+        await driver.clickElement(By.css('[data-testid="eth-overview-send"]'));
+
+        const inputAddress = await driver.findElement(
+          By.css('input[placeholder="Search, public address (0x), or ENS"]'),
+        );
+        await inputAddress.sendKeys(
+          '0x2f318C334780961FB129D2a6c30D0763d9a5C970',
+        );
+
+        await driver.clickElement(
+          By.css('.dialog.send__dialog.dialog--message'),
+        );
+
+        const addressBookAddModal = await driver.findElement(
+          By.css('span .modal'),
+        );
+        await driver.findElement(By.css('.add-to-address-book-modal'));
+        const addressBookInput = await driver.findElement(
+          By.css('.add-to-address-book-modal__input'),
+        );
+        await addressBookInput.sendKeys('Test Name 1');
+        await driver.clickElement(
+          By.css('.add-to-address-book-modal__footer .btn-primary'),
+        );
+        await driver.wait(until.stalenessOf(addressBookAddModal));
+
+        const inputAmount = await driver.findElement(
+          By.css('.unit-input__input'),
+        );
+        await inputAmount.sendKeys('1');
+
+        const inputValue = await inputAmount.getAttribute('value');
+        assert.equal(inputValue, '1');
+
+        await driver.clickElement(
+          By.xpath(`//button[contains(text(), 'Next')]`),
+        );
+
+        await driver.clickElement(
+          By.xpath(`//button[contains(text(), 'Confirm')]`),
+        );
+
+        await driver.clickElement(By.css('[data-testid="home__activity-tab"]'));
+        await driver.wait(async () => {
+          const confirmedTxes = await driver.findElements(
+            By.css(
+              '.transaction-list__completed-transactions .transaction-list-item',
+            ),
+          );
+          return confirmedTxes.length === 1;
+        }, 10000);
+
+        const txValues = await driver.findElement(
+          By.css('.transaction-list-item__primary-currency'),
+        );
+        await driver.wait(
+          until.elementTextMatches(txValues, /-1\s*ETH/u),
+          10000,
+        );
+      },
+    );
+  });
+  it('Sends to an address book entry', async function () {
+    await withFixtures(
+      {
+        dapp: true,
+        fixtures: 'address-entry',
+        ganacheOptions,
+        title: this.test.title,
+      },
+      async ({ driver }) => {
+        await driver.navigate();
+        const passwordField = await driver.findElement(By.css('#password'));
+        await passwordField.sendKeys('correct horse battery staple');
+        await passwordField.sendKeys(Key.ENTER);
+
+        await driver.clickElement(By.css('[data-testid="eth-overview-send"]'));
+        const recipientRowTitle = await driver.findElement(
+          By.css('.send__select-recipient-wrapper__group-item__title'),
+        );
+        const recipientRowTitleString = await recipientRowTitle.getText();
+        assert.equal(recipientRowTitleString, 'Test Name 1');
+        await driver.clickElement(
+          By.css('.send__select-recipient-wrapper__group-item'),
+        );
+
+        const inputAmount = await driver.findElement(
+          By.css('.unit-input__input'),
+        );
+        await inputAmount.sendKeys('2');
+
+        await driver.clickElement(
+          By.xpath(`//button[contains(text(), 'Next')]`),
+        );
+
+        await driver.clickElement(
+          By.xpath(`//button[contains(text(), 'Confirm')]`),
+        );
+
+        await driver.clickElement(By.css('[data-testid="home__activity-tab"]'));
+        await driver.wait(async () => {
+          const confirmedTxes = await driver.findElements(
+            By.css(
+              '.transaction-list__completed-transactions .transaction-list-item',
+            ),
+          );
+          return confirmedTxes.length === 1;
+        }, 10000);
+
+        const txValues = await driver.findElement(
+          By.css('.transaction-list-item__primary-currency'),
+        );
+        await driver.wait(
+          until.elementTextMatches(txValues, /-2\s*ETH/u),
+          10000,
+        );
+      },
+    );
+  });
+});