diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index a702584e..8027f64b 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -1,22 +1,19 @@
name: CI
-
on: [push, pull_request]
jobs:
tests:
runs-on: ubuntu-latest
-
strategy:
matrix:
- php: [8.0, 8.1, 8.2]
- symfony: ["4.4.*", "5.4.*", "6.0.*", "6.1.*"]
- exclude:
- - php: 8.0
- symfony: "6.1.*"
+ php: [8.2, 8.3, 8.4]
+ symfony: ["5.4.*", "6.4.*", "6.4wApi", "7.3.*"]
+ env:
+ only_sf_latest: &only_sf_latest ${{ matrix.symfony == '7.3.*' }}
steps:
- name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
@@ -26,80 +23,101 @@ jobs:
extensions: ctype, iconv, intl, json, mbstring, pdo, pdo_sqlite
coverage: none
- - name: Checkout Symfony 4.4 Sample
- if: "matrix.symfony == '4.4.*'"
- uses: actions/checkout@v2
- with:
- repository: Codeception/symfony-module-tests
- path: framework-tests
- ref: "4.4_codecept5"
-
- - name: Checkout Symfony 5.4 Sample
- if: "matrix.symfony == '5.4.*'"
- uses: actions/checkout@v2
- with:
- repository: Codeception/symfony-module-tests
- path: framework-tests
- ref: "5.4_codecept5"
-
- - name: Checkout Symfony 6.0 Sample
- if: "matrix.symfony == '6.0.*'"
- uses: actions/checkout@v2
- with:
- repository: Codeception/symfony-module-tests
- path: framework-tests
- ref: "6.0"
-
- - name: Checkout Symfony 6.1 Sample
- if: "matrix.symfony == '6.1.*'"
- uses: actions/checkout@v2
+ - name: Set Symfony version reference
+ env:
+ MATRIX_SYMFONY: ${{ matrix.symfony }}
+ run: |
+ if [[ "$MATRIX_SYMFONY" == *'*' ]]; then
+ echo "SF_REF=${MATRIX_SYMFONY%.*}" >> "$GITHUB_ENV"
+ else
+ echo "SF_REF=$MATRIX_SYMFONY" >> "$GITHUB_ENV"
+ fi
+
+ - name: Set Composer Symfony constraint
+ env:
+ MATRIX_SYMFONY: ${{ matrix.symfony }}
+ run: |
+ if [[ "$MATRIX_SYMFONY" == "6.4wApi" ]]; then
+ echo "COMP_SYMFONY=6.4.*" >> "$GITHUB_ENV"
+ else
+ echo "COMP_SYMFONY=$MATRIX_SYMFONY" >> "$GITHUB_ENV"
+ fi
+
+ - name: Checkout Symfony ${{ env.SF_REF }} sample
+ uses: actions/checkout@v4
with:
repository: Codeception/symfony-module-tests
path: framework-tests
- ref: "6.1"
+ ref: ${{ env.SF_REF }}
- name: Get composer cache directory
id: composer-cache
- run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+ run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
- - name: Cache composer dependencies
- uses: actions/cache@v2.1.3
+ - name: Cache Composer dependencies
+ uses: actions/cache@v3
with:
path: ${{ steps.composer-cache.outputs.dir }}
- key: ${{ runner.os }}-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
- restore-keys: ${{ runner.os }}-${{ matrix.php }}-composer-
+ key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.{json,lock}') }}
+ restore-keys: ${{ runner.os }}-php-${{ matrix.php }}-composer-
+
+ - name: Install PHPUnit 10
+ run: composer require --dev --no-update phpunit/phpunit:^10.0
- name: Install dependencies
+ env:
+ MATRIX_SYMFONY: ${{ matrix.symfony }}
run: |
- composer require symfony/finder=${{ matrix.symfony }} --no-update
- composer require symfony/yaml=${{ matrix.symfony }} --no-update
- composer require symfony/console=${{ matrix.symfony }} --no-update
- composer require symfony/event-dispatcher=${{ matrix.symfony }} --no-update
- composer require symfony/css-selector=${{ matrix.symfony }} --no-update
- composer require symfony/dom-crawler=${{ matrix.symfony }} --no-update
- composer require symfony/browser-kit=${{ matrix.symfony }} --no-update
- composer require vlucas/phpdotenv --no-update
- composer require codeception/module-asserts="3.*" --no-update
- composer require codeception/module-doctrine2="3.*" --no-update
- composer update --prefer-dist --no-progress --no-dev
-
- - name: Validate composer.json and composer.lock
- run: composer validate
+ composer require --no-update \
+ symfony/{finder,yaml,console,event-dispatcher,css-selector,dom-crawler,browser-kit}:${{ env.COMP_SYMFONY }} \
+ vlucas/phpdotenv \
+ codeception/module-asserts:"3.*" \
+ codeception/module-doctrine:"3.*"
+
+ if [[ "$MATRIX_SYMFONY" == "6.4wApi" ]]; then
+ composer require codeception/module-rest="3.*" --no-update
+ fi
+
+ composer update --prefer-dist --no-progress
+
+ - name: Run PHPStan (max)
+ if: *only_sf_latest
+ run: composer phpstan
+
+ - name: Run PHP-CS-Fixer
+ if: *only_sf_latest
+ run: composer cs-check
+
+ - name: Run Composer Audit
+ if: *only_sf_latest
+ run: composer audit
+
+ - name: Validate Composer files
+ run: composer validate --strict
+ working-directory: framework-tests
+
+ - name: Install PHPUnit in framework-tests
+ run: composer require --dev --no-update phpunit/phpunit:^10.0
working-directory: framework-tests
- - name: Install Symfony Sample
+ - name: Prepare Symfony sample
run: |
- composer remove codeception/codeception codeception/module-asserts codeception/module-doctrine2 codeception/lib-innerbrowser codeception/module-symfony --dev --no-update
+ composer remove codeception/codeception codeception/module-asserts codeception/module-doctrine codeception/lib-innerbrowser codeception/module-symfony --dev --no-update
composer update --no-progress
working-directory: framework-tests
- - name: Prepare the test environment
+ - name: Setup Database
run: |
- php bin/console d:s:u -f
- php bin/console d:f:l -q
+ php bin/console doctrine:schema:update --force
+ php bin/console doctrine:fixtures:load --quiet
+ working-directory: framework-tests
+
+ - name: Generate JWT keypair
+ if: ${{ matrix.symfony == '6.4wApi' }}
+ run: php bin/console lexik:jwt:generate-keypair --skip-if-exists
working-directory: framework-tests
- - name: Run test suite
+ - name: Run tests
run: |
php vendor/bin/codecept build -c framework-tests
php vendor/bin/codecept run Functional -c framework-tests
diff --git a/.gitignore b/.gitignore
index 55018224..a8169301 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
/.idea/
/vendor/
/composer.lock
-/framework-tests
\ No newline at end of file
+/framework-tests
+/.php-cs-fixer.cache
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a3624a43..e2eb5a9e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,7 +41,7 @@ It is a minimal (but complete) Symfony project, ready to run tests.
- Edit the trait's source code in the `vendor/codeception/module-symfony/src/Codeception/Module/Symfony/` folder.
-- If you create a new method, you can test it by adding a test in the `tests/Functional/SymfonyModuleCest.php` file.
+- If you create a new method, you can test it by adding a test in the corresponding `/tests/Functional/*Cest.php` file.
> :bulb: Be sure to rebuild Codeception's "Actor" classes (see [Console Commands](https://codeception.com/docs/reference/Commands#Build)):
> ```shell
> vendor/bin/codecept clean
diff --git a/LICENSE b/LICENSE
index 61d82091..624026b5 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2011-2020 Michael Bodnarchuk and contributors
+Copyright (c) 2011-2024 Michael Bodnarchuk and contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/composer.json b/composer.json
index 74e19855..03ca4985 100644
--- a/composer.json
+++ b/composer.json
@@ -1,12 +1,17 @@
{
"name": "codeception/module-symfony",
"description": "Codeception module for Symfony framework",
- "license": "MIT",
"type": "library",
+ "license": "MIT",
"keywords": [
"codeception",
+ "functional testing",
"symfony"
],
+ "homepage": "https://codeception.com/",
+ "support": {
+ "docs": "https://codeception.com/docs/modules/Symfony"
+ },
"authors": [
{
"name": "Michael Bodnarchuk"
@@ -16,36 +21,64 @@
"homepage": "https://medium.com/@ganieves"
}
],
- "homepage": "https://codeception.com/",
"require": {
- "php": "^8.0",
+ "php": "^8.2",
"ext-json": "*",
- "codeception/codeception": "^5.0.0-RC3",
- "codeception/lib-innerbrowser": "^3.1.1"
+ "codeception/codeception": "^5.3",
+ "codeception/lib-innerbrowser": "^3.1 | ^4.0"
},
"require-dev": {
"codeception/module-asserts": "^3.0",
- "codeception/module-doctrine2": "^3.0",
- "doctrine/orm": "^2.10",
- "symfony/form": "^4.4 | ^5.0 | ^6.0",
- "symfony/framework-bundle": "^4.4 | ^5.0 | ^6.0",
- "symfony/http-kernel": "^4.4 | ^5.0 | ^6.0",
- "symfony/mailer": "^4.4 | ^5.0 | ^6.0",
- "symfony/routing": "^4.4 | ^5.0 | ^6.0",
- "symfony/security-bundle": "^4.4 | ^5.0 | ^6.0",
- "symfony/twig-bundle": "^4.4 | ^5.0 | ^6.0",
+ "codeception/module-doctrine": "^3.1",
+ "doctrine/orm": "^3.5",
+ "friendsofphp/php-cs-fixer": "^3.85",
+ "phpstan/phpstan": "^2.1",
+ "symfony/browser-kit": "^5.4 | ^6.4 | ^7.3",
+ "symfony/cache": "^5.4 | ^6.4 | ^7.3",
+ "symfony/config": "^5.4 | ^6.4 | ^7.3",
+ "symfony/dependency-injection": "^5.4 | ^6.4 | ^7.3",
+ "symfony/dom-crawler": "^5.4 | ^6.4 | ^7.3",
+ "symfony/dotenv": "^5.4 | ^6.4 | ^7.3",
+ "symfony/error-handler": "^5.4 | ^6.4 | ^7.3",
+ "symfony/filesystem": "^5.4 | ^6.4 | ^7.3",
+ "symfony/form": "^5.4 | ^6.4 | ^7.3",
+ "symfony/framework-bundle": "^5.4 | ^6.4 | ^7.3",
+ "symfony/http-client": "^5.4 | ^6.4 | ^7.3",
+ "symfony/http-foundation": "^5.4 | ^6.4 | ^7.3",
+ "symfony/http-kernel": "^5.4 | ^6.4 | ^7.3",
+ "symfony/mailer": "^5.4 | ^6.4 | ^7.3",
+ "symfony/mime": "^5.4 | ^6.4 | ^7.3",
+ "symfony/notifier": "^5.4 | ^6.4 | ^7.3",
+ "symfony/options-resolver": "^5.4 | ^6.4 | ^7.3",
+ "symfony/property-access": "^5.4 | ^6.4 | ^7.3",
+ "symfony/property-info": "^5.4 | ^6.4 | ^7.3",
+ "symfony/routing": "^5.4 | ^6.4 | ^7.3",
+ "symfony/security-bundle": "^5.4 | ^6.4 | ^7.3",
+ "symfony/security-core": "^5.4 | ^6.4 | ^7.3",
+ "symfony/security-csrf": "^5.4 | ^6.4 | ^7.3",
+ "symfony/security-http": "^5.4 | ^6.4 | ^7.3",
+ "symfony/translation": "^5.4 | ^6.4 | ^7.3",
+ "symfony/twig-bundle": "^5.4 | ^6.4 | ^7.3",
+ "symfony/validator": "^5.4 | ^6.4 | ^7.3",
+ "symfony/var-exporter": "^5.4 | ^6.4 | ^7.3",
"vlucas/phpdotenv": "^4.2 | ^5.4"
},
"suggest": {
"codeception/module-asserts": "Include traditional PHPUnit assertions in your tests",
"symfony/web-profiler-bundle": "Tool that gives information about the execution of requests"
},
- "minimum-stability": "RC",
"autoload": {
- "classmap": ["src/"]
+ "psr-4": {
+ "Codeception\\": "src/Codeception/"
+ }
},
"config": {
- "classmap-authoritative": true,
"sort-packages": true
+ },
+ "minimum-stability": "RC",
+ "scripts": {
+ "phpstan": "phpstan analyse src --level=max --memory-limit=1G",
+ "cs-check": "php-cs-fixer fix src --dry-run --diff --using-cache=no",
+ "cs-fix": "php-cs-fixer fix src --using-cache=no"
}
}
diff --git a/readme.md b/readme.md
index c832d43a..34cac759 100644
--- a/readme.md
+++ b/readme.md
@@ -9,8 +9,8 @@ A Codeception module for Symfony framework.
## Requirements
-* `Symfony` `4.4.x`, `5.4.x`, `6.x` or higher, as per the [Symfony supported versions](https://symfony.com/releases).
-* `PHP 8.0` or higher.
+* `Symfony` `5.4.x`, `6.4.x`, `7.3.x` or higher, as per the [Symfony supported versions](https://symfony.com/releases).
+* `PHP 8.2` or higher.
## Installation
diff --git a/src/Codeception/Lib/Connector/Symfony.php b/src/Codeception/Lib/Connector/Symfony.php
index dafcaa5a..bf18eb21 100644
--- a/src/Codeception/Lib/Connector/Symfony.php
+++ b/src/Codeception/Lib/Connector/Symfony.php
@@ -5,65 +5,51 @@
namespace Codeception\Lib\Connector;
use InvalidArgumentException;
-use ReflectionClass;
+use LogicException;
use ReflectionMethod;
use ReflectionProperty;
use Symfony\Bundle\FrameworkBundle\Test\TestContainer;
use Symfony\Component\DependencyInjection\ContainerInterface;
-use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\HttpKernelBrowser;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\HttpKernel\Profiler\Profiler;
-use function array_keys;
+
use function codecept_debug;
+/**
+ * @property KernelInterface $kernel
+ */
class Symfony extends HttpKernelBrowser
{
- private bool $rebootable;
-
+ private ContainerInterface $container;
private bool $hasPerformedRequest = false;
- private ?ContainerInterface $container;
-
- public array $persistentServices = [];
-
- /**
- * Constructor.
- *
- * @param Kernel $kernel A booted HttpKernel instance
- * @param array $services An injected services
- * @param bool $rebootable
- */
- public function __construct(Kernel $kernel, array $services = [], bool $rebootable = true)
- {
+ public function __construct(
+ HttpKernelInterface $kernel,
+ /** @var array */
+ public array $persistentServices = [],
+ private bool $reboot = true
+ ) {
parent::__construct($kernel);
$this->followRedirects();
- $this->rebootable = $rebootable;
- $this->persistentServices = $services;
- $this->container = $this->getContainer();
+ $this->container = $this->resolveContainer();
$this->rebootKernel();
}
- /**
- * @param Request $request
- * @return Response
- */
- protected function doRequest($request): Response
+ protected function doRequest(object $request): Response
{
- if ($this->rebootable) {
- if ($this->hasPerformedRequest) {
- $this->rebootKernel();
- } else {
- $this->hasPerformedRequest = true;
- }
+ if ($this->reboot) {
+ $this->hasPerformedRequest ? $this->rebootKernel() : $this->hasPerformedRequest = true;
}
return parent::doRequest($request);
}
/**
- * Reboot kernel
+ * Reboots the kernel.
*
* Services from the list of persistent services
* are updated from service container before kernel shutdown
@@ -71,39 +57,45 @@ protected function doRequest($request): Response
*/
public function rebootKernel(): void
{
- if ($this->container) {
- foreach (array_keys($this->persistentServices) as $serviceName) {
- if ($service = $this->getService($serviceName)) {
- $this->persistentServices[$serviceName] = $service;
- }
+ foreach (array_keys($this->persistentServices) as $service) {
+ if ($this->container->has($service)) {
+ $this->persistentServices[$service] = $this->container->get($service);
}
}
$this->persistDoctrineConnections();
- $this->kernel->reboot(null);
-
- $this->container = $this->getContainer();
-
- foreach ($this->persistentServices as $serviceName => $service) {
+ if ($this->kernel instanceof Kernel) {
+ $this->ensureKernelShutdown();
+ $this->kernel->boot();
+ }
+ $this->container = $this->resolveContainer();
+ foreach ($this->persistentServices as $name => $service) {
try {
- $this->container->set($serviceName, $service);
+ $this->container->set($name, $service);
} catch (InvalidArgumentException $e) {
- //Private services can't be set in Symfony 4
- codecept_debug("[Symfony] Can't set persistent service {$serviceName}: " . $e->getMessage());
+ codecept_debug("[Symfony] Can't set persistent service {$name}: {$e->getMessage()}");
}
}
- if ($profiler = $this->getProfiler()) {
- $profiler->enable();
- }
+ $this->getProfiler()?->enable();
}
- private function getContainer(): ?ContainerInterface
+ protected function ensureKernelShutdown(): void
+ {
+ $this->kernel->boot();
+ $this->kernel->shutdown();
+ }
+
+ private function resolveContainer(): ContainerInterface
{
- /** @var ContainerInterface $container */
$container = $this->kernel->getContainer();
+
if ($container->has('test.service_container')) {
- $container = $container->get('test.service_container');
+ $testContainer = $container->get('test.service_container');
+ if (!$testContainer instanceof ContainerInterface) {
+ throw new LogicException('Service "test.service_container" must implement ' . ContainerInterface::class);
+ }
+ $container = $testContainer;
}
return $container;
@@ -111,22 +103,13 @@ private function getContainer(): ?ContainerInterface
private function getProfiler(): ?Profiler
{
- if ($this->container->has('profiler')) {
- /** @var Profiler $profiler */
- $profiler = $this->container->get('profiler');
- return $profiler;
+ if (!$this->container->has('profiler')) {
+ return null;
}
- return null;
- }
+ $profiler = $this->container->get('profiler');
- private function getService(string $serviceName): ?object
- {
- if ($this->container->has($serviceName)) {
- return $this->container->get($serviceName);
- }
-
- return null;
+ return $profiler instanceof Profiler ? $profiler : null;
}
private function persistDoctrineConnections(): void
@@ -136,20 +119,27 @@ private function persistDoctrineConnections(): void
}
if ($this->container instanceof TestContainer) {
- $reflectedTestContainer = new ReflectionMethod($this->container, 'getPublicContainer');
- $reflectedTestContainer->setAccessible(true);
- $publicContainer = $reflectedTestContainer->invoke($this->container);
+ $method = new ReflectionMethod($this->container, 'getPublicContainer');
+ $publicContainer = $method->invoke($this->container);
} else {
$publicContainer = $this->container;
}
- $reflectedContainer = new ReflectionClass($publicContainer);
- $reflectionTarget = $reflectedContainer->hasProperty('parameters') ? $publicContainer : $publicContainer->getParameterBag();
+ if (!is_object($publicContainer) || !method_exists($publicContainer, 'getParameterBag')) {
+ return;
+ }
+
+ $target = property_exists($publicContainer, 'parameters')
+ ? $publicContainer
+ : $publicContainer->getParameterBag();
+
+ if (!is_object($target) || !property_exists($target, 'parameters')) {
+ return;
+ }
+ $prop = new ReflectionProperty($target, 'parameters');
- $reflectedParameters = new ReflectionProperty($reflectionTarget, 'parameters');
- $reflectedParameters->setAccessible(true);
- $parameters = $reflectedParameters->getValue($reflectionTarget);
- unset($parameters['doctrine.connections']);
- $reflectedParameters->setValue($reflectionTarget, $parameters);
+ $params = (array) $prop->getValue($target);
+ unset($params['doctrine.connections']);
+ $prop->setValue($target, $params);
}
}
diff --git a/src/Codeception/Module/Symfony.php b/src/Codeception/Module/Symfony.php
index fc8044ca..0f98cf13 100644
--- a/src/Codeception/Module/Symfony.php
+++ b/src/Codeception/Module/Symfony.php
@@ -12,9 +12,13 @@
use Codeception\Lib\Interfaces\PartedModule;
use Codeception\Module\Symfony\BrowserAssertionsTrait;
use Codeception\Module\Symfony\ConsoleAssertionsTrait;
+use Codeception\Module\Symfony\DataCollectorName;
use Codeception\Module\Symfony\DoctrineAssertionsTrait;
+use Codeception\Module\Symfony\DomCrawlerAssertionsTrait;
use Codeception\Module\Symfony\EventsAssertionsTrait;
use Codeception\Module\Symfony\FormAssertionsTrait;
+use Codeception\Module\Symfony\HttpClientAssertionsTrait;
+use Codeception\Module\Symfony\LoggerAssertionsTrait;
use Codeception\Module\Symfony\MailerAssertionsTrait;
use Codeception\Module\Symfony\MimeAssertionsTrait;
use Codeception\Module\Symfony\ParameterAssertionsTrait;
@@ -23,39 +27,49 @@
use Codeception\Module\Symfony\ServicesAssertionsTrait;
use Codeception\Module\Symfony\SessionAssertionsTrait;
use Codeception\Module\Symfony\TimeAssertionsTrait;
+use Codeception\Module\Symfony\TranslationAssertionsTrait;
use Codeception\Module\Symfony\TwigAssertionsTrait;
+use Codeception\Module\Symfony\ValidatorAssertionsTrait;
use Codeception\TestInterface;
use Doctrine\ORM\EntityManagerInterface;
-use Exception;
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\AssertionFailedError;
use ReflectionClass;
use ReflectionException;
+use Symfony\Bridge\Twig\DataCollector\TwigDataCollector;
use Symfony\Bundle\SecurityBundle\DataCollector\SecurityDataCollector;
use Symfony\Component\BrowserKit\AbstractBrowser;
use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Dotenv\Dotenv;
use Symfony\Component\Finder\Finder;
+use Symfony\Component\Form\Extension\DataCollector\FormDataCollector;
+use Symfony\Component\HttpClient\DataCollector\HttpClientDataCollector;
use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
+use Symfony\Component\HttpKernel\DataCollector\EventDataCollector;
+use Symfony\Component\HttpKernel\DataCollector\LoggerDataCollector;
use Symfony\Component\HttpKernel\DataCollector\TimeDataCollector;
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\HttpKernel\Profiler\Profile;
use Symfony\Component\HttpKernel\Profiler\Profiler;
use Symfony\Component\Mailer\DataCollector\MessageDataCollector;
-use Symfony\Component\Routing\Route;
+use Symfony\Component\Translation\DataCollector\TranslationDataCollector;
use Symfony\Component\VarDumper\Cloner\Data;
+
use function array_keys;
use function array_map;
-use function array_merge;
-use function array_search;
use function array_unique;
+use function array_values;
use function class_exists;
use function codecept_root_dir;
use function count;
use function file_exists;
use function implode;
+use function in_array;
+use function extension_loaded;
use function ini_get;
use function ini_set;
-use function is_null;
+use function is_object;
use function iterator_to_array;
-use function number_format;
use function sprintf;
/**
@@ -63,7 +77,7 @@
* and [HttpKernel Component](https://symfony.com/doc/current/components/http_kernel.html) to emulate requests and test response.
*
* * Access Symfony services through the dependency injection container: [`$I->grabService(...)`](#grabService)
- * * Use Doctrine to test against the database: `$I->seeInRepository(...)` - see [Doctrine Module](https://codeception.com/docs/modules/Doctrine2)
+ * * Use Doctrine to test against the database: `$I->seeInRepository(...)` - see [Doctrine Module](https://codeception.com/docs/modules/Doctrine)
* * Assert that emails would have been sent: [`$I->seeEmailIsSent()`](#seeEmailIsSent)
* * Tests are wrapped into Doctrine transaction to speed them up.
* * Symfony Router can be cached between requests to speed up testing.
@@ -74,19 +88,20 @@
*
* ## Config
*
- * ### Symfony 5.x or 4.4
+ * ### Symfony 5.4 or higher
*
- * * app_path: 'src' - Specify custom path to your app dir, where the kernel interface is located.
- * * environment: 'local' - Environment used for load kernel
- * * kernel_class: 'App\Kernel' - Kernel class name
- * * em_service: 'doctrine.orm.entity_manager' - Use the stated EntityManager to pair with Doctrine Module.
- * * debug: true - Turn on/off debug mode
- * * cache_router: 'false' - Enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
- * * rebootable_client: 'true' - Reboot client's kernel before each request
- * * guard: 'false' - Enable custom authentication system with guard (only for 4.x and 5.x versions of the symfony)
- * * authenticator: 'false' - Reboot client's kernel before each request (only for 6.x versions of the symfony)
+ * * `app_path`: 'src' - Specify custom path to your app dir, where the kernel interface is located.
+ * * `environment`: 'local' - Environment used for load kernel
+ * * `kernel_class`: 'App\Kernel' - Kernel class name
+ * * `em_service`: 'doctrine.orm.entity_manager' - Use the stated EntityManager to pair with Doctrine Module.
+ * * `debug`: true - Turn on/off [debug mode](https://codeception.com/docs/Debugging)
+ * * `cache_router`: 'false' - Enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire) (can have an impact on ajax requests sending via '$I->sendAjaxPostRequest()')
+ * * `rebootable_client`: 'true' - Reboot client's kernel before each request
+ * * `guard`: 'false' - Enable custom authentication system with guard (only for Symfony 5.4)
+ * * `bootstrap`: 'false' - Enable the test environment setup with the tests/bootstrap.php file if it exists or with Symfony DotEnv otherwise. If false, it does nothing.
+ * * `authenticator`: 'false' - Reboot client's kernel before each request (only for Symfony 6.0 or higher)
*
- * #### Example (`functional.suite.yml`) - Symfony 4 Directory Structure
+ * #### Sample `Functional.suite.yml`
*
* modules:
* enabled:
@@ -119,24 +134,26 @@
* enabled:
* - Symfony:
* part: services
- * - Doctrine2:
+ * - Doctrine:
* depends: Symfony
* - WebDriver:
* url: http://example.com
* browser: firefox
* ```
*
- * If you're using Symfony with Eloquent ORM (instead of Doctrine), you can load the [`ORM` part of Laravel module](https://codeception.com/docs/modules/Laravel5#Parts)
+ * If you're using Symfony with Eloquent ORM (instead of Doctrine), you can load the [`ORM` part of Laravel module](https://codeception.com/docs/modules/Laravel#Parts)
* in addition to Symfony module.
- *
*/
class Symfony extends Framework implements DoctrineProvider, PartedModule
{
use BrowserAssertionsTrait;
use ConsoleAssertionsTrait;
use DoctrineAssertionsTrait;
+ use DomCrawlerAssertionsTrait;
use EventsAssertionsTrait;
use FormAssertionsTrait;
+ use HttpClientAssertionsTrait;
+ use LoggerAssertionsTrait;
use MailerAssertionsTrait;
use MimeAssertionsTrait;
use ParameterAssertionsTrait;
@@ -144,93 +161,120 @@ class Symfony extends Framework implements DoctrineProvider, PartedModule
use SecurityAssertionsTrait;
use ServicesAssertionsTrait;
use SessionAssertionsTrait;
+ use TranslationAssertionsTrait;
use TimeAssertionsTrait;
use TwigAssertionsTrait;
+ use ValidatorAssertionsTrait;
public Kernel $kernel;
- /**
- * @var SymfonyConnector
- */
+ /** @var SymfonyConnector|null */
public ?AbstractBrowser $client = null;
/**
- * @var array
+ * @var array{
+ * app_path:string,
+ * kernel_class:string,
+ * environment:string,
+ * debug:bool,
+ * cache_router:bool,
+ * em_service:string,
+ * rebootable_client:bool,
+ * authenticator:bool,
+ * bootstrap:bool,
+ * guard:bool
+ * }
*/
public array $config = [
- 'app_path' => 'app',
- 'kernel_class' => 'App\Kernel',
- 'environment' => 'test',
- 'debug' => true,
- 'cache_router' => false,
- 'em_service' => 'doctrine.orm.entity_manager',
+ 'app_path' => 'app',
+ 'kernel_class' => 'App\\Kernel',
+ 'environment' => 'test',
+ 'debug' => true,
+ 'cache_router' => false,
+ 'em_service' => 'doctrine.orm.entity_manager',
'rebootable_client' => true,
- 'authenticator' => false,
- 'guard' => false
+ 'authenticator' => false,
+ 'bootstrap' => false,
+ 'guard' => false,
];
- /**
- * @return string[]
- */
- public function _parts(): array
- {
- return ['services'];
- }
-
+ /** @var class-string|null */
protected ?string $kernelClass = null;
/**
* Services that should be persistent permanently for all tests
*
- * @var array
+ * @var array
*/
- protected $permanentServices = [];
+ protected array $permanentServices = [];
/**
* Services that should be persistent during test execution between kernel reboots
*
- * @var array
+ * @var array
*/
- protected $persistentServices = [];
+ protected array $persistentServices = [];
+
+ /** @return list */
+ public function _parts(): array
+ {
+ return ['services'];
+ }
public function _initialize(): void
{
$this->kernelClass = $this->getKernelClass();
- $maxNestingLevel = 200; // Symfony may have very long nesting level
- $xdebugMaxLevelKey = 'xdebug.max_nesting_level';
- if (ini_get($xdebugMaxLevelKey) < $maxNestingLevel) {
- ini_set($xdebugMaxLevelKey, (string)$maxNestingLevel);
+ $this->setXdebugMaxNestingLevel(200);
+
+ /** @var class-string $kernelClass */
+ $kernelClass = $this->kernelClass;
+ $this->kernel = new $kernelClass(
+ $this->config['environment'],
+ $this->config['debug']
+ );
+
+ if ($this->config['bootstrap']) {
+ $this->bootstrapEnvironment();
}
- $this->kernel = new $this->kernelClass($this->config['environment'], $this->config['debug']);
$this->kernel->boot();
- if ($this->config['cache_router'] === true) {
+ if ($this->config['cache_router']) {
$this->persistPermanentService('router');
}
}
/**
- * Initialize new client instance before each test
+ * Initialize new client instance before each test.
*/
public function _before(TestInterface $test): void
{
$this->persistentServices = array_merge($this->persistentServices, $this->permanentServices);
- $this->client = new SymfonyConnector($this->kernel, $this->persistentServices, $this->config['rebootable_client']);
+
+ $this->client = new SymfonyConnector(
+ $this->kernel,
+ $this->persistentServices,
+ $this->config['rebootable_client']
+ );
}
/**
- * Update permanent services after each test
+ * Update permanent services after each test.
*/
public function _after(TestInterface $test): void
{
foreach (array_keys($this->permanentServices) as $serviceName) {
- $this->permanentServices[$serviceName] = $this->grabService($serviceName);
+ $service = $this->getService($serviceName);
+ if (is_object($service)) {
+ $this->permanentServices[$serviceName] = $service;
+ } else {
+ unset($this->permanentServices[$serviceName]);
+ }
}
-
parent::_after($test);
}
+ /** @param array $settings */
protected function onReconfigure(array $settings = []): void
{
parent::_beforeSuite($settings);
@@ -238,224 +282,270 @@ protected function onReconfigure(array $settings = []): void
}
/**
- * Retrieve Entity Manager.
- *
- * EM service is retrieved once and then that instance returned on each call
+ * Retrieve the Doctrine EntityManager.
+ * EntityManager service is retrieved once and then reused.
*/
public function _getEntityManager(): EntityManagerInterface
{
- if ($this->kernel === null) {
- $this->fail('Symfony module is not loaded');
- }
-
+ /** @var non-empty-string $emService */
$emService = $this->config['em_service'];
+
if (!isset($this->permanentServices[$emService])) {
- // Try to persist configured entity manager
$this->persistPermanentService($emService);
$container = $this->_getContainer();
- if ($container->has('doctrine')) {
- $this->persistPermanentService('doctrine');
- }
-
- if ($container->has('doctrine.orm.default_entity_manager')) {
- $this->persistPermanentService('doctrine.orm.default_entity_manager');
- }
-
- if ($container->has('doctrine.dbal.default_connection')) {
- $this->persistPermanentService('doctrine.dbal.default_connection');
+ foreach (
+ ['doctrine', 'doctrine.orm.default_entity_manager', 'doctrine.dbal.default_connection'] as $service
+ ) {
+ if ($container->has($service)) {
+ $this->persistPermanentService($service);
+ }
}
}
+ /** @var EntityManagerInterface */
return $this->permanentServices[$emService];
}
- /**
- * Return container.
- */
public function _getContainer(): ContainerInterface
{
$container = $this->kernel->getContainer();
- if (!$container instanceof ContainerInterface) {
- $this->fail('Could not get Symfony container');
- }
-
- if ($container->has('test.service_container')) {
- $container = $container->get('test.service_container');
- }
-
- return $container;
+ /** @var ContainerInterface $testContainer */
+ $testContainer = $container->has('test.service_container') ? $container->get('test.service_container') : $container;
+ return $testContainer;
}
protected function getClient(): SymfonyConnector
{
- return $this->client ?: $this->fail('Client is not initialized');
+ if ($this->client === null) {
+ Assert::fail('Client is not initialized');
+ }
+
+ return $this->client;
}
/**
- * Attempts to guess the kernel location.
- * When the Kernel is located, the file is required.
+ * Find and require the Kernel class file.
*
- * @return string The Kernel class name
+ * @return class-string
* @throws ModuleRequireException|ReflectionException
*/
protected function getKernelClass(): string
{
- $path = codecept_root_dir() . $this->config['app_path'];
+ /** @var string $rootDir */
+ $rootDir = codecept_root_dir();
+ $path = $rootDir . $this->config['app_path'];
+
if (!file_exists($path)) {
throw new ModuleRequireException(
self::class,
- "Can't load Kernel from {$path}.\n"
- . 'Directory does not exist. Set `app_path` in your suite configuration to a valid application path.'
+ "Can't load Kernel from {$path}.\n" .
+ 'Directory does not exist. Set `app_path` in your suite configuration to a valid application path.'
);
}
- $finder = new Finder();
- $finder->name('*Kernel.php')->depth('0')->in($path);
- $results = iterator_to_array($finder);
+ $this->requireAdditionalAutoloader();
+
+ $finder = new Finder();
+ $results = iterator_to_array($finder->name('*Kernel.php')->depth('0')->in($path));
+
if ($results === []) {
throw new ModuleRequireException(
self::class,
- "File with Kernel class was not found at {$path}.\n"
- . 'Specify directory where file with Kernel class for your application is located with `app_path` parameter.'
+ "File with Kernel class was not found at {$path}.\n" .
+ 'Specify directory where file with Kernel class for your application is located with `app_path` parameter.'
);
}
- $this->requireAdditionalAutoloader();
-
- $filesRealPath = array_map(function ($file) {
- require_once $file;
- return $file->getRealPath();
- }, $results);
+ $kernelClass = $this->config['kernel_class'];
+ $filesRealPath = [];
- $kernelClass = $this->config['kernel_class'];
+ foreach ($results as $file) {
+ include_once $file->getRealPath();
+ $filesRealPath[] = $file->getRealPath();
+ }
if (class_exists($kernelClass)) {
- $reflectionClass = new ReflectionClass($kernelClass);
- if ($file = array_search($reflectionClass->getFileName(), $filesRealPath)) {
+ $ref = new ReflectionClass($kernelClass);
+ $fileName = $ref->getFileName();
+ if ($fileName !== false && in_array($fileName, $filesRealPath, true)) {
+ /** @var class-string $kernelClass */
return $kernelClass;
}
-
- throw new ModuleRequireException(self::class, "Kernel class was not found in {$file}.");
}
throw new ModuleRequireException(
self::class,
- "Kernel class was not found.\n"
- . 'Specify directory where file with Kernel class for your application is located with `app_path` parameter.'
+ "Kernel class was not found.\n" .
+ 'Specify directory where file with Kernel class for your application is located with `kernel_class` parameter.'
);
}
+ /**
+ * @throws AssertionFailedError
+ */
protected function getProfile(): ?Profile
{
- /** @var Profiler $profiler */
- if (!$profiler = $this->getService('profiler')) {
+ /** @var Profiler|null $profiler */
+ $profiler = $this->getService('profiler');
+
+ if ($profiler === null) {
return null;
}
try {
- $response = $this->getClient()->getResponse();
- return $profiler->loadProfileFromResponse($response);
- } catch (BadMethodCallException $e) {
- $this->fail('You must perform a request before using this method.');
- } catch (Exception $e) {
- $this->fail($e->getMessage());
+ return $profiler->loadProfileFromResponse($this->getClient()->getResponse());
+ } catch (BadMethodCallException) {
+ Assert::fail('You must perform a request before using this method.');
}
-
- return null;
}
/**
- * Grabs a Symfony Data Collector
+ * Grab a Symfony Data Collector from the current profile.
+ *
+ * @phpstan-return (
+ * $collector is DataCollectorName::EVENTS ? EventDataCollector :
+ * ($collector is DataCollectorName::FORM ? FormDataCollector :
+ * ($collector is DataCollectorName::HTTP_CLIENT ? HttpClientDataCollector :
+ * ($collector is DataCollectorName::LOGGER ? LoggerDataCollector :
+ * ($collector is DataCollectorName::TIME ? TimeDataCollector :
+ * ($collector is DataCollectorName::TRANSLATION ? TranslationDataCollector :
+ * ($collector is DataCollectorName::TWIG ? TwigDataCollector :
+ * ($collector is DataCollectorName::SECURITY ? SecurityDataCollector :
+ * ($collector is DataCollectorName::MAILER ? MessageDataCollector :
+ * DataCollectorInterface
+ * ))))))))
+ * )
+ *
+ * @throws AssertionFailedError
*/
- protected function grabCollector(string $collector, string $function, string $message = null): DataCollectorInterface
+ protected function grabCollector(DataCollectorName $collector, string $function, ?string $message = null): DataCollectorInterface
{
- if (($profile = $this->getProfile()) === null) {
- $this->fail(
- sprintf("The Profile is needed to use the '%s' function.", $function)
- );
- }
+ $profile = $this->getProfile();
- if (!$profile->hasCollector($collector)) {
- if ($message) {
- $this->fail($message);
- }
+ if ($profile === null) {
+ Assert::fail(sprintf("The Profile is needed to use the '%s' function.", $function));
+ }
- $this->fail(
- sprintf("The '%s' collector is needed to use the '%s' function.", $collector, $function)
+ if (!$profile->hasCollector($collector->value)) {
+ Assert::fail(
+ $message ?: sprintf(
+ "The '%s' collector is needed to use the '%s' function.",
+ $collector->value,
+ $function
+ )
);
}
- return $profile->getCollector($collector);
+ return $profile->getCollector($collector->value);
}
/**
- * Set the data that will be displayed when running a test with the `--debug` flag
- *
- * @param $url
+ * Set the data that will be displayed when running a test with the `--debug` flag.
*/
- protected function debugResponse($url): void
+ protected function debugResponse(mixed $url): void
{
parent::debugResponse($url);
- if (($profile = $this->getProfile()) === null) {
+ $profile = $this->getProfile();
+ if ($profile === null) {
return;
}
- if ($profile->hasCollector('security')) {
- /** @var SecurityDataCollector $security */
- $security = $profile->getCollector('security');
- if ($security->isAuthenticated()) {
- $roles = $security->getRoles();
+ if ($profile->hasCollector(DataCollectorName::SECURITY->value)) {
+ $securityCollector = $profile->getCollector(DataCollectorName::SECURITY->value);
+ if ($securityCollector instanceof SecurityDataCollector) {
+ $this->debugSecurityData($securityCollector);
+ }
+ }
- if ($roles instanceof Data) {
- $roles = $roles->getValue();
- }
+ if ($profile->hasCollector(DataCollectorName::MAILER->value)) {
+ $mailerCollector = $profile->getCollector(DataCollectorName::MAILER->value);
+ if ($mailerCollector instanceof MessageDataCollector) {
+ $this->debugMailerData($mailerCollector);
+ }
+ }
- $this->debugSection(
- 'User',
- $security->getUser()
- . ' [' . implode(',', $roles) . ']'
- );
- } else {
- $this->debugSection('User', 'Anonymous');
+ if ($profile->hasCollector(DataCollectorName::TIME->value)) {
+ $timeCollector = $profile->getCollector(DataCollectorName::TIME->value);
+ if ($timeCollector instanceof TimeDataCollector) {
+ $this->debugTimeData($timeCollector);
+ }
+ }
+ }
+
+ /** @return list */
+ protected function getInternalDomains(): array
+ {
+ $domains = [];
+
+ foreach ($this->grabRouterService()->getRouteCollection() as $route) {
+ if ($route->getHost() !== '') {
+ $regex = $route->compile()->getHostRegex();
+ if ($regex !== null && $regex !== '') {
+ $domains[] = $regex;
+ }
}
}
- if ($profile->hasCollector('mailer')) {
- /** @var MessageDataCollector $mailerCollector */
- $mailerCollector = $profile->getCollector('mailer');
- $emails = count($mailerCollector->getEvents()->getMessages());
- $this->debugSection('Emails', $emails . ' sent');
+ /** @var list */
+ return array_values(array_unique($domains));
+ }
+
+ /**
+ * Ensure Xdebug allows deep nesting.
+ */
+ private function setXdebugMaxNestingLevel(int $max): void
+ {
+ if (!extension_loaded('xdebug')) {
+ return;
}
- if ($profile->hasCollector('time')) {
- /** @var TimeDataCollector $timeCollector */
- $timeCollector = $profile->getCollector('time');
- $duration = number_format($timeCollector->getDuration(), 2) . ' ms';
- $this->debugSection('Time', $duration);
+ if ((int) ini_get('xdebug.max_nesting_level') < $max) {
+ ini_set('xdebug.max_nesting_level', (string) $max);
}
}
/**
- * Returns a list of recognized domain names.
+ * Bootstrap environment via tests/bootstrap.php or Dotenv.
*/
- protected function getInternalDomains(): array
+ private function bootstrapEnvironment(): void
{
- $internalDomains = [];
-
- $router = $this->grabRouterService();
- $routes = $router->getRouteCollection();
- /* @var Route $route */
- foreach ($routes as $route) {
- if (!is_null($route->getHost())) {
- $compiled = $route->compile();
- if (!is_null($compiled->getHostRegex())) {
- $internalDomains[] = $compiled->getHostRegex();
- }
- }
+ $bootstrapFile = $this->kernel->getProjectDir() . '/tests/bootstrap.php';
+
+ if (file_exists($bootstrapFile)) {
+ include_once $bootstrapFile;
+ return;
}
- return array_unique($internalDomains);
+ $_ENV['APP_ENV'] = $this->config['environment'];
+ (new Dotenv())->bootEnv('.env');
+ }
+
+ private function debugSecurityData(SecurityDataCollector $securityCollector): void
+ {
+ if (!$securityCollector->isAuthenticated()) {
+ $this->debugSection('User', 'Anonymous');
+ return;
+ }
+
+ $roles = $securityCollector->getRoles();
+ if ($roles instanceof Data) {
+ $roles = $roles->getValue(true);
+ }
+
+ $rolesStr = implode(',', array_map('strval', array_filter((array) $roles, 'is_scalar')));
+ $this->debugSection('User', sprintf('%s [%s]', $securityCollector->getUser(), $rolesStr));
+ }
+
+ private function debugMailerData(MessageDataCollector $messageCollector): void
+ {
+ $count = count($messageCollector->getEvents()->getMessages());
+ $this->debugSection('Emails', sprintf('%d sent', $count));
+ }
+
+ private function debugTimeData(TimeDataCollector $timeCollector): void
+ {
+ $this->debugSection('Time', sprintf('%.2f ms', $timeCollector->getDuration()));
}
/**
@@ -464,9 +554,12 @@ protected function getInternalDomains(): array
*/
private function requireAdditionalAutoloader(): void
{
- $autoLoader = codecept_root_dir() . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
- if (file_exists($autoLoader)) {
- require_once $autoLoader;
+ /** @var string $rootDir */
+ $rootDir = codecept_root_dir();
+ $autoload = $rootDir . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
+
+ if (file_exists($autoload)) {
+ include_once $autoload;
}
}
}
diff --git a/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php b/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php
index cabd34f2..8bd940b7 100644
--- a/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php
+++ b/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php
@@ -4,14 +4,277 @@
namespace Codeception\Module\Symfony;
+use PHPUnit\Framework\Constraint\Constraint;
+use PHPUnit\Framework\Constraint\LogicalNot;
+use Symfony\Component\BrowserKit\Test\Constraint\BrowserCookieValueSame;
+use Symfony\Component\BrowserKit\Test\Constraint\BrowserHasCookie;
+use Symfony\Component\HttpFoundation\Test\Constraint\RequestAttributeValueSame;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseCookieValueSame;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseFormatSame;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseHasCookie;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseHasHeader;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseHeaderLocationSame;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseHeaderSame;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseIsRedirected;
use Symfony\Component\HttpFoundation\Test\Constraint\ResponseIsSuccessful;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseIsUnprocessable;
+use Symfony\Component\HttpFoundation\Test\Constraint\ResponseStatusCodeSame;
+
use function sprintf;
trait BrowserAssertionsTrait
{
/**
- * Reboot client's kernel.
- * Can be used to manually reboot kernel when 'rebootable_client' => false
+ * Asserts that the given cookie in the test client is set to the expected value.
+ *
+ * ```php
+ * assertBrowserCookieValueSame('cookie_name', 'expected_value');
+ * ```
+ */
+ public function assertBrowserCookieValueSame(string $name, string $expectedValue, bool $raw = false, string $path = '/', ?string $domain = null, string $message = ''): void
+ {
+ $this->assertThatForClient(new BrowserHasCookie($name, $path, $domain), $message);
+ $this->assertThatForClient(new BrowserCookieValueSame($name, $expectedValue, $raw, $path, $domain), $message);
+ }
+
+ /**
+ * Asserts that the test client has the specified cookie set.
+ * This indicates that the cookie was set by any response during the test.
+ *
+ * ```
+ * assertBrowserHasCookie('cookie_name');
+ * ```
+ */
+ public function assertBrowserHasCookie(string $name, string $path = '/', ?string $domain = null, string $message = ''): void
+ {
+ $this->assertThatForClient(new BrowserHasCookie($name, $path, $domain), $message);
+ }
+
+ /**
+ * Asserts that the test client does not have the specified cookie set.
+ * This indicates that the cookie was not set by any response during the test.
+ *
+ * ```php
+ * assertBrowserNotHasCookie('cookie_name');
+ * ```
+ */
+ public function assertBrowserNotHasCookie(string $name, string $path = '/', ?string $domain = null, string $message = ''): void
+ {
+ $this->assertThatForClient(new LogicalNot(new BrowserHasCookie($name, $path, $domain)), $message);
+ }
+
+ /**
+ * Asserts that the specified request attribute matches the expected value.
+ *
+ * ```php
+ * assertRequestAttributeValueSame('attribute_name', 'expected_value');
+ * ```
+ */
+ public function assertRequestAttributeValueSame(string $name, string $expectedValue, string $message = ''): void
+ {
+ $this->assertThat($this->getClient()->getRequest(), new RequestAttributeValueSame($name, $expectedValue), $message);
+ }
+
+ /**
+ * Asserts that the specified response cookie is present and matches the expected value.
+ *
+ * ```php
+ * assertResponseCookieValueSame('cookie_name', 'expected_value');
+ * ```
+ */
+ public function assertResponseCookieValueSame(string $name, string $expectedValue, string $path = '/', ?string $domain = null, string $message = ''): void
+ {
+ $this->assertThatForResponse(new ResponseHasCookie($name, $path, $domain), $message);
+ $this->assertThatForResponse(new ResponseCookieValueSame($name, $expectedValue, $path, $domain), $message);
+ }
+
+ /**
+ * Asserts that the response format matches the expected format. This checks the format returned by the `Response::getFormat()` method.
+ *
+ * ```php
+ * assertResponseFormatSame('json');
+ * ```
+ */
+ public function assertResponseFormatSame(?string $expectedFormat, string $message = ''): void
+ {
+ $this->assertThatForResponse(new ResponseFormatSame($this->getClient()->getRequest(), $expectedFormat), $message);
+ }
+
+ /**
+ * Asserts that the specified cookie is present in the response. Optionally, it can check for a specific cookie path or domain.
+ *
+ * ```php
+ * assertResponseHasCookie('cookie_name');
+ * ```
+ */
+ public function assertResponseHasCookie(string $name, string $path = '/', ?string $domain = null, string $message = ''): void
+ {
+ $this->assertThatForResponse(new ResponseHasCookie($name, $path, $domain), $message);
+ }
+
+ /**
+ * Asserts that the specified header is available in the response.
+ * For example, use `assertResponseHasHeader('content-type');`.
+ *
+ * ```php
+ * assertResponseHasHeader('content-type');
+ * ```
+ */
+ public function assertResponseHasHeader(string $headerName, string $message = ''): void
+ {
+ $this->assertThatForResponse(new ResponseHasHeader($headerName), $message);
+ }
+
+ /**
+ * Asserts that the specified header does not contain the expected value in the response.
+ * For example, use `assertResponseHeaderNotSame('content-type', 'application/octet-stream');`.
+ *
+ * ```php
+ * assertResponseHeaderNotSame('content-type', 'application/json');
+ * ```
+ */
+ public function assertResponseHeaderNotSame(string $headerName, string $expectedValue, string $message = ''): void
+ {
+ $this->assertThatForResponse(new LogicalNot(new ResponseHeaderSame($headerName, $expectedValue)), $message);
+ }
+
+ /**
+ * Asserts that the specified header contains the expected value in the response.
+ * For example, use `assertResponseHeaderSame('content-type', 'application/octet-stream');`.
+ *
+ * ```php
+ * assertResponseHeaderSame('content-type', 'application/json');
+ * ```
+ */
+ public function assertResponseHeaderSame(string $headerName, string $expectedValue, string $message = ''): void
+ {
+ $this->assertThatForResponse(new ResponseHeaderSame($headerName, $expectedValue), $message);
+ }
+
+ /**
+ * Asserts that the response was successful (HTTP status code is in the 2xx range).
+ *
+ * ```php
+ * assertResponseIsSuccessful();
+ * ```
+ */
+ public function assertResponseIsSuccessful(string $message = '', bool $verbose = true): void
+ {
+ $this->assertThatForResponse(new ResponseIsSuccessful($verbose), $message);
+ }
+
+ /**
+ * Asserts that the response is unprocessable (HTTP status code is 422).
+ *
+ * ```php
+ * assertResponseIsUnprocessable();
+ * ```
+ */
+ public function assertResponseIsUnprocessable(string $message = '', bool $verbose = true): void
+ {
+ $this->assertThatForResponse(new ResponseIsUnprocessable($verbose), $message);
+ }
+
+ /**
+ * Asserts that the specified cookie is not present in the response. Optionally, it can check for a specific cookie path or domain.
+ *
+ * ```php
+ * assertResponseNotHasCookie('cookie_name');
+ * ```
+ */
+ public function assertResponseNotHasCookie(string $name, string $path = '/', ?string $domain = null, string $message = ''): void
+ {
+ $this->assertThatForResponse(new LogicalNot(new ResponseHasCookie($name, $path, $domain)), $message);
+ }
+
+ /**
+ * Asserts that the specified header is not available in the response.
+ *
+ * ```php
+ * assertResponseNotHasHeader('content-type');
+ * ```
+ */
+ public function assertResponseNotHasHeader(string $headerName, string $message = ''): void
+ {
+ $this->assertThatForResponse(new LogicalNot(new ResponseHasHeader($headerName)), $message);
+ }
+
+ /**
+ * Asserts that the response is a redirect. Optionally, you can check the target location and status code.
+ * The expected location can be either an absolute or a relative path.
+ *
+ * ```php
+ * assertResponseRedirects('/login', 302);
+ * ```
+ */
+ public function assertResponseRedirects(?string $expectedLocation = null, ?int $expectedCode = null, string $message = '', bool $verbose = true): void
+ {
+ $this->assertThatForResponse(new ResponseIsRedirected($verbose), $message);
+
+ if ($expectedLocation) {
+ $constraint = class_exists(ResponseHeaderLocationSame::class)
+ ? new ResponseHeaderLocationSame($this->getClient()->getRequest(), $expectedLocation)
+ : new ResponseHeaderSame('Location', $expectedLocation);
+ $this->assertThatForResponse($constraint, $message);
+ }
+
+ if ($expectedCode) {
+ $this->assertThatForResponse(new ResponseStatusCodeSame($expectedCode), $message);
+ }
+ }
+
+ /**
+ * Asserts that the response status code matches the expected code.
+ *
+ * ```php
+ * assertResponseStatusCodeSame(200);
+ * ```
+ */
+ public function assertResponseStatusCodeSame(int $expectedCode, string $message = '', bool $verbose = true): void
+ {
+ $this->assertThatForResponse(new ResponseStatusCodeSame($expectedCode, $verbose), $message);
+ }
+
+ /**
+ * Asserts the request matches the given route and optionally route parameters.
+ *
+ * ```php
+ * assertRouteSame('profile', ['id' => 123]);
+ * ```
+ *
+ * @param array $parameters
+ */
+ public function assertRouteSame(string $expectedRoute, array $parameters = [], string $message = ''): void
+ {
+ $request = $this->getClient()->getRequest();
+ $this->assertThat($request, new RequestAttributeValueSame('_route', $expectedRoute));
+
+ foreach ($parameters as $key => $value) {
+ $this->assertThat($request, new RequestAttributeValueSame($key, (string)$value), $message);
+ }
+ }
+
+ /**
+ * Reboots the client's kernel.
+ * Can be used to manually reboot the kernel when 'rebootable_client' is set to false.
*
* ```php
* seePageIsAvailable('/dashboard'); // Same as above
* ```
*
- * @param string|null $url
+ * @param string|null $url The URL of the page to check. If null, the current page is checked.
*/
- public function seePageIsAvailable(string $url = null): void
+ public function seePageIsAvailable(?string $url = null): void
{
if ($url !== null) {
$this->amOnPage($url);
$this->seeInCurrentUrl($url);
}
- $this->assertThat($this->getClient()->getResponse(), new ResponseIsSuccessful());
+ $this->assertResponseIsSuccessful();
}
/**
- * Goes to a page and check that it redirects to another.
+ * Navigates to a page and verifies that it redirects to another page.
*
* ```php
* seePageRedirectsTo('/admin', '/login');
* ```
- *
- * @param string $page
- * @param string $redirectsTo
*/
public function seePageRedirectsTo(string $page, string $redirectsTo): void
{
- $this->getClient()->followRedirects(false);
+ $client = $this->getClient();
+ $client->followRedirects(false);
$this->amOnPage($page);
- $response = $this->getClient()->getResponse();
- $this->assertTrue(
- $response->isRedirection()
- );
- $this->getClient()->followRedirect();
+
+ $this->assertThatForResponse(new ResponseIsRedirected(), 'The response is not a redirection.');
+
+ $client->followRedirect();
$this->seeInCurrentUrl($redirectsTo);
}
/**
- * Submit a form specifying the form name only once.
+ * Submits a form by specifying the form name only once.
*
* Use this function instead of [`$I->submitForm()`](#submitForm) to avoid repeating the form name in the field selectors.
- * If you customized the names of the field selectors use `$I->submitForm()` for full control.
+ * If you have customized the names of the field selectors, use `$I->submitForm()` for full control.
*
* ```php
* ` (you cannot use an array as selector here)
- * @param string[] $fields
+ * @param string $name The `name` attribute of the `