Add BaseGeneratorTets

Author: Chi-teck

src/Test/BaseGeneratorTest.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace DrupalCodeGenerator\Test;
+
+use DrupalCodeGenerator\Application;
+use DrupalCodeGenerator\Helper\Renderer;
+use DrupalCodeGenerator\Tests\QuestionHelper;
+use DrupalCodeGenerator\Twig\TwigEnvironment;
+use DrupalCodeGenerator\Utils;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Filesystem\Filesystem;
+use Twig\Loader\FilesystemLoader;
+
+/**
+ * Base class for generator tests.
+ */
+abstract class BaseGeneratorTest extends TestCase {
+
+  protected $display;
+  protected $fixtureDir;
+  private $directory;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setUp(): void {
+    $this->directory = \sys_get_temp_dir() . '/dcg_sandbox';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function tearDown(): void {
+    (new Filesystem())->remove($this->directory);
+  }
+
+  /**
+   * Executes the command.
+   *
+   * @param \Symfony\Component\Console\Command\Command $command
+   *   A command to execute.
+   * @param array $input
+   *   An array of strings representing each input passed to the command input
+   *   stream.
+   *
+   * @return int
+   *   The command exit code
+   */
+  protected function execute(Command $command, array $input): int {
+    $this->createApplication()->add($command);
+
+    $command_tester = new CommandTester($command);
+    $result = $command_tester
+      ->setInputs(\array_values($input))
+      ->execute(['--destination' => $this->directory, '--working-dir' => $this->directory]);
+
+    $this->display = $command_tester->getDisplay();
+
+    return $result;
+  }
+
+  /**
+   * Asserts generat display.
+   */
+  protected function assertDisplay(string $expected_display): void {
+    $default_name = Utils::machine2human(\basename($this->directory), TRUE);
+    $expected_display = \str_replace('%default_name%', $default_name, $expected_display);
+    self::assertEquals($expected_display, $this->display);
+  }
+
+  /**
+   * Asserts generated file.
+   */
+  protected function assertGeneratedFile(string $file, string $fixture): void {
+    self::assertFileEquals($this->fixtureDir . '/' . $fixture, $this->directory . '/' . $file);
+  }
+
+  /**
+   * Creates DCG application.
+   */
+  private function createApplication(): Application {
+    $application = Application::create();
+
+    $helper_set = $application->getHelperSet();
+
+    // Replace default question helper to ease parsing output.
+    $helper_set->set(new QuestionHelper());
+
+    // Replace default renderer to support 'strict_variables' in tests.
+    $twig_environment = new TwigEnvironment(new FilesystemLoader(), ['strict_variables' => TRUE]);
+    $helper_set->set(new Renderer($twig_environment));
+    return $application;
+  }
+
+}

tests/dcg/Generator/BaseGeneratorTest.php

@@ -2,11 +2,12 @@
 
 namespace DrupalCodeGenerator\Tests\Generator;
 
-use DrupalCodeGenerator\GeneratorTester;
 use DrupalCodeGenerator\Tests\BaseTestCase;
 
 /**
  * Base class for generators tests.
+ *
+ * @todo Replace with \DrupalCodeGenerator\Test\BaseGeneratorTest
  */
 abstract class BaseGeneratorTest extends BaseTestCase {
 

tests/dcg/Generator/ControllerTest.php

@@ -2,30 +2,85 @@
 
 namespace DrupalCodeGenerator\Tests\Generator;
 
+use DrupalCodeGenerator\Command\Controller;
+use DrupalCodeGenerator\Test\BaseGeneratorTest;
+
 /**
  * Test for controller command.
  */
 final class ControllerTest extends BaseGeneratorTest {
 
-  protected $class = 'Controller';
-
-  protected $interaction = [
-    'Module name [%default_name%]:' => 'Foo',
-    'Module machine name [foo]:' => 'foo',
-    'Class [FooController]:' => 'FooController',
-    'Would you like to inject dependencies? [No]:' => 'Yes',
-    '<1> Type the service name or use arrows up/down. Press enter to continue:' => 'database',
-    '<2> Type the service name or use arrows up/down. Press enter to continue:' => '',
-    'Would you like to create a route for this controller? [Yes]:' => 'Yes',
-    'Route name [foo.example]:' => 'example.bar',
-    'Route path [/foo/example]:' => '/foo/example',
-    'Route title [Example]:' => 'Bar',
-    'Route permission [access content]:' => 'access content',
-  ];
-
-  protected $fixtures = [
-    'foo.routing.yml' => '/_controller_routing.yml',
-    'src/Controller/FooController.php' => '/_controller.php',
-  ];
+  protected $fixtureDir = __DIR__;
+
+  /**
+   * Test callback.
+   */
+  public function testGenerator(): void {
+
+    $input = [
+      'Foo',
+      'foo',
+      'FooController',
+      'Yes',
+      'database',
+      '',
+      'Yes',
+      'example.bar',
+      '/foo/example',
+      'Bar',
+      'access content',
+    ];
+    $this->execute(new Controller(), $input);
+
+    $expected_display = <<< 'TXT'
+
+     Welcome to controller generator!
+    ––––––––––––––––––––––––––––––––––
+
+     Module name [%default_name%]:
+     ➤ 
+
+     Module machine name [foo]:
+     ➤ 
+
+     Class [FooController]:
+     ➤ 
+
+     Would you like to inject dependencies? [No]:
+     ➤ 
+
+     Type the service name or use arrows up/down. Press enter to continue:
+     ➤ 
+
+     Type the service name or use arrows up/down. Press enter to continue:
+     ➤ 
+
+     Would you like to create a route for this controller? [Yes]:
+     ➤ 
+
+     Route name [foo.example]:
+     ➤ 
+
+     Route path [/foo/example]:
+     ➤ 
+
+     Route title [Example]:
+     ➤ 
+
+     Route permission [access content]:
+     ➤ 
+
+     The following directories and files have been created or updated:
+    –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
+     • foo.routing.yml
+     • src/Controller/FooController.php
+
+
+    TXT;
+    $this->assertDisplay($expected_display);
+
+    $this->assertGeneratedFile('src/Controller/FooController.php', '_controller.php');
+    $this->assertGeneratedFile('foo.routing.yml', '_controller_routing.yml');
+  }
 
 }

src/GeneratorTester.php renamed to tests/dcg/Generator/GeneratorTester.php

@@ -1,10 +1,12 @@
 <?php
 
-namespace DrupalCodeGenerator;
+namespace DrupalCodeGenerator\Tests\Generator;
 
+use DrupalCodeGenerator\Application;
 use DrupalCodeGenerator\Helper\Renderer;
 use DrupalCodeGenerator\Tests\QuestionHelper;
 use DrupalCodeGenerator\Twig\TwigEnvironment;
+use DrupalCodeGenerator\Utils;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Tester\CommandTester;
 use Twig\Loader\FilesystemLoader;

tests/dcg/Generator/PhpStormMetadataTest.php

@@ -3,7 +3,6 @@
 namespace DrupalCodeGenerator\Tests\Generator;
 
 use DrupalCodeGenerator\Command\PhpStormMetadata;
-use DrupalCodeGenerator\GeneratorTester;
 use DrupalCodeGenerator\Helper\DrupalContext;
 
 /**