-
Notifications
You must be signed in to change notification settings - Fork 324
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add E2E tests for chromium and firefox
- Loading branch information
Showing
7 changed files
with
275 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| #!/bin/sh | ||
| set -ex | ||
|
|
||
| ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["*"]' | ||
| ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["*"]' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| #!/bin/sh | ||
| set -ex | ||
|
|
||
| IPFS_COMPANION_VERSION=${IPFS_COMPANION_VERSION:-$(jq -r '.version' ./add-on/manifest.common.json)} | ||
|
|
||
| id="$(curl --retry 5 --no-progress-meter "https://github.com/gitapi/repos/ipfs/ipfs-companion/releases/tags/v$IPFS_COMPANION_VERSION" | jq '.id')" | ||
| assets="$(curl --retry 5 --no-progress-meter --location "https://github.com/gitapi/repos/ipfs/ipfs-companion/releases/$id/assets" | jq -r '.[].name')" | ||
|
|
||
| for asset in $assets; do | ||
| curl --retry 5 --no-progress-meter --location --output "build/$asset" "https://github.com/ipfs/ipfs-companion/releases/download/v$IPFS_COMPANION_VERSION/$asset" | ||
| done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| version: "3.9" | ||
| services: | ||
| firefox: | ||
| image: selenium/standalone-firefox:${FIREFOX_VERSION:-latest} | ||
| shm_size: 2g | ||
| ports: | ||
| - 4444 | ||
| - 7900 | ||
| chromium: | ||
| # WARN: `standalone-chrome` does NOT work on ARM-based machines; | ||
| # see https://github.com/SeleniumHQ/docker-selenium#experimental-mult-arch-aarch64armhfamd64-images; | ||
| # try using `seleniarm/standalone-chromium` instead | ||
| # export CHROMIUM_IMAGE=seleniarm/standalone-chromium | ||
| image: ${CHROMIUM_IMAGE:-selenium/standalone-chrome}:${CHROMIUM_VERSION:-latest} | ||
| shm_size: 2g | ||
| ports: | ||
| - 4444 | ||
| - 7900 | ||
| kubo: | ||
| image: ipfs/kubo:${KUBO_VERSION:-latest} | ||
| ports: | ||
| - 4001 | ||
| - 5001 | ||
| - 8080 | ||
| volumes: | ||
| - ./ci/access-control-allow-all.sh:/container-init.d/001-access-control-allow-all.sh | ||
| e2e: | ||
| build: | ||
| dockerfile: ./Dockerfile | ||
| environment: | ||
| - SELENIUM_REMOTE_CHROMIUM_URL=http://chromium:4444 | ||
| - SELENIUM_REMOTE_FIREFOX_URL=http://firefox:4444 | ||
| - IPFS_API_URL=http://kubo:5001 | ||
| - CUSTOM_GATEWAY_URL=http://kubo:8080 | ||
| - IPFS_COMPANION_VERSION=${IPFS_COMPANION_VERSION} | ||
| - TEST_E2E=1 | ||
| volumes: | ||
| - ./build:/home/node/app/build |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| import {Builder, By, Key} from 'selenium-webdriver' | ||
| import { describe, it, before } from 'mocha' | ||
| import { expect } from 'chai' | ||
| import fs from 'fs' | ||
| import chrome from 'selenium-webdriver/chrome.js' | ||
| import firefox from 'selenium-webdriver/firefox.js' | ||
| import manifest from '../../add-on/manifest.common.json' assert { type: 'json' } | ||
|
|
||
| async function delay(ms) { | ||
| return new Promise(res => setTimeout(res, ms)) | ||
| } | ||
|
|
||
| function getVersion() { | ||
| return process.env.IPFS_COMPANION_VERSION || manifest.version | ||
| } | ||
|
|
||
| async function openChromiumBrowser() { | ||
| console.info('Opening Chromium browser') | ||
| const extension = `build/ipfs_companion-${getVersion()}_chromium.zip` | ||
| console.info(`Checking if ${extension} exists`) | ||
| expect(fs.existsSync(extension)).to.be.true | ||
| const options = new chrome.Options() | ||
| options.addExtensions(extension) | ||
| options.addArguments('--lang=en-GB,en-US') | ||
| options.addArguments('--headless=chrome') | ||
| var builder = new Builder(). | ||
| forBrowser('chrome'). | ||
| setChromeOptions(options) | ||
| if (process.env.SELENIUM_REMOTE_CHROMIUM_URL !== undefined) { | ||
| console.info(`Using remote webdriver: ${process.env.SELENIUM_REMOTE_CHROMIUM_URL}`) | ||
| builder.usingServer(process.env.SELENIUM_REMOTE_CHROMIUM_URL) | ||
| } | ||
| console.info('Starting Chromium') | ||
| const browser = await builder.build() | ||
| await delay(5000) // waiting for the browser/extension to load | ||
| console.info('Chromium is ready') | ||
| return browser | ||
| } | ||
|
|
||
| async function openFirefoxBrowser() { | ||
| console.info('Opening Firefox browser') | ||
| const extension = `build/ipfs_companion-${getVersion()}_firefox.zip` | ||
| console.info(`Checking if ${extension} exists`) | ||
| expect(fs.existsSync(extension)).to.be.true | ||
| const options = new firefox.Options() | ||
| options.setPreference('intl.accept_languages', 'en-gb,en-us') | ||
| options.setPreference('intl.locale.requested', 'en-GB,en-US') | ||
| // options.addArguments('--headless') | ||
| const builder = new Builder(). | ||
| forBrowser('firefox'). | ||
| setFirefoxOptions(options) | ||
| if (process.env.SELENIUM_REMOTE_FIREFOX_URL !== undefined) { | ||
| console.info(`Using remote webdriver: ${process.env.SELENIUM_REMOTE_FIREFOX_URL}`) | ||
| builder.usingServer(process.env.SELENIUM_REMOTE_FIREFOX_URL) | ||
| } | ||
| console.info('Starting Firefox') | ||
| const browser = builder.build() | ||
| console.info('Installing the extension') | ||
| await browser.installAddon(extension, true) | ||
| await delay(5000) // waiting for the browser/extension to load | ||
| console.info('Firefox is ready') | ||
| return browser | ||
| } | ||
|
|
||
| const ExtensionURLRegex = /^(moz|chrome)-extension:\/\/[^\/]+/ | ||
| async function findExtensionUrl(browser) { | ||
| console.info('Looking for an open extension tab') | ||
| const handles = await browser.getAllWindowHandles() | ||
| console.info(`Found ${handles.length} candidates`) | ||
|
|
||
| for (const handle of handles) { | ||
| console.info('Switching tabs') | ||
| await browser.switchTo().window(handle) | ||
| const url = await browser.getCurrentUrl() | ||
| console.info(`The current URL is: ${url}`) | ||
| const extensionURL = ExtensionURLRegex.exec(url)?.at(0) | ||
| if (extensionURL !== undefined) { | ||
| console.info(`Found the extension URL: ${extensionURL}`) | ||
| return extensionURL | ||
| } | ||
| } | ||
| console.error('No extension URL found') | ||
| } | ||
|
|
||
| async function updateExtensionSettings(browser, url, id, value) { | ||
| console.info('Updating extension setting') | ||
| console.info(`Going to: ${url}/dist/options/options.html`) | ||
| await browser.get(`${url}/dist/options/options.html`) | ||
| console.info(`Looking for an element: ${id}`) | ||
| var element = browser.findElement(By.id(id)) | ||
| console.info(`Setting new value to: ${value}`) | ||
| await element.sendKeys('') | ||
| await delay(1000) // waiting for focus to be acquired | ||
| await element.clear() | ||
| await delay(1000) // waiting for input to be cleared | ||
| await element.sendKeys(value) | ||
| await element.sendKeys(Key.TAB) | ||
| await delay(5000) // waiting for the setting to be applied | ||
| console.info('Checking if the update worked') | ||
| element = browser.findElement(By.id(id)) | ||
| const v = await element.getAttribute('value') | ||
| expect(v).to.equal(value) | ||
| console.info('The setting update is complete') | ||
| } | ||
|
|
||
| async function getNumberOfConnectedPeers(browser, url) { | ||
| console.info('Checking the number of connected peers') | ||
| console.info(`Going to: ${url}/dist/landing-pages/welcome/index.html`) | ||
| await browser.get(`${url}/dist/landing-pages/welcome/index.html`) | ||
| await delay(5000) // waiting for the connection number to appear | ||
| const html = await browser.getPageSource() | ||
| console.debug(html) | ||
| console.info(`Looking for an element with text: 'Your node is connected to ...'`) | ||
| const p = browser.findElement(By.xpath("//p[text()='Your node is connected to ']")) | ||
| const span = p.findElement(By.css('span')) | ||
| const peers = await span.getText() | ||
| console.info(`There are ${peers} connected peers`) | ||
| return parseInt(peers) | ||
| } | ||
|
|
||
| async function runTest(browser) { | ||
| const url = await findExtensionUrl(browser) | ||
| expect(url).not.to.be.undefined | ||
| await updateExtensionSettings(browser, url, 'ipfsApiUrl', process.env.IPFS_API_URL || 'http://127.0.0.1:5001') | ||
| await updateExtensionSettings(browser, url, 'customGatewayUrl', process.env.CUSTOM_GATEWAY_URL || 'http://localhost:8080') | ||
| const peers = await getNumberOfConnectedPeers(browser, url) | ||
| expect(peers).not.to.equal(0) | ||
| } | ||
|
|
||
| describe('ipfs-companion', function () { | ||
| before(() => { | ||
| if (process.env.TEST_E2E !== '1') { | ||
| this.skip() | ||
| } | ||
| }) | ||
| it('should be able to discover peers in Chromium', async function () { | ||
| const browser = await openChromiumBrowser() | ||
| try { | ||
| await runTest(browser) | ||
| } finally { | ||
| await browser.quit() | ||
| } | ||
| }) | ||
| it('should be able to discover peers in Firefox', async function () { | ||
| const browser = await openFirefoxBrowser() | ||
| try { | ||
| await runTest(browser) | ||
| } finally { | ||
| await browser.quit() | ||
| } | ||
| }) | ||
| }) |