Create new test type aamtest for accessibility API testing

.taskcluster.yml

@@ -57,7 +57,7 @@ tasks:
             owner: ${owner}
             source: ${event.repository.clone_url}
           payload:
-            image: ghcr.io/web-platform-tests/wpt:2
+            image: ghcr.io/web-platform-tests/wpt:3
             maxRunTime: 7200
             artifacts:
               public/results:

core-aam/aamtests/attribute/aria_autocomplete_inline_list_both.py

@@ -0,0 +1,33 @@
+import pytest
+
+# Testing: https://w3c.github.io/core-aam/#ariaAutocompleteInlineListBoth
+
+TEST_HTML = {
+    "both": "<input role='combobox' id='test' aria-autocomplete='both'>",
+    "inline": "<input role='combobox' id='test' aria-autocomplete='inline'>",
+    "list": "<input role='combobox' id='test' aria-autocomplete='list'>",
+}
+
+@pytest.mark.parametrize("test_value,test_html", TEST_HTML.items(), ids=TEST_HTML.keys())
+def test_atspi(atspi, session, inline, test_value, test_html):
+    session.url = inline(test_html)
+
+    # Spec:
+    # Object Attribute: autocomplete:<value>
+    # State: STATE_SUPPORTS_AUTOCOMPLETION
+
+    node = atspi.find_node("test", session.url)
+    assert f"autocomplete:{test_value}" in atspi.Accessible.get_attributes_as_array(node)
+    assert "STATE_SUPPORTS_AUTOCOMPLETION" in atspi.get_state_list_helper(node)
+
+# Intentionally no AX API test. AX API does not surface this attribute.
+
+# @pytest.mark.parametrize("test_value,test_html", TEST_HTML.items(), ids=TEST_HTML.keys())
+# def test_ia2(ia2, session, inline, test_value, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Object Attribute: autocomplete:<value>
+#     # State: IA2_STATE_SUPPORTS_AUTOCOMPLETION
+
+# Intentionally no UIA test. UIA does not surface this attribute.

core-aam/aamtests/attribute/aria_braillelabel.py

@@ -0,0 +1,30 @@
+# Testing: https://w3c.github.io/core-aam/#ariaBraillelabel
+
+TEST_HTML = "<button id='test' aria-braillelabel='foobar'> </button>"
+
+def test_atspi(atspi, session, inline):
+    session.url = inline(TEST_HTML)
+
+    # Spec:
+    # Object Attribute: braillelabel:<value>
+
+    node = atspi.find_node("test", session.url)
+    assert "braillelabel:foobar" in atspi.Accessible.get_attributes_as_array(node)
+
+# def test_axapi(axapi, session, inline):
+#     session.url = inline(TEST_HTML)
+#
+#     # Spec:
+#     # AXBrailleLabel: <value>
+
+# def test_ia2(ia2, session, inline):
+#     session.url = inline(TEST_HTML)
+#
+#     # Spec:
+#     # Object Attribute: braillelabel:<value>
+
+# def test_uia(uia, session, inline):
+#     session.url = inline(TEST_HTML)
+#
+#     # Spec:
+#     # Property: AriaProperties.braillelabel: <value>

core-aam/aamtests/attribute/aria_error_message.py

@@ -0,0 +1,39 @@
+# Testing: https://w3c.github.io/core-aam/#ariaErrorMessage
+
+TEST_HTML = "<div role='checkbox' id='test' aria-errormessage='error' aria-invalid='true'>content</div> <div id='error'>hello world</div>"
+
+def test_atspi(atspi, session, inline):
+    session.url = inline(TEST_HTML)
+
+    # Spec:
+    # Relation: RELATION_ERROR_MESSAGE: points to accessible nodes matching IDREFs, if the referenced objects are in the accessibility tree
+    # Reverse Relation: RELATION_ERROR_FOR: points to element
+
+    node = atspi.find_node("test", session.url)
+    relations = atspi.get_relations_dictionary_helper(node)
+    assert 'RELATION_ERROR_MESSAGE' in relations
+    assert 'error' in relations['RELATION_ERROR_MESSAGE']
+    reverse_node = atspi.find_node('error', session.url)
+    reverse_relations = atspi.get_relations_dictionary_helper(reverse_node)
+    assert 'RELATION_ERROR_FOR' in reverse_relations
+    assert 'test' in reverse_relations['RELATION_ERROR_FOR']
+
+# def test_axapi(axapi, session, inline):
+#     session.url = inline(TEST_HTML)
+#
+#     # Spec:
+#     # Property: AXErrorMessageElements: pointers to accessible nodes matching IDREFs
+
+# def test_ia2(ia2, session, inline):
+#     session.url = inline(TEST_HTML)
+#
+#     # Spec:
+#     # Relation: IA2_RELATION_ERROR: points to accessible nodes matching IDREFs, if the referenced objects are in the accessibility tree
+#     # Reverse Relation: IA2_RELATION_ERROR_FOR: points to element
+#     # See also: Mapping Additional Relations
+
+# def test_uia(uia, session, inline):
+#     session.url = inline(TEST_HTML)
+#
+#     # Spec:
+#     # Property: ControllerFor: pointer to the target accessible object

