Issue 1135: More changes for accessibility (#3011)

labkey-susanh · web-flow · commit a355dbcf4f39 · 2026-05-27T09:12:25.000-07:00
diff --git a/src/org/labkey/test/LabKeySiteWrapper.java b/src/org/labkey/test/LabKeySiteWrapper.java
@@ -409,7 +409,7 @@ public void attemptSignIn(String email, String password)
         assertElementPresent(Locator.tagWithName("form", "login"));
         setFormElement(Locator.id("email"), email);
         setFormElement(Locator.id("password"), password);
-        WebElement signInButton = Locator.lkButton("Sign In").findElement(getDriver());
+        WebElement signInButton = Locator.button("Sign In").findElement(getDriver());
         doAndMaybeWaitForPageToLoad(10_000, () -> {
             signInButton.click();
             shortWait().until(ExpectedConditions.invisibilityOfElementLocated(Locator.byClass("signing-in-msg")));
diff --git a/src/org/labkey/test/components/react/BaseReactSelect.java b/src/org/labkey/test/components/react/BaseReactSelect.java
@@ -612,21 +612,16 @@ public BaseReactSelectFinder<Select> withLabelForNamedInput(String label)
             return this;
         }
 
-        /* use this to find a reactSelect when the label text is contained within a label/span*/
-        public BaseReactSelectFinder<Select> withLabelwithSpan(String labelSpanText)
+        /* use this to find a reactSelect when the label text is contained within a span/span*/
+        public BaseReactSelectFinder<Select> withSpanLabel(String spanText)
         {
-            return followingLabelWithSpan(labelSpanText);
-        }
-
-        public BaseReactSelectFinder<Select> followingLabelWithSpan(String labelText)
-        {
-            _locator = Locators.containerWithDescendant(Locator.tag("label").withChild(Locator.tagWithText("span", labelText)));
+            _locator = Locators.containerWithDescendant(Locator.tagWithClassContaining("span", "control-label").withDescendant(Locator.tag("span").withText(spanText)));
             return this;
         }
 
-        public BaseReactSelectFinder<Select> followingLabelWithClass(String cls)
+        public BaseReactSelectFinder<Select> followingSpanWithClass(String cls)
         {
-            _locator = Locators.containerWithDescendant(Locator.tagWithClass("label", cls));
+            _locator = Locators.containerWithDescendant(Locator.tagWithClass("span", cls));
             return this;
         }
 
@@ -639,15 +634,15 @@ public BaseReactSelectFinder<Select> followingLabelWithClass(String cls)
         public BaseReactSelectFinder<Select> withinFormGroup(String labelText)
         {
             _locator = Locator.tagWithClass("div", "form-group")
-                    .withChild(Locator.tag("label").withPredicate("text() = " + Locator.xq(labelText)))
+                    .withChild(Locator.byClass("control-label").withPredicate("text() = " + Locator.xq(labelText)))
                     .descendant(Locators.selectContainer());
             return this;
         }
 
         public BaseReactSelectFinder<Select> withinFormGroupSkipSelect(String labelText)
         {
             _locator = Locator.tagWithClass("div", "form-group")
-                    .withChild(Locator.tag("label").withChild(Locator.tagWithText("span", labelText)));
+                    .withChild(Locator.byClass("control-label").withChild(Locator.tagWithText("span", labelText)));
             return this;
         }
 
diff --git a/src/org/labkey/test/components/ui/entities/EntityBulkDialog.java b/src/org/labkey/test/components/ui/entities/EntityBulkDialog.java
@@ -175,12 +175,12 @@ protected abstract class ElementCache extends ModalDialog.ElementCache
          */
         public abstract WebElement formRow(CharSequence fieldIdentifier);
 
-        // For composite fields (e.g. StoredAmount + Units) that render a <div> label instead of <label for="...">,
+        // For composite fields (e.g. StoredAmount + Units) that render a <span> label instead of <label for="...">,
         private WebElement formRowByControlLabel(String fieldLabel)
         {
             return _rows.computeIfAbsent(fieldLabel, k ->
                     Locator.tagWithClass("div", "row")
-                            .withChild(Locator.tagWithClass("div", "control-label").withText(fieldLabel))
+                            .withChild(Locator.tagWithClass("span", "control-label").withText(fieldLabel))
                             .waitForElement(this, WAIT_FOR_JAVASCRIPT));
         }
 
diff --git a/src/org/labkey/test/components/ui/entities/EntityBulkInsertDialog.java b/src/org/labkey/test/components/ui/entities/EntityBulkInsertDialog.java
@@ -428,7 +428,7 @@ public WebElement formRow(CharSequence fieldIdentifier)
             return _rows.computeIfAbsent(fieldKey, fk ->
                 Locator.tagWithClass("div", "row")
                     // TODO: Shouldn't need to be case-insensitive. Parent/source lookups have weird casing
-                    .withDescendant(Locator.tagWithAttributeIgnoreCase("label", "for", fieldKey))
+                    .withDescendant(Locator.tagWithAttributeIgnoreCase("span", "data-fieldkey", fieldKey))
                     .findElement(this));
         }
 
diff --git a/src/org/labkey/test/components/ui/entities/EntityBulkUpdateDialog.java b/src/org/labkey/test/components/ui/entities/EntityBulkUpdateDialog.java
@@ -18,6 +18,7 @@
 import org.labkey.test.params.FieldDefinition;
 import org.labkey.test.params.FieldKey;
 import org.labkey.test.util.AuditLogHelper;
+import org.openqa.selenium.NoSuchElementException;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.support.ui.ExpectedConditions;
@@ -26,6 +27,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.time.Duration;
+import java.util.ArrayList;
 import java.util.List;
 
 /**
@@ -325,15 +327,29 @@ public String getWarningAlertText()
 
     public List<String> getFieldNames()
     {
-        List<WebElement> labels = Locator.tagWithClass("label", "control-label").withAttribute("for")
-                .waitForElements(elementCache(), 2_000);
+        List<WebElement> controlLabels = Locator.byClass("control-label").waitForElements(elementCache(), 2_000);
+        List<String> names = new ArrayList<>();
+        for (WebElement label : controlLabels)
+        {
+            if (label.getAttribute("data-fieldkey") == null)
+                try
+                {
+                    label = label.findElement(Locator.tagWithAttribute("span", "data-fieldkey"));
+                }
+                catch (NoSuchElementException e)
+                {
+                    throw new RuntimeException("Could not find field key for label: " + label.getText(), e);
+                }
+            String attribute = label.getAttribute("data-fieldkey");
+            names.add(FieldKey.fromFieldKey(attribute).getFullName());
+        }
 
         // Amount and Units is an example that has a "hide-label" for StoredAmount
         List<WebElement> hiddenLabels = Locator.tagWithClass("label", "hide-label").withAttribute("for")
                 .findElements(elementCache());
-        labels.addAll(hiddenLabels);
+        names.addAll(hiddenLabels.stream().map(a -> FieldKey.fromFieldKey(a.getDomAttribute("for")).getFullName()).toList());
 
-        return labels.stream().map(a -> FieldKey.fromFieldKey(a.getDomAttribute("for")).getFullName()).toList();
+        return names;
     }
 
     public EntityBulkUpdateDialog waitForFieldsToBe(List<String> expectedFieldNames, int waitMilliseconds)
@@ -425,7 +441,7 @@ public WebElement formRow(CharSequence fieldIdentifier)
         {
             String fieldKey = FieldKey.fromName(fieldIdentifier).toString();
             return Locator.tagWithClass("div", "row")
-                    .withDescendant(Locator.tagWithAttribute("label", "for", fieldKey))
+                    .withDescendant(Locator.tagWithAttribute("span", "data-fieldkey", fieldKey))
                     .waitForElement(this, WAIT_TIMEOUT);
         }
 
diff --git a/src/org/labkey/test/components/ui/entities/ParentEntityEditPanel.java b/src/org/labkey/test/components/ui/entities/ParentEntityEditPanel.java
@@ -277,7 +277,7 @@ public ReactSelect getEntityTypeByPosition(int index)
     public ReactSelect getDisabledEntityTypeByLabel(String typeName)
     {
         return ReactSelect.finder(getDriver())
-                .followingLabelWithSpan(typeName)
+                .withSpanLabel(typeName)
                 .waitFor(elementCache());
     }
 
@@ -300,7 +300,7 @@ public ReactSelect getEntityType(String entityName)
      */
     public List<String> getEntityTypeNames()
     {
-        List<WebElement> labels = Locator.tagWithClass("label", "entity-insert--type-select").findElements(elementCache());
+        List<WebElement> labels = Locator.tagWithClass("span", "entity-insert--type-select").findElements(elementCache());
         return labels.stream().map(WebElement::getText).toList();
     }
 
@@ -312,7 +312,7 @@ public List<String> getEntityTypeNames()
     public List<ReactSelect> getAllEntityTypes()
     {
         return ReactSelect.finder(getDriver())
-                .followingLabelWithClass("entity-insert--type-select")
+                .followingSpanWithClass("entity-insert--type-select")
                 .findAll(elementCache());
     }
 
@@ -340,7 +340,7 @@ public FilteringReactSelect getParent(String typeName)
     public List<FilteringReactSelect> getAllParents()
     {
         return FilteringReactSelect.finder(getDriver())
-                .followingLabelWithClass("entity-insert--parent-select")
+                .followingSpanWithClass("entity-insert--parent-select")
                 .findAll(elementCache());
     }
 
diff --git a/src/org/labkey/test/components/ui/grids/DetailDataPanel.java b/src/org/labkey/test/components/ui/grids/DetailDataPanel.java
@@ -44,7 +44,7 @@ public WebDriver getDriver()
     public String getTitle()
     {
         if (_title == null)
-            _title = elementCache().heading.getText();
+            _title = elementCache().headingText.getText();
         return _title;
     }
 
@@ -160,12 +160,15 @@ protected ElementCache newElementCache()
 
     protected class ElementCache extends Component<?>.ElementCache
     {
-        final WebElement heading = Locator.tagWithClass("span", "detail__edit--heading").parent().findWhenNeeded(this);
+        final Locator.XPathLocator editHeadingLocator = Locator.tagWithClass("span", "detail__edit--heading");
+        final Locator.XPathLocator headingLocator = editHeadingLocator.parent();
+        final WebElement editHeading = editHeadingLocator.findWhenNeeded(this);
+        final WebElement headingText = headingLocator.childTag("span").findWhenNeeded(this);
 
         public Optional<WebElement> editButton()
         {
             return Locator.byClass("detail__edit-button")
-                    .findOptionalElement(heading);
+                    .findOptionalElement(editHeading);
         }
 
         // If this panel is for an aliquot sample there will be more than one table present.
@@ -223,7 +226,7 @@ protected Locator locator()
                 return _baseLocatorAsTooltip;
             else if (_title != null)
                 return _baseLocator.withChild(Locator.byClass("panel-heading")
-                        .withText(_title));
+                        .withText().containing(_title));
             else
                 return _baseLocator;
         }
