Improve a11y by providing the current language (keycloak#20213)

Jay Linski · web-flow · commit 403632438a40 · 2023-05-30T13:46:14.000-04:00
diff --git a/testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/pages/LoginPage.java b/testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/pages/LoginPage.java
@@ -38,6 +38,9 @@ public class LoginPage extends LanguageComboboxAwarePage {
     @ArquillianResource
     protected OAuthClient oauth;
 
+    @FindBy(xpath = "//html")
+    protected WebElement htmlRoot;
+
     @FindBy(id = "username")
     protected WebElement usernameInput;
 
@@ -68,7 +71,6 @@ public class LoginPage extends LanguageComboboxAwarePage {
     @FindBy(className = "alert-success")
     private WebElement loginSuccessMessage;
 
-
     @FindBy(className = "alert-info")
     private WebElement loginInfoMessage;
 
@@ -109,12 +111,15 @@ public void missingPassword(String username) {
         usernameInput.sendKeys(username);
         passwordInput.clear();
         clickLink(submitButton);
-
     }
+
     public void missingUsername() {
         clearUsernameInputAndWaitIfNecessary();
         clickLink(submitButton);
+    }
 
+    public String getHtmlLanguage() {
+        return htmlRoot.getAttribute("lang");
     }
 
     public String getUsername() {
@@ -168,6 +173,7 @@ public String getInstruction() {
     public String getSuccessMessage() {
         return loginSuccessMessage != null ? loginSuccessMessage.getText() : null;
     }
+
     public String getInfoMessage() {
         try {
             return getTextFromElement(loginInfoMessage);
@@ -176,7 +182,6 @@ public String getInfoMessage() {
         }
     }
 
-
     public boolean isCurrent() {
         String realm = "test";
         return isCurrent(realm);
diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/i18n/LoginPageTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/i18n/LoginPageTest.java
@@ -120,6 +120,16 @@ public void uiLocalesParameter() {
         assertEquals("Deutsch", loginPage.getLanguageDropdownText());
     }
 
+    @Test
+    public void htmlLangAttribute() {
+        loginPage.open();
+        assertEquals("en", loginPage.getHtmlLanguage());
+
+        oauth.uiLocales("de");
+        loginPage.open();
+        assertEquals("de", loginPage.getHtmlLanguage());
+    }
+
     @Test
     public void acceptLanguageHeader() throws IOException {
         try(CloseableHttpClient httpClient = (CloseableHttpClient) new HttpClientBuilder().build()) {
diff --git a/themes/src/main/resources/theme/base/account/template.ftl b/themes/src/main/resources/theme/base/account/template.ftl
@@ -1,6 +1,6 @@
 <#macro mainLayout active bodyClass>
 <!doctype html>
-<html>
+<html<#if realm.internationalizationEnabled> lang="${locale.currentLanguageTag}"</#if>>
 <head>
     <meta charset="utf-8">
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
diff --git a/themes/src/main/resources/theme/base/login/template.ftl b/themes/src/main/resources/theme/base/login/template.ftl
@@ -1,6 +1,6 @@
 <#macro registrationLayout bodyClass="" displayInfo=false displayMessage=true displayRequiredFields=false>
 <!DOCTYPE html>
-<html class="${properties.kcHtmlClass!}">
+<html class="${properties.kcHtmlClass!}"<#if realm.internationalizationEnabled> lang="${locale.currentLanguageTag}"</#if>>
 
 <head>
     <meta charset="utf-8">
