cypress-8.x-1.x-dev/src/TestSite/TestSiteInstallCommand.php

<?php

namespace Drupal\cypress\TestSite;

use Drupal\cypress\CachedInstallation;
use Drupal\cypress\CypressRootFactory;
use Drupal\TestSite\Commands\TestSiteInstallCommand as CoreTestSiteInstallCommand;
use Symfony\Component\Process\Process;

/**
 * Cypress derivative of the TestSiteInstallCommand.
 */
class TestSiteInstallCommand extends CoreTestSiteInstallCommand {

  /**
   * The Drupal root directory.
   *
   * @var string
   */
  protected $appRoot;

  /**
   * {@inheritDoc}
   */
  public function __construct($name = NULL) {
    parent::__construct($name);
    $appRoot = getenv('DRUPAL_APP_ROOT');
    if (!$appRoot) {
      throw new \Exception('DRUPAL_APP_ROOT environment variable must be set.');
    }
    $this->appRoot = $appRoot;
  }

  /**
   * {@inheritDoc}
   *
   * Also sets parameters to install from configuration if
   * DRUPAL_CONFIG_DIR is set.
   *
   * @return array
   */
  public function installParameters() {
    $parameters = parent::installParameters();
    if ($configDirectory = getenv('DRUPAL_CONFIG_DIR')) {
      $parameters['parameters']['existing_config'] = TRUE;
      $parameters['config_install_path'] = $configDirectory;
    }
    return $parameters;
  }

  /**
   * {@inheritDoc}
   *
   * Allows to reference setup classes relative to test suites.
   *
   * ```
   * cypress:integration/CypressTestInstallScript.php
   * ```
   */
  protected function getSetupClass($file) {
    // Make sure "CypressTestSetup" is already added, else "getSetupClass" finds
    // two new classes after including $file and gets confused.
    require_once __DIR__ . '/CypressTestSetup.php';
    if ($file && strpos($file, ':') !== FALSE) {
      list($suite, $path) = explode(':', $file);
      return parent::getSetupClass(
        "drupal-cypress-environment/suites/{$suite}/{$path}"
      );
    }
    return parent::getSetupClass($file);
  }

  /**
   * {@inheritDoc}
   *
   * Uses `CachedInstallation` to add setup caching.
   *
   * @return void
   *
   * @see \Drupal\cypress\CachedInstallation
   */
  public function setup($profile = 'testing', $setup_class = NULL, $langcode = 'en') {
    // Optionally turn of strict config checking.
    $this->strictConfigSchema = getenv('DRUPAL_CONFIG_CHECK') !== 'false';

    $this->profile = $profile;
    $this->langcode = $langcode;
    $this->setupBaseUrl();
    $this->prepareEnvironment();


    $setup_class = $setup_class ?? '\Drupal\cypress\TestSite\CypressTestSetup';
    $lockId = substr($this->databasePrefix, 4);

    $cachedInstallation = new CachedInstallation(
      $this->appRoot,
      $this->siteDirectory,
      $lockId,
      getenv('SIMPLETEST_DB') ?: '',
      $this->databasePrefix
    );

    $cacheDir = implode(
      '/',
      [
        $this->appRoot,
        CypressRootFactory::CYPRESS_ROOT_DIRECTORY,
        'cache',
      ]
    );

    $cachedInstallation
      ->setProfile($profile)
      ->setLangCode($langcode)
      ->setCacheDir($cacheDir)
      ->setInstallCache(getenv('DRUPAL_INSTALL_CACHE') ?: '')
      ->setConfigDir(getenv('DRUPAL_CONFIG_DIR') ?: '')
      ->setSetupClass($setup_class);

    /** @var \Drupal\TestSite\TestSetupInterface $setupScript */
    $setupScript = new $setup_class();

    $drush = getenv('DRUPAL_DRUSH') ?: 'drush';
    $drushEnv = ['HTTP_USER_AGENT' => drupal_generate_test_ua($this->databasePrefix)] + $_SERVER;

    $cachedInstallation->install(
      function () use ($setupScript, $drush, $drushEnv) {
        $this->installDrupal();

        if (getenv('DRUPAL_CONFIG_DIR')) {
          // \Drupal\TestSite\Commands\TestSiteInstallCommand::installDrupal()
          // does some modifications to the existing configuration. For example,
          // it changes the default theme.
          // Avoid this with an additional config import.
          $command = [$drush, 'cim', '-y'];
          (new Process($command, $this->appRoot, $drushEnv, NULL, 0))
            ->mustRun();
        }

        $setupScript->setup();
      },
      function () use ($drush, $drushEnv) {
        foreach ([
                   [$drush, 'cr'],
                   [$drush, 'updb', '-y'],
                   [$drush, 'cim', '-y'],
                   [$drush, 'cr', '-y'],
                 ] as $command) {
          (new Process($command, $this->appRoot, $drushEnv, null, 0))
            ->mustRun();
        }
      }
    );
  }

}