class GenerateThemeTest
Tests the generate-theme commands.
@requires extension pdo_sqlite
@group Command @group #slow
Hierarchy
- class \Drupal\BuildTests\Framework\BuildTestBase uses \Drupal\TestTools\Extension\RequiresComposerTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait extends \PHPUnit\Framework\TestCase- class \Drupal\BuildTests\QuickStart\QuickStartTestBase extends \Drupal\BuildTests\Framework\BuildTestBase- class \Drupal\BuildTests\Command\GenerateThemeTest extends \Drupal\BuildTests\QuickStart\QuickStartTestBase
 
 
- class \Drupal\BuildTests\QuickStart\QuickStartTestBase extends \Drupal\BuildTests\Framework\BuildTestBase
Expanded class hierarchy of GenerateThemeTest
File
- 
              core/tests/ Drupal/ BuildTests/ Command/ GenerateThemeTest.php, line 24 
Namespace
Drupal\BuildTests\CommandView source
class GenerateThemeTest extends QuickStartTestBase {
  
  /**
   * The PHP executable path.
   *
   * @var string
   */
  protected $php;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $sqlite = (new \PDO('sqlite::memory:'))->query('select sqlite_version()')
      ->fetch()[0];
    if (version_compare($sqlite, Tasks::SQLITE_MINIMUM_VERSION) < 0) {
      $this->markTestSkipped();
    }
    parent::setUp();
    $php_executable_finder = new PhpExecutableFinder();
    $this->php = $php_executable_finder->find();
    $this->copyCodebase();
    $this->executeCommand('COMPOSER_DISCARD_CHANGES=true composer install --no-dev --no-interaction');
    chdir($this->getWorkingPath());
  }
  
  /**
   * Generates PHP process to generate a theme from core's starterkit theme.
   *
   * @return \Symfony\Component\Process\Process
   *   The PHP process
   */
  private function generateThemeFromStarterkit($env = NULL) : Process {
    $install_command = [
      $this->php,
      'core/scripts/drupal',
      'generate-theme',
      'test_custom_theme',
      '--name="Test custom starterkit theme"',
      '--description="Custom theme generated from a starterkit theme"',
    ];
    $process = new Process($install_command, NULL, $env);
    $process->setTimeout(60);
    return $process;
  }
  
  /**
   * Asserts the theme exists. Returns the parsed *.info.yml file.
   *
   * @param string $theme_path_relative
   *   The core-relative path to the theme.
   *
   * @return array
   *   The parsed *.info.yml file.
   */
  private function assertThemeExists(string $theme_path_relative) : array {
    $theme_path_absolute = $this->getWorkspaceDirectory() . "/{$theme_path_relative}";
    $theme_name = basename($theme_path_relative);
    $info_yml_filename = "{$theme_name}.info.yml";
    $this->assertFileExists($theme_path_absolute . '/' . $info_yml_filename);
    $info = Yaml::decode(file_get_contents($theme_path_absolute . '/' . $info_yml_filename));
    return $info;
  }
  
  /**
   * Tests the generate-theme command.
   */
  public function test() : void {
    // Do not rely on \Drupal::VERSION: change the version to a concrete version
    // number, to simulate using a tagged core release.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['version'] = '9.4.0';
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    $process = $this->generateThemeFromStarterkit();
    $result = $process->run();
    $this->assertStringContainsString('Theme generated successfully to themes/test_custom_theme', trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $result);
    $theme_path_relative = 'themes/test_custom_theme';
    $info = $this->assertThemeExists($theme_path_relative);
    self::assertArrayNotHasKey('hidden', $info);
    self::assertArrayHasKey('generator', $info);
    self::assertEquals('starterkit_theme:9.4.0', $info['generator']);
    // Confirm readme is rewritten.
    $readme_file = $this->getWorkspaceDirectory() . "/{$theme_path_relative}/README.md";
    $this->assertSame('"Test custom starterkit theme" theme, generated from starterkit_theme. Additional information on generating themes can be found in the [Starterkit documentation](https://www.drupal.org/docs/core-modules-and-themes/core-themes/starterkit-theme).', file_get_contents($readme_file));
    // Ensure that the generated theme can be installed.
    $this->installQuickStart('minimal');
    $this->formLogin($this->adminUsername, $this->adminPassword);
    $this->visit('/admin/appearance');
    $this->getMink()
      ->assertSession()
      ->pageTextContains('Test custom starterkit');
    $this->getMink()
      ->assertSession()
      ->pageTextContains('Custom theme generated from a starterkit theme');
    $this->getMink()
      ->getSession()
      ->getPage()
      ->clickLink('Install "Test custom starterkit theme" theme');
    $this->getMink()
      ->assertSession()
      ->pageTextContains('The "Test custom starterkit theme" theme has been installed.');
    // Ensure that a new theme cannot be generated when the destination
    // directory already exists.
    $theme_path_absolute = $this->getWorkspaceDirectory() . "/{$theme_path_relative}";
    $this->assertFileExists($theme_path_absolute . '/test_custom_theme.theme');
    unlink($theme_path_absolute . '/test_custom_theme.theme');
    $process = $this->generateThemeFromStarterkit();
    $result = $process->run();
    $this->assertStringContainsString('Theme could not be generated because the destination directory', $process->getErrorOutput());
    $this->assertStringContainsString($theme_path_relative, $process->getErrorOutput());
    $this->assertSame(1, $result);
    $this->assertFileDoesNotExist($theme_path_absolute . '/test_custom_theme.theme');
  }
  
  /**
   * Tests generating a theme from another Starterkit enabled theme.
   */
  public function testGeneratingFromAnotherTheme() : void {
    // Do not rely on \Drupal::VERSION: change the version to a concrete version
    // number, to simulate using a tagged core release.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['version'] = '9.4.0';
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    $process = $this->generateThemeFromStarterkit();
    $exit_code = $process->run();
    $this->assertStringContainsString('Theme generated successfully to themes/test_custom_theme', trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $exit_code);
    file_put_contents($this->getWorkspaceDirectory() . '/themes/test_custom_theme/test_custom_theme.starterkit.yml', <<<YAML
    delete: []
    no_edit: []
    no_rename: []
    info:
      version: 1.0.0
    YAML);
    $install_command = [
      $this->php,
      'core/scripts/drupal',
      'generate-theme',
      'generated_from_another_theme',
      '--name="Generated from another theme"',
      '--description="Custom theme generated from a theme other than starterkit_theme"',
      '--starterkit=test_custom_theme',
    ];
    $process = new Process($install_command);
    $exit_code = $process->run();
    $this->assertStringContainsString('Theme generated successfully to themes/generated_from_another_theme', trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $exit_code);
    // Confirm new .theme file.
    $dot_theme_file = $this->getWorkspaceDirectory() . '/themes/generated_from_another_theme/generated_from_another_theme.theme';
    $this->assertStringContainsString('function generated_from_another_theme_preprocess_image_widget(array &$variables) {', file_get_contents($dot_theme_file));
  }
  
  /**
   * Tests the generate-theme command on a dev snapshot of Drupal core.
   */
  public function testDevSnapshot() : void {
    // Do not rely on \Drupal::VERSION: change the version to a development
    // snapshot version number, to simulate using a branch snapshot of core.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['version'] = '9.4.0-dev';
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    $process = $this->generateThemeFromStarterkit();
    $result = $process->run();
    $this->assertStringContainsString('Theme generated successfully to themes/test_custom_theme', trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $result);
    $theme_path_relative = 'themes/test_custom_theme';
    $info = $this->assertThemeExists($theme_path_relative);
    self::assertArrayNotHasKey('hidden', $info);
    self::assertArrayHasKey('generator', $info);
    self::assertMatchesRegularExpression('/^starterkit_theme\\:9.4.0-dev#[0-9a-f]+$/', $info['generator']);
  }
  
  /**
   * Tests the generate-theme command on a theme with a release version number.
   */
  public function testContribStarterkit() : void {
    // Change the version to a concrete version number, to simulate using a
    // contrib theme as the starterkit.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['version'] = '1.20';
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    $process = $this->generateThemeFromStarterkit();
    $result = $process->run();
    $this->assertStringContainsString('Theme generated successfully to themes/test_custom_theme', trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $result);
    $info = $this->assertThemeExists('themes/test_custom_theme');
    self::assertArrayNotHasKey('hidden', $info);
    self::assertArrayHasKey('generator', $info);
    self::assertEquals('starterkit_theme:1.20', $info['generator']);
  }
  
  /**
   * Tests the generate-theme command on a theme with a dev version number.
   */
  public function testContribStarterkitDevSnapshot() : void {
    // Change the version to a development snapshot version number, to simulate
    // using a contrib theme as the starterkit.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['core_version_requirement'] = '*';
    $info['version'] = '7.x-dev';
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    // Avoid the core git commit from being considered the source theme's: move
    // it out of core.
    Process::fromShellCommandline('mv core/themes/starterkit_theme themes/', $this->getWorkspaceDirectory())
      ->run();
    $process = $this->generateThemeFromStarterkit();
    $result = $process->run();
    $this->assertStringContainsString("The source theme starterkit_theme has a development version number (7.x-dev). Because it is not a git checkout, a specific commit could not be identified. This makes tracking changes in the source theme difficult. Are you sure you want to continue? (yes/no) [yes]:\n > Theme generated successfully to themes/test_custom_theme", trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $result);
    $info = $this->assertThemeExists('themes/test_custom_theme');
    self::assertArrayNotHasKey('hidden', $info);
    self::assertArrayHasKey('generator', $info);
    self::assertEquals('starterkit_theme:7.x-dev#unknown-commit', $info['generator']);
  }
  
  /**
   * Tests the generate-theme command on a theme with a dev version without git.
   */
  public function testContribStarterkitDevSnapshotWithGitNotInstalled() : void {
    // Change the version to a development snapshot version number, to simulate
    // using a contrib theme as the starterkit.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['core_version_requirement'] = '*';
    $info['version'] = '7.x-dev';
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    // Avoid the core git commit from being considered the source theme's: move
    // it out of core.
    Process::fromShellCommandline('mv core/themes/starterkit_theme themes/', $this->getWorkspaceDirectory())
      ->run();
    // Confirm that 'git' is available.
    $output = [];
    exec('git --help', $output, $status);
    $this->assertEquals(0, $status);
    // Modify our $PATH so that it begins with a path that contains an
    // executable script named 'git' that always exits with 127, as if git were
    // not found. Note that we run our tests using process isolation, so we do
    // not need to restore the PATH when we are done.
    $unavailableGitPath = $this->getWorkspaceDirectory() . '/bin';
    putenv('PATH=' . $unavailableGitPath . ':' . getenv('PATH'));
    mkdir($unavailableGitPath);
    $bash = <<<SH
    #!/bin/bash
    exit 127
    
    SH;
    file_put_contents($unavailableGitPath . '/git', $bash);
    chmod($unavailableGitPath . '/git', 0755);
    // Confirm that 'git' is no longer available.
    $process = new Process([
      'git',
      '--help',
    ]);
    $process->run();
    $this->assertEquals(127, $process->getExitCode(), 'Fake git used by process.');
    $process = $this->generateThemeFromStarterkit([
      'PATH' => getenv('PATH'),
      'COLUMNS' => 80,
    ]);
    $result = $process->run();
    $this->assertEquals("[ERROR] The source theme starterkit_theme has a development version number     \n         (7.x-dev). Determining a specific commit is not possible because git is\n         not installed. Either install git or use a tagged release to generate a\n         theme.", trim($process->getErrorOutput()), $process->getErrorOutput());
    $this->assertSame(1, $result);
    $this->assertFileDoesNotExist($this->getWorkspaceDirectory() . "/themes/test_custom_theme");
  }
  
  /**
   * Tests the generate-theme command on a theme without a version number.
   */
  public function testCustomStarterkit() : void {
    // Omit the version, to simulate using a custom theme as the starterkit.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    unset($info['version']);
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    $process = $this->generateThemeFromStarterkit();
    $result = $process->run();
    $this->assertStringContainsString("The source theme starterkit_theme does not have a version specified. This makes tracking changes in the source theme difficult. Are you sure you want to continue? (yes/no) [yes]:\n > Theme generated successfully to themes/test_custom_theme", trim($process->getOutput()), $process->getErrorOutput());
    $this->assertSame(0, $result);
    $info = $this->assertThemeExists('themes/test_custom_theme');
    self::assertArrayNotHasKey('hidden', $info);
    self::assertArrayHasKey('generator', $info);
    self::assertEquals('starterkit_theme:unknown-version', $info['generator']);
  }
  
  /**
   * Tests themes that do not exist return an error.
   */
  public function testThemeDoesNotExist() : void {
    $install_command = [
      $this->php,
      'core/scripts/drupal',
      'generate-theme',
      'test_custom_theme',
      '--name="Test custom starterkit theme"',
      '--description="Custom theme generated from a starterkit theme"',
      '--starterkit',
      'foobar',
    ];
    $process = new Process($install_command, NULL);
    $process->setTimeout(60);
    $result = $process->run();
    $this->assertStringContainsString('Theme source theme foobar cannot be found.', trim($process->getErrorOutput()));
    $this->assertSame(1, $result);
  }
  
  /**
   * Tests that only themes with `starterkit` flag can be used.
   */
  public function testStarterKitFlag() : void {
    // Explicitly not a starter theme.
    $install_command = [
      $this->php,
      'core/scripts/drupal',
      'generate-theme',
      'test_custom_theme',
      '--name="Test custom starterkit theme"',
      '--description="Custom theme generated from a starterkit theme"',
      '--starterkit',
      'stark',
    ];
    $process = new Process($install_command, NULL);
    $process->setTimeout(60);
    $result = $process->run();
    $this->assertStringContainsString('Theme source theme stark is not a valid starter kit.', trim($process->getErrorOutput()));
    $this->assertSame(1, $result);
    // Has not defined `starterkit`.
    $install_command = [
      $this->php,
      'core/scripts/drupal',
      'generate-theme',
      'test_custom_theme',
      '--name="Test custom starterkit theme"',
      '--description="Custom theme generated from a starterkit theme"',
      '--starterkit',
      'olivero',
    ];
    $process = new Process($install_command, NULL);
    $process->setTimeout(60);
    $result = $process->run();
    $this->assertStringContainsString('Theme source theme olivero is not a valid starter kit.', trim($process->getErrorOutput()));
    $this->assertSame(1, $result);
  }
  public function testDeleteDirectory() : void {
    $this->writeStarterkitConfig([
      'ignore' => [
        '/src/*',
        '/starterkit_theme.starterkit.yml',
      ],
    ]);
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    $tester->assertCommandIsSuccessful($tester->getErrorOutput());
    $this->assertThemeExists('themes/test_custom_theme');
    $theme_path_absolute = $this->getWorkspaceDirectory() . '/themes/test_custom_theme';
    self::assertDirectoryExists($theme_path_absolute);
    self::assertFileDoesNotExist($theme_path_absolute . '/src/StarterKit.php');
    self::assertDirectoryDoesNotExist($theme_path_absolute . '/src');
  }
  public function testNoEditMissingFilesWarning() : void {
    $this->writeStarterkitConfig([
      'no_edit' => [
        '/js/starterkit_theme.js',
      ],
    ]);
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    self::assertThat($tester->getStatusCode(), self::logicalNot(new CommandIsSuccessful()), trim($tester->getDisplay()));
    self::assertEquals('[ERROR] Paths were defined `no_edit` but no files found.', trim($tester->getErrorOutput()));
    $theme_path_absolute = $this->getWorkspaceDirectory() . '/themes/test_custom_theme';
    self::assertDirectoryDoesNotExist($theme_path_absolute);
  }
  public function testNoRenameMissingFilesWarning() : void {
    $this->writeStarterkitConfig([
      'no_rename' => [
        '/js/starterkit_theme.js',
      ],
    ]);
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    self::assertThat($tester->getStatusCode(), self::logicalNot(new CommandIsSuccessful()), trim($tester->getDisplay()));
    self::assertEquals('[ERROR] Paths were defined `no_rename` but no files found.', trim($tester->getErrorOutput()));
    $theme_path_absolute = $this->getWorkspaceDirectory() . '/themes/test_custom_theme';
    self::assertDirectoryDoesNotExist($theme_path_absolute);
  }
  public function testNoRename() : void {
    $this->writeStarterkitConfig([
      'no_rename' => [
        'js/starterkit_theme.js',
        '**/js/*.js',
        'js/**/*.js',
      ],
    ]);
    mkdir($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/js');
    mkdir($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/js/baz');
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/js/starterkit_theme.js', '');
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/js/starterkit_theme.foo.js', '');
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/js/baz/starterkit_theme.bar.js', '');
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    $tester->assertCommandIsSuccessful($tester->getErrorOutput());
    $this->assertThemeExists('themes/test_custom_theme');
    $theme_path_absolute = $this->getWorkspaceDirectory() . '/themes/test_custom_theme';
    self::assertFileExists($theme_path_absolute . '/js/starterkit_theme.js');
    self::assertFileExists($theme_path_absolute . '/js/starterkit_theme.foo.js');
    self::assertFileExists($theme_path_absolute . '/js/baz/starterkit_theme.bar.js');
  }
  public function testNoEdit() : void {
    $this->writeStarterkitConfig([
      'no_edit' => [
        '*no_edit_*',
      ],
    ]);
    $fixture = <<<FIXTURE
    # machine_name
    starterkit_theme
    # label
    Starterkit theme
    # machine_class_name
    StarterkitTheme
    # label_class_name
    StarterkitTheme
    FIXTURE;
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/edit_fixture.txt', $fixture);
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/no_edit_fixture.txt', $fixture);
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/src/StarterkitThemePreRender.php', <<<PHP
    <?php
    
    namespace Drupal\\starterkit_theme;
    
    use Drupal\\Core\\Security\\TrustedCallbackInterface;
    
    /**
     * Implements trusted prerender callbacks for the Starterkit theme.
     *
     * @internal
     */
    class StarterkitThemePreRender implements TrustedCallbackInterface {
    
    }
    PHP);
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    $tester->assertCommandIsSuccessful($tester->getErrorOutput());
    $this->assertThemeExists('themes/test_custom_theme');
    $theme_path_absolute = $this->getWorkspaceDirectory() . '/themes/test_custom_theme';
    self::assertFileExists($theme_path_absolute . '/no_edit_fixture.txt');
    self::assertEquals($fixture, file_get_contents($theme_path_absolute . '/no_edit_fixture.txt'));
    self::assertFileExists($theme_path_absolute . '/edit_fixture.txt');
    self::assertEquals(<<<EDITED
    # machine_name
    test_custom_theme
    # label
    Test custom starterkit theme
    # machine_class_name
    TestCustomTheme
    # label_class_name
    TestCustomTheme
    EDITED, file_get_contents($theme_path_absolute . '/edit_fixture.txt'));
    self::assertEquals(<<<EDITED
    <?php
    
    namespace Drupal\\test_custom_theme;
    
    use Drupal\\Core\\Security\\TrustedCallbackInterface;
    
    /**
     * Implements trusted prerender callbacks for the Test custom starterkit theme.
     *
     * @internal
     */
    class TestCustomThemePreRender implements TrustedCallbackInterface {
    
    }
    EDITED, file_get_contents($theme_path_absolute . '/src/TestCustomThemePreRender.php'));
  }
  public function testInfoOverrides() : void {
    // Force `base theme` to be `false.
    $starterkit_info_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.info.yml';
    $info = Yaml::decode(file_get_contents($starterkit_info_yml));
    $info['base theme'] = FALSE;
    file_put_contents($starterkit_info_yml, Yaml::encode($info));
    $this->writeStarterkitConfig([
      'info' => [
        'libraries' => [
          'core/jquery',
        ],
      ],
    ]);
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    $tester->assertCommandIsSuccessful($tester->getErrorOutput());
    $info = $this->assertThemeExists('themes/test_custom_theme');
    self::assertArrayHasKey('base theme', $info);
    self::assertFalse($info['base theme']);
    self::assertArrayHasKey('libraries', $info);
    self::assertEquals([
      'core/jquery',
    ], $info['libraries']);
  }
  public function testIncludeDotFiles() : void {
    file_put_contents($this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/.gitignore', '*.map');
    $tester = $this->runCommand([
      'machine-name' => 'test_custom_theme',
      '--name' => 'Test custom starterkit theme',
      '--description' => 'Custom theme generated from a starterkit theme',
    ]);
    $tester->assertCommandIsSuccessful($tester->getErrorOutput());
    $this->assertThemeExists('themes/test_custom_theme');
    // Verify that the .gitignore file is present in the generated theme.
    $theme_path_absolute = $this->getWorkspaceDirectory() . '/themes/test_custom_theme';
    self::assertFileExists($theme_path_absolute . '/.gitignore');
  }
  private function writeStarterkitConfig(array $config) : void {
    $starterkit_yml = $this->getWorkspaceDirectory() . '/core/themes/starterkit_theme/starterkit_theme.starterkit.yml';
    $starterkit_config = Yaml::decode(file_get_contents($starterkit_yml));
    $starterkit_config = array_replace_recursive($starterkit_config, $config);
    file_put_contents($starterkit_yml, Yaml::encode($starterkit_config));
  }
  private function runCommand(array $input) : CommandTester {
    $tester = new CommandTester(new GenerateTheme(NULL, $this->getWorkspaceDirectory()));
    $tester->execute($input, [
      'capture_stderr_separately' => TRUE,
    ]);
    return $tester;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| BuildTestBase::$commandProcess | private | property | The most recent command process. | ||
| BuildTestBase::$destroyBuild | protected | property | Default to destroying build artifacts after a test finishes. | ||
| BuildTestBase::$hostName | private static | property | Our native host name, used by PHP when it starts up the server. | ||
| BuildTestBase::$hostPort | private | property | Port that will be tested. | ||
| BuildTestBase::$mink | private | property | The Mink session manager. | ||
| BuildTestBase::$phpFinder | private | property | The PHP executable finder. | ||
| BuildTestBase::$portLocks | private | property | A list of ports used by the test. | ||
| BuildTestBase::$serverDocroot | private | property | The docroot for the server process. | ||
| BuildTestBase::$serverProcess | private | property | The process that's running the HTTP server. | ||
| BuildTestBase::$workspaceDir | private | property | The working directory where this test will manipulate files. | ||
| BuildTestBase::assertCommandExitCode | public | function | Asserts that the last command returned the specified exit code. | ||
| BuildTestBase::assertCommandOutputContains | public | function | Assert that text is present in the output of the most recent command. | ||
| BuildTestBase::assertCommandSuccessful | public | function | Asserts that the last command ran without error. | ||
| BuildTestBase::assertDrupalVisit | public | function | Helper function to assert that the last visit was a Drupal site. | ||
| BuildTestBase::assertErrorOutputContains | public | function | Assert that text is present in the error output of the most recent command. | ||
| BuildTestBase::assertErrorOutputNotContains | public | function | Assert text is not present in the error output of the most recent command. | ||
| BuildTestBase::checkPortIsAvailable | protected | function | Checks whether a port is available. | ||
| BuildTestBase::copyCodebase | public | function | Copy the current working codebase into a workspace. | ||
| BuildTestBase::executeCommand | public | function | Run a command. | ||
| BuildTestBase::findAvailablePort | protected | function | Discover an available port number. | ||
| BuildTestBase::getCodebaseFinder | public | function | Get a default Finder object for a Drupal codebase. | ||
| BuildTestBase::getComposerRoot | public | function | Gets the path to the Composer root directory. | ||
| BuildTestBase::getDrupalRoot | public | function | Get the root path of this Drupal codebase. | ||
| BuildTestBase::getDrupalRootStatic | public static | function | Get the root path of this Drupal codebase. | ||
| BuildTestBase::getMink | public | function | Get the Mink instance. | ||
| BuildTestBase::getPortNumber | protected | function | Get the port number for requests. | ||
| BuildTestBase::getWorkingPath | protected | function | Get the working directory within the workspace, creating if necessary. | ||
| BuildTestBase::getWorkingPathDrupalRoot | public | function | Gets the working path for Drupal core. | ||
| BuildTestBase::getWorkspaceDirectory | public | function | Full path to the workspace where this test can build. | ||
| BuildTestBase::getWorkspaceDrupalRoot | public | function | Gets the path to Drupal root in the workspace directory. | ||
| BuildTestBase::initMink | protected | function | Set up the Mink session manager. | ||
| BuildTestBase::instantiateServer | protected | function | Do the work of making a server process. | ||
| BuildTestBase::standUpServer | protected | function | Makes a local test server using PHP's internal HTTP server. | ||
| BuildTestBase::stopServer | protected | function | Stop the HTTP server, zero out all necessary variables. | ||
| BuildTestBase::tearDown | protected | function | 1 | ||
| BuildTestBase::visit | public | function | Visit a URI on the HTTP server. | ||
| GenerateThemeTest::$php | protected | property | The PHP executable path. | ||
| GenerateThemeTest::assertThemeExists | private | function | Asserts the theme exists. Returns the parsed *.info.yml file. | ||
| GenerateThemeTest::generateThemeFromStarterkit | private | function | Generates PHP process to generate a theme from core's starterkit theme. | ||
| GenerateThemeTest::runCommand | private | function | |||
| GenerateThemeTest::setUp | protected | function | Overrides BuildTestBase::setUp | ||
| GenerateThemeTest::test | public | function | Tests the generate-theme command. | ||
| GenerateThemeTest::testContribStarterkit | public | function | Tests the generate-theme command on a theme with a release version number. | ||
| GenerateThemeTest::testContribStarterkitDevSnapshot | public | function | Tests the generate-theme command on a theme with a dev version number. | ||
| GenerateThemeTest::testContribStarterkitDevSnapshotWithGitNotInstalled | public | function | Tests the generate-theme command on a theme with a dev version without git. | ||
| GenerateThemeTest::testCustomStarterkit | public | function | Tests the generate-theme command on a theme without a version number. | ||
| GenerateThemeTest::testDeleteDirectory | public | function | |||
| GenerateThemeTest::testDevSnapshot | public | function | Tests the generate-theme command on a dev snapshot of Drupal core. | ||
| GenerateThemeTest::testGeneratingFromAnotherTheme | public | function | Tests generating a theme from another Starterkit enabled theme. | ||
| GenerateThemeTest::testIncludeDotFiles | public | function | |||
| GenerateThemeTest::testInfoOverrides | public | function | |||
| GenerateThemeTest::testNoEdit | public | function | |||
| GenerateThemeTest::testNoEditMissingFilesWarning | public | function | |||
| GenerateThemeTest::testNoRename | public | function | |||
| GenerateThemeTest::testNoRenameMissingFilesWarning | public | function | |||
| GenerateThemeTest::testStarterKitFlag | public | function | Tests that only themes with `starterkit` flag can be used. | ||
| GenerateThemeTest::testThemeDoesNotExist | public | function | Tests themes that do not exist return an error. | ||
| GenerateThemeTest::writeStarterkitConfig | private | function | |||
| PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | ||
| PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | ||
| QuickStartTestBase::$adminPassword | protected | property | Password of the admin account generated during install. | ||
| QuickStartTestBase::$adminUsername | protected | property | User name of the admin account generated during install. | ||
| QuickStartTestBase::formLogin | public | function | Helper that uses Drupal's user/login form to log in. | ||
| QuickStartTestBase::installQuickStart | public | function | Install a Drupal site using the quick start feature. | ||
| RequiresComposerTrait::requiresComposer | public static | function | @beforeClass | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
