Bug 1300811 - Part 6 - test setPopup and getPopup with multiple tabs r?mixedpuppy draft
authorMatthew Wein <mwein@mozilla.com>
Tue, 13 Jun 2017 23:16:48 -0400
changeset 593771 a7bf0532a1452b68f846bf7dc895c2cf9457631e
parent 593770 6d28dfd34a0b3513c518f64d6ef6cba4b68070ee
child 633200 9ccc032bfed279cc1dccc414312ae982a3b4a4b3
push id63794
push usermwein@mozilla.com
push dateWed, 14 Jun 2017 03:42:14 +0000
reviewersmixedpuppy
bugs1300811
milestone56.0a1
Bug 1300811 - Part 6 - test setPopup and getPopup with multiple tabs r?mixedpuppy MozReview-Commit-ID: F0hREZCulF4
mobile/android/components/extensions/test/mochitest/chrome.ini
mobile/android/components/extensions/test/mochitest/test_ext_pageAction_getPopup_setPopup.html
mobile/android/components/extensions/test/mochitest/test_ext_pageAction_popup.html
--- a/mobile/android/components/extensions/test/mochitest/chrome.ini
+++ b/mobile/android/components/extensions/test/mochitest/chrome.ini
@@ -2,9 +2,9 @@
 support-files =
   head.js
   ../../../../../../toolkit/components/extensions/test/mochitest/chrome_cleanup_script.js
 tags = webextensions
 
 [test_ext_browserAction_getTitle_setTitle.html]
 [test_ext_browserAction_onClicked.html]
 [test_ext_pageAction_show_hide.html]
