You are here

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

class IndividualExportImportTest in Configuration Split 8

Same name and namespace in other branches
  1. 2.0.x tests/src/Kernel/IndividualExportImportTest.php \Drupal\Tests\config_split\Kernel\IndividualExportImportTest

Test the export and import of individual splits.

@group config_split

Hierarchy

Expanded class hierarchy of IndividualExportImportTest

File

tests/src/Kernel/IndividualExportImportTest.php, line 16

Namespace

Drupal\Tests\config_split\Kernel
View source 
class IndividualExportImportTest extends KernelTestBase {
  use ConfigStorageTestTrait;
  use SplitTestTrait;

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

  /**
   * The split config.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $split;

  /**
   * The fake IO object cli tools provide us normally.
   *
   * @var object
   */
  protected $io;

  /**
   * The t function.
   *
   * @var callable
   */
  protected $t;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Make sure there is a good amount of config to play with.
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('node');
    $this
      ->installConfig([
      'system',
      'field',
      'config_test',
    ]);

    // Set up multilingual.
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();
    ConfigurableLanguage::createFromLangcode('de')
      ->save();

    // Sort the extensions, kernel tests don't concern themselves with that.
    // But we care because the config importer would see a difference when we
    // sort the extensions in the split.
    $extension = $this->container
      ->get('config.storage')
      ->read('core.extension');
    $extension['module'] = module_config_sort($extension['module']);
    $this->container
      ->get('config.storage')
      ->write('core.extension', $extension);

    // The split we test with.
    $this->split = $this
      ->createSplitConfig($this
      ->randomMachineName(), [
      'module' => [
        'config_test' => 0,
      ],
    ]);

    // The stand-in for \Symfony\Component\Console\Style\StyleInterface.
    $this->io = new class {

      /**
       * The log of the method calls.
       *
       * @var array
       */
      public $calls;

      /**
       * {@inheritdoc}
       */
      public function __call($name, $arguments) {
        $this->calls[] = [
          $name => $arguments,
        ];
        return TRUE;
      }

    };

