[DomCrawler] Add assertFormValue() and assertNoFormValue() in WebTestCase

mnapoli · mnapoli · commit b135c4703573 · 2020-09-24T10:54:18.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -11,6 +11,7 @@ CHANGELOG
  * Added `TemplateAwareDataCollectorInterface` and `AbstractDataCollector` to simplify custom data collector creation and leverage autoconfiguration
  * Add `cache.adapter.redis_tag_aware` tag to use `RedisCacheAwareAdapter`
  * added `framework.http_client.retry_failing` configuration tree
+ * added `assertFormValue()` and `assertNoFormValue()` in `WebTestCase`
 
 5.1.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/DomCrawlerAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/DomCrawlerAssertionsTrait.php
@@ -83,6 +83,23 @@ public static function assertInputValueNotSame(string $fieldName, string $expect
         ), $message);
     }
 
+    public static function assertFormValue(string $formSelector, string $fieldName, string $value, string $message = ''): void
+    {
+        $node = self::getCrawler()->filter($formSelector);
+        self::assertNotEmpty($node, "Form '$formSelector' not found.");
+        $values = $node->form()->getValues();
+        self::assertArrayHasKey($fieldName, $values, $message ?: "Field '$fieldName' not found in form '$formSelector'.");
+        self::assertSame($value, $values[$fieldName]);
+    }
+
+    public static function assertNoFormValue(string $formSelector, string $fieldName, string $message = ''): void
+    {
+        $node = self::getCrawler()->filter($formSelector);
+        self::assertNotEmpty($node, "Form '$formSelector' not found.");
+        $values = $node->form()->getValues();
+        self::assertArrayNotHasKey($fieldName, $values, $message ?: "Field '$fieldName' has a value in form '$formSelector'.");
+    }
+
     private static function getCrawler(): Crawler
     {
         if (!$crawler = self::getClient()->getCrawler()) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Test/WebTestCaseTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Test/WebTestCaseTest.php
@@ -220,6 +220,22 @@ public function testAssertInputValueNotSame()
         $this->getCrawlerTester(new Crawler('<html><body><form><input type="text" name="password" value="pa$$">'))->assertInputValueNotSame('password', 'pa$$');
     }
 
+    public function testAssertFormValue()
+    {
+        $this->getCrawlerTester(new Crawler('<html><body><form id="form"><input type="text" name="username" value="Fabien">', 'http://localhost'))->assertFormValue('#form', 'username', 'Fabien');
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Failed asserting that two strings are identical.');
+        $this->getCrawlerTester(new Crawler('<html><body><form id="form"><input type="text" name="username" value="Fabien">', 'http://localhost'))->assertFormValue('#form', 'username', 'Jane');
+    }
+
+    public function testAssertNoFormValue()
+    {
+        $this->getCrawlerTester(new Crawler('<html><body><form id="form"><input type="checkbox" name="rememberMe">', 'http://localhost'))->assertNoFormValue('#form', 'rememberMe');
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage("Field 'rememberMe' has a value in form '#form'.");
+        $this->getCrawlerTester(new Crawler('<html><body><form id="form"><input type="checkbox" name="rememberMe" checked>', 'http://localhost'))->assertNoFormValue('#form', 'rememberMe');
+    }
+
     public function testAssertRequestAttributeValueSame()
     {
         $this->getRequestTester()->assertRequestAttributeValueSame('foo', 'bar');
