ConfigInstallProfileUnmetDependenciesTest.php

Same filename in other branches
  1. 9 core/modules/config/tests/src/Functional/ConfigInstallProfileUnmetDependenciesTest.php
  2. 10 core/modules/config/tests/src/Functional/ConfigInstallProfileUnmetDependenciesTest.php
  3. 11.x core/modules/config/tests/src/Functional/ConfigInstallProfileUnmetDependenciesTest.php

Namespace

Drupal\Tests\config\Functional

File

core/modules/config/tests/src/Functional/ConfigInstallProfileUnmetDependenciesTest.php

View source
<?php

namespace Drupal\Tests\config\Functional;

use Drupal\FunctionalTests\Installer\InstallerTestBase;
use Drupal\Core\Config\InstallStorage;
use Drupal\Core\Serialization\Yaml;

/**
 * Tests install profile config overrides can not add unmet dependencies.
 *
 * @group Config
 */
class ConfigInstallProfileUnmetDependenciesTest extends InstallerTestBase {
    
    /**
     * The installation profile to install.
     *
     * @var string
     */
    protected $profile = 'testing_config_overrides';
    
    /**
     * Contains the expected exception if it is thrown.
     *
     * @var \Drupal\Core\Config\UnmetDependenciesException
     */
    protected $expectedException = FALSE;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function prepareEnvironment() {
        parent::prepareEnvironment();
        $this->copyTestingOverrides();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        // During set up an UnmetDependenciesException should be thrown, which will
        // be re-thrown by TestHttpClientMiddleware as a standard Exception.
        try {
            parent::setUp();
        } catch (\Exception $exception) {
            $this->expectedException = $exception;
        }
    }
    
    /**
     * Copy the testing_config_overrides install profile.
     *
     * So we can change the configuration to include a dependency that can not be
     * met. File API functions are not available yet.
     */
    protected function copyTestingOverrides() {
        $dest = $this->siteDirectory . '/profiles/testing_config_overrides';
        mkdir($dest, 0777, TRUE);
        $source = DRUPAL_ROOT . '/core/profiles/testing_config_overrides';
        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($source, \RecursiveDirectoryIterator::SKIP_DOTS), \RecursiveIteratorIterator::SELF_FIRST);
        foreach ($iterator as $item) {
            if ($item->isDir()) {
                mkdir($dest . DIRECTORY_SEPARATOR . $iterator->getSubPathName());
            }
            else {
                copy($item, $dest . DIRECTORY_SEPARATOR . $iterator->getSubPathName());
            }
        }
        // Add a dependency that can not be met.
        $config_file = $dest . DIRECTORY_SEPARATOR . InstallStorage::CONFIG_INSTALL_DIRECTORY . DIRECTORY_SEPARATOR . 'system.action.user_block_user_action.yml';
        $action = Yaml::decode(file_get_contents($config_file));
        $action['dependencies']['module'][] = 'does_not_exist';
        file_put_contents($config_file, Yaml::encode($action));
    }
    
    /**
     * Confirms that the installation succeeded.
     */
    public function testInstalled() {
        if ($this->expectedException) {
            $this->assertStringContainsString('Configuration objects provided by <em class="placeholder">testing_config_overrides</em> have unmet dependencies: <em class="placeholder">system.action.user_block_user_action (does_not_exist)</em>', $this->expectedException
                ->getMessage());
            $this->assertStringContainsString('Drupal\\Core\\Config\\UnmetDependenciesException', $this->expectedException
                ->getMessage());
        }
        else {
            $this->fail('Expected Drupal\\Core\\Config\\UnmetDependenciesException exception not thrown');
        }
    }

}

Classes

Title Deprecated Summary
ConfigInstallProfileUnmetDependenciesTest Tests install profile config overrides can not add unmet dependencies.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.