diff --git a/src/org/labkey/test/components/ui/grids/DetailTableEdit.java b/src/org/labkey/test/components/ui/grids/DetailTableEdit.java
@@ -667,7 +667,7 @@ public DetailTableEditFinder(WebDriver driver)
         public DetailTableEditFinder withTitle(String title)
         {
             _locator = _baseLocator.withDescendant(Locator.tagWithClass("span", "detail__edit--heading")
-                .parent().withText(title));
+                .parent().childTag("span").withText(title));
             return this;
         }
 
diff --git a/src/org/labkey/test/components/ui/grids/ParentDetailPanel.java b/src/org/labkey/test/components/ui/grids/ParentDetailPanel.java
@@ -200,8 +200,9 @@ public ResponsiveGrid<?> responsiveGridFor(String type)
     public static class ParentDetailPanelFinder extends WebDriverComponentFinder<ParentDetailPanel, ParentDetailPanelFinder>
     {
         private final Locator.XPathLocator _baseLocator = Locator.tagWithClass("div", "panel-default")
-                .withChild(Locator.byClass("panel-heading")
-                .withChild(Locator.tagWithClass("span", "detail__edit--heading")));
+                .withChild(
+                        Locator.byClass("panel-heading").withChild(Locator.tagWithClass("span", "detail__edit--heading"))
+                );
         private String _title = null;
 
         public ParentDetailPanelFinder(WebDriver driver)
diff --git a/src/org/labkey/test/tests/SecurityTest.java b/src/org/labkey/test/tests/SecurityTest.java
@@ -514,7 +514,7 @@ public void loginSelfRegistrationEnabledTest()
         }
         assertTitleContains(SIGN_IN_TEXT);
         assertElementPresent(Locator.tagWithName("form", "login"));
