minor #49839 [BrowserKit] Improve the error message when submitForm() can't find the form (alamirault)

fabpot · fabpot · commit da9f199a943d · 2023-04-08T18:33:59.000+02:00
This PR was squashed before being merged into the 6.3 branch.

Discussion
----------

[BrowserKit] Improve the error message when `submitForm()` can't find the form

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | no &lt;!-- please update src/**/CHANGELOG.md files --&gt;
| Deprecations? | no &lt;!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --&gt;
| Tickets       | Fix #49826 &lt;!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead --&gt;
| License       | MIT
| Doc PR        | symfony/symfony-docs#... &lt;!-- required for new features --&gt;

When form is not found, error message is now `The form doesn't contain any button with "Save changes" as its content, id, value or name.` instead of `The current node list is empty.`

Commits
-------

187c120cd0 [BrowserKit] Improve the error message when `submitForm()` can't find the form
diff --git a/AbstractBrowser.php b/AbstractBrowser.php
@@ -333,6 +333,11 @@ public function submitForm(string $button, array $fieldValues = [], string $meth
         }
 
         $buttonNode = $this->crawler->selectButton($button);
+
+        if (0 === $buttonNode->count()) {
+            throw new \InvalidArgumentException(sprintf('There is no button with "%s" as its content, id, value or name.', $button));
+        }
+
         $form = $buttonNode->form($fieldValues, $method);
 
         return $this->submit($form, [], $serverParameters);
diff --git a/Tests/AbstractBrowserTest.php b/Tests/AbstractBrowserTest.php
@@ -350,15 +350,14 @@ public function testSubmitFormNotFound()
         $client->setNextResponse(new Response('<html><form action="/foo"><input type="submit" /></form></html>'));
         $client->request('GET', 'http://www.example.com/foo/foobar');
 
-        try {
-            $client->submitForm('Register', [
-                'username' => 'username',
-                'password' => 'password',
-            ], 'POST');
-            $this->fail('->submitForm() throws a \InvalidArgumentException if the form could not be found');
-        } catch (\Exception $e) {
-            $this->assertInstanceOf(\InvalidArgumentException::class, $e, '->submitForm() throws a \InvalidArgumentException if the form could not be found');
-        }
+        $this->expectExceptionObject(
+            new \InvalidArgumentException('There is no button with "Register" as its content, id, value or name.')
+        );
+
+        $client->submitForm('Register', [
+            'username' => 'username',
+            'password' => 'password',
+        ], 'POST');
     }
 
     public function testSubmitPreserveAuth()
