Skip to content

Added Symfony Logger assertion (dontSeeDeprecations) #206

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.

Sign up for GitHub

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
TavoNiievez merged 1 commit into from
Feb 20, 2025
Merged

Added Symfony Logger assertion (dontSeeDeprecations) #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/Codeception/Module/Symfony.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
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;
Expand Down Expand Up @@ -142,6 +143,7 @@ class Symfony extends Framework implements DoctrineProvider, PartedModule
use EventsAssertionsTrait;
use FormAssertionsTrait;
use HttpClientAssertionsTrait;
use LoggerAssertionsTrait;
use MailerAssertionsTrait;
use MimeAssertionsTrait;
use ParameterAssertionsTrait;
Expand Down
60 changes: 60 additions & 0 deletions src/Codeception/Module/Symfony/LoggerAssertionsTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php

declare(strict_types=1);

namespace Codeception\Module\Symfony;

use Symfony\Component\HttpKernel\DataCollector\LoggerDataCollector;
use Symfony\Component\VarDumper\Cloner\Data;
use function sprintf;

trait LoggerAssertionsTrait
{
/**
* Asserts that there are no deprecation messages in Symfony's log.
*
* ```php
* <?php
* $I->amOnPage('/home');
* $I->dontSeeDeprecations();
* ```
*
* @param string $message Optional custom failure message.
*/
public function dontSeeDeprecations(string $message = ''): void
{
$loggerCollector = $this->grabLoggerCollector(__FUNCTION__);
$logs = $loggerCollector->getProcessedLogs();

$foundDeprecations = [];

foreach ($logs as $log) {
if (isset($log['type']) && $log['type'] === 'deprecation') {
$msg = $log['message'];
if ($msg instanceof Data) {
$msg = $msg->getValue(true);
}
if (!is_string($msg)) {
$msg = (string)$msg;
}
$foundDeprecations[] = $msg;
}
}

$errorMessage = $message ?: sprintf(
"Found %d deprecation message%s in the log:\n%s",
count($foundDeprecations),
count($foundDeprecations) > 1 ? 's' : '',
implode("\n", array_map(static function ($msg) {
return " - " . $msg;
}, $foundDeprecations))
);

$this->assertEmpty($foundDeprecations, $errorMessage);
}

protected function grabLoggerCollector(string $function): LoggerDataCollector
{
return $this->grabCollector('logger', $function);
}
}