-        clickAndWait(Locator.lkButton("Register"));
+        clickAndWait(Locator.linkWithText("Register"));
 
         assertTitleContains("Register");
         assertElementPresent(Locator.tagWithName("form", "register"));
@@ -542,7 +542,7 @@ public void loginSelfRegistrationDisabledTest()
             clickAndWait(Locator.linkWithText(SIGN_IN_TEXT));
         }
         assertTitleContains(SIGN_IN_TEXT);
-        WebElement link = Locator.button("Register").findElementOrNull(getDriver());
+        WebElement link = Locator.linkWithText("Register").findElementOrNull(getDriver());
         assertFalse("Self-registration button is visible", link != null && link.isDisplayed());
 
         beginAt(buildURL("login", "register"));

Original file line number	Diff line number	Diff line change
`@@ -612,21 +612,16 @@ public BaseReactSelectFinder<Select> withLabelForNamedInput(String label)`
`612`	`612`	`return this;`
`613`	`613`	`}`
`614`	`614`
`615`		`- /* use this to find a reactSelect when the label text is contained within a label/span*/`
`616`		`- public BaseReactSelectFinder<Select> withLabelwithSpan(String labelSpanText)`
	`615`	`+ /* use this to find a reactSelect when the label text is contained within a span/span*/`
	`616`	`+ public BaseReactSelectFinder<Select> withSpanLabel(String spanText)`