    // By default no translations.
    $this->t = static function (string $s, $args = []) : string {
      return strtr($s, $args);
    };
  }

  /**
   * Test exporting when there is no files in the system.
   */
  public function testExportEmptyFiles() {

    // At the beginning all folders are empty.
    static::assertEmpty($this
      ->getSyncFileStorage()
      ->listAll());
    static::assertEmpty($this
      ->getSyncFileStorage()
      ->getAllCollectionNames());
    static::assertEmpty($this
      ->getSplitSourceStorage($this->split)
      ->listAll());
    static::assertEmpty($this
      ->getSplitSourceStorage($this->split)
      ->getAllCollectionNames());
    static::assertEmpty($this
      ->getSplitPreviewStorage($this->split)
      ->listAll());
    static::assertEmpty($this
      ->getSplitPreviewStorage($this->split)
      ->getAllCollectionNames());

    // Do the export.
    $this->container
      ->get('config_split.cli')
      ->ioExport($this->split
      ->getName(), $this->io, $this->t);

    // The sync storage is still empty.
    static::assertEmpty($this
      ->getSyncFileStorage()
      ->listAll());
    static::assertEmpty($this
      ->getSyncFileStorage()
      ->getAllCollectionNames());

    // The split is successfully exported.
    static::assertStorageEquals($this
      ->getSplitExpectationStorage(), $this
      ->getSplitSourceStorage($this->split));

    // Check the IO, but we skip checking the confirmation message.
    static::assertCount(2, $this->io->calls);
    static::assertEquals([
      'confirm',
    ], array_keys($this->io->calls[0]));
    static::assertEquals([
      'success' => [
        'Configuration successfully exported.',
      ],
    ], $this->io->calls[1]);
  }

  /**
   * Test exporting when there is already data to be overwritten.
   */
  public function testExportNonEmptyFiles() {

    // Start with random data in the storages.
    $random = $this
      ->getRandomDataStorage();
    $this
      ->copyConfig($random, $this
      ->getSyncFileStorage());
    $this
      ->copyConfig($this
      ->getRandomDataStorage(), $this
      ->getSplitSourceStorage($this->split));

    // Do the export.
    $this->container
      ->get('config_split.cli')
      ->ioExport($this->split
      ->getName(), $this->io, $this->t);

    // The sync storage is still random.
    static::assertStorageEquals($random, $this
      ->getSyncFileStorage());

    // The split is successfully exported.
    static::assertStorageEquals($this
      ->getSplitExpectationStorage(), $this
      ->getSplitSourceStorage($this->split));

    // Check the IO, but we skip checking the confirmation message.
    static::assertCount(2, $this->io->calls);
    static::assertEquals([
      'confirm',
    ], array_keys($this->io->calls[0]));
    static::assertEquals([
      'success' => [
        'Configuration successfully exported.',
      ],
    ], $this->io->calls[1]);
  }

  /**
   * Test importing of a split.
   */
  public function testImport() {

    // Set up the split storage to contain the data it should.
    $storage = $this
      ->getSplitSourceStorage($this->split);
    $this
      ->copyConfig($this
      ->getSplitExpectationStorage(), $storage);
    static::assertEmpty($this
      ->getSyncFileStorage()
      ->listAll());
    static::assertEmpty($this
      ->getSyncFileStorage()
      ->getAllCollectionNames());

    // Do the import.
    $this->container
      ->get('config_split.cli')
      ->ioImport($this->split
      ->getName(), $this->io, $this->t);
    static::assertCount(2, $this->io->calls);
    static::assertEquals([
      'confirm',
    ], array_keys($this->io->calls[0]));
    if (isset($this->io->calls[1]['error'])) {

      // This is not a real assertion but it will display nicer.
      static::assertEquals([
        '',
      ], $this->io->calls[1]['error']);
    }
    static::assertEquals([
      'text' => [
        'There are no changes to import.',
      ],
    ], $this->io->calls[1]);

    // Change some data so that there is something to import.
    $data = $storage
      ->read('config_test.system');
    $data['foo'] = 'test split';
    $storage
      ->write('config_test.system', $data);
    $this->io->calls = [];

    // Do the import.
    $this->container
      ->get('config_split.cli')
      ->ioImport($this->split
      ->getName(), $this->io, $this->t);

    // The data was imported.
    static::assertEquals($data, $this
      ->getActiveStorage()
      ->read('config_test.system'));
    static::assertCount(2, $this->io->calls);
    static::assertEquals([
      'confirm',
    ], array_keys($this->io->calls[0]));
    static::assertEquals([
      'success' => [
        'Configuration successfully imported.',
      ],
    ], $this->io->calls[1]);
  }

  /**
   * Get the config which is expected to be split off.
   *
   * @return \Drupal\Core\Config\StorageInterface
   *   The config storage with the data the split should have.
   */
  protected function getSplitExpectationStorage() : StorageInterface {
    $expected = new MemoryStorage();
    foreach (array_merge($this
      ->getActiveStorage()
      ->getAllCollectionNames(), [
      StorageInterface::DEFAULT_COLLECTION,
    ]) as $collection) {
      $active = $this
        ->getActiveStorage()
        ->createCollection($collection);
      $expected = $expected
        ->createCollection($collection);
      foreach ($active
        ->listAll() as $name) {
        if (strpos($name, 'config_test') !== FALSE) {

          // Split all config starting with config_test, the module we split.
          $expected
            ->write($name, $active
            ->read($name));
        }
      }
    }
    return $expected;
  }

  /**
   * Get random data in a config storage.
   *
   * @return \Drupal\Core\Config\StorageInterface
   *   The storage witrh random data.
   */
  protected function getRandomDataStorage() : StorageInterface {
    $random = new MemoryStorage();
    $collections = array_merge($this
      ->getActiveStorage()
      ->getAllCollectionNames(), [
      StorageInterface::DEFAULT_COLLECTION,
      $this
        ->randomMachineName(),
    ]);
    foreach ($collections as $collection) {
      $random = $random
        ->createCollection($collection);
      $size = random_int(4, 10);
      for ($i = 0; $i < $size; $i++) {
        $random
          ->write($this
          ->randomMachineName(), (array) $this
          ->randomObject());
      }
    }
    return $random;
  }

}

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
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.
IndividualExportImportTest::$io protected property The fake IO object cli tools provide us normally.
IndividualExportImportTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
IndividualExportImportTest::$split protected property The split config.
IndividualExportImportTest::$t protected property The t function.
IndividualExportImportTest::getRandomDataStorage protected function Get random data in a config storage.
IndividualExportImportTest::getSplitExpectationStorage protected function Get the config which is expected to be split off.
IndividualExportImportTest::setUp protected function Overrides KernelTestBase::setUp
IndividualExportImportTest::testExportEmptyFiles public function Test exporting when there is no files in the system.
IndividualExportImportTest::testExportNonEmptyFiles public function Test exporting when there is already data to be overwritten.
IndividualExportImportTest::testImport public function Test importing of a split.
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.
SplitTestTrait::createSplitConfig protected function Create a split configuration.
SplitTestTrait::getSplitPreviewStorage protected function Get the preview storage for a split.
SplitTestTrait::getSplitSourceStorage protected function Get the storage for a split.
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.