Skip to content

Added Twig assertions #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Codeception/Module/Symfony.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use Codeception\Module\Symfony\SecurityAssertionsTrait;
use Codeception\Module\Symfony\ServicesAssertionsTrait;
use Codeception\Module\Symfony\SessionAssertionsTrait;
use Codeception\Module\Symfony\TwigAssertionsTrait;
use Codeception\TestInterface;
use Exception;
use ReflectionClass;
Expand Down Expand Up @@ -153,7 +154,8 @@ class Symfony extends Framework implements DoctrineProvider, PartedModule
RouterAssertionsTrait,
SecurityAssertionsTrait,
ServicesAssertionsTrait,
SessionAssertionsTrait
SessionAssertionsTrait,
TwigAssertionsTrait
;

private static $possibleKernelClasses = [
Expand Down
87 changes: 87 additions & 0 deletions src/Codeception/Module/Symfony/TwigAssertionsTrait.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<?php

declare(strict_types=1);

namespace Codeception\Module\Symfony;

use Symfony\Bridge\Twig\DataCollector\TwigDataCollector;

trait TwigAssertionsTrait
{
/**
* Asserts that a template was not rendered in the response.
*
* ```php
* <?php
* $I->dontSeeRenderedTemplate('home.html.twig');
* ```
*
* @param string $template
*/
public function dontSeeRenderedTemplate(string $template): void
{
$twigCollector = $this->grabTwigCollector(__FUNCTION__);

$templates = (array) $twigCollector->getTemplates();

$this->assertArrayNotHasKey(
$template,
$templates,
"Template {$template} was rendered."
);
}

/**
* Asserts that the current template matches the expected template.
*
* ```php
* <?php
* $I->seeCurrentTemplateIs('home.html.twig');
* ```
*
* @param string $expectedTemplate
*/
public function seeCurrentTemplateIs(string $expectedTemplate): void
{
$twigCollector = $this->grabTwigCollector(__FUNCTION__);

$templates = (array) $twigCollector->getTemplates();
$actualTemplate = array_key_first($templates);

$this->assertEquals(
$expectedTemplate,
$actualTemplate,
"Actual template {$actualTemplate} does not match expected template {$expectedTemplate}."
);
}

/**
* Asserts that a template was rendered in the response.
* That includes templates built with [inheritance](https://twig.symfony.com/doc/3.x/templates.html#template-inheritance).
*
* ```php
* <?php
* $I->seeRenderedTemplate('home.html.twig');
* $I->seeRenderedTemplate('layout.html.twig');
* ```
*
* @param string $template
*/
public function seeRenderedTemplate(string $template): void
{
$twigCollector = $this->grabTwigCollector(__FUNCTION__);

$templates = (array) $twigCollector->getTemplates();

$this->assertArrayHasKey(
$template,
$templates,
"Template {$template} was not rendered."
);
}

protected function grabTwigCollector(string $function): TwigDataCollector
{
return $this->grabCollector('twig', $function);
}
}