`617`	`617`	`{`
`618`		`- return followingLabelWithSpan(labelSpanText);`
`619`		`- }`
`620`		`-`
`621`		`- public BaseReactSelectFinder<Select> followingLabelWithSpan(String labelText)`
`622`		`- {`
`623`		`- _locator = Locators.containerWithDescendant(Locator.tag("label").withChild(Locator.tagWithText("span", labelText)));`
	`618`	`+ _locator = Locators.containerWithDescendant(Locator.tagWithClassContaining("span", "control-label").withDescendant(Locator.tag("span").withText(spanText)));`
`624`	`619`	`return this;`
`625`	`620`	`}`
`626`	`621`
`627`		`- public BaseReactSelectFinder<Select> followingLabelWithClass(String cls)`
	`622`	`+ public BaseReactSelectFinder<Select> followingSpanWithClass(String cls)`
`628`	`623`	`{`
`629`		`- _locator = Locators.containerWithDescendant(Locator.tagWithClass("label", cls));`
	`624`	`+ _locator = Locators.containerWithDescendant(Locator.tagWithClass("span", cls));`
`630`	`625`	`return this;`
`631`	`626`	`}`
`632`	`627`
`@@ -639,15 +634,15 @@ public BaseReactSelectFinder<Select> followingLabelWithClass(String cls)`
`639`	`634`	`public BaseReactSelectFinder<Select> withinFormGroup(String labelText)`
`640`	`635`	`{`
`641`	`636`	`_locator = Locator.tagWithClass("div", "form-group")`
`642`		`- .withChild(Locator.tag("label").withPredicate("text() = " + Locator.xq(labelText)))`
	`637`	`+ .withChild(Locator.byClass("control-label").withPredicate("text() = " + Locator.xq(labelText)))`