core-aam/aamtests/conftest.py

@@ -0,0 +1,12 @@
+import sys
+from pathlib import Path
+
+# Add webdriver to the Python path so we can import the fixtures
+webdriver_tests_path = Path(__file__).parent.parent.parent / "webdriver"
+sys.path.insert(0, str(webdriver_tests_path))
+
+pytest_plugins = (
+    "tests.support.fixtures",
+    "tests.support.classic.fixtures",
+    "aamtests.support.fixtures_a11y_api",
+)

core-aam/aamtests/role/blockquote.py

@@ -0,0 +1,45 @@
+# Testing: https://w3c.github.io/core-aam/#role-map-blockquote
+
+TEST_HTML = "<div role='blockquote' id='test'>content</div>"
+
+def test_atspi(atspi, session, inline):
+    session.url = inline(TEST_HTML)
+
+    # Spec:
+    # Role: ROLE_BLOCK_QUOTE
+
+    node = atspi.find_node("test", session.url)
+    assert atspi.Accessible.get_role(node) == atspi.Role.BLOCK_QUOTE
+
+def test_axapi(axapi, session, inline):
+    session.url = inline(TEST_HTML)
+
+    # Spec:
+    # AXRole: AXGroup
+    # AXSubrole: <nil>
+
+    node = axapi.find_node("test", session.url)
+    role = axapi.AXUIElementCopyAttributeValue(node, "AXRole", None)[1]
+    assert role == "AXGroup"
+    role = axapi.AXUIElementCopyAttributeValue(node, "AXSubrole", None)[1]
+    assert role == "AXUnknown"
+
+def test_ia2(ia2, session, inline):
+    session.url = inline(TEST_HTML)
+
+    # Spec:
+    # Role: ROLE_SYSTEM_GROUPING
+    # Role: IA2_ROLE_BLOCK_QUOTE
+
+    node = ia2.find_node("test", session.url)
+    assert ia2.get_role(node) == "IA2_ROLE_BLOCK_QUOTE"
+    assert ia2.get_msaa_role(node) == "ROLE_SYSTEM_GROUPING"
+
+
+# def test_uia(uia, session, inline):
+#     session.url = inline(TEST_HTML)
+#     node = uia.find_node("test", session.url)
+#
+#     # Spec:
+#     # Control Type: Group
+#     # Localized Control Type: blockquote

core-aam/aamtests/role/button.py

@@ -0,0 +1,42 @@
+import pytest
+
+# Testing: https://w3c.github.io/core-aam/#role-map-button
+
+TEST_HTML = {
+    "no-attributes": "<div id=test role=button>click me</div>",
+    "aria-pressed-undefined": "<div id=test role=button aria-pressed>click me</div>",
+    "aria-haspopup-undefined": "<div id=test role=button aria-haspopup>click me</div>",
+    "aria-haspopup-false": "<div id=test role=button aria-haspopup=false>click me</div>",
+}
+
+@pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+def test_atspi(atspi, session, inline, test_html):
+    session.url = inline(test_html)
+
+    # Spec:
+    # Role: ROLE_PUSH_BUTTON
+
+    node = atspi.find_node("test", session.url)
+    assert atspi.Accessible.get_role(node) == atspi.Role.PUSH_BUTTON
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_axapi(axapi, session, inline):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # AXRole: AXButton
+#     # AXSubrole: <nil>
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_ia2(ia2, session, inline):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Role: ROLE_SYSTEM_PUSHBUTTON
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_uia(uia, session, inline):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Control Type: Button

core-aam/aamtests/role/button_haspopup.py

