[java] Implementing getAriaRole and getAccessibleName operations

Author: barancev

java/client/src/org/openqa/selenium/WebElement.java

@@ -170,6 +170,30 @@ default String getDomAttribute(String name) {
    */
   String getAttribute(String name);
 
+  /**
+   * Gets result of computing the WAI-ARIA role of element.
+   * <p>
+   * See <a href="https://www.w3.org/TR/webdriver/#get-computed-role">W3C WebDriver specification</a>
+   * for more details.
+   *
+   * @return the WAI-ARIA role of the element.
+   */
+  default String getAriaRole() {
+    throw new UnsupportedOperationException();
+  }
+
+  /**
+   * Gets result of a Accessible Name and Description Computation for the Accessible Name of the element.
+   * <p>
+   * See <a href="https://www.w3.org/TR/webdriver/#get-computed-label">W3C WebDriver specification</a>
+   * for more details.
+   *
+   * @return the accessible name of the element.
+   */
+  default String getAccessibleName() {
+    throw new UnsupportedOperationException();
+  }
+
   /**
    * Determine whether or not this element is selected or not. This operation only applies to input
    * elements such as checkboxes, options in a select and radio buttons.

java/client/src/org/openqa/selenium/remote/DriverCommand.java

@@ -200,6 +200,14 @@ static CommandPayload GET_ELEMENT_ATTRIBUTE(String id, String name) {
   static CommandPayload GET_ELEMENT_VALUE_OF_CSS_PROPERTY(String id, String name) {
     return new CommandPayload(GET_ELEMENT_VALUE_OF_CSS_PROPERTY, ImmutableMap.of("id", id, "propertyName", name));
   }
+  String GET_ELEMENT_ARIA_ROLE = "getElementAriaRole";
+  static CommandPayload GET_ELEMENT_ARIA_ROLE(String id) {
+    return new CommandPayload(GET_ELEMENT_ARIA_ROLE, ImmutableMap.of("id", id));
+  }
+  String GET_ELEMENT_ACCESSIBLE_NAME = "getElementAccessibleName";
+  static CommandPayload GET_ELEMENT_ACCESSIBLE_NAME(String id) {
+    return new CommandPayload(GET_ELEMENT_ACCESSIBLE_NAME, ImmutableMap.of("id", id));
+  }
   String ELEMENT_EQUALS = "elementEquals";
 
   String SCREENSHOT = "screenshot";

java/client/src/org/openqa/selenium/remote/RemoteWebElement.java

@@ -155,6 +155,20 @@ public String getAttribute(String name) {
         .getValue());
   }
 
+  @Override
+  public String getAriaRole() {
+    return stringValueOf(
+      execute(DriverCommand.GET_ELEMENT_ARIA_ROLE(id))
+        .getValue());
+  }
+
+  @Override
+  public String getAccessibleName() {
+    return stringValueOf(
+      execute(DriverCommand.GET_ELEMENT_ACCESSIBLE_NAME(id))
+        .getValue());
+  }
+
   private static String stringValueOf(Object o) {
     if (o == null) {
       return null;

java/client/src/org/openqa/selenium/remote/codec/w3c/W3CHttpCommandCodec.java

@@ -37,6 +37,8 @@
 import static org.openqa.selenium.remote.DriverCommand.GET_CURRENT_WINDOW_HANDLE;
 import static org.openqa.selenium.remote.DriverCommand.GET_CURRENT_WINDOW_POSITION;
 import static org.openqa.selenium.remote.DriverCommand.GET_CURRENT_WINDOW_SIZE;
+import static org.openqa.selenium.remote.DriverCommand.GET_ELEMENT_ACCESSIBLE_NAME;
+import static org.openqa.selenium.remote.DriverCommand.GET_ELEMENT_ARIA_ROLE;
 import static org.openqa.selenium.remote.DriverCommand.GET_ELEMENT_ATTRIBUTE;
 import static org.openqa.selenium.remote.DriverCommand.GET_ELEMENT_DOM_ATTRIBUTE;
 import static org.openqa.selenium.remote.DriverCommand.GET_ELEMENT_LOCATION;
@@ -162,6 +164,8 @@ public W3CHttpCommandCodec() {
     String elementId = sessionId + "/element/:id";
     defineCommand(GET_ELEMENT_DOM_PROPERTY, get(elementId + "/property/:name"));
     defineCommand(GET_ELEMENT_DOM_ATTRIBUTE, get(elementId + "/attribute/:name"));
+    defineCommand(GET_ELEMENT_ARIA_ROLE, get(elementId + "/computedrole"));
+    defineCommand(GET_ELEMENT_ACCESSIBLE_NAME, get(elementId + "/computedlabel"));
 
     // Emulate the old Actions API since everyone still likes to call these things.
     alias(CLICK, ACTIONS);

java/client/test/org/openqa/selenium/ElementAccessibleNameTest.java

@@ -0,0 +1,36 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.openqa.selenium;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.Test;
+import org.openqa.selenium.environment.webserver.Page;
+import org.openqa.selenium.testing.JUnit4TestBase;
+
+public class ElementAccessibleNameTest extends JUnit4TestBase {
+
+  @Test
+  public void shouldReturnAccessibleName() {
+    driver.get(appServer.create(
+      new Page().withTitle("Testing Aria Role")
+        .withBody("<h1>Level 1 Header</h1>")));
+    WebElement header1 = driver.findElement(By.cssSelector("h1"));
+    assertThat(header1.getAccessibleName()).isEqualTo("Level 1 Header");
+  }
+}

java/client/test/org/openqa/selenium/ElementAriaRoleTest.java

@@ -0,0 +1,54 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.openqa.selenium;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.Test;
+import org.openqa.selenium.environment.webserver.Page;
+import org.openqa.selenium.testing.JUnit4TestBase;
+
+public class ElementAriaRoleTest extends JUnit4TestBase {
+
+  @Test
+  public void shouldReturnExplicitlySpecifiedRole() {
+    driver.get(appServer.create(
+      new Page().withTitle("Testing Aria Role")
+        .withBody("<div role='heading' aria-level='1'>Level 1 Header</div>")));
+    WebElement header1 = driver.findElement(By.cssSelector("div"));
+    assertThat(header1.getAriaRole()).isEqualTo("heading");
+  }
+
+  @Test
+  public void shouldReturnImplicitRoleDefinedByTagName() {
+    driver.get(appServer.create(
+      new Page().withTitle("Testing Aria Role")
+        .withBody("<h1>Level 1 Header</h1>")));
+    WebElement header1 = driver.findElement(By.cssSelector("h1"));
+    assertThat(header1.getAriaRole()).isEqualTo("heading");
+  }
+
+  @Test
+  public void shouldReturnExplicitRoleEvenIfItContradictsTagName() {
+    driver.get(appServer.create(
+      new Page().withTitle("Testing Aria Role")
+        .withBody("<h1 role='alert'>Level 1 Header</h1>")));
+    WebElement header1 = driver.findElement(By.cssSelector("h1"));
+    assertThat(header1.getAriaRole()).isEqualTo("alert");
+  }
+}