`643`	`638`	`.descendant(Locators.selectContainer());`
`644`	`639`	`return this;`
`645`	`640`	`}`
`646`	`641`
`647`	`642`	`public BaseReactSelectFinder<Select> withinFormGroupSkipSelect(String labelText)`
`648`	`643`	`{`
`649`	`644`	`_locator = Locator.tagWithClass("div", "form-group")`
`650`		`- .withChild(Locator.tag("label").withChild(Locator.tagWithText("span", labelText)));`
	`645`	`+ .withChild(Locator.byClass("control-label").withChild(Locator.tagWithText("span", labelText)));`
`651`	`646`	`return this;`
`652`	`647`	`}`
`653`	`648`
Original file line number	Diff line number	Diff line change
`@@ -175,12 +175,12 @@ protected abstract class ElementCache extends ModalDialog.ElementCache`
`175`	`175`	`*/`
`176`	`176`	`public abstract WebElement formRow(CharSequence fieldIdentifier);`
`177`	`177`
`178`		`- // For composite fields (e.g. StoredAmount + Units) that render a <div> label instead of <label for="...">,`
	`178`	`+ // For composite fields (e.g. StoredAmount + Units) that render a <span> label instead of <label for="...">,`
`179`	`179`	`private WebElement formRowByControlLabel(String fieldLabel)`
`180`	`180`	`{`
`181`	`181`	`return _rows.computeIfAbsent(fieldLabel, k ->`
`182`	`182`	`Locator.tagWithClass("div", "row")`
`183`		`- .withChild(Locator.tagWithClass("div", "control-label").withText(fieldLabel))`
	`183`	`+ .withChild(Locator.tagWithClass("span", "control-label").withText(fieldLabel))`
`184`	`184`	`.waitForElement(this, WAIT_FOR_JAVASCRIPT));`
`185`	`185`	`}`
`186`	`186`
Original file line number	Diff line number	Diff line change
`@@ -428,7 +428,7 @@ public WebElement formRow(CharSequence fieldIdentifier)`
`428`	`428`	`return _rows.computeIfAbsent(fieldKey, fk ->`
`429`	`429`	`Locator.tagWithClass("div", "row")`
`430`	`430`	`// TODO: Shouldn't need to be case-insensitive. Parent/source lookups have weird casing`
`431`		`- .withDescendant(Locator.tagWithAttributeIgnoreCase("label", "for", fieldKey))`
	`431`	`+ .withDescendant(Locator.tagWithAttributeIgnoreCase("span", "data-fieldkey", fieldKey))`
