vendor/symfony/maker-bundle/src/Maker/MakeTest.php line 166

  1. <?php
  3. /*
  4.  * This file is part of the Symfony MakerBundle package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\MakerBundle\Maker;
  14. use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase as LegacyApiTestCase;
  15. use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
  16. use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
  17. use Symfony\Bundle\FrameworkBundle\Test\WebTestAssertionsTrait;
  18. use Symfony\Bundle\MakerBundle\ConsoleStyle;
  19. use Symfony\Bundle\MakerBundle\DependencyBuilder;
  20. use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
  21. use Symfony\Bundle\MakerBundle\Generator;
  22. use Symfony\Bundle\MakerBundle\InputAwareMakerInterface;
  23. use Symfony\Bundle\MakerBundle\InputConfiguration;
  24. use Symfony\Bundle\MakerBundle\Validator;
  25. use Symfony\Component\BrowserKit\History;
  26. use Symfony\Component\Console\Command\Command;
  27. use Symfony\Component\Console\Input\InputArgument;
  28. use Symfony\Component\Console\Input\InputInterface;
  29. use Symfony\Component\CssSelector\CssSelectorConverter;
  30. use Symfony\Component\Panther\PantherTestCaseTrait;
  32. /**
  33.  * @author Kévin Dunglas <kevin@dunglas.fr>
  34.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  35.  * @author Ryan Weaver <weaverryan@gmail.com>
  36.  */
  37. final class MakeTest extends AbstractMaker implements InputAwareMakerInterface
  38. {
  39.     private const DESCRIPTIONS = [
  40.         'TestCase' => 'basic PHPUnit tests',
  41.         'KernelTestCase' => 'basic tests that have access to Symfony services',
  42.         'WebTestCase' => 'to run browser-like scenarios, but that don\'t execute JavaScript code',
  43.         'ApiTestCase' => 'to run API-oriented scenarios',
  44.         'PantherTestCase' => 'to run e2e scenarios, using a real-browser or HTTP client and a real web server',
  45.     ];
  46.     private const DOCS = [
  47.         'TestCase' => 'https://symfony.com/doc/current/testing.html#unit-tests',
  48.         'KernelTestCase' => 'https://symfony.com/doc/current/testing/database.html#functional-testing-of-a-doctrine-repository',
  49.         'WebTestCase' => 'https://symfony.com/doc/current/testing.html#functional-tests',
  50.         'ApiTestCase' => 'https://api-platform.com/docs/distribution/testing/',
  51.         'PantherTestCase' => 'https://github.com/symfony/panther#testing-usage',
  52.     ];
  54.     public static function getCommandName(): string
  55.     {
  56.         return 'make:test';
  57.     }
  59.     /**
  60.      * @deprecated remove this method when removing make:unit-test and make:functional-test
  61.      */
  62.     public static function getCommandAliases(): iterable
  63.     {
  64.         yield 'make:unit-test';
  65.         yield 'make:functional-test';
  66.     }
  68.     public static function getCommandDescription(): string
  69.     {
  70.         return 'Creates a new test class';
  71.     }
  73.     public function configureCommand(Command $command, InputConfiguration $inputConfig): void
  74.     {
  75.         $typesDesc = [];
  76.         $typesHelp = [];
  77.         foreach (self::DESCRIPTIONS as $type => $desc) {
  78.             $typesDesc[] = sprintf('<fg=yellow>%s</> (%s)', $type, $desc);
  79.             $typesHelp[] = sprintf('* <info>%s</info>: %s', $type, $desc);
  80.         }
  82.         $command
  83.             ->addArgument('type', InputArgument::OPTIONAL, 'The type of test: '.implode(', ', $typesDesc))
  84.             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the test class (e.g. <fg=yellow>BlogPostTest</>)')
  85.             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeTest.txt').implode("\n", $typesHelp));
  87.         $inputConfig->setArgumentAsNonInteractive('name');
  88.         $inputConfig->setArgumentAsNonInteractive('type');
  89.     }
  91.     public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
  92.     {
  93.         /* @deprecated remove the following block when removing make:unit-test and make:functional-test */
  94.         $this->handleDeprecatedMakerCommands($input, $io);
  96.         if (null !== $type = $input->getArgument('type')) {
  97.             if (!isset(self::DESCRIPTIONS[$type])) {
  98.                 throw new RuntimeCommandException(sprintf('The test type must be one of "%s", "%s" given.', implode('", "', array_keys(self::DESCRIPTIONS)), $type));
  99.             }
  100.         } else {
  101.             $input->setArgument(
  102.                 'type',
  103.                 $io->choice('Which test type would you like?', self::DESCRIPTIONS)
  104.             );
  105.         }
  107.         if ('ApiTestCase' === $input->getArgument('type') && !class_exists(ApiTestCase::class) && !class_exists(LegacyApiTestCase::class)) {
  108.             $io->warning([
  109.                 'API Platform is required for this test type. Install it with',
  110.                 'composer require api',
  111.             ]);
  112.         }
  114.         if ('PantherTestCase' === $input->getArgument('type') && !trait_exists(PantherTestCaseTrait::class)) {
  115.             $io->warning([
  116.                 'symfony/panther is required for this test type. Install it with',
  117.                 'composer require symfony/panther --dev',
  118.             ]);
  119.         }
  121.         if (null === $input->getArgument('name')) {
  122.             $io->writeln([
  123.                 '',
  124.                 'Choose a class name for your test, like:',
  125.                 ' * <fg=yellow>UtilTest</> (to create tests/UtilTest.php)',
  126.                 ' * <fg=yellow>Service\\UtilTest</> (to create tests/Service/UtilTest.php)',
  127.                 ' * <fg=yellow>\\App\Tests\\Service\\UtilTest</> (to create tests/Service/UtilTest.php)',
  128.             ]);
  130.             $nameArgument = $command->getDefinition()->getArgument('name');
  131.             $value = $io->ask($nameArgument->getDescription(), $nameArgument->getDefault(), [Validator::class, 'notBlank']);
  132.             $input->setArgument($nameArgument->getName(), $value);
  133.         }
  134.     }
  136.     public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
  137.     {
  138.         $testClassNameDetails = $generator->createClassNameDetails(
  139.             $input->getArgument('name'),
  140.             'Tests\\',
  141.             'Test'
  142.         );
  144.         $type = $input->getArgument('type');
  146.         $generator->generateClass(
  147.             $testClassNameDetails->getFullName(),
  148.             "test/$type.tpl.php",
  149.             [
  150.                 'web_assertions_are_available' => trait_exists(WebTestAssertionsTrait::class),
  151.                 'use_legacy_container_property' => $this->useLegacyContainerProperty(),
  152.                 'api_test_case_fqcn' => !class_exists(ApiTestCase::class) ? LegacyApiTestCase::class : ApiTestCase::class,
  153.             ]
  154.         );
  156.         $generator->writeChanges();
  158.         $this->writeSuccessMessage($io);
  160.         $io->text([
  161.             'Next: Open your new test class and start customizing it.',
  162.             sprintf('Find the documentation at <fg=yellow>%s</>', self::DOCS[$type]),
  163.         ]);
  164.     }
  166.     public function configureDependencies(DependencyBuilder $dependencies, InputInterface $input = null): void
  167.     {
  168.         if (null === $input) {
  169.             return;
  170.         }
  172.         switch ($input->getArgument('type')) {
  173.             case 'WebTestCase':
  174.                 $dependencies->addClassDependency(
  175.                     History::class,
  176.                     'browser-kit',
  177.                     true,
  178.                     true
  179.                 );
  180.                 $dependencies->addClassDependency(
  181.                     CssSelectorConverter::class,
  182.                     'css-selector',
  183.                     true,
  184.                     true
  185.                 );
  187.                 return;
  189.             case 'ApiTestCase':
  190.                 $dependencies->addClassDependency(
  191.                     !class_exists(ApiTestCase::class) ? LegacyApiTestCase::class : ApiTestCase::class,
  192.                     'api',
  193.                     true,
  194.                     false
  195.                 );
  197.                 return;
  199.             case 'PantherTestCase':
  200.                 $dependencies->addClassDependency(
  201.                     PantherTestCaseTrait::class,
  202.                     'panther',
  203.                     true,
  204.                     true
  205.                 );
  207.                 return;
  208.         }
  209.     }
  211.     /**
  212.      * @deprecated
  213.      */
  214.     private function handleDeprecatedMakerCommands(InputInterface $input, ConsoleStyle $io): void
  215.     {
  216.         $currentCommand = $input->getFirstArgument();
  217.         switch ($currentCommand) {
  218.             case 'make:unit-test':
  219.                 $input->setArgument('type', 'TestCase');
  220.                 $io->warning('The "make:unit-test" command is deprecated, use "make:test" instead.');
  221.                 break;
  223.             case 'make:functional-test':
  224.                 $input->setArgument('type', trait_exists(PantherTestCaseTrait::class) ? 'WebTestCase' : 'PantherTestCase');
  225.                 $io->warning('The "make:functional-test" command is deprecated, use "make:test" instead.');
  226.                 break;
  227.         }
  228.     }
  230.     private function useLegacyContainerProperty(): bool
  231.     {
  232.         // for 5.2 and lower
  233.         return !method_exists(KernelTestCase::class, 'getContainer');
  234.     }
  235. }