You are here

Home » API reference » Configuration Split 8 » ConfigSplitCliServiceTest.php

class ConfigSplitCliServiceTest in Configuration Split 8

Test the cli service.

@group config_split

Hierarchy

Expanded class hierarchy of ConfigSplitCliServiceTest

File

tests/src/Kernel/ConfigSplitCliServiceTest.php, line 22

Namespace

Drupal\Tests\config_split\Kernel
View source 
class ConfigSplitCliServiceTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'system',
    'user',
    'node',
    'field',
    'text',
    'config',
    'config_test',
    'config_filter',
    'config_split',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('node');
    $this
      ->installConfig([
      'field',
      'config_test',
    ]);
  }

  /**
   * Test that our export behaves the same as Drupal core without a split.
   */
  public function testVanillaExport() {

    // Set the "current user" to have "export configuration" permission.
    $account = $this
      ->prophesize(AccountInterface::class);
    $account
      ->id()
      ->willReturn(27);
    $account
      ->hasPermission('export configuration')
      ->willReturn(TRUE);
    $this->container
      ->set('current_user', $account
      ->reveal());

    // Export the configuration the way drupal core does it.
    $configController = ConfigController::create($this->container);

    // Download and open the tar file.
    $file = $configController
      ->downloadExport()
      ->getFile()
      ->openFile();
    $archive_data = $file
      ->fread($file
      ->getSize());

    // Save the tar file to unpack and read it.
    // See \Drupal\config\Tests\ConfigExportUITest::testExport()
    $uri = $this->container
      ->get('file_system')
      ->saveData($archive_data, 'temporary://config.tar.gz');
    $temp_folder = $this->container
      ->get('file_system')
      ->getTempDirectory();
    $file_target = StreamWrapperManager::getTarget($uri);
    $file_path = $temp_folder . '/' . $file_target;
    $archiver = new Tar($file_path);
    $this
      ->assertNotEmpty($archiver
      ->listContents(), 'Downloaded archive file is not empty.');

    // Extract the zip to a virtual file system.
    $core_export = vfsStream::setup('core-export');
    $archiver
      ->extract($core_export
      ->url());
    $this
      ->assertNotEmpty($core_export
      ->getChildren(), 'Successfully extract archive.');

    // Set a new virtual file system for the split export.
    $split_export = vfsStream::setup('split-export');
    $primary = new FileStorage($split_export
      ->url());
    $this
      ->assertEmpty($split_export
      ->getChildren(), 'Before exporting the folder is empty.');

    // Do the export without a split configuration to the export folder.
    $this->container
      ->get('config_split.cli')
      ->export($primary);

    // Assert that the exported configuration is the same in both cases.
    $this
      ->assertEquals(count($core_export
      ->getChildren()), count($split_export
      ->getChildren()), 'The same amount of config is exported.');
    foreach ($core_export
      ->getChildren() as $child) {
      $name = $child
        ->getName();
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE) {

        // If it is a file we can compare the content.
        $this
          ->assertEquals($child
          ->getContent(), $split_export
          ->getChild($name)
          ->getContent(), 'The content of the exported file is the same.');
      }
    }
  }

  /**
   * Test a simple export split.
   */
  public function testSimpleSplitExport() {

    // Set the split stream up.
    $split = vfsStream::setup('split');
    $split_root = vfsStreamWrapper::getRoot();
    $primary = new FileStorage($split
      ->url() . '/sync');
    $config = new Config('config_split.config_split.test_split', $this->container
      ->get('config.storage'), $this->container
      ->get('event_dispatcher'), $this->container
      ->get('config.typed'));
    $config
      ->initWithData([
      'id' => 'test_split',
      'folder' => $split
        ->url() . '/split',
      'module' => [
        'config_test' => 0,
      ],
      'theme' => [],
      'blacklist' => [],
      'graylist' => [],
    ])
      ->save();

    // Export the configuration the way Drupal core does.
    $vanilla = vfsStream::setup('vanilla');
    vfsStreamWrapper::getRoot();
    $vanilla_primary = new FileStorage($vanilla
      ->url());
    $this->container
      ->get('config_split.cli')
      ->export($vanilla_primary);
    vfsStreamWrapper::setRoot($split_root);

    // Export the configuration without the test configuration.
    $filter = $this->container
      ->get('plugin.manager.config_filter')
      ->getFilterInstance('config_split:test_split');
    $storage = new FilteredStorage($primary, [
      $filter,
    ]);
    $this->container
      ->get('config_split.cli')
      ->export($storage);

    // Extract the configuration for easier comparison.
    $vanilla_config = [];
    foreach ($vanilla
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $vanilla_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $sync_config = [];
    foreach ($split
      ->getChild('sync')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $sync_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $split_config = [];
    foreach ($split
      ->getChild('split')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $split_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $this
      ->assertNotEmpty($split_config, 'There is split off configuration.');
    $this
      ->assertEquals(count($vanilla_config), count($sync_config) + count($split_config), 'All the config is still here.');
    foreach ($vanilla_config as $name => $content) {
      if ($name == 'core.extension.yml') {
        continue;
      }

      // All the filtered test config has config_test in its name.
      if (strpos($name, 'config_test') === FALSE) {
        $this
          ->assertEquals($content, $sync_config[$name], 'The configuration is complete.');
        $this
          ->assertNotContains($name, array_keys($split_config), 'And it does not exist in the other folder.');
      }
      else {
        $this
          ->assertEquals($content, $split_config[$name], 'The configuration is complete.');
        $this
          ->assertNotContains($name, array_keys($sync_config), 'And it does not exist in the other folder.');
      }
    }
    $this
      ->assertNotFalse(strpos($vanilla_config['core.extension.yml'], 'config_test'), 'config_test is enabled.');
    $this
      ->assertFalse(strpos($sync_config['core.extension.yml'], 'config_test'), 'config_test is not enabled.');
  }

  /**
   * Test blacklist and gray list export.
   */
  public function testGrayAndBlackListExport() {
    $split = vfsStream::setup('split');
    $primary = new FileStorage($split
      ->url() . '/sync');
    $config = new Config('config_split.config_split.test_split', $this->container
      ->get('config.storage'), $this->container
      ->get('event_dispatcher'), $this->container
      ->get('config.typed'));
    $config
      ->initWithData([
      'id' => 'test_split',
      'folder' => $split
        ->url() . '/split',
      'module' => [],
      'theme' => [],
      'blacklist' => [
        'config_test.types',
      ],
      'graylist' => [
        'config_test.system',
      ],
    ])
      ->save();

    // Export the configuration like core.
    $this->container
      ->get('config_split.cli')
      ->export($primary);
    $original_config = [];
    foreach ($split
      ->getChild('sync')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $original_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $this
      ->assertFalse($split
      ->hasChild('split'), 'The split directory is empty.');
    $this
      ->assertTrue(isset($original_config['config_test.system.yml']), 'The graylisted config is exported.');
    $this
      ->assertTrue(isset($original_config['config_test.types.yml']), 'The blacklisted config is exported.');

    // Change the gray listed config to see if it is exported the same.
    $this
      ->config('config_test.system')
      ->set('foo', 'baz')
      ->save();

    // Export the configuration with filtering.
    $filter = $this->container
      ->get('plugin.manager.config_filter')
      ->getFilterInstance('config_split:test_split');
    $storage = new FilteredStorage($primary, [
      $filter,
    ]);
    $this->container
      ->get('config_split.cli')
      ->export($storage);
    $sync_config = [];
    foreach ($split
      ->getChild('sync')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $sync_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $split_config = [];
    foreach ($split
      ->getChild('split')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $split_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $this
      ->assertTrue(isset($split_config['config_test.system.yml']), 'The graylisted config is exported to the split.');
    $this
      ->assertTrue(isset($split_config['config_test.types.yml']), 'The blacklisted config is exported to the split.');
    $this
      ->assertTrue(isset($sync_config['config_test.system.yml']), 'The graylisted config is exported to the sync.');
    $this
      ->assertFalse(isset($sync_config['config_test.types.yml']), 'The blacklisted config is not exported to the sync.');
    $this
      ->assertEquals($original_config['config_test.types.yml'], $split_config['config_test.types.yml'], 'The split blacklisted config is the same..');
    $this
      ->assertEquals($original_config['config_test.system.yml'], $sync_config['config_test.system.yml'], 'The graylisted config stayed the same.');
    $this
      ->assertNotEquals($original_config['config_test.system.yml'], $split_config['config_test.system.yml'], 'The split graylisted config is different.');

    // Change the filter.
    $config
      ->initWithData([
      'folder' => $split
        ->url() . '/split',
      'module' => [],
      'theme' => [],
      'blacklist' => [
        'config_test.system',
      ],
      'graylist' => [],
    ])
      ->save();

    // Export the configuration with filtering.
    $filter = $this->container
      ->get('plugin.manager.config_filter')
      ->getFilterInstance('config_split:test_split');
    $storage = new FilteredStorage($primary, [
      $filter,
    ]);
    $this->container
      ->get('config_split.cli')
      ->export($storage);
    $sync_config = [];
    foreach ($split
      ->getChild('sync')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $sync_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $split_config = [];
    foreach ($split
      ->getChild('split')
      ->getChildren() as $child) {
      if ($child
        ->getType() == vfsStreamContent::TYPE_FILE && $child
        ->getName() != '.htaccess') {
        $split_config[$child
          ->getName()] = $child
          ->getContent();
      }
    }
    $this
      ->assertFalse(isset($sync_config['config_test.system.yml']), 'The newly blacklisted config is removed.');
    $this
      ->assertTrue(isset($split_config['config_test.system.yml']), 'The newly blacklisted config is exported to the split.');
    $this
      ->assertFalse(isset($split_config['config_test.types.yml']), 'The config no longer blacklisted is not exported to the split.');
    $this
      ->assertTrue(isset($sync_config['config_test.types.yml']), 'The config no longer blacklisted is exported to the sync.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigSplitCliServiceTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ConfigSplitCliServiceTest::setUp protected function Overrides KernelTestBase::setUp
ConfigSplitCliServiceTest::testGrayAndBlackListExport public function Test blacklist and gray list export.
ConfigSplitCliServiceTest::testSimpleSplitExport public function Test a simple export split.
ConfigSplitCliServiceTest::testVanillaExport public function Test that our export behaves the same as Drupal core without a split.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.