`432`	`432`	`.findElement(this));`
`433`	`433`	`}`
`434`	`434`
Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ public ReactSelect getEntityTypeByPosition(int index)`
`277`	`277`	`public ReactSelect getDisabledEntityTypeByLabel(String typeName)`
`278`	`278`	`{`
`279`	`279`	`return ReactSelect.finder(getDriver())`
`280`		`- .followingLabelWithSpan(typeName)`
	`280`	`+ .withSpanLabel(typeName)`
`281`	`281`	`.waitFor(elementCache());`
`282`	`282`	`}`
`283`	`283`
`@@ -300,7 +300,7 @@ public ReactSelect getEntityType(String entityName)`
`300`	`300`	`*/`
`301`	`301`	`public List<String> getEntityTypeNames()`
`302`	`302`	`{`
`303`		`- List<WebElement> labels = Locator.tagWithClass("label", "entity-insert--type-select").findElements(elementCache());`
	`303`	`+ List<WebElement> labels = Locator.tagWithClass("span", "entity-insert--type-select").findElements(elementCache());`
`304`	`304`	`return labels.stream().map(WebElement::getText).toList();`
`305`	`305`	`}`
`306`	`306`
`@@ -312,7 +312,7 @@ public List<String> getEntityTypeNames()`
`312`	`312`	`public List<ReactSelect> getAllEntityTypes()`
`313`	`313`	`{`
`314`	`314`	`return ReactSelect.finder(getDriver())`
`315`		`- .followingLabelWithClass("entity-insert--type-select")`
	`315`	`+ .followingSpanWithClass("entity-insert--type-select")`
`316`	`316`	`.findAll(elementCache());`
`317`	`317`	`}`
`318`	`318`
`@@ -340,7 +340,7 @@ public FilteringReactSelect getParent(String typeName)`
`340`	`340`	`public List<FilteringReactSelect> getAllParents()`
`341`	`341`	`{`
`342`	`342`	`return FilteringReactSelect.finder(getDriver())`
`343`		`- .followingLabelWithClass("entity-insert--parent-select")`
	`343`	`+ .followingSpanWithClass("entity-insert--parent-select")`
`344`	`344`	`.findAll(elementCache());`
`345`	`345`	`}`
`346`	`346`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public WebDriver getDriver()`
`44`	`44`	`public String getTitle()`
`45`	`45`	`{`
`46`	`46`	`if (_title == null)`
`47`		`- _title = elementCache().heading.getText();`
	`47`	`+ _title = elementCache().headingText.getText();`
`48`	`48`	`return _title;`
`49`	`49`	`}`
`50`	`50`
`@@ -160,12 +160,15 @@ protected ElementCache newElementCache()`
`160`	`160`
`161`	`161`	`protected class ElementCache extends Component<?>.ElementCache`
`162`	`162`	`{`
`163`		`- final WebElement heading = Locator.tagWithClass("span", "detail__edit--heading").parent().findWhenNeeded(this);`
	`163`	`+ final Locator.XPathLocator editHeadingLocator = Locator.tagWithClass("span", "detail__edit--heading");`
	`164`	`+ final Locator.XPathLocator headingLocator = editHeadingLocator.parent();`
	`165`	`+ final WebElement editHeading = editHeadingLocator.findWhenNeeded(this);`
	`166`	`+ final WebElement headingText = headingLocator.childTag("span").findWhenNeeded(this);`
`164`	`167`
`165`	`168`	`public Optional<WebElement> editButton()`
`166`	`169`	`{`
`167`	`170`	`return Locator.byClass("detail__edit-button")`
`168`		`- .findOptionalElement(heading);`
	`171`	`+ .findOptionalElement(editHeading);`
`169`	`172`	`}`
`170`	`173`
`171`	`174`	`// If this panel is for an aliquot sample there will be more than one table present.`
`@@ -223,7 +226,7 @@ protected Locator locator()`
`223`	`226`	`return _baseLocatorAsTooltip;`
`224`	`227`	`else if (_title != null)`
`225`	`228`	`return _baseLocator.withChild(Locator.byClass("panel-heading")`
`226`		`- .withText(_title));`
	`229`	`+ .withText().containing(_title));`
`227`	`230`	`else`
`228`	`231`	`return _baseLocator;`
`229`	`232`	`}`
Original file line number	Diff line number	Diff line change
`@@ -667,7 +667,7 @@ public DetailTableEditFinder(WebDriver driver)`
`667`	`667`	`public DetailTableEditFinder withTitle(String title)`
`668`	`668`	`{`
`669`	`669`	`_locator = _baseLocator.withDescendant(Locator.tagWithClass("span", "detail__edit--heading")`
`670`		`- .parent().withText(title));`
	`670`	`+ .parent().childTag("span").withText(title));`
`671`	`671`	`return this;`
`672`	`672`	`}`
`673`	`673`