Improved xpath matching related elements to handle input associated to different <form>

Added @Form attribute check, because it's possible to put <input/> into a form which is not related to it, see MDN https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#form

Author: oleg-andreyev

lib/AbstractWebDriverCheckboxOrRadio.php

@@ -218,12 +218,17 @@ protected function getRelatedElements($value = null)
             }
         }
 
-        return $this->element->findElements(WebDriverBy::xpath(sprintf(
-            '//form[@id = %1$s]//input[@name = %2$s%3$s] | //input[@form = %1$s and @name = %2$s%3$s]',
-            XPathEscaper::escapeQuotes($formId),
-            XPathEscaper::escapeQuotes($this->name),
-            $valueSelector
-        )));
+        // https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#form
+        return $this->element->findElements(
+            WebDriverBy::xpath(sprintf(
+                '//form[@id = %1$s]//input[@name = %2$s%3$s'
+                . ' and ((boolean(@form) = true() and @form = %1$s) or boolean(@form) = false())]'
+                . ' | //input[@form = %1$s and @name = %2$s%3$s]',
+                XPathEscaper::escapeQuotes($formId),
+                XPathEscaper::escapeQuotes($this->name),
+                $valueSelector
+            ))
+        );
     }
 
     /**

tests/functional/WebDriverCheckboxesTest.php

@@ -51,6 +51,12 @@ public function testGetFirstSelectedOption()
         $this->assertSame('j2a', $c->getFirstSelectedOption()->getAttribute('value'));
     }
 
+    public function testGetFirstSelectedOptionWithSameNameDifferentForm()
+    {
+        $radio = new WebDriverCheckboxes($this->driver->findElement(WebDriverBy::xpath('//input[@id="j5b"]')));
+        $this->assertEquals('j5b', $radio->getFirstSelectedOption()->getAttribute('value'));
+    }
+
     public function testSelectByValue()
     {
         $selectedOptions = ['j2b', 'j2c'];

tests/functional/WebDriverRadiosTest.php

@@ -55,6 +55,12 @@ public function testGetFirstSelectedOption()
         $this->assertSame('j3a', $c->getFirstSelectedOption()->getAttribute('value'));
     }
 
+    public function testGetFirstSelectedOptionWithSameNameDifferentForm()
+    {
+        $radio = new WebDriverRadios($this->driver->findElement(WebDriverBy::xpath('//input[@id="j4b"]')));
+        $this->assertEquals('j4b', $radio->getFirstSelectedOption()->getAttribute('value'));
+    }
+
     public function testSelectByValue()
     {
         $c = new WebDriverRadios($this->driver->findElement(WebDriverBy::xpath('//input[@type="radio"]')));

tests/functional/web/form_checkbox_radio.html

@@ -27,6 +27,12 @@
         <input type="radio" name="j3" value="j3b">
     </label>
 
+    <label for="j4a">J4A</label>
+    <input type="radio" form="yet-another-form" name="j4" value="j4a" id="j4a" checked/>
+
+    <label for="j5a">J5A</label>
+    <input type="checkbox" form="yet-another-form" name="j5" value="j5a" id="j5a" checked/>
+
     <input type="submit" value="OK">
 </form>
 
@@ -36,7 +42,13 @@
 <label for="j3c">J3C</label>
 <input type="radio" form="another-form" name="j3" value="j3c" id="j3c">
 
-<form>
+<label for="j4b">J4B</label>
+<input type="radio" form="another-form" name="j4" value="j4b" id="j4b" checked>
+
+<label for="j5b">J5B</label>
+<input type="checkbox" form="another-form" name="j5" value="j5b" id="j5b" checked>
+
+<form id="yet-another-form">
     <input type="checkbox" name="single-cb">
 </form>
 </body>