-[test_ext_pageAction_popup.html]
+[test_ext_pageAction_getPopup_setPopup.html]
new file mode 100644
--- /dev/null
+++ b/mobile/android/components/extensions/test/mochitest/test_ext_pageAction_getPopup_setPopup.html
@@ -0,0 +1,209 @@
+<!DOCTYPE HTML>
+<html>
+<head>
+  <title>PageAction Test</title>
+  <script src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
+  <script src="chrome://mochikit/content/tests/SimpleTest/SpawnTask.js"></script>
+  <script src="chrome://mochikit/content/tests/SimpleTest/ExtensionTestUtils.js"></script>
+  <script type="text/javascript" src="head.js"></script>
+  <link rel="stylesheet" href="chrome://mochikit/contents/tests/SimpleTest/test.css"/>
+</head>
+<body>
+
+<script type="text/javascript">
+"use strict";
+
+const {classes: Cc, interfaces: Ci, utils: Cu} = Components;
+
+Cu.import("resource://gre/modules/Services.jsm");
+
+var {PageActions} = Cu.import("resource://gre/modules/PageActions.jsm", {});
+
+let dataURI = "iVBORw0KGgoAAAANSUhEUgAAACQAAAAkCAYAAADhAJiYAAAC4klEQVRYhdWXLWzbQBSADQtDAwsHC1tUhUxqfL67lk2tdn+OJg0ODU0rLByqgqINBY6tmlbn7LMTJ5FaFVVBk1G0oUGjG2jT2Y7jxmmcbU/6iJ+f36fz+e5sGP9riCGm9hB37RG+scd4Yo/wsDXCZyIE2xuXsce4bY+wXkAsQtzYmExrfFgvkJkRbkzo1ehoxx5iXcgI/9iYUGt8WH9MqDXEcmNChmEYrRCf2SHWeYgQx3x0tLNRIeKQLTtEFyJEep4NTuhk8BC+yMrwEE3+iozo42d8gK7FAOkMsRiiN8QhW2ttSK5QTfRRV4QoymVeJMvPvDp7gCZigD613MN6yRFA3SWarow9QB9LCfG+NeF9qCtjAKOSQjCqVKhfVsiHEQ+grgx/lRGqUihAc1uL8EFD+KCRO+GrF4J61phcoRoPoEzkYhZYpykh5sMb7kOdIeY+jHKur4QI4Feh4AFX1nVeLxrAvQchGsBz5ls6wa2QdwcvIcE2863bTH79KOvsz/uUYJsp+J0pSzNlDckVqqVGUAF+n6uS7txcOl6wot4JVy70ufDLy4pWLUQVPE81pRI0mGe9oxLMHSeohHvMs/STUNaUK6vDPCvOyxMFDx4achehRDJmHnydnkPww5OFfLxrGIZBFDyYl4LpMzlTQFIP6AQx86w2UeYBccFpJrcKv5L9eGDtUAU6RIELqsB74uynjy/UBRF1gS5BTFxwQT1wTiXoUg9MH7m/3NZRRoi5IJytUbMgzv4Wc832+oQkiKgEehmyMkkpKsFkQV11QsRJL5rJYBLItQgRaUZEmnoZXsomz3vGiWw+I9KMF9SVFOqZEemZekli1jN3U/UOqhHHvC6oWWGElhfSpGdOk6+O9prdwvtLj5BjRsQxdRnot+Zeifpy/2/0stktKTRNLmbk0mwXyl8253fyojj+8rxOHNAhjjm5n0/5OOCGOKBzkrMO0Z75lvSAzKlrF32Z/3z8BqLAn+yMV7VhAAAAAElFTkSuQmCC";
+
+let image = atob(dataURI);
+const IMAGE_ARRAYBUFFER = Uint8Array.from(image, byte => byte.charCodeAt(0)).buffer;
+
+add_task(async function test_setPopup_and_getPopup() {
+  async function background() {
+    let tabCreatedPromise = new Promise(resolve => {
+      let onTabCreated = tab => {
+        browser.tabs.onCreated.removeListener(onTabCreated);
+        resolve();
+      };
+      browser.tabs.onCreated.addListener(onTabCreated);
+    });
+
+    async function createAndTestNewTab(expectedPopup, url) {
+      // Create a tab.
+      let [tab] = await Promise.all([
+        browser.tabs.create({url}),
+        tabCreatedPromise,
+      ]);
+
+      // Test that the default popup is returned before the popup is set for the tab.
+      let defaultPopup = await browser.pageAction.getPopup({tabId: tab.id});
+      browser.test.assertTrue(defaultPopup.includes("default.html"), "Expected the default popup to be returned");
+
+      // Set the title for the new tab and test that getTitle returns the correct title.
+      await browser.pageAction.setPopup({tabId: tab.id, popup: expectedPopup});
+      let actualPopup = await browser.pageAction.getPopup({tabId: tab.id});
+      browser.test.assertTrue(actualPopup.includes(expectedPopup), "Expected the new tab popup to be returned");
+
+      return tab;
+    }
+
+    // Create and test 2 new tabs.
+    let tab1 = await createAndTestNewTab("a.html", "about:blank");
+    let tab2 = await createAndTestNewTab("b.html", "about:blank");
+
+    // Check all of the created tabs now.
+    let popup = await browser.pageAction.getPopup({tabId: tab1.id});
+    browser.test.assertTrue(popup.includes("a.html"), "Expected the first tab popup");
+    popup = await browser.pageAction.getPopup({tabId: tab2.id});
+    browser.test.assertTrue(popup.includes("b.html"), "Expected the second tab popup");
+
+    // Unset the title for the first tab and confirm that it is unset.
+    browser.pageAction.setPopup({tabId: tab1.id, popup: ""});
+    popup = await browser.pageAction.getPopup({tabId: tab1.id});
+    browser.test.assertTrue(popup.includes("default.html"), "Expected the default popup to be returned");
+
+    // Reset the title for the first tab.
+    browser.pageAction.setPopup({tabId: tab1.id, popup: "a.html"});
+    popup = await browser.pageAction.getPopup({tabId: tab1.id});
+    browser.test.assertTrue(popup.includes("a.html"), "Expected the first tab popup");
+
+    // Keeps track of the tabs for which onClicked should fire when the page action is clicked on.
+    let expectingOnClicked = {};
+
+    browser.pageAction.onClicked.addListener(tab => {
+      browser.test.assertTrue(expectingOnClicked[tab.id], "The onClicked listener should only fire when we expect it to.");
+      browser.test.sendMessage("page-action-onClicked-fired");
+    });
+
+    browser.test.onMessage.addListener(async (msg, data) => {
+      if (msg === "select-tab") {
+        await browser.tabs.update(data.tabId, {active: true});
+        browser.test.sendMessage("tab-selected");
+      } else if (msg === "page-action-show") {
+        browser.pageAction.show(data.tabId).then(() => {
+          browser.test.sendMessage("page-action-shown");
+        });
+      } else if (msg == "page-action-set-popup") {
+        if (data.popup == "") {
+          expectingOnClicked[data.tabId] = true;
+        } else {
+          delete expectingOnClicked[tabId];
+        }
+        browser.pageAction.setPopup({tabId: data.tabId, popup: data.popup}).then(() => {
+          browser.test.sendMessage("page-action-popup-set");
+        });
+      } else if (msg == "page-action-get-popup") {
+        browser.pageAction.getPopup({tabId: data.tabId}).then(url => {
+          browser.test.sendMessage("page-action-got-popup", url);
+        });
+      } else if (msg === "finish") {
+        await browser.tabs.remove([tab1.id, tab2.id]);
+        browser.test.notifyPass("page-action-popup");
+      }
+    });
+
+    browser.test.sendMessage("tabs", {tab1, tab2});
+  }
+
+  function popupScript() {
+    window.onload = () => {
+      browser.test.sendMessage("page-action-from-popup", location.href);
+    };
+    browser.test.onMessage.addListener((msg, details) => {
+      if (msg == "page-action-close-popup") {
+        if (details.location == location.href) {
+          window.close();
+        }
+      }
+    });
+  }
+
+  let extension = ExtensionTestUtils.loadExtension({
+    background,
+    manifest: {
+      "name": "PageAction Extension",
+      "page_action": {
+        "default_title": "Page Action",
+        "default_popup": "default.html",
+        "default_icon": {
+          "18": "extension.png",
+        },
+      },
+    },
+    files: {
+      "default.html": `<html><head><meta charset="utf-8"><script src="popup.js"><\/script></head></html>`,
+      "extension.png": IMAGE_ARRAYBUFFER,
+      "a.html": `<html><head><meta charset="utf-8"><script src="popup.js"><\/script></head></html>`,
+      "b.html": `<html><head><meta charset="utf-8"><script src="popup.js"><\/script></head></html>`,
+      "popup.js": popupScript,
+    },
+  });
+
+  let tabClosedPromise = () => {
+    return new Promise(resolve => {
+      let chromeWin = Services.wm.getMostRecentWindow("navigator:browser");
+      let BrowserApp = chromeWin.BrowserApp;
+
+      let tabCloseListener = (event) => {
+        BrowserApp.deck.removeEventListener("TabClose", tabCloseListener);
+        let browser = event.target;
+        let url = browser.currentURI.spec;
+        resolve(url);
+      };
+
+      BrowserApp.deck.addEventListener("TabClose", tabCloseListener);
+    });
+  };
+
+  async function testPopup(tabId, expectedPopup, uuid) {
+    extension.sendMessage("page-action-get-popup", {tabId});
+    let actualPopup = await extension.awaitMessage("page-action-got-popup");
+    ok(actualPopup.includes(expectedPopup), `Expected the correct popup for tab ${tabId}`);
+
+    extension.sendMessage("select-tab", {tabId});
+    await extension.awaitMessage("tab-selected");
+
+    extension.sendMessage("page-action-show", {tabId});
+    await extension.awaitMessage("page-action-shown");
+
+    ok(PageActions.isShown(uuid), "page action is shown");
+    PageActions.synthesizeClick(uuid);
+    let location = await extension.awaitMessage("page-action-from-popup");
+    ok(location.includes(expectedPopup), "The popup with the correct URL should be shown.");
+
+    extension.sendMessage("page-action-close-popup", {location});
+    location = await tabClosedPromise();
+    ok(location.includes(expectedPopup), "The popup with the correct URL should be closed.");
+  }
+
+  await extension.startup();
+
+  let {tab1, tab2} = await extension.awaitMessage("tabs");
+
+  const uuid = `{${extension.uuid}}`;
+  await testPopup(tab1.id, "a.html", uuid);
+  await testPopup(tab2.id, "b.html", uuid);
+
+  // Test that the default popup is used when the first tabs popup is unset.
+  extension.sendMessage("page-action-set-popup", {tabId: tab1.id, popup: ""});
+  await extension.awaitMessage("page-action-popup-set");
+
+  await testPopup(tab1.id, "default.html", uuid);
+
+  extension.sendMessage("finish");
+  await extension.awaitFinish("page-action-popup");
+
+  await extension.unload();
+});
+
+
+</script>
+
+</body>
+</html>
deleted file mode 100644
--- a/mobile/android/components/extensions/test/mochitest/test_ext_pageAction_popup.html
+++ /dev/null
@@ -1,169 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-<head>
-  <title>PageAction Test</title>
-  <script src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
-  <script src="chrome://mochikit/content/tests/SimpleTest/SpawnTask.js"></script>
-  <script src="chrome://mochikit/content/tests/SimpleTest/ExtensionTestUtils.js"></script>
-  <script type="text/javascript" src="head.js"></script>
-  <link rel="stylesheet" href="chrome://mochikit/contents/tests/SimpleTest/test.css"/>
-</head>
-<body>
-
-<script type="text/javascript">
-"use strict";
-
-const {classes: Cc, interfaces: Ci, utils: Cu} = Components;
-
-Cu.import("resource://gre/modules/Services.jsm");
-
-var {PageActions} = Cu.import("resource://gre/modules/PageActions.jsm", {});
-
-let dataURI = "iVBORw0KGgoAAAANSUhEUgAAACQAAAAkCAYAAADhAJiYAAAC4klEQVRYhdWXLWzbQBSADQtDAwsHC1tUhUxqfL67lk2tdn+OJg0ODU0rLByqgqINBY6tmlbn7LMTJ5FaFVVBk1G0oUGjG2jT2Y7jxmmcbU/6iJ+f36fz+e5sGP9riCGm9hB37RG+scd4Yo/wsDXCZyIE2xuXsce4bY+wXkAsQtzYmExrfFgvkJkRbkzo1ehoxx5iXcgI/9iYUGt8WH9MqDXEcmNChmEYrRCf2SHWeYgQx3x0tLNRIeKQLTtEFyJEep4NTuhk8BC+yMrwEE3+iozo42d8gK7FAOkMsRiiN8QhW2ttSK5QTfRRV4QoymVeJMvPvDp7gCZigD613MN6yRFA3SWarow9QB9LCfG+NeF9qCtjAKOSQjCqVKhfVsiHEQ+grgx/lRGqUihAc1uL8EFD+KCRO+GrF4J61phcoRoPoEzkYhZYpykh5sMb7kOdIeY+jHKur4QI4Feh4AFX1nVeLxrAvQchGsBz5ls6wa2QdwcvIcE2863bTH79KOvsz/uUYJsp+J0pSzNlDckVqqVGUAF+n6uS7txcOl6wot4JVy70ufDLy4pWLUQVPE81pRI0mGe9oxLMHSeohHvMs/STUNaUK6vDPCvOyxMFDx4achehRDJmHnydnkPww5OFfLxrGIZBFDyYl4LpMzlTQFIP6AQx86w2UeYBccFpJrcKv5L9eGDtUAU6RIELqsB74uynjy/UBRF1gS5BTFxwQT1wTiXoUg9MH7m/3NZRRoi5IJytUbMgzv4Wc832+oQkiKgEehmyMkkpKsFkQV11QsRJL5rJYBLItQgRaUZEmnoZXsomz3vGiWw+I9KMF9SVFOqZEemZekli1jN3U/UOqhHHvC6oWWGElhfSpGdOk6+O9prdwvtLj5BjRsQxdRnot+Zeifpy/2/0stktKTRNLmbk0mwXyl8253fyojj+8rxOHNAhjjm5n0/5OOCGOKBzkrMO0Z75lvSAzKlrF32Z/3z8BqLAn+yMV7VhAAAAAElFTkSuQmCC";
-
-let image = atob(dataURI);
-const IMAGE_ARRAYBUFFER = Uint8Array.from(image, byte => byte.charCodeAt(0)).buffer;
-
-add_task(function* test_pageAction_withPopup() {
-  function background() {
-    // TODO: Use the Tabs API to obtain the tab ids for showing pageActions.
-    let tabId = 1;
-    let onClickedListenerEnabled = false;
-
-    browser.test.onMessage.addListener((msg, details) => {
-      if (msg === "page-action-show") {
-        // TODO: switch to using .show(tabId).then(...) once bug 1270742 lands.
-        browser.pageAction.show(tabId).then(() => {
-          browser.test.sendMessage("page-action-shown");
-        });
-      } else if (msg == "page-action-set-popup") {
-        browser.pageAction.setPopup({popup: details.name, tabId: tabId}).then(() => {
-          browser.test.sendMessage("page-action-popup-set");
-        });
-      } else if (msg == "page-action-get-popup") {
-        browser.pageAction.getPopup({tabId: tabId}).then(url => {
-          browser.test.sendMessage("page-action-got-popup", url);
-        });
-      } else if (msg == "page-action-enable-onClicked-listener") {
-        onClickedListenerEnabled = true;
-        browser.test.sendMessage("page-action-onClicked-listener-enabled");
-      } else if (msg == "page-action-disable-onClicked-listener") {
-        onClickedListenerEnabled = false;
-        browser.test.sendMessage("page-action-onClicked-listener-disabled");
-      }
-    });
-
-    browser.pageAction.onClicked.addListener(tab => {
-      browser.test.assertTrue(onClickedListenerEnabled, "The onClicked listener should only fire when it is enabled.");
-      browser.test.sendMessage("page-action-onClicked-fired");
-    });
-
-    browser.test.sendMessage("ready");
-  }
-
-  function popupScript() {
-    window.onload = () => {
-      browser.test.sendMessage("page-action-from-popup", location.href);
-    };
-    browser.test.onMessage.addListener((msg, details) => {
-      if (msg == "page-action-close-popup") {
-        if (details.location == location.href) {
-          window.close();
-        }
-      }
-    });
-  }
-
-  let extension = ExtensionTestUtils.loadExtension({
-    background,
-    manifest: {
-      "name": "PageAction Extension",
-      "page_action": {
-        "default_title": "Page Action",
-        "default_popup": "default.html",
-        "default_icon": {
-          "18": "extension.png",
-        },
-      },
-    },
-    files: {
-      "default.html": `<html><head><meta charset="utf-8"><script src="popup.js"><\/script></head></html>`,
-      "extension.png": IMAGE_ARRAYBUFFER,
-      "a.html": `<html><head><meta charset="utf-8"><script src="popup.js"><\/script></head></html>`,
-      "b.html": `<html><head><meta charset="utf-8"><script src="popup.js"><\/script></head></html>`,
-      "popup.js": popupScript,
-    },
-  });
-
-  let tabClosedPromise = () => {
-    return new Promise(resolve => {
-      let chromeWin = Services.wm.getMostRecentWindow("navigator:browser");
-      let BrowserApp = chromeWin.BrowserApp;
-
-      let tabCloseListener = (event) => {
-        BrowserApp.deck.removeEventListener("TabClose", tabCloseListener);
-        let browser = event.target;
-        let url = browser.currentURI.spec;
-        resolve(url);
-      };
-
-      BrowserApp.deck.addEventListener("TabClose", tabCloseListener);
-    });
-  };
-
-  function* testPopup(name, uuid) {
-    // We don't need to set the popup when testing default_popup.
-    if (name != "default.html") {
-      extension.sendMessage("page-action-set-popup", {name});
-      yield extension.awaitMessage("page-action-popup-set");
-    }
-
-    extension.sendMessage("page-action-get-popup");
-    let url = yield extension.awaitMessage("page-action-got-popup");
-
-    if (name == "") {
-      ok(url == name, "Calling pageAction.getPopup should return an empty string when the popup is not set.");
-
-      // The onClicked listener should get called when the popup is set to an empty string.
-      extension.sendMessage("page-action-enable-onClicked-listener");
-      yield extension.awaitMessage("page-action-onClicked-listener-enabled");
-
-      PageActions.synthesizeClick(uuid);
-      yield extension.awaitMessage("page-action-onClicked-fired");
-
-      extension.sendMessage("page-action-disable-onClicked-listener");
-      yield extension.awaitMessage("page-action-onClicked-listener-disabled");
-    } else {
-      ok(url.includes(name), "Calling pageAction.getPopup should return the correct popup URL when the popup is set.");
-
-      PageActions.synthesizeClick(uuid);
-      let location = yield extension.awaitMessage("page-action-from-popup");
-      ok(location.includes(name), "The popup with the correct URL should be shown.");
-
-      extension.sendMessage("page-action-close-popup", {location});
-
-      url = yield tabClosedPromise();
-      ok(url.includes(name), "The tab for the popup should be closed.");
-    }
-  }
-
-  yield extension.startup();
-  yield extension.awaitMessage("ready");
-  const uuid = `{${extension.uuid}}`;
-
-  extension.sendMessage("page-action-show");
-  yield extension.awaitMessage("page-action-shown");
-  ok(PageActions.isShown(uuid), "The PageAction should be shown.");
-
-  yield testPopup("default.html", uuid);
-  yield testPopup("a.html", uuid);
-  yield testPopup("", uuid);
-  yield testPopup("b.html", uuid);
-
-  yield extension.unload();
-  ok(!PageActions.isShown(uuid), "The PageAction should be removed after unload.");
-});
-</script>
-
-</body>
-</html>