diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
commit | 26a029d407be480d791972afb5975cf62c9360a6 (patch) | |
tree | f435a8308119effd964b339f76abb83a57c29483 /devtools/client/inspector/markup/test/helper_markup_accessibility_navigation.js | |
parent | Initial commit. (diff) | |
download | firefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz firefox-26a029d407be480d791972afb5975cf62c9360a6.zip |
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/client/inspector/markup/test/helper_markup_accessibility_navigation.js')
-rw-r--r-- | devtools/client/inspector/markup/test/helper_markup_accessibility_navigation.js | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/devtools/client/inspector/markup/test/helper_markup_accessibility_navigation.js b/devtools/client/inspector/markup/test/helper_markup_accessibility_navigation.js new file mode 100644 index 0000000000..870a58abf8 --- /dev/null +++ b/devtools/client/inspector/markup/test/helper_markup_accessibility_navigation.js @@ -0,0 +1,92 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +/* eslint no-unused-vars: [2, {"vars": "local"}] */ +/* import-globals-from head.js */ +"use strict"; + +/** + * Execute a keyboard event and check that the state is as expected (focused element, aria + * attribute etc...). + * + * @param {InspectorPanel} inspector + * Current instance of the inspector being tested. + * @param {Object} elms + * Map of elements that will be used to retrieve live references to children + * elements + * @param {Element} focused + * Element expected to be focused + * @param {Element} activedescendant + * Element expected to be the aria activedescendant of the root node + */ +function testNavigationState(inspector, elms, focused, activedescendant) { + const doc = inspector.markup.doc; + const id = activedescendant.getAttribute("id"); + is(doc.activeElement, focused, `Keyboard focus should be set to ${focused}`); + is( + elms.root.elt.getAttribute("aria-activedescendant"), + id, + `Active descendant should be set to ${id}` + ); +} + +/** + * Lookup the provided dotted path ("prop1.subprop2.myProp") in the provided object. + * + * @param {Object} obj + * Object to expand. + * @param {String} path + * Dotted path to use to expand the object. + * @return {?} anything that is found at the provided path in the object. + */ +function lookupPath(obj, path) { + const segments = path.split("."); + return segments.reduce((prev, current) => prev[current], obj); +} + +/** + * Execute a keyboard event and check that the state is as expected (focused element, aria + * attribute etc...). + * + * @param {InspectorPanel} inspector + * Current instance of the inspector being tested. + * @param {Object} elms + * MarkupContainers/Elements that will be used to retrieve references to other + * elements based on objects' paths. + * @param {Object} testData + * - {String} desc: description for better logging. + * - {String} key: keyboard event's key. + * - {Object} options, optional: event data such as shiftKey, etc. + * - {String} focused: path to expected focused element in elms map. + * - {String} activedescendant: path to expected aria-activedescendant element in + * elms map. + * - {String} waitFor, optional: markupview event to wait for if keyboard actions + * result in async updates. Also accepts the inspector event "inspector-updated". + */ +async function runAccessibilityNavigationTest( + inspector, + elms, + { desc, key, options, focused, activedescendant, waitFor } +) { + info(desc); + + const markup = inspector.markup; + const doc = markup.doc; + const win = doc.defaultView; + + let updated; + if (waitFor) { + updated = + waitFor === "inspector-updated" + ? inspector.once(waitFor) + : markup.once(waitFor); + } else { + updated = Promise.resolve(); + } + EventUtils.synthesizeKey(key, options, win); + await updated; + + const focusedElement = lookupPath(elms, focused); + const activeDescendantElement = lookupPath(elms, activedescendant); + testNavigationState(inspector, elms, focusedElement, activeDescendantElement); +} |