Add functional tests for the new Symfony module assertions

Cover the assertions added in codeception/module-symfony:
assertSessionHasFlashMessage(), the console ExecutionResult assertions,
mockService(), seeNumQueriesIsLessThan()/dontSeeDuplicateQueries() and the
Messenger in-memory transport assertions.

Add the matching app fixtures: a flash-and-redirect controller (/flash), a
ResultCommand exercising success / failure / invalid / stderr for
runCommand(), a Greeting service behind /greeting to swap with
mockService(), a query-heavy /run-queries page for the Doctrine query-count
assertions, and an in-memory async transport with SendWelcomeMessage routed
to it.

Author: TavoNiievez

config/packages/messenger.yaml

@@ -5,3 +5,7 @@ framework:
         default_bus: messenger.bus.default
         buses:
             messenger.bus.default: ~
+        transports:
+            async: 'in-memory://'
+        routing:
+            App\Message\SendWelcomeMessage: async

config/routes.php

@@ -6,10 +6,13 @@
 use App\Controller\DashboardController;
 use App\Controller\DomCrawlerController;
 use App\Controller\ExternalApiController;
+use App\Controller\FlashController;
 use App\Controller\FormController;
+use App\Controller\GreetingController;
 use App\Controller\HomeController;
 use App\Controller\HttpClientController;
 use App\Controller\RegistrationController;
+use App\Controller\RunQueriesController;
 use App\Controller\SecurityController;
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 
@@ -109,4 +112,16 @@
     $routes->add('dispatch_message', '/dispatch-message')
         ->controller(App\Controller\DispatchMessageController::class)
         ->methods(['GET']);
+
+    $routes->add('app_flash', '/flash')
+        ->controller(FlashController::class)
+        ->methods(['GET']);
+
+    $routes->add('app_greeting', '/greeting')
+        ->controller(GreetingController::class)
+        ->methods(['GET']);
+
+    $routes->add('app_run_queries', '/run-queries')
+        ->controller(RunQueriesController::class)
+        ->methods(['GET']);
 };

config/services_test.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use App\Service\Greeting;
 use Symfony\Bundle\SecurityBundle\Security;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
@@ -10,4 +11,8 @@
 
     $services->alias(Security::class, 'security.helper')
         ->public();
+
+    $services->set(Greeting::class)
+        ->autowire()
+        ->public();
 };

src/Command/ResultCommand.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Command;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\ConsoleOutputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(ResultCommand::COMMAND_NAME, 'A command exercising the execution result paths.')]
+final class ResultCommand extends Command
+{
+    public const COMMAND_NAME = 'app:result-command';
+
+    protected function configure(): void
+    {
+        $this->addOption('fail', null, InputOption::VALUE_NONE);
+        $this->addOption('invalid', null, InputOption::VALUE_NONE);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        if ($input->getOption('invalid')) {
+            $output->writeln('Invalid input.');
+
+            return Command::INVALID;
+        }
+
+        if ($input->getOption('fail')) {
+            if ($output instanceof ConsoleOutputInterface) {
+                $output->getErrorOutput()->writeln('Something failed.');
+            }
+
+            return Command::FAILURE;
+        }
+
+        $output->writeln('All good.');
+
+        return Command::SUCCESS;
+    }
+}

src/Controller/FlashController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+
+final class FlashController extends AbstractController
+{
+    public function __invoke(): RedirectResponse
+    {
+        $this->addFlash('success', 'Welcome back!');
+
+        return $this->redirectToRoute('index');
+    }
+}

src/Controller/GreetingController.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Service\Greeting;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+final class GreetingController extends AbstractController
+{
+    public function __construct(
+        private readonly Greeting $greeting,
+    ) {
+    }
+
+    public function __invoke(): Response
+    {
+        return new Response($this->greeting->greet());
+    }
+}

src/Controller/RunQueriesController.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Repository\UserRepository;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+final class RunQueriesController extends AbstractController
+{
+    public function __construct(
+        private readonly UserRepository $users,
+    ) {
+    }
+
+    public function __invoke(): Response
+    {
+        $this->users->findAll();
+        $this->users->getByEmail('john_doe@gmail.com');
+
+        return new Response('Queries executed.');
+    }
+}

src/Service/Greeting.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Service;
+
+class Greeting
+{
+    public function greet(): string
+    {
+        return 'Hello world!';
+    }
+}

tests/Functional/ConsoleCest.php

@@ -5,6 +5,7 @@
 namespace App\Tests\Functional;
 
 use App\Command\ExampleCommand;
+use App\Command\ResultCommand;
 use App\Tests\Support\FunctionalTester;
 
 final class ConsoleCest
@@ -29,4 +30,15 @@ public function runSymfonyConsoleCommand(FunctionalTester $I)
         );
         $I->assertStringContainsString('Bye world!', $output);
     }
+
+    public function consoleExecutionResult(FunctionalTester $I): void
+    {
+        $I->assertCommandIsSuccessful($I->runCommand(ResultCommand::COMMAND_NAME));
+        $I->assertCommandFailed($I->runCommand(ResultCommand::COMMAND_NAME, ['--fail' => true]));
+        $I->assertCommandIsInvalid($I->runCommand(ResultCommand::COMMAND_NAME, ['--invalid' => true]));
+
+        $result = $I->runCommand(ResultCommand::COMMAND_NAME, ['--fail' => true]);
+        $I->assertStringContainsString('Something failed.', $result->getErrorOutput());
+        $I->assertCommandResultEquals($result, expectedStatusCode: 1);
+    }
 }

tests/Functional/DoctrineCest.php

@@ -43,4 +43,11 @@ public function seeNumRecords(FunctionalTester $I)
     {
         $I->seeNumRecords(1, User::class);
     }
+
+    public function queryCountAssertions(FunctionalTester $I): void
+    {
+        $I->amOnPage('/run-queries');
+        $I->seeNumQueriesIsLessThan(10);
+        $I->dontSeeDuplicateQueries();
+    }
 }