Refactored button clicking, added tests for full coverage

Author: SamMousa

src/Codeception/Lib/InnerBrowser.php

@@ -439,41 +439,47 @@ protected function clickByLocator($link)
      */
     private function clickButton(\DOMNode $node)
     {
-        $formParams = [];
-        $buttonName = (string)$node->getAttribute('name');
-        $buttonValue = $node->getAttribute('value');
-
-        if ($buttonName !== '' && $buttonValue !== null) {
-            $formParams = [$buttonName => $buttonValue];
+        /**
+         * First we check if the button is associated to a form.
+         * It is associated to a form when it has a nonempty form
+         */
+        $formAttribute = $node->attributes->getNamedItem('form');
+        if (isset($formAttribute)) {
+            $form = empty($formAttribute->nodeValue) ? null : $this->filterByCSS('#' . $formAttribute->nodeValue)->getNode(0);
+        } else {
+            // Check parents
+            $currentNode = $node;
+            $form = null;
+            while ($currentNode->parentNode !== null) {
+                $currentNode = $currentNode->parentNode;
+                if ($currentNode->nodeName === 'form') {
+                    $form = $node;
+                    break;
+                }
+            }
         }
 
-        if (!empty($node->getAttribute('form'))) {
-            $formCrawler = $this->filterByCSS('#' . $node->getAttribute('form'));
-            if ($formCrawler->count() !== 1) {
-                throw new TestRuntimeException("Found form with id {$node->getAttribute('form')} {$formCrawler->count()} times, expected exactly 1");
+        if (isset($form)) {
+            $buttonName = $node->getAttribute('name');
+            if ($buttonName !== '') {
+                $formParams = [$buttonName => $node->getAttribute('value')];
+            } else {
+                $formParams = [];
             }
             $this->proceedSubmitForm(
-                new Crawler($formCrawler->getNode(0), $this->getAbsoluteUrlFor($this->_getCurrentUri()), $this->getBaseUrl()),
+                new Crawler($form, $this->getAbsoluteUrlFor($this->_getCurrentUri()), $this->getBaseUrl()),
                 $formParams
             );
             return true;
-        }
-        
-        while ($node->parentNode !== null) {
-            $node = $node->parentNode;
-            if (!isset($node->tagName)) {
-                // this is the top most node, it has no parent either
-                break;
-            }
-            if ($node->tagName === 'a') {
-                $this->openHrefFromDomNode($node);
-                return true;
-            } elseif ($node->tagName === 'form') {
-                $this->proceedSubmitForm(
-                    new Crawler($node, $this->getAbsoluteUrlFor($this->_getCurrentUri()), $this->getBaseUrl()),
-                    $formParams
-                );
-                return true;
+        } else {
+            // Check if the button is inside an anchor.
+            $currentNode = $node;
+            while ($currentNode->parentNode !== null) {
+                $currentNode = $currentNode->parentNode;
+                if ($currentNode->nodeName === 'a') {
+                    $this->openHrefFromDomNode($currentNode);
+                    return true;
+                }
             }
         }
         throw new TestRuntimeException('Button is not inside a link or a form');

tests/data/app/view/form/button-not-in-form.php

@@ -5,11 +5,16 @@
     <form action="/form/button" method="POST" id="form-id">
         <input type="hidden" name="text" value="val" />
         <button type="submit" name="btn0">Submit</button>
+        <input id="button2" type="submit" form="form-nonexistent" value="Invalid form2" />
+        <input type="submit" value="Should not submit" form="" />
     </form>
 </div>
 
 <div>
     <input type="submit" form="form-id" value="Submit 2" />
+    <input type="submit" value="Outside submit" />
+
+    <input id="button2" type="submit" form="form-nonexistent" value="Invalid form" />
 </div>
 </body>
 </html>

tests/unit/Codeception/Module/TestsForWeb.php

@@ -1648,6 +1648,42 @@ public function testClickHashButton()
         $this->module->seeCurrentUrlEquals('/form/anchor');
     }
 
+    public function testClickButtonWithForm()
+    {
+        $this->module->amOnPage('/form/button-not-in-form');
+        $this->module->click('Submit 2');
+        $this->module->seeCurrentUrlEquals('/form/button');
+    }
+
+    public function testClickButtonWithEmptyForm()
+    {
+        $this->module->amOnPage('/form/button-not-in-form');
+        $this->expectException(\Codeception\Exception\TestRuntimeException::class);
+        $this->module->click('Should not submit');
+        $this->module->seeCurrentUrlEquals('/form/button-not-in-form');
+    }
+
+    public function testClickButtonNotInForm()
+    {
+        $this->module->amOnPage('/form/button-not-in-form');
+        $this->expectException(\Codeception\Exception\TestRuntimeException::class);
+        $this->module->click('Outside submit');
+    }
+
+    public function testClickButtonWithFormInvalidIdInside()
+    {
+        $this->module->amOnPage('/form/button-not-in-form');
+        $this->expectException(\Codeception\Exception\TestRuntimeException::class);
+        $this->module->click('Invalid form2');
+    }
+
+    public function testClickButtonWithFormInvalidIdOutside()
+    {
+        $this->module->amOnPage('/form/button-not-in-form');
+        $this->expectException(\Codeception\Exception\TestRuntimeException::class);
+        $this->module->click('Invalid form');
+    }
+
     public function testSubmitHashForm()
     {
         $this->module->amOnPage('/form/anchor');