DistributionProfileExistingSettingsTest.php

<?php

declare (strict_types=1);
namespace Drupal\FunctionalTests\Installer;

use Drupal\Component\Serialization\Yaml;
use Drupal\Core\Database\Database;
use Drupal\Core\DrupalKernel;
use Symfony\Component\HttpFoundation\Request;

/**
 * Tests distribution profile support with existing settings.
 *
 * @group Installer
 */
class DistributionProfileExistingSettingsTest extends InstallerTestBase {
    
    /**
     * The distribution profile info.
     *
     * @var array
     */
    protected $info;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function prepareEnvironment() {
        parent::prepareEnvironment();
        $this->info = [
            'type' => 'profile',
            'core_version_requirement' => '*',
            'name' => 'Distribution profile',
            'distribution' => [
                'name' => 'My Distribution',
                'install' => [
                    'theme' => 'olivero',
                ],
            ],
        ];
        // File API functions are not available yet.
        $path = $this->siteDirectory . '/profiles/my_distribution';
        mkdir($path, 0777, TRUE);
        file_put_contents("{$path}/my_distribution.info.yml", Yaml::encode($this->info));
        // Pre-configure hash salt.
        // Any string is valid, so simply use the class name of this test.
        $this->settings['settings']['hash_salt'] = (object) [
            'value' => __CLASS__,
            'required' => TRUE,
        ];
        // Pre-configure database credentials.
        $connection_info = Database::getConnectionInfo();
        unset($connection_info['default']['pdo']);
        unset($connection_info['default']['init_commands']);
        $this->settings['databases']['default'] = (object) [
            'value' => $connection_info,
            'required' => TRUE,
        ];
        // Use the kernel to find the site path because the site.path service should
        // not be available at this point in the install process.
        $site_path = DrupalKernel::findSitePath(Request::createFromGlobals());
        // Pre-configure config directories.
        $this->settings['settings']['config_sync_directory'] = (object) [
            'value' => $site_path . '/files/config_staging',
            'required' => TRUE,
        ];
        mkdir($this->settings['settings']['config_sync_directory']->value, 0777, TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUpLanguage() {
        // Make settings file not writable.
        $filename = $this->siteDirectory . '/settings.php';
        // Make the settings file read-only.
        // Not using File API; a potential error must trigger a PHP warning.
        chmod($filename, 0444);
        // Verify that the distribution name appears.
        $this->assertSession()
            ->pageTextContains($this->info['distribution']['name']);
        // Verify that the requested theme is used.
        $this->assertSession()
            ->responseContains($this->info['distribution']['install']['theme']);
        // Verify that the "Choose profile" step does not appear.
        $this->assertSession()
            ->pageTextNotContains('profile');
        parent::setUpLanguage();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUpProfile() {
        // This step is skipped, because there is a distribution profile.
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUpSettings() {
        // This step should not appear, since settings.php is fully configured
        // already.
    }
    
    /**
     * Confirms that the installation succeeded.
     */
    public function testInstalled() : void {
        $this->assertSession()
            ->addressEquals('user/1');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Confirm that we are logged-in after installation.
        $this->assertSession()
            ->pageTextContains($this->rootUser
            ->getAccountName());
        // Confirm that Drupal recognizes this distribution as the current profile.
        $this->assertEquals('my_distribution', \Drupal::installProfile());
        $this->assertEquals('my_distribution', $this->config('core.extension')
            ->get('profile'), 'The install profile has been written to core.extension configuration.');
        $this->rebuildContainer();
        $this->assertEquals('my_distribution', \Drupal::installProfile());
    }

}