Search

Symfony

Installation

composer require --dev codeception/module-symfony

Description

This module uses Symfony’s DomCrawler and HttpKernel Component to emulate requests and test response.

Access Symfony services through the dependency injection container: $I->grabService(...)
Use Doctrine to test against the database: $I->seeInRepository(...) - see Doctrine Module
Assert that emails would have been sent: $I->seeEmailIsSent()
Tests are wrapped into Doctrine transaction to speed them up.
Symfony Router can be cached between requests to speed up testing.

Demo Project

https://github.com/Codeception/symfony-module-tests

Config

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
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)

Sample `Functional.suite.yml`

modules:
   enabled:
      - Symfony:
          app_path: 'src'
          environment: 'test'

Public Properties

kernel - HttpKernel instance
client - current Crawler instance

Parts

services: Includes methods related to the Symfony dependency injection container (DIC):
- grabService
- persistService
- persistPermanentService
- unpersistService

See WebDriver module for general information on how to load parts of a framework module.

Usage example:

actor: AcceptanceTester
modules:
    enabled:
        - Symfony:
            part: services
        - Doctrine:
            depends: Symfony
        - WebDriver:
            url: https://example.com
            browser: firefox

If you’re using Symfony with Eloquent ORM (instead of Doctrine), you can load the ORM part of Laravel module in addition to Symfony module.

Actions

_findElements

hidden API method, expected to be used from Helper classes

api
param mixed $locator
return iterable

Locates element using available Codeception locator types:

XPath
CSS
Strict Locator

Use it in Helpers or GroupObject or Extension classes:

<?php
$els = $this->getModule('Symfony')->_findElements('.items');
$els = $this->getModule('Symfony')->_findElements(['name' => 'username']);

$editLinks = $this->getModule('Symfony')->_findElements(['link' => 'Edit']);
// now you can iterate over $editLinks and check that all them have valid hrefs

WebDriver module returns Facebook\WebDriver\Remote\RemoteWebElement instances PhpBrowser and Framework modules return Symfony\Component\DomCrawler\Crawler instances

_getResponseContent

hidden API method, expected to be used from Helper classes

api
throws ModuleException
return string

Returns content of the last response Use it in Helpers when you want to retrieve response of request performed by another module.

<?php
// in Helper class
public function seeResponseContains($text)
{
   $this->assertStringContainsString($text, $this->getModule('Symfony')->_getResponseContent(), "response contains");
}

_loadPage

hidden API method, expected to be used from Helper classes

api
param string $method
param string $uri
param array $parameters
param array $files
param array $server
param ?string $content
return void

Opens a page with arbitrary request parameters.

Useful for testing multi-step forms on a specific step.

<?php
// in Helper class
public function openCheckoutFormStep2($orderId) {
    $this->getModule('Symfony')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]);
}

_request

hidden API method, expected to be used from Helper classes

api
see _loadPage
param string $method
param string $uri
param array $parameters
param array $files
param array $server
param ?string $content
throws ExternalUrlException|ModuleException
return ?string

Send custom request to a backend using method, uri, parameters, etc.

Use it in Helpers to create special request actions, like accessing API Returns a string with response body.

<?php
// in Helper class
public function createUserByApi($name) {
    $userData = $this->getModule('Symfony')->_request('POST', '/api/v1/users', ['name' => $name]);
    $user = json_decode($userData);
    return $user->id;
}

Does not load the response into the module so you can’t interact with response page (click, fill forms). To load arbitrary page for interaction, use _loadPage method.

_savePageSource

hidden API method, expected to be used from Helper classes

api
param string $filename
return void

Saves page source of to a file

$this->getModule('Symfony')->_savePageSource(codecept_output_dir().'page.html');

amHttpAuthenticated

param string $username
param string $password
return void

Authenticates user for HTTP_AUTH

amLoggedInAs

param \Symfony\Component\Security\Core\User\UserInterface $user
param string $firewallName
param ?string $firewallContext
return void

The $user object must have a persistent identifier. If you have more than one firewall or firewall context, you can specify the desired one as a parameter.

<?php
$user = $I->grabEntityFromRepository(User::class, [
    'email' => '[email protected]'
]);
$I->amLoggedInAs($user);

amLoggedInWithToken

param \Symfony\Component\Security\Core\Authentication\Token\TokenInterface $token
param string $firewallName
param ?string $firewallContext
return void

amOnAction

param string $action
param array $params
return void

Opens web page by action name

<?php
$I->amOnAction('PostController::index');
$I->amOnAction('HomeController');
$I->amOnAction('ArticleController', ['slug' => 'lorem-ipsum']);

amOnPage

param string $page
return void

Opens the page for the given relative URI.

<?php
// opens front page
$I->amOnPage('/');
// opens /register page
$I->amOnPage('/register');

amOnRoute

param string $routeName
param array $params
return void

Opens web page using route name and parameters.

<?php
$I->amOnRoute('posts.create');
$I->amOnRoute('posts.show', ['id' => 34]);

assertEmailAddressContains

param string $headerName
param string $expectedValue
param ?\Symfony\Component\Mime\Email $email
return void

Verify that an email contains addresses with a header $headerName and its expected value $expectedValue.