get the assertions inherent to Symfony

Author: TavoNiievez

composer.json

@@ -5,6 +5,7 @@
     "type": "library",
     "keywords": [
         "codeception",
+        "functional testing",
         "symfony"
     ],
     "authors": [

src/Codeception/Module/Symfony.php

@@ -13,6 +13,7 @@
 use Codeception\Module\Symfony\BrowserAssertionsTrait;
 use Codeception\Module\Symfony\ConsoleAssertionsTrait;
 use Codeception\Module\Symfony\DoctrineAssertionsTrait;
+use Codeception\Module\Symfony\DomCrawlerAssertionsTrait;
 use Codeception\Module\Symfony\EventsAssertionsTrait;
 use Codeception\Module\Symfony\FormAssertionsTrait;
 use Codeception\Module\Symfony\MailerAssertionsTrait;
@@ -135,6 +136,7 @@ class Symfony extends Framework implements DoctrineProvider, PartedModule
     use BrowserAssertionsTrait;
     use ConsoleAssertionsTrait;
     use DoctrineAssertionsTrait;
+    use DomCrawlerAssertionsTrait;
     use EventsAssertionsTrait;
     use FormAssertionsTrait;
     use MailerAssertionsTrait;

src/Codeception/Module/Symfony/BrowserAssertionsTrait.php

@@ -4,11 +4,38 @@
 
 namespace Codeception\Module\Symfony;
 
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseFormatSame;
 use Symfony\Component\HttpFoundation\Test\Constraint\ResponseIsSuccessful;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseStatusCodeSame;
 use function sprintf;
 
 trait BrowserAssertionsTrait
 {
+    /**
+     * Asserts the response format returned by the `Response::getFormat()` method is the same as the expected value.
+     */
+    public function assertResponseFormatSame(?string $expectedFormat, string $message = ''): void
+    {
+        $this->assertThatForResponse(new ResponseFormatSame($this->getClient()->getRequest(), $expectedFormat), $message);
+    }
+
+    /**
+     * Asserts that the response was successful (HTTP status is 2xx).
+     */
+    public function assertResponseIsSuccessful(string $message = '', bool $verbose = true): void
+    {
+        $this->assertThatForResponse(new ResponseIsSuccessful($verbose), $message);
+    }
+
+    /**
+     * Asserts a specific HTTP status code.
+     */
+    public function assertResponseStatusCodeSame(int $expectedCode, string $message = '', bool $verbose = true): void
+    {
+        $this->assertThatForResponse(new ResponseStatusCodeSame($expectedCode, $verbose), $message);
+    }
+
     /**
      * Reboot client's kernel.
      * Can be used to manually reboot kernel when 'rebootable_client' => false
@@ -50,7 +77,7 @@ public function seePageIsAvailable(?string $url = null): void
             $this->seeInCurrentUrl($url);
         }
 
-        $this->assertThat($this->getClient()->getResponse(), new ResponseIsSuccessful());
+        $this->assertResponseIsSuccessful();
     }
 
     /**
@@ -104,4 +131,9 @@ public function submitSymfonyForm(string $name, array $fields): void
 
         $this->submitForm($selector, $params, $button);
     }
+
+    protected function assertThatForResponse(Constraint $constraint, string $message = ''): void
+    {
+        $this->assertThat($this->getClient()->getResponse(), $constraint, $message);
+    }
 }

src/Codeception/Module/Symfony/DomCrawlerAssertionsTrait.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codeception\Module\Symfony;
+
+use PHPUnit\Framework\Constraint\LogicalNot;
+use Symfony\Component\DomCrawler\Crawler;
+use Symfony\Component\DomCrawler\Test\Constraint\CrawlerSelectorExists;
+
+trait DomCrawlerAssertionsTrait
+{
+    /**
+     * Asserts that the checkbox with the given name is checked.
+     */
+    public function assertCheckboxChecked(string $fieldName, string $message = ''): void
+    {
+        $this->assertThat(
+            $this->getCrawler(),
+            new CrawlerSelectorExists("input[name=\"$fieldName\"]:checked"),
+            $message
+        );
+    }
+
+    /**
+     * Asserts that the checkbox with the given name is not checked.
+     */
+    public function assertCheckboxNotChecked(string $fieldName, string $message = ''): void
+    {
+        $this->assertThat(
+            $this->getCrawler(),
+            new LogicalNot(new CrawlerSelectorExists("input[name=\"$fieldName\"]:checked")),
+            $message
+        );
+    }
+
+    protected function getCrawler(): Crawler
+    {
+        return $this->client->getCrawler();
+    }
+}

src/Codeception/Module/Symfony/FormAssertionsTrait.php

@@ -4,6 +4,8 @@
 
 namespace Codeception\Module\Symfony;
 
+use DateInterval;
+use DateTime;
 use Symfony\Component\Form\Extension\DataCollector\FormDataCollector;
 use function array_key_exists;
 use function in_array;
@@ -12,6 +14,40 @@
 
 trait FormAssertionsTrait
 {
+    public function assertDateTimeEquals(DateTime $expected, DateTime $actual): void
+    {
+        $this->assertSame($expected->format('c'), $actual->format('c'));
+    }
+
+    public function assertDateIntervalEquals(DateInterval $expected, DateInterval $actual): void
+    {
+        $format = '%RP%yY%mM%dDT%hH%iM%sS';
+        $this->assertSame($expected->format($format), $actual->format($format));
+    }
+
+    /**
+     * Asserts that value of the field of the first form matching the given selector does equal the expected value.
+     */
+    public function assertFormValue(string $formSelector, string $fieldName, string $value, string $message = ''): void
+    {
+        $node = $this->getCrawler()->filter($formSelector);
+        $this->assertNotEmpty($node, sprintf('Form "%s" not found.', $formSelector));
+        $values = $node->form()->getValues();
+        $this->assertArrayHasKey($fieldName, $values, $message ?: sprintf('Field "%s" not found in form "%s".', $fieldName, $formSelector));
+        $this->assertSame($value, $values[$fieldName]);
+    }
+
+    /**
+     * Asserts that value of the field of the first form matching the given selector does equal the expected value.
+     */
+    public function assertNoFormValue(string $formSelector, string $fieldName, string $message = ''): void
+    {
+        $node = $this->getCrawler()->filter($formSelector);
+        $this->assertNotEmpty($node, sprintf('Form "%s" not found.', $formSelector));
+        $values = $node->form()->getValues();
+        $this->assertArrayNotHasKey($fieldName, $values, $message ?: sprintf('Field "%s" has a value in form "%s".', $fieldName, $formSelector));
+    }
+
     /**
      * Verifies that there are no errors bound to the submitted form.
      *