feature #38287 [DomCrawler] Add checkbox assertions for functional tests (mnapoli)

fabpot · fabpot · commit 84719a6c44aa · 2020-09-24T17:01:52.000+02:00
This PR was merged into the 5.2-dev branch.

Discussion
----------

[DomCrawler] Add checkbox assertions for functional tests

| Q             | A
| ------------- | ---
| Branch?       | master for features
| Bug fix?      | no
| New feature?  | yes &lt;!-- please update src/**/CHANGELOG.md files --&gt;
| Deprecations? | no &lt;!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --&gt;
| Tickets       |
| License       | MIT
| Doc PR        | symfony/symfony-docs#... &lt;!-- required for new features --&gt;

Add new assertions for checkboxes, to use in functional tests.

Example:

```php
    public function testAssertCheckboxChecked()
    {
        $this-&gt;visit('/edit-form');

        $this-&gt;client-&gt;submitForm('Save', [
            'activateMembership' =&gt; 'on',
        ]);

        self::assertResponseIsSuccessful();
        // Check that the field is checked after the form was submitted
        self::assertCheckboxChecked('activateMembership');
    }
```

This wasn't possible to achieve with the existing `self::assertInputValueSame()` assertion.

Commits
-------

f26758e1c0 [DomCrawler] Add `assertCheckboxChecked()`
diff --git a/CHANGELOG.md b/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 `assertCheckboxChecked()` and `assertCheckboxNotChecked()` in `WebTestCase`
 
 5.1.0
 -----
diff --git a/Test/DomCrawlerAssertionsTrait.php b/Test/DomCrawlerAssertionsTrait.php
@@ -15,6 +15,8 @@
 use PHPUnit\Framework\Constraint\LogicalNot;
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\DomCrawler\Test\Constraint as DomCrawlerConstraint;
+use Symfony\Component\DomCrawler\Test\Constraint\CrawlerSelectorAttributeValueSame;
+use Symfony\Component\DomCrawler\Test\Constraint\CrawlerSelectorExists;
 
 /**
  * Ideas borrowed from Laravel Dusk's assertions.
@@ -83,6 +85,22 @@ public static function assertInputValueNotSame(string $fieldName, string $expect
         ), $message);
     }
 
+    public static function assertCheckboxChecked(string $fieldName, string $message = ''): void
+    {
+        self::assertThat(self::getCrawler(), LogicalAnd::fromConstraints(
+            new CrawlerSelectorExists("input[name=\"$fieldName\"]"),
+            new CrawlerSelectorAttributeValueSame("input[name=\"$fieldName\"]", 'checked', 'checked')
+        ), $message);
+    }
+
+    public static function assertCheckboxNotChecked(string $fieldName, string $message = ''): void
+    {
+        self::assertThat(self::getCrawler(), LogicalAnd::fromConstraints(
+            new CrawlerSelectorExists("input[name=\"$fieldName\"]"),
+            new LogicalNot(new CrawlerSelectorAttributeValueSame("input[name=\"$fieldName\"]", 'checked', 'checked'))
+        ), $message);
+    }
+
     private static function getCrawler(): Crawler
     {
         if (!$crawler = self::getClient()->getCrawler()) {
diff --git a/Tests/Test/WebTestCaseTest.php b/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 testAssertCheckboxChecked()
+    {
+        $this->getCrawlerTester(new Crawler('<html><body><form><input type="checkbox" name="rememberMe" checked>'))->assertCheckboxChecked('rememberMe');
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('matches selector "input[name="rememberMe"]" and has a node matching selector "input[name="rememberMe"]" with attribute "checked" of value "checked".');
+        $this->getCrawlerTester(new Crawler('<html><body><form><input type="checkbox" name="rememberMe">'))->assertCheckboxChecked('rememberMe');
+    }
+
+    public function testAssertCheckboxNotChecked()
+    {
+        $this->getCrawlerTester(new Crawler('<html><body><form><input type="checkbox" name="rememberMe">'))->assertCheckboxNotChecked('rememberMe');
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('matches selector "input[name="rememberMe"]" and does not have a node matching selector "input[name="rememberMe"]" with attribute "checked" of value "checked".');
+        $this->getCrawlerTester(new Crawler('<html><body><form><input type="checkbox" name="rememberMe" checked>'))->assertCheckboxNotChecked('rememberMe');
+    }
+
     public function testAssertRequestAttributeValueSame()
     {
         $this->getRequestTester()->assertRequestAttributeValueSame('foo', 'bar');
