The Tor Browser / file revision

 /* Any copyright is dedicated to the Public Domain.

  * http://creativecommons.org/publicdomain/zero/1.0/ */

 let doc = null, toolbox = null, panelWin = null, modifiedPrefs = [];

 function test() {

   waitForExplicitFinish();

   gBrowser.selectedTab = gBrowser.addTab();

   let target = TargetFactory.forTab(gBrowser.selectedTab);

   gBrowser.selectedBrowser.addEventListener("load", function onLoad(evt) {

     gBrowser.selectedBrowser.removeEventListener(evt.type, onLoad, true);

     gDevTools.showToolbox(target)

       .then(testSelectTool)

       .then(testToggleToolboxButtons)

       .then(testPrefsAreRespectedWhenReopeningToolbox)

       .then(cleanup, errorHandler);

   }, true);

   content.location = "data:text/html;charset=utf8,test for dynamically registering and unregistering tools";

 }

 function testPrefsAreRespectedWhenReopeningToolbox() {

   let deferred = promise.defer();

   let target = TargetFactory.forTab(gBrowser.selectedTab);

   info ("Closing toolbox to test after reopening");

   gDevTools.closeToolbox(target).then(() => {

     let target = TargetFactory.forTab(gBrowser.selectedTab);

     gDevTools.showToolbox(target)

       .then(testSelectTool)

       .then(() => {

         info ("Toolbox has been reopened.  Checking UI state.");

         testPreferenceAndUIStateIsConsistent();

         deferred.resolve();

       });

   });

   return deferred.promise;

 }

 function testSelectTool(aToolbox) {

   let deferred = promise.defer();

   info ("Selecting the options panel");

   toolbox = aToolbox;

   doc = toolbox.doc;

   toolbox.once("options-selected", (event, tool) => {

     ok(true, "Options panel selected via selectTool method");

     panelWin = tool.panelWin;

     deferred.resolve();

   });

   toolbox.selectTool("options");

   return deferred.promise;

 }

 function testPreferenceAndUIStateIsConsistent() {

   let checkNodes = [...panelWin.document.querySelectorAll("#enabled-toolbox-buttons-box > checkbox")];

   let toolboxButtonNodes = [...doc.querySelectorAll("#toolbox-buttons > toolbarbutton")];

   let toggleableTools = toolbox.toolboxButtons;

   for (let tool of toggleableTools) {

     let isVisible = getBoolPref(tool.visibilityswitch);

     let button = toolboxButtonNodes.filter(button=>button.id === tool.id)[0];

     is (!button.hasAttribute("hidden"), isVisible, "Button visibility matches pref for " + tool.id);

     let check = checkNodes.filter(node=>node.id === tool.id)[0];

     is (check.checked, isVisible, "Checkbox should be selected based on current pref for " + tool.id);

   }

 }

 function testToggleToolboxButtons() {

   let checkNodes = [...panelWin.document.querySelectorAll("#enabled-toolbox-buttons-box > checkbox")];

   let toolboxButtonNodes = [...doc.querySelectorAll("#toolbox-buttons > toolbarbutton")];

   let visibleButtons = toolboxButtonNodes.filter(button=>!button.hasAttribute("hidden"));

   let toggleableTools = toolbox.toolboxButtons;

   is (checkNodes.length, toggleableTools.length, "All of the buttons are toggleable." );

   is (checkNodes.length, toolboxButtonNodes.length, "All of the DOM buttons are toggleable." );

   for (let tool of toggleableTools) {

     let id = tool.id;

     let matchedCheckboxes = checkNodes.filter(node=>node.id === id);

     let matchedButtons = toolboxButtonNodes.filter(button=>button.id === id);

     ok (matchedCheckboxes.length === 1,

       "There should be a single toggle checkbox for: " + id);

     ok (matchedButtons.length === 1,

       "There should be a DOM button for: " + id);

     is (matchedButtons[0], tool.button,

       "DOM buttons should match for: " + id);

     is (matchedCheckboxes[0].getAttribute("label"), tool.label,

       "The label for checkbox matches the tool definition.")

     is (matchedButtons[0].getAttribute("tooltiptext"), tool.label,

       "The tooltip for button matches the tool definition.")

   }

   // Store modified pref names so that they can be cleared on error.

   for (let tool of toggleableTools) {

     let pref = tool.visibilityswitch;

     modifiedPrefs.push(pref);

   }

   // Try checking each checkbox, making sure that it changes the preference

   for (let node of checkNodes) {

     let tool = toggleableTools.filter(tool=>tool.id === node.id)[0];

     let isVisible = getBoolPref(tool.visibilityswitch);

     testPreferenceAndUIStateIsConsistent();

     toggleButton(node);

     testPreferenceAndUIStateIsConsistent();

     let isVisibleAfterClick = getBoolPref(tool.visibilityswitch);

     is (isVisible, !isVisibleAfterClick,

       "Clicking on the node should have toggled visibility preference for " + tool.visibilityswitch);

   }

   return promise.resolve();

 }

 function getBoolPref(key) {

   return Services.prefs.getBoolPref(key);

 }

 function toggleButton(node) {

   node.scrollIntoView();

   EventUtils.synthesizeMouseAtCenter(node, {}, panelWin);

 }

 function cleanup() {

   toolbox.destroy().then(function() {

     gBrowser.removeCurrentTab();

     for (let pref of modifiedPrefs) {

       Services.prefs.clearUserPref(pref);

     }

     toolbox = doc = panelWin = modifiedPrefs = null;

     finish();

   });

 }

 function errorHandler(error) {

   ok(false, "Unexpected error: " + error);

   cleanup();

 }