Add e2e tests for ethereum.on events

test/e2e/contract-test/index.html

@@ -31,6 +31,12 @@
       <button id="approveTokensWithoutGas">Approve Tokens Without Gas</button>
     </div>
   </div>
+  <div style="display: flex; flex-flow: column;">
+    <div>Network: <div id="network"></div></div>
+    <div>ChainId: <div id="chainId"></div></div>
+    <div>Accounts: <div id="accounts"></div></div>
+    <div style="display: flex;">
+  </div>
 
 <script src="contract.js"></script>
 </body>

test/e2e/ethereum-on.spec.js

@@ -0,0 +1,223 @@
+const path = require('path')
+const assert = require('assert')
+const webdriver = require('selenium-webdriver')
+const { By, until } = webdriver
+const {
+  delay,
+  buildChromeWebDriver,
+  buildFirefoxWebdriver,
+  installWebExt,
+  getExtensionIdChrome,
+  getExtensionIdFirefox,
+} = require('./func')
+const {
+  checkBrowserForConsoleErrors,
+  closeAllWindowHandlesExcept,
+  findElement,
+  findElements,
+  openNewPage,
+  verboseReportOnFailure,
+  waitUntilXWindowHandles,
+  switchToWindowWithTitle,
+} = require('./helpers')
+const fetchMockResponses = require('./fetch-mocks.js')
+
+describe('MetaMask', function () {
+  let extensionId
+  let driver
+  let publicAddress
+
+  const tinyDelayMs = 200
+  const regularDelayMs = tinyDelayMs * 2
+  const largeDelayMs = regularDelayMs * 2
+
+  this.timeout(0)
+  this.bail(true)
+
+  before(async function () {
+    let extensionUrl
+    switch (process.env.SELENIUM_BROWSER) {
+      case 'chrome': {
+        const extPath = path.resolve('dist/chrome')
+        driver = buildChromeWebDriver(extPath)
+        extensionId = await getExtensionIdChrome(driver)
+        await delay(largeDelayMs)
+        extensionUrl = `chrome-extension://${extensionId}/home.html`
+        break
+      }
+      case 'firefox': {
+        const extPath = path.resolve('dist/firefox')
+        driver = buildFirefoxWebdriver()
+        await installWebExt(driver, extPath)
+        await delay(largeDelayMs)
+        extensionId = await getExtensionIdFirefox(driver)
+        extensionUrl = `moz-extension://${extensionId}/home.html`
+        break
+      }
+    }
+    // Depending on the state of the application built into the above directory (extPath) and the value of
+    // METAMASK_DEBUG we will see different post-install behaviour and possibly some extra windows. Here we
+    // are closing any extraneous windows to reset us to a single window before continuing.
+    const [tab1] = await driver.getAllWindowHandles()
+    await closeAllWindowHandlesExcept(driver, [tab1])
+    await driver.switchTo().window(tab1)
+    await driver.get(extensionUrl)
+  })
+
+  beforeEach(async function () {
+    await driver.executeScript(
+      'window.origFetch = window.fetch.bind(window);' +
+      'window.fetch = ' +
+      '(...args) => { ' +
+      'if (args[0] === "https://ethgasstation.info/json/ethgasAPI.json") { return ' +
+      'Promise.resolve({ json: () => Promise.resolve(JSON.parse(\'' + fetchMockResponses.ethGasBasic + '\')) }); } else if ' +
+      '(args[0] === "https://ethgasstation.info/json/predictTable.json") { return ' +
+      'Promise.resolve({ json: () => Promise.resolve(JSON.parse(\'' + fetchMockResponses.ethGasPredictTable + '\')) }); } else if ' +
+      '(args[0].match(/chromeextensionmm/)) { return ' +
+      'Promise.resolve({ json: () => Promise.resolve(JSON.parse(\'' + fetchMockResponses.metametrics + '\')) }); } else if ' +
+      '(args[0] === "https://dev.blockscale.net/api/gasexpress.json") { return ' +
+      'Promise.resolve({ json: () => Promise.resolve(JSON.parse(\'' + fetchMockResponses.gasExpress + '\')) }); } ' +
+      'return window.origFetch(...args); };' +
+      'function cancelInfuraRequest(requestDetails) {' +
+        'console.log("Canceling: " + requestDetails.url);' +
+        'return {' +
+          'cancel: true' +
+        '};' +
+     ' }' +
+      'window.chrome && window.chrome.webRequest && window.chrome.webRequest.onBeforeRequest.addListener(' +
+        'cancelInfuraRequest,' +
+        '{urls: ["https://*.infura.io/*"]},' +
+        '["blocking"]' +
+      ');'
+    )
+  })
+
+  afterEach(async function () {
+    if (process.env.SELENIUM_BROWSER === 'chrome') {
+      const errors = await checkBrowserForConsoleErrors(driver)
+      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 verboseReportOnFailure(driver, this.currentTest)
+    }
+  })
+
+  after(async function () {
+    await driver.quit()
+  })
+
+  describe('Going through the first time flow, but skipping the seed phrase challenge', () => {
+    it('clicks the continue button on the welcome screen', async () => {
+      await findElement(driver, By.css('.welcome-page__header'))
+      const welcomeScreenBtn = await findElement(driver, By.css('.first-time-flow__button'))
+      welcomeScreenBtn.click()
+      await delay(largeDelayMs)
+    })
+
+    it('clicks the "Create New Wallet" option', async () => {
+      const customRpcButton = await findElement(driver, By.xpath(`//button[contains(text(), 'Create a Wallet')]`))
+      customRpcButton.click()
+      await delay(largeDelayMs)
+    })
+
+    it('clicks the "No thanks" option on the metametrics opt-in screen', async () => {
+      const optOutButton = await findElement(driver, By.css('.btn-default'))
+      optOutButton.click()
+      await delay(largeDelayMs)
+    })
+
+    it('accepts a secure password', async () => {
+      const passwordBox = await findElement(driver, By.css('.first-time-flow__form #create-password'))
+      const passwordBoxConfirm = await findElement(driver, By.css('.first-time-flow__form #confirm-password'))
+      const button = await findElement(driver, By.css('.first-time-flow__form button'))
+
+      await passwordBox.sendKeys('correct horse battery staple')
+      await passwordBoxConfirm.sendKeys('correct horse battery staple')
+
+      const tosCheckBox = await findElement(driver, By.css('.first-time-flow__checkbox'))
+      await tosCheckBox.click()
+
+      await button.click()
+      await delay(largeDelayMs)
+    })
+
+    it('skips the seed phrase challenge', async () => {
+      const buttons = await findElements(driver, By.css('.first-time-flow__button'))
+      await buttons[0].click()
+      await delay(regularDelayMs)
+
+      const detailsButton = await findElement(driver, By.css('.account-details__details-button'))
+      await detailsButton.click()
+      await delay(regularDelayMs)
+    })
+
+    it('gets the current accounts address', async () => {
+      const addressInput = await findElement(driver, By.css('.qr-ellip-address'))
+      publicAddress = await addressInput.getAttribute('value')
+      const accountModal = await driver.findElement(By.css('span .modal'))
+
+      await driver.executeScript("document.querySelector('.account-modal-close').click()")
+
+      await driver.wait(until.stalenessOf(accountModal))
+      await delay(regularDelayMs)
+    })
+
+  })
+
+  describe('provider listening for events', () => {
+    let extension
+    let popup
+    let dapp
+    it('switches to a dapp', async () => {
+      await openNewPage(driver, 'http://127.0.0.1:8080/')
+      await delay(regularDelayMs)
+
+      await waitUntilXWindowHandles(driver, 3)
+      const windowHandles = await driver.getAllWindowHandles()
+
+      extension = windowHandles[0]
+      popup = await switchToWindowWithTitle(driver, 'MetaMask Notification', windowHandles)
+      dapp = windowHandles.find(handle => handle !== extension && handle !== popup)
+
+      await delay(regularDelayMs)
+      const approveButton = await findElement(driver, By.xpath(`//button[contains(text(), 'Connect')]`))
+      await approveButton.click()
+
+      await driver.switchTo().window(dapp)
+      await delay(regularDelayMs)
+    })
+
+    it('has not set the network within the dapp', async () => {
+      const networkDiv = await findElement(driver, By.css('#network'))
+      assert.equal(await networkDiv.getText(), '')
+    })
+
+    it('changes the network', async () => {
+      await driver.switchTo().window(extension)
+
+      const networkDropdown = await findElement(driver, By.css('.network-name'))
+      await networkDropdown.click()
+      await delay(regularDelayMs)
+
+      const ropstenButton = await findElement(driver, By.xpath(`//span[contains(text(), 'Ropsten')]`))
+      await ropstenButton.click()
+      await delay(largeDelayMs)
+    })
+
+    it('sets the network div within the dapp', async () => {
+      await driver.switchTo().window(dapp)
+      const networkDiv = await findElement(driver, By.css('#network'))
+      assert.equal(await networkDiv.getText(), '3')
+    })
+
+    it('sets the account div within the dapp', async () => {
+      await driver.switchTo().window(dapp)
+      const accountsDiv = await findElement(driver, By.css('#accounts'))
+      assert.equal(await accountsDiv.getText(), publicAddress.toLowerCase())
+    })
+  })
+})

test/e2e/run-all.sh

@@ -46,6 +46,14 @@ concurrently --kill-others \
   'sleep 5 && mocha test/e2e/send-edit.spec'
 
 
+  concurrently --kill-others \
+    --names 'ganache,dapp,e2e' \
+    --prefix '[{time}][{name}]' \
+    --success first \
+    'yarn ganache:start' \
+    'yarn dapp' \
+    'sleep 5 && mocha test/e2e/ethereum-on.spec'
+
 export GANACHE_ARGS="${BASE_GANACHE_ARGS} --deterministic --account=0x250F458997A364988956409A164BA4E16F0F99F916ACDD73ADCD3A1DE30CF8D1,0  --account=0x53CB0AB5226EEBF4D872113D98332C1555DC304443BEE1CF759D15798D3C55A9,25000000000000000000"
 concurrently --kill-others \
   --names 'ganache,sendwithprivatedapp,e2e' \