@@ -0,0 +1,44 @@
+import pytest
+
+# Testing: https://w3c.github.io/core-aam/#role-map-button-haspopup
+
+TEST_HTML = {
+    "true": "<div id=test role=button aria-haspopup=true>click me</div>",
+    "menu": "<div id=test role=button aria-haspopup=menu>click me</div>",
+    "listbox": "<div id=test role=button aria-haspopup=listbox>click me</div>",
+    "tree": "<div id=test role=button aria-haspopup=tree>click me</div>",
+    "grid": "<div id=test role=button aria-haspopup=grid>click me</div>",
+    "dialog": "<div id=test role=button aria-haspopup=dialog>click me</div>"
+}
+
+@pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+def test_atspi(atspi, session, inline, test_html):
+    session.url = inline(test_html)
+
+    # Spec:
+    # Role: ROLE_PUSH_BUTTON
+
+    node = atspi.find_node("test", session.url)
+    assert atspi.Accessible.get_role(node) == atspi.Role.PUSH_BUTTON
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_axapi(axapi, session, inline, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # AXRole: AXPopUpButton
+#     # AXSubrole: <nil>
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_ia2(ia2, session, inline, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Role: ROLE_SYSTEM_BUTTONMENU
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_uia(uia, session, inline, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Control Type: Button

core-aam/aamtests/role/button_pressed.py

@@ -0,0 +1,41 @@
+import pytest
+
+# Testing: https://w3c.github.io/core-aam/#role-map-button-pressed
+
+TEST_HTML = {
+    "true": "<div id=test role=button aria-pressed=true>press me</div>",
+    "false": "<div id=test role=button aria-pressed=false>press me</div>"
+}
+
+@pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+def test_atspi(atspi, session, inline, test_html):
+    session.url = inline(test_html)
+
+    # Spec:
+    # Role: ROLE_TOGGLE_BUTTON
+
+    node = atspi.find_node("test", session.url)
+    assert atspi.Accessible.get_role(node) == atspi.Role.TOGGLE_BUTTON
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_axapi(axapi, session, inline, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # AXRole: AXCheckBox
+#     # AXSubrole: AXToggle
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_ia2(ia2, session, inline, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Role: ROLE_SYSTEM_PUSHBUTTON
+#     # Role: IA2_ROLE_TOGGLE_BUTTON
+
+# @pytest.mark.parametrize("test_html", TEST_HTML.values(), ids=TEST_HTML.keys())
+# def test_uia(uia, session, inline, test_html):
+#     session.url = inline(test_html)
+#
+#     # Spec:
+#     # Control Type: Button

core-aam/aamtests/support/api_wrapper.py

@@ -0,0 +1,53 @@
+import abc
+import time
+from typing import Any, Callable, Generic, Optional, TypeVar
+
+ApiNode = TypeVar('ApiNode')
+PollResult = TypeVar('PollResult')
+
+class ApiWrapper(Generic[ApiNode], abc.ABC):
+    def __init__(self, pid: int, product_name: str, timeout: float) -> None:
+        """Setup for accessibility API testing.
+
+        :pid: The PID of the process which exposes the accessibility API.
+        :product_name: The name of the browser, used to find the browser in the accessibility API.
+        :timeout: The timeout the test harness has set for this test, local timeouts can be set based on it.
+        """
+        self.product_name: str = product_name
+        self.pid: int = pid
+        self.root: Optional[Any] = None
+        self.document: Optional[ApiNode] = None
+        self.test_url: Optional[str] = None
+        self.timeout: float = timeout
+
+        self.root = self._find_browser()
+
+        if not self.root:
+            raise Exception(
+                f"Couldn't find browser {self.product_name} in accessibility API {self.api_name}."
+            )
+
+    @property
+    @abc.abstractmethod
+    def api_name(self) -> str:
+        pass
+
+    @abc.abstractmethod
+    def _find_browser(self) -> Optional[ApiNode]:
+        pass
+
+    def _poll_for(self, find: Callable[[], Optional[PollResult]], error: str) -> PollResult:
+        """Poll until the `find` function returns something.
+
+        :param url: The url of the test.
+        :return: Whatever find returns.
+        """
+        found = find()
+        stop = time.time() + self.timeout
+        while not found:
+            if time.time() > stop:
+                raise TimeoutError(error)
+            time.sleep(0.01)
+            found = find()
+
+        return found