diff options
| author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
|---|---|---|
| committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
| commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
| tree | 10027f336435511475e392454359edea8e25895d /devtools/client/inspector/rules/test/browser_rules_context-menu-show-mdn-docs-03.js | |
| parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
| download | UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip | |
Add m-esr52 at 52.6.0
Diffstat (limited to 'devtools/client/inspector/rules/test/browser_rules_context-menu-show-mdn-docs-03.js')
| -rw-r--r-- | devtools/client/inspector/rules/test/browser_rules_context-menu-show-mdn-docs-03.js | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/devtools/client/inspector/rules/test/browser_rules_context-menu-show-mdn-docs-03.js b/devtools/client/inspector/rules/test/browser_rules_context-menu-show-mdn-docs-03.js new file mode 100644 index 000000000..d1089fcf6 --- /dev/null +++ b/devtools/client/inspector/rules/test/browser_rules_context-menu-show-mdn-docs-03.js @@ -0,0 +1,118 @@ +/* vim: set ft=javascript ts=2 et sw=2 tw=80: */ +/* Any copyright is dedicated to the Public Domain. + http://creativecommons.org/publicdomain/zero/1.0/ */ + +/** + * This file tests the "devtools.inspector.mdnDocsTooltip.enabled" preference, + * that we use to enable/disable the MDN tooltip in the Inspector. + * + * The desired behavior is: + * - if the preference is true, show the "Show MDN Docs" context menu item + * - if the preference is false, don't show the item + * - listen for changes to the pref, so we can show/hide the item dynamically + */ + +"use strict"; + +const { PrefObserver } = require("devtools/client/styleeditor/utils"); +const PREF_ENABLE_MDN_DOCS_TOOLTIP = + "devtools.inspector.mdnDocsTooltip.enabled"; +const PROPERTY_NAME_CLASS = "ruleview-propertyname"; + +const TEST_DOC = ` + <html> + <body> + <div style="color: red"> + Test the pref to enable/disable the "Show MDN Docs" context menu option + </div> + </body> + </html> +`; + +add_task(function* () { + info("Ensure the pref is true to begin with"); + let initial = Services.prefs.getBoolPref(PREF_ENABLE_MDN_DOCS_TOOLTIP); + if (initial != true) { + setBooleanPref(PREF_ENABLE_MDN_DOCS_TOOLTIP, true); + } + + yield addTab("data:text/html;charset=utf8," + encodeURIComponent(TEST_DOC)); + + let {inspector, view} = yield openRuleView(); + yield selectNode("div", inspector); + yield testMdnContextMenuItemVisibility(view, true); + + yield setBooleanPref(PREF_ENABLE_MDN_DOCS_TOOLTIP, false); + yield testMdnContextMenuItemVisibility(view, false); + + info("Close the Inspector"); + let target = TargetFactory.forTab(gBrowser.selectedTab); + yield gDevTools.closeToolbox(target); + + ({inspector, view} = yield openRuleView()); + yield selectNode("div", inspector); + yield testMdnContextMenuItemVisibility(view, false); + + yield setBooleanPref(PREF_ENABLE_MDN_DOCS_TOOLTIP, true); + yield testMdnContextMenuItemVisibility(view, true); + + info("Ensure the pref is reset to its initial value"); + let eventual = Services.prefs.getBoolPref(PREF_ENABLE_MDN_DOCS_TOOLTIP); + if (eventual != initial) { + setBooleanPref(PREF_ENABLE_MDN_DOCS_TOOLTIP, initial); + } +}); + +/** + * Set a boolean pref, and wait for the pref observer to + * trigger, so that code listening for the pref change + * has had a chance to update itself. + * + * @param pref {string} Name of the pref to change + * @param state {boolean} Desired value of the pref. + * + * Note that if the pref already has the value in `state`, + * then the prefObserver will not trigger. So you should only + * call this function if you know the pref's current value is + * not `state`. + */ +function* setBooleanPref(pref, state) { + let oncePrefChanged = defer(); + let prefObserver = new PrefObserver("devtools."); + prefObserver.on(pref, oncePrefChanged.resolve); + + info("Set the pref " + pref + " to: " + state); + Services.prefs.setBoolPref(pref, state); + + info("Wait for prefObserver to call back so the UI can update"); + yield oncePrefChanged.promise; + prefObserver.off(pref, oncePrefChanged.resolve); +} + +/** + * Test whether the MDN tooltip context menu item is visible when it should be. + * + * @param view The rule view + * @param shouldBeVisible {boolean} Whether we expect the context + * menu item to be visible or not. + */ +function* testMdnContextMenuItemVisibility(view, shouldBeVisible) { + let message = shouldBeVisible ? "shown" : "hidden"; + info("Test that MDN context menu item is " + message); + + info("Set a CSS property name as popupNode"); + let root = rootElement(view); + let node = root.querySelector("." + PROPERTY_NAME_CLASS).firstChild; + let allMenuItems = openStyleContextMenuAndGetAllItems(view, node); + let menuitemShowMdnDocs = allMenuItems.find(item => item.label === + STYLE_INSPECTOR_L10N.getStr("styleinspector.contextmenu.showMdnDocs")); + + let isVisible = menuitemShowMdnDocs.visible; + is(isVisible, shouldBeVisible, + "The MDN context menu item is " + message); +} + +/** + * Returns the root element for the rule view. + */ +var rootElement = view => (view.element) ? view.element : view.styleDocument; |