test(browsers-smoketests): Run a set of smoke tests on both Chrome and Firefox
This commit introduces tape as the test framework used to define the tests in the test extension contexts and send them to the nodejs script that orchestrate the test run. The nodejs script has also been migrated from mocha to tape, it uses the custom test helpers provided to setup the test environment (e.g. create a temporary dir for the test extension, copy the last polyfill build, bundle tape to be used in the test extension, start the browser which run the test extension and finally collect the results of the test extension) and then it merges all the tap logs collected from every test extension into a single "per browser" test suite. - updated travis nodejs environment to nodejs 8 - uses tape to collect test results from inside the test extension - added test case to check polyfill 'existing browser API object' detection - added test for expected rejection on tabs.sendMessage with an invalid tabId - added test with multiple listeners which resolves to undefined and null - optionally run chrome smoketests with --enable-features=NativeCrxBindings
This commit is contained in:
Luca Greco
parent
6c8268f6fb
commit
5d186bae84
12
.travis.yml
12
.travis.yml
|
|
@ -2,7 +2,8 @@ language: node_js
|
|||
sudo: false
|
||||
node_js:
|
||||
## Some of the ES6 syntax used in the browser-polyfill sources is only supported on nodejs >= 6
|
||||
- '6'
|
||||
## and the selenium-webdriver dependency used by the integration tests requires nodejs >= 8.
|
||||
- '8'
|
||||
|
||||
script:
|
||||
- npm run build
|
||||
|
|
@ -14,7 +15,14 @@ script:
|
|||
- export DISPLAY=:99.0
|
||||
- sh -e /etc/init.d/xvfb start
|
||||
- echo "RUN integration tests on chrome" &&
|
||||
TRAVIS_CI=true ./test/run-chrome-smoketests.sh
|
||||
TRAVIS_CI=true ./test/run-browsers-smoketests.sh
|
||||
|
||||
## See https://docs.travis-ci.com/user/chrome
|
||||
sudo: required
|
||||
|
||||
addons:
|
||||
firefox: 'latest'
|
||||
chrome: 'stable'
|
||||
|
||||
after_script: npm run publish-coverage
|
||||
|
||||
|
|
|
|||
14
package.json
14
package.json
|
|
@ -22,9 +22,13 @@
|
|||
"babel-plugin-transform-es2015-modules-umd": "^6.24.1",
|
||||
"babel-preset-babili": "^0.0.10",
|
||||
"babel-preset-es2017": "^6.24.1",
|
||||
"browserify": "^16.2.2",
|
||||
"chai": "^3.5.0",
|
||||
"chromedriver": "^2.38.3",
|
||||
"eslint": "^3.9.1",
|
||||
"finalhandler": "^1.1.0",
|
||||
"geckodriver": "^1.11.0",
|
||||
"global-replaceify": "^1.0.0",
|
||||
"grunt": "^1.0.1",
|
||||
"grunt-babel": "^6.0.0",
|
||||
"grunt-contrib-concat": "^1.0.1",
|
||||
|
|
@ -35,9 +39,13 @@
|
|||
"jsdom": "^9.6.0",
|
||||
"mocha": "^3.1.0",
|
||||
"nyc": "^8.3.1",
|
||||
"puppeteer": "^0.10.2",
|
||||
"selenium-webdriver": "^4.0.0-alpha.1",
|
||||
"serve-static": "^1.13.1",
|
||||
"sinon": "^1.17.6"
|
||||
"shelljs": "^0.8.2",
|
||||
"sinon": "^1.17.6",
|
||||
"tap-nirvana": "^1.0.8",
|
||||
"tape-async": "^2.3.0",
|
||||
"tmp": "0.0.33"
|
||||
},
|
||||
"nyc": {
|
||||
"reporter": [
|
||||
|
|
@ -54,6 +62,6 @@
|
|||
"test": "mocha",
|
||||
"test-coverage": "COVERAGE=y nyc mocha",
|
||||
"test-minified": "TEST_MINIFIED_POLYFILL=1 mocha",
|
||||
"test-integration": "mocha -r test/mocha-babel test/integration/test-*"
|
||||
"test-integration": "tape test/integration/test-*"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
const browserify = require("browserify");
|
||||
|
||||
const b = browserify();
|
||||
|
||||
b.add("./test/fixtures/tape-standalone.js");
|
||||
b.transform("global-replaceify", {
|
||||
global: true,
|
||||
replacements: {
|
||||
setImmediate: "require('timers').setImmediate",
|
||||
},
|
||||
});
|
||||
b.bundle().pipe(process.stdout);
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
test("browser api object in content script", (t) => {
|
||||
t.ok(browser && browser.runtime, "a global browser API object should be defined");
|
||||
t.ok(chrome && chrome.runtime, "a global chrome API object should be defined");
|
||||
|
||||
if (navigator.userAgent.includes("Firefox/")) {
|
||||
// Check that the polyfill didn't create a polyfill wrapped browser API object on Firefox.
|
||||
t.equal(browser.runtime, chrome.runtime, "browser.runtime and chrome.runtime should be equal on Firefox");
|
||||
// On Firefox, window is not the global object for content scripts, and so we expect window.browser to not
|
||||
// be defined.
|
||||
t.equal(window.browser, undefined, "window.browser is expected to be undefined on Firefox");
|
||||
} else {
|
||||
// Check that the polyfill has created a wrapped API namespace as expected.
|
||||
t.notEqual(browser.runtime, chrome.runtime, "browser.runtime and chrome.runtime should not be equal");
|
||||
// On chrome, window is the global object and so the polyfilled browser API should
|
||||
// be also equal to window.browser.
|
||||
t.equal(browser, window.browser, "browser and window.browser should be the same object");
|
||||
}
|
||||
});
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
{
|
||||
"manifest_version": 2,
|
||||
"name": "test-detect-browser-api-object-in-content-script",
|
||||
"version": "0.1",
|
||||
"description": "test-detect-browser-api-object-in-content-script",
|
||||
"content_scripts": [
|
||||
{
|
||||
"matches": [
|
||||
"http://localhost/*"
|
||||
],
|
||||
"js": [
|
||||
"browser-polyfill.js",
|
||||
"tape.js",
|
||||
"content.js"
|
||||
]
|
||||
}
|
||||
],
|
||||
"permissions": []
|
||||
}
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
console.log(name, "background page loaded");
|
||||
|
||||
async function testMessageHandler(msg, sender) {
|
||||
console.log(name, "background received msg", {msg, sender});
|
||||
|
||||
// We only expect messages coming from a content script in this test.
|
||||
if (!sender.tab || !msg.startsWith("test-multiple-onmessage-listeners:")) {
|
||||
return {
|
||||
success: false,
|
||||
failureReason: `An unexpected message has been received: ${JSON.stringify({msg, sender})}`,
|
||||
};
|
||||
}
|
||||
|
||||
if (msg.endsWith(":resolve-to-undefined")) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
if (msg.endsWith(":resolve-to-null")) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
success: false,
|
||||
failureReason: `An unexpected message has been received: ${JSON.stringify({msg, sender})}`,
|
||||
};
|
||||
}
|
||||
|
||||
// Register the same message handler twice.
|
||||
browser.runtime.onMessage.addListener(testMessageHandler);
|
||||
browser.runtime.onMessage.addListener(testMessageHandler);
|
||||
|
||||
// Register an additional message handler that always reply after
|
||||
// a small latency time.
|
||||
browser.runtime.onMessage.addListener(async (msg, sender) => {
|
||||
await new Promise(resolve => setTimeout(resolve, 100));
|
||||
return "resolved-to-string-with-latency";
|
||||
});
|
||||
|
||||
console.log(name, "background page ready to receive a content script message...");
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
test("Multiple runtime.onmessage listeners which resolve to undefined", async (t) => {
|
||||
const res = await browser.runtime.sendMessage("test-multiple-onmessage-listeners:resolve-to-undefined");
|
||||
|
||||
if (navigator.userAgent.includes("Firefox/")) {
|
||||
t.deepEqual(res, undefined, "Got an undefined value as expected");
|
||||
} else {
|
||||
// NOTE: When an onMessage listener sends `undefined` in a response,
|
||||
// Chrome internally converts it to null and the receiver receives it
|
||||
// as a null object.
|
||||
t.deepEqual(res, null, "Got a null value as expected on Chrome");
|
||||
}
|
||||
});
|
||||
|
||||
test("Multiple runtime.onmessage listeners which resolve to null", async (t) => {
|
||||
const res = await browser.runtime.sendMessage("test-multiple-onmessage-listeners:resolve-to-null");
|
||||
|
||||
t.deepEqual(res, null, "Got a null value as expected");
|
||||
});
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"manifest_version": 2,
|
||||
"name": "test-multiple-onmessage-listeners",
|
||||
"version": "0.1",
|
||||
"description": "test-multiple-onmessage-listeners",
|
||||
"content_scripts": [
|
||||
{
|
||||
"matches": [
|
||||
"http://localhost/*"
|
||||
],
|
||||
"js": [
|
||||
"browser-polyfill.js",
|
||||
"tape.js",
|
||||
"content.js"
|
||||
]
|
||||
}
|
||||
],
|
||||
"permissions": [],
|
||||
"background": {
|
||||
"scripts": [
|
||||
"browser-polyfill.js",
|
||||
"background.js"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -39,6 +39,12 @@ browser.runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||
case "test - sendMessage with returned rejected Promise with non-Error value":
|
||||
return Promise.reject("rejected-non-error-value");
|
||||
|
||||
case "test - sendMessage with returned rejected Promise with non-Error value with message property":
|
||||
return Promise.reject({message: "rejected-non-error-message"});
|
||||
|
||||
case "test - sendMessage with listener callback throws":
|
||||
throw new Error("listener throws");
|
||||
|
||||
default:
|
||||
return Promise.resolve(
|
||||
`Unxpected message received by the background page: ${JSON.stringify(msg)}\n`);
|
||||
|
|
|
|||
|
|
@ -1,29 +1,26 @@
|
|||
const {name} = browser.runtime.getManifest();
|
||||
test("sendMessage with returned Promise reply", async (t) => {
|
||||
const reply = await browser.runtime.sendMessage("test - sendMessage with returned Promise reply");
|
||||
t.equal(reply, "bg page reply 1");
|
||||
});
|
||||
|
||||
async function runTest() {
|
||||
let reply;
|
||||
reply = await browser.runtime.sendMessage("test - sendMessage with returned Promise reply");
|
||||
console.log(name, "test - returned resolved Promise - received", reply);
|
||||
test("sendMessage with returned value reply", async (t) => {
|
||||
const reply = await browser.runtime.sendMessage("test - sendMessage with returned value reply");
|
||||
t.equal(reply, "second listener reply");
|
||||
});
|
||||
|
||||
reply = await browser.runtime.sendMessage("test - sendMessage with returned value reply");
|
||||
console.log(name, "test - returned value - received", reply);
|
||||
test("sendMessage with synchronous sendResponse", async (t) => {
|
||||
const reply = await browser.runtime.sendMessage("test - sendMessage with synchronous sendResponse");
|
||||
t.equal(reply, "bg page reply 3");
|
||||
});
|
||||
|
||||
reply = await browser.runtime.sendMessage("test - sendMessage with synchronous sendResponse");
|
||||
console.log(name, "test - synchronous sendResponse - received", reply);
|
||||
test("sendMessage with asynchronous sendResponse", async (t) => {
|
||||
const reply = await browser.runtime.sendMessage("test - sendMessage with asynchronous sendResponse");
|
||||
t.equal(reply, "bg page reply 4");
|
||||
});
|
||||
|
||||
reply = await browser.runtime.sendMessage("test - sendMessage with asynchronous sendResponse");
|
||||
console.log(name, "test - asynchronous sendResponse - received", reply);
|
||||
|
||||
reply = await browser.runtime.sendMessage("test - second listener if the first does not reply");
|
||||
console.log(name, "test - second listener sendResponse - received", reply);
|
||||
|
||||
console.log(name, "content script messages sent");
|
||||
}
|
||||
|
||||
console.log(name, "content script loaded");
|
||||
|
||||
runTest().catch((err) => {
|
||||
console.error("content script error", err);
|
||||
test("second listener if the first does not reply", async (t) => {
|
||||
const reply = await browser.runtime.sendMessage("test - second listener if the first does not reply");
|
||||
t.equal(reply, "second listener reply");
|
||||
});
|
||||
|
||||
test("sendMessage with returned rejected Promise with Error value", async (t) => {
|
||||
|
|
@ -33,6 +30,7 @@ test("sendMessage with returned rejected Promise with Error value", async (t) =>
|
|||
t.fail(`Unexpected successfully reply while expecting a rejected promise`);
|
||||
t.equal(reply, undefined, "Unexpected successfully reply");
|
||||
} catch (err) {
|
||||
t.ok(err instanceof Error, "Got an error object as expected");
|
||||
t.equal(err.message, "rejected-error-value", "Got an error rejection with the expected message");
|
||||
}
|
||||
});
|
||||
|
|
@ -44,9 +42,36 @@ test("sendMessage with returned rejected Promise with non-Error value", async (t
|
|||
t.fail(`Unexpected successfully reply while expecting a rejected promise`);
|
||||
t.equal(reply, undefined, "Unexpected successfully reply");
|
||||
} catch (err) {
|
||||
// Unfortunately Firefox currently reject an error with an undefined
|
||||
// message, in the meantime we just check that the object rejected is
|
||||
// an instance of Error.
|
||||
// Unfortunately Firefox currently rejects an error with an "undefined"
|
||||
// message in Firefox 60 and "An unexpected error occurred" in Firefox 59,
|
||||
// in the meantime we just check that the object rejected is an instance
|
||||
// of Error.
|
||||
t.ok(err instanceof Error, "Got an error object as expected");
|
||||
}
|
||||
});
|
||||
|
||||
test("sendMessage with returned rejected Promise with non-Error value with message property", async (t) => {
|
||||
try {
|
||||
const reply = await browser.runtime.sendMessage(
|
||||
"test - sendMessage with returned rejected Promise with non-Error value with message property");
|
||||
t.fail(`Unexpected successfully reply while expecting a rejected promise`);
|
||||
t.equal(reply, undefined, "Unexpected successfully reply");
|
||||
} catch (err) {
|
||||
// Firefox currently converts any rejection with a message property into an error instance
|
||||
// with the value of that message property as the error message.
|
||||
t.ok(err instanceof Error, "Got an error object as expected");
|
||||
t.equal(err.message, "rejected-non-error-message", "Got an error rejection with the expected message");
|
||||
}
|
||||
});
|
||||
|
||||
test("sendMessage with listener callback throws", async (t) => {
|
||||
try {
|
||||
const reply = await browser.runtime.sendMessage(
|
||||
"test - sendMessage with listener callback throws");
|
||||
t.fail(`Unexpected successfully reply while expecting a rejected promise`);
|
||||
t.equal(reply, undefined, "Unexpected successfully reply");
|
||||
} catch (err) {
|
||||
t.ok(err instanceof Error, "Got an error object as expected");
|
||||
t.equal(err.message, "listener throws", "Got an error with the expected message");
|
||||
}
|
||||
});
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@
|
|||
],
|
||||
"js": [
|
||||
"browser-polyfill.js",
|
||||
"tape.js",
|
||||
"content.js"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
console.log(name, "background page loaded");
|
||||
|
||||
browser.runtime.onMessage.addListener(async (msg, sender, sendResponse) => {
|
||||
console.log(name, "background received msg", {msg, sender});
|
||||
|
||||
// We only expect messages coming from a content script in this test.
|
||||
if (!sender.tab || msg != "test-tabssendMessage-unknown-tabid") {
|
||||
return {
|
||||
success: false,
|
||||
failureReason: `An unexpected message has been received: ${JSON.stringify({msg, sender})}`,
|
||||
};
|
||||
}
|
||||
|
||||
try {
|
||||
const tabs = await browser.tabs.query({});
|
||||
const lastValidTabId = tabs.reduce((acc, tab) => {
|
||||
return Math.max(acc, tab.id);
|
||||
}, 0);
|
||||
const INVALID_TABID = lastValidTabId + 100;
|
||||
|
||||
await browser.tabs.sendMessage(INVALID_TABID, "message-to-unknown-tab");
|
||||
|
||||
return {
|
||||
success: false,
|
||||
failureReason: `browser.tabs.sendMessage should reject on sending messages to non-existing tab`,
|
||||
};
|
||||
} catch (err) {
|
||||
return {
|
||||
success: true,
|
||||
isRejected: true,
|
||||
errorMessage: err.message,
|
||||
};
|
||||
}
|
||||
});
|
||||
|
||||
console.log(name, "background page ready to receive a content script message...");
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
test("tabs.sendMessage reject when sending to unknown tab id", async (t) => {
|
||||
const res = await browser.runtime.sendMessage("test-tabssendMessage-unknown-tabid");
|
||||
t.deepEqual(res, {
|
||||
success: true,
|
||||
isRejected: true,
|
||||
errorMessage: "Could not establish connection. Receiving end does not exist.",
|
||||
}, "The background page got a rejection as expected");
|
||||
});
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"manifest_version": 2,
|
||||
"name": "test-tabs-sendmessage",
|
||||
"version": "0.1",
|
||||
"description": "test-tabs-sendmessage",
|
||||
"content_scripts": [
|
||||
{
|
||||
"matches": [
|
||||
"http://localhost/*"
|
||||
],
|
||||
"js": [
|
||||
"browser-polyfill.js",
|
||||
"tape.js",
|
||||
"content.js"
|
||||
]
|
||||
}
|
||||
],
|
||||
"permissions": [],
|
||||
"background": {
|
||||
"scripts": [
|
||||
"browser-polyfill.js",
|
||||
"background.js"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
const tape = require("tape-async");
|
||||
|
||||
const DEFAULT_TIMEOUT = 500;
|
||||
|
||||
let browser = "unknown";
|
||||
if (navigator.userAgent.includes("Chrome/")) {
|
||||
browser = "Chrome";
|
||||
} else if (navigator.userAgent.includes("Firefox/")) {
|
||||
browser = "Firefox";
|
||||
}
|
||||
|
||||
// Export as a global a wrapped test function which enforces a timeout by default.
|
||||
window.test = (desc, fn) => {
|
||||
tape(`${desc} (${browser})`, async (t) => {
|
||||
t.timeoutAfter(DEFAULT_TIMEOUT);
|
||||
await fn(t);
|
||||
});
|
||||
};
|
||||
|
||||
// Export the rest of the property usually available on the tape test object.
|
||||
window.test.skip = tape.skip.bind(tape);
|
||||
window.test.onFinish = tape.onFinish.bind(tape);
|
||||
window.test.onFailure = tape.onFailure.bind(tape);
|
||||
|
||||
// Configure dump test results into an HTML pre element
|
||||
// added to the test page.
|
||||
const stream = tape.createStream();
|
||||
let results = "";
|
||||
stream.on("data", (result) => {
|
||||
// Skip the TAP protocol version from the collected logs.
|
||||
if (!result.startsWith("TAP version")) {
|
||||
console.log("TAP test result:", result);
|
||||
results += result;
|
||||
}
|
||||
});
|
||||
stream.on("end", () => {
|
||||
try {
|
||||
const el = document.createElement("pre");
|
||||
el.setAttribute("id", "test-results");
|
||||
el.textContent = results;
|
||||
document.body.appendChild(el);
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
} finally {
|
||||
console.log("TAP tests completed.");
|
||||
}
|
||||
});
|
||||
|
|
@ -1,12 +1,89 @@
|
|||
const finalhandler = require("finalhandler");
|
||||
"use strict";
|
||||
|
||||
const fs = require("fs");
|
||||
const http = require("http");
|
||||
const path = require("path");
|
||||
|
||||
const browserify = require("browserify");
|
||||
const finalhandler = require("finalhandler");
|
||||
const serveStatic = require("serve-static");
|
||||
const puppeteer = require("puppeteer");
|
||||
const {Builder, By, until} = require("selenium-webdriver");
|
||||
|
||||
exports.createHTTPServer = async (path) => {
|
||||
var serve = serveStatic(path);
|
||||
const test = require("tape-async");
|
||||
const tmp = require("tmp");
|
||||
const {cp} = require("shelljs");
|
||||
|
||||
var server = http.createServer((req, res) => {
|
||||
const TEST_TIMEOUT = 5000;
|
||||
|
||||
const launchBrowser = async (launchOptions) => {
|
||||
const browser = launchOptions.browser || process.env.TEST_BROWSER_TYPE;
|
||||
const extensionPath = launchOptions.extensionPath;
|
||||
|
||||
let driver;
|
||||
|
||||
if (browser === "chrome") {
|
||||
const chrome = require("selenium-webdriver/chrome");
|
||||
const chromedriver = require("chromedriver");
|
||||
|
||||
if (process.env.HEADLESS === "1") {
|
||||
console.warn("WARN: Chrome doesn't currently support extensions in headless mode. " +
|
||||
"Falling back to non-headless mode");
|
||||
}
|
||||
|
||||
const options = new chrome.Options();
|
||||
options.addArguments([
|
||||
`--load-extension=${extensionPath}`,
|
||||
// See https://docs.travis-ci.com/user/chrome and issue #85 for a rationale.
|
||||
"--no-sandbox",
|
||||
]);
|
||||
|
||||
if (process.env.TEST_NATIVE_CRX_BINDINGS === "1") {
|
||||
console.warn("NOTE: Running tests on a Chrome instance with NativeCrxBindings enabled.");
|
||||
options.addArguments([
|
||||
"--enable-features=NativeCrxBindings",
|
||||
]);
|
||||
}
|
||||
|
||||
driver = await new Builder()
|
||||
.forBrowser("chrome")
|
||||
.setChromeOptions(options)
|
||||
.setChromeService(new chrome.ServiceBuilder(chromedriver.path))
|
||||
.build();
|
||||
} else if (browser === "firefox") {
|
||||
const firefox = require("selenium-webdriver/firefox");
|
||||
const geckodriver = require("geckodriver");
|
||||
const {Command} = require("selenium-webdriver/lib/command");
|
||||
|
||||
const options = new firefox.Options();
|
||||
|
||||
if (process.env.HEADLESS === "1") {
|
||||
options.headless();
|
||||
}
|
||||
|
||||
driver = await new Builder()
|
||||
.forBrowser("firefox")
|
||||
.setFirefoxOptions(options)
|
||||
.setFirefoxService(new firefox.ServiceBuilder(geckodriver.path))
|
||||
.build();
|
||||
|
||||
const command = new Command("install addon")
|
||||
.setParameter("path", extensionPath)
|
||||
.setParameter("temporary", true);
|
||||
|
||||
await driver.execute(command);
|
||||
} else {
|
||||
const errorHelpMsg = (
|
||||
"Set a supported browser (firefox or chrome) " +
|
||||
"using the TEST_BROWSER_TYPE environment var.");
|
||||
throw new Error(`Target browser not supported yet: ${browser}. ${errorHelpMsg}`);
|
||||
}
|
||||
|
||||
return driver;
|
||||
};
|
||||
|
||||
const createHTTPServer = async (path) => {
|
||||
const serve = serveStatic(path);
|
||||
const server = http.createServer((req, res) => {
|
||||
serve(req, res, finalhandler(req, res));
|
||||
});
|
||||
|
||||
|
|
@ -21,24 +98,104 @@ exports.createHTTPServer = async (path) => {
|
|||
});
|
||||
};
|
||||
|
||||
exports.launchPuppeteer = async (puppeteerArgs) => {
|
||||
if (!puppeteerArgs || !Array.isArray(puppeteerArgs)) {
|
||||
throw new Error(`Invalid puppeteer arguments: ${JSON.stringify(puppeteerArgs)}`);
|
||||
async function runExtensionTest(t, server, driver, extensionDirName) {
|
||||
try {
|
||||
const url = `http://localhost:${server.address().port}`;
|
||||
const userAgent = await driver.executeScript(() => window.navigator.userAgent);
|
||||
|
||||
t.pass(`Connected to browser: ${userAgent}"`);
|
||||
|
||||
await driver.get(url);
|
||||
|
||||
// Merge tap results from the connected browser.
|
||||
const el = await driver.wait(until.elementLocated(By.id("test-results")), 10000);
|
||||
const testResults = await el.getAttribute("textContent");
|
||||
console.log(testResults);
|
||||
} catch (err) {
|
||||
t.fail(err);
|
||||
}
|
||||
}
|
||||
|
||||
const args = [].concat(puppeteerArgs);
|
||||
|
||||
// Pass the --no-sandbox chrome CLI option when running the integration tests
|
||||
// on Travis.
|
||||
if (process.env.TRAVIS_CI) {
|
||||
args.push("--no-sandbox");
|
||||
}
|
||||
|
||||
return puppeteer.launch({
|
||||
// Chrome Extensions are not currently supported in headless mode.
|
||||
headless: false,
|
||||
|
||||
// Custom chrome arguments.
|
||||
args,
|
||||
const awaitStreamEnd = (stream) => {
|
||||
return new Promise((resolve, reject) => {
|
||||
stream.on("end", resolve);
|
||||
stream.on("error", reject);
|
||||
});
|
||||
};
|
||||
|
||||
const bundleTapeStandalone = async (destDir) => {
|
||||
const bundleFileName = path.join(destDir, "tape.js");
|
||||
const b = browserify();
|
||||
b.add(path.join(__dirname, "..", "fixtures", "tape-standalone.js"));
|
||||
|
||||
// Inject setImmediate (used internally by tape).
|
||||
b.transform("global-replaceify", {
|
||||
global: true,
|
||||
replacements: {
|
||||
setImmediate: "require('timers').setImmediate",
|
||||
},
|
||||
});
|
||||
|
||||
const stream = b.bundle();
|
||||
const onceStreamEnd = awaitStreamEnd(stream);
|
||||
stream.pipe(fs.createWriteStream(bundleFileName));
|
||||
|
||||
await onceStreamEnd;
|
||||
};
|
||||
|
||||
test.onFailure(() => {
|
||||
process.exit(1);
|
||||
});
|
||||
|
||||
const defineExtensionTests = ({description, extensions}) => {
|
||||
for (const extensionDirName of extensions) {
|
||||
test(`${description} (test extension: ${extensionDirName})`, async (tt) => {
|
||||
let timeout;
|
||||
let driver;
|
||||
let server;
|
||||
let tempDir;
|
||||
|
||||
try {
|
||||
const srcExtensionPath = path.resolve(
|
||||
path.join(__dirname, "..", "fixtures", extensionDirName));
|
||||
const srcPolyfill = path.join(__dirname, "..", "..", "dist", "browser-polyfill.js");
|
||||
|
||||
const tmpDir = tmp.dirSync({unsafeCleanup: true});
|
||||
const extensionPath = path.join(tmpDir.name, extensionDirName);
|
||||
|
||||
cp("-rf", srcExtensionPath, extensionPath);
|
||||
cp("-f", srcPolyfill, extensionPath);
|
||||
cp("-f", `${srcPolyfill}.map`, extensionPath);
|
||||
await bundleTapeStandalone(extensionPath);
|
||||
|
||||
server = await createHTTPServer(path.join(__dirname, "..", "fixtures"));
|
||||
driver = await launchBrowser({extensionPath});
|
||||
await Promise.race([
|
||||
runExtensionTest(tt, server, driver, extensionDirName),
|
||||
new Promise((resolve, reject) => {
|
||||
timeout = setTimeout(() => reject(new Error(`test timeout after ${TEST_TIMEOUT}`)), TEST_TIMEOUT);
|
||||
}),
|
||||
]);
|
||||
} finally {
|
||||
clearTimeout(timeout);
|
||||
if (driver) {
|
||||
await driver.quit();
|
||||
driver = null;
|
||||
}
|
||||
if (server) {
|
||||
server.close();
|
||||
server = null;
|
||||
}
|
||||
if (tempDir) {
|
||||
tempDir.removeCallback();
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
launchBrowser,
|
||||
createHTTPServer,
|
||||
defineExtensionTests,
|
||||
};
|
||||
|
|
|
|||
|
|
@ -0,0 +1,23 @@
|
|||
"use strict";
|
||||
|
||||
const {defineExtensionTests} = require("./setup");
|
||||
|
||||
defineExtensionTests({
|
||||
description: "browser.runtime.onMessage/sendMessage",
|
||||
extensions: ["runtime-messaging-extension"],
|
||||
});
|
||||
|
||||
defineExtensionTests({
|
||||
description: "browser.runtime.onMessage/sendMessage",
|
||||
extensions: ["tabs-sendmessage-extension"],
|
||||
});
|
||||
|
||||
defineExtensionTests({
|
||||
description: "browser.runtime.onMessage/sendMessage",
|
||||
extensions: ["multiple-onmessage-listeners-extension"],
|
||||
});
|
||||
|
||||
defineExtensionTests({
|
||||
description: "polyfill should detect an existent browser API object in content scripts",
|
||||
extensions: ["detect-browser-api-object-in-content-script"],
|
||||
});
|
||||
|
|
@ -1,89 +0,0 @@
|
|||
"use strict";
|
||||
|
||||
const path = require("path");
|
||||
|
||||
const waitUntil = require("async-wait-until");
|
||||
const {deepEqual} = require("chai").assert;
|
||||
|
||||
const {createHTTPServer, launchPuppeteer} = require("./setup");
|
||||
|
||||
const fixtureExtensionDirName = "runtime-messaging-extension";
|
||||
|
||||
const extensionName = require(`../fixtures/${fixtureExtensionDirName}/manifest.json`).name;
|
||||
|
||||
describe("browser.runtime.onMessage/sendMessage", function() {
|
||||
this.timeout(10000);
|
||||
|
||||
it("works as expected on Chrome", async () => {
|
||||
const server = await createHTTPServer(path.join(__dirname, "..", "fixtures"));
|
||||
|
||||
const url = `http://localhost:${server.address().port}`;
|
||||
|
||||
const browser = await launchPuppeteer([
|
||||
`--load-extension=${process.env.TEST_EXTENSIONS_PATH}/${fixtureExtensionDirName}`,
|
||||
]);
|
||||
|
||||
const page = await browser.newPage();
|
||||
|
||||
const pageConsoleMessages = [];
|
||||
const pageErrors = [];
|
||||
|
||||
page.on("console", (...args) => {
|
||||
pageConsoleMessages.push(args);
|
||||
});
|
||||
|
||||
page.on("error", (error) => {
|
||||
pageErrors.push(error);
|
||||
});
|
||||
|
||||
await page.goto(url);
|
||||
|
||||
const expectedConsoleMessages = [
|
||||
[extensionName, "content script loaded"],
|
||||
[extensionName, "test - returned resolved Promise - received", "bg page reply 1"],
|
||||
[extensionName, "test - returned value - received", "second listener reply"],
|
||||
[extensionName, "test - synchronous sendResponse - received", "bg page reply 3"],
|
||||
[extensionName, "test - asynchronous sendResponse - received", "bg page reply 4"],
|
||||
[extensionName, "test - second listener sendResponse - received", "second listener reply"],
|
||||
[extensionName, "content script messages sent"],
|
||||
];
|
||||
|
||||
const lastExpectedMessage = expectedConsoleMessages.slice(-1).pop();
|
||||
|
||||
let unexpectedException;
|
||||
|
||||
try {
|
||||
// Wait until the last expected message has been received.
|
||||
await waitUntil(() => {
|
||||
return pageConsoleMessages.filter((msg) => {
|
||||
return msg[0] === lastExpectedMessage[0] && msg[1] === lastExpectedMessage[1];
|
||||
}).length > 0;
|
||||
}, 5000);
|
||||
} catch (error) {
|
||||
// Collect any unexpected exception (e.g. a timeout error raised by waitUntil),
|
||||
// it will be part of the deepEqual assertion of the results.
|
||||
unexpectedException = error;
|
||||
}
|
||||
|
||||
let actualResults = {
|
||||
consoleMessages: pageConsoleMessages,
|
||||
unexpectedException,
|
||||
};
|
||||
|
||||
let expectedResults = {
|
||||
consoleMessages: expectedConsoleMessages,
|
||||
unexpectedException: undefined,
|
||||
};
|
||||
|
||||
try {
|
||||
deepEqual(actualResults, expectedResults, "Got the expected results");
|
||||
} finally {
|
||||
// ensure that we close the browser and the test HTTP server before exiting
|
||||
// the test, even when the assertions fails.
|
||||
await Promise.all([
|
||||
browser.close(),
|
||||
new Promise(resolve => server.close(resolve)),
|
||||
]);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
echo "\nTest webextension-polyfill on real browsers"
|
||||
echo "============================================"
|
||||
|
||||
export PATH=$PATH:./node_modules/.bin/
|
||||
|
||||
## HEADLESS=1 Enable the headless mode (currently used only on Firefox
|
||||
## because Chrome doesn't currently support the extensions in headless mode)
|
||||
export HEADLESS=1
|
||||
|
||||
echo "\nRun smoketests on Chrome"
|
||||
TEST_BROWSER_TYPE=chrome npm run test-integration | tap-nirvana
|
||||
|
||||
echo "\nRun smoketests on Firefox"
|
||||
TEST_BROWSER_TYPE=firefox npm run test-integration | tap-nirvana
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
echo "\nTest webextension-polyfill from an extension running on chrome"
|
||||
echo "==============================================="
|
||||
|
||||
export TEST_EXTENSIONS_PATH=/tmp/browser-polyfill-chrome-smoketests
|
||||
|
||||
MARKER_FILE=$TEST_EXTENSIONS_PATH/.created-for-run-chrome-smoketests
|
||||
|
||||
# Check if the marker file exists and then remove the directory.
|
||||
if [ -f $MARKER_FILE ]; then
|
||||
rm -fr $TEST_EXTENSIONS_PATH
|
||||
fi
|
||||
|
||||
## Exits immediately if the directory already exists (which can only happen in a local
|
||||
## development environment, while this test will usually run on travis).
|
||||
mkdir $TEST_EXTENSIONS_PATH || exit 1
|
||||
touch $MARKER_FILE
|
||||
|
||||
cp -rf test/fixtures/runtime-messaging-extension $TEST_EXTENSIONS_PATH
|
||||
cp -rf dist/browser-polyfill.js* $TEST_EXTENSIONS_PATH/runtime-messaging-extension/
|
||||
|
||||
npm run test-integration
|
||||
Loading…
Reference in New Issue