You are here

Home » API reference » Tome 8 » ExporterTest.php

class ExporterTest in Tome 8

Tests that the exporter works.

@group tome_sync

Hierarchy

Expanded class hierarchy of ExporterTest

File

modules/tome_sync/tests/src/Kernel/ExporterTest.php, line 15

Namespace

Drupal\Tests\tome_sync\Kernel
View source 
class ExporterTest extends TestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'tome_sync',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('tome_sync', [
      'tome_sync_content_hash',
    ]);
    if (\Drupal::entityTypeManager()
      ->hasDefinition('path_alias')) {
      $this
        ->installEntitySchema('path_alias');
    }
  }

  /**
   * @covers \Drupal\tome_sync\Exporter::exportContent
   */
  public function testExportContent() {

    /** @var \Symfony\Component\Serializer\Serializer $serializer */
    $serializer = \Drupal::service('serializer');

    /** @var \Drupal\Core\Config\StorageInterface $storage */
    $storage = \Drupal::service('tome_sync.storage.content');
    $user = $this
      ->createUser();
    $article = Node::create([
      'type' => 'article',
      'title' => 'My article',
      'uid' => $user
        ->id(),
    ]);
    $article
      ->save();
    $page = Node::create([
      'type' => 'page',
      'title' => 'My page',
      'field_reference' => [
        'target_id' => $article
          ->id(),
      ],
      'uid' => $user
        ->id(),
    ]);
    $page
      ->save();
    $data = $storage
      ->read(TomeSyncHelper::getContentName($page));
    $exported_page = $serializer
      ->denormalize($data, Node::class, 'json');
    $this
      ->assertEquals($page
      ->uuid(), $exported_page
      ->uuid());
    $this
      ->assertEquals($page
      ->getTitle(), $exported_page
      ->getTitle());
    $this
      ->assertEquals($article
      ->id(), $exported_page->field_reference->target_id);
    $page
      ->addTranslation('fr', [
      'title' => 'My french page',
    ])
      ->save();
    $data = $storage
      ->read(TomeSyncHelper::getContentName($page
      ->getTranslation('fr')));
    $exported_page = $serializer
      ->denormalize($data, Node::class, 'json');
    $this
      ->assertEquals('My french page', $exported_page
      ->getTitle());
    $index_file = Settings::get('tome_content_directory', '../content') . '/meta/index.json';
    $this
      ->assertFileExists($index_file);
    $index = json_decode(file_get_contents($index_file), TRUE);
    $user_name = TomeSyncHelper::getContentName($user);
    $page_name = TomeSyncHelper::getContentName($page);
    $article_name = TomeSyncHelper::getContentName($article);
    $this
      ->assertArrayHasKey($user_name, $index);
    $this
      ->assertArrayHasKey($page_name, $index);
    $this
      ->assertArrayHasKey($article_name, $index);
    $this
      ->assertEmpty($index[$user_name]);
    $this
      ->assertContains($article_name, $index[$page_name]);
    $this
      ->assertContains($user_name, $index[$page_name]);
    $this
      ->assertContains($user_name, $index[$article_name]);
  }

  /**
   * @covers \Drupal\tome_sync\Exporter::deleteContentExport
   */
  public function testDeleteContentExport() {

    /** @var \Drupal\Core\Config\StorageInterface $storage */
    $storage = \Drupal::service('tome_sync.storage.content');
    $article = Node::create([
      'type' => 'article',
      'title' => 'My article',
    ]);
    $article
      ->save();
    $this
      ->assertTrue($storage
      ->exists(TomeSyncHelper::getContentName($article)));
    $article_name = TomeSyncHelper::getContentName($article);
    $index_file = Settings::get('tome_content_directory', '../content') . '/meta/index.json';
    $this
      ->assertFileExists($index_file);
    $index = json_decode(file_get_contents($index_file), TRUE);
    $this
      ->assertArrayHasKey($article_name, $index);
    $article
      ->addTranslation('fr', [
      'title' => 'My french article',
    ])
      ->save();
    $name = TomeSyncHelper::getContentName($article
      ->getTranslation('fr'));
    $this
      ->assertTrue($storage
      ->exists($name));
    $article
      ->removeTranslation('fr');
    $article
      ->save();
    $this
      ->assertFalse($storage
      ->exists($name));
    $article
      ->addTranslation('fr', [
      'title' => 'My french article',
    ])
      ->save();
    $this
      ->assertTrue($storage
      ->exists($name));
    $article
      ->delete();
    $this
      ->assertFalse($storage
      ->exists(TomeSyncHelper::getContentName($article)));
    $this
      ->assertFalse($storage
      ->exists($name));
    $index = json_decode(file_get_contents($index_file), TRUE);
    $this
      ->assertArrayNotHasKey($article_name, $index);
  }

  /**
   * @covers \Drupal\tome_sync\EventSubscriber\ConfigEventSubscriber::configDelete
   * @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configDelete
   */
  public function testDeleteConfigExport() {

    /** @var \Drupal\Core\Config\StorageInterface $storage */
    $storage = \Drupal::service('config.storage.sync');
    \Drupal::configFactory()
      ->getEditable('foo.bar')
      ->save();
    $this
      ->assertTrue($storage
      ->exists('foo.bar'));

    /** @var \Drupal\language\Config\LanguageConfigFactoryOverrideInterface $config_factory_override */
    $config_factory_override = \Drupal::service('language.config_factory_override');
    $override = $config_factory_override
      ->getOverride('fr', 'foo.bar');
    $override
      ->setData([
      'bonjour' => 'monde',
    ])
      ->save();
    $collection = $storage
      ->createCollection($override
      ->getStorage()
      ->getCollectionName());
    $this
      ->assertTrue($collection
      ->exists('foo.bar'));
    \Drupal::configFactory()
      ->getEditable('foo.bar')
      ->delete();
    $this
      ->assertFalse($storage
      ->exists('foo.bar'));
    $this
      ->assertFalse($collection
      ->exists('foo.bar'));
  }

  /**
   * @covers \Drupal\tome_sync\EventSubscriber\ConfigEventSubscriber::configSave
   * @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configSave
   */
  public function testExportConfig() {

    /** @var \Drupal\Core\Config\StorageInterface $storage */
    $storage = \Drupal::service('config.storage.sync');
    $data = [
      'hello' => 'world',
    ];
    \Drupal::configFactory()
      ->getEditable('foo.bar')
      ->setData($data)
      ->save();
    $this
      ->assertEquals($data, $storage
      ->read('foo.bar'));
    $data = [
      'bonjour' => 'monde',
    ];

    /** @var \Drupal\language\Config\LanguageConfigFactoryOverrideInterface $config_factory_override */
    $config_factory_override = \Drupal::service('language.config_factory_override');
    $override = $config_factory_override
      ->getOverride('fr', 'foo.bar');
    $override
      ->setData($data)
      ->save();
    $collection = $storage
      ->createCollection($override
      ->getStorage()
      ->getCollectionName());
    $this
      ->assertEquals($data, $collection
      ->read('foo.bar'));
  }

  /**
   * @covers \Drupal\tome_sync\EventSubscriber\ConfigEventSubscriber::configRename
   * @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configSave
   * @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configDelete
   */
  public function testRenameConfig() {

    /** @var \Drupal\Core\Config\StorageInterface $storage */
    $storage = \Drupal::service('config.storage.sync');
    $data = [
      'hello' => 'world',
    ];
    \Drupal::configFactory()
      ->getEditable('foo.bar')
      ->setData($data)
      ->save();
    $this
      ->assertEquals($data, $storage
      ->read('foo.bar'));
    $override_data = [
      'bonjour' => 'monde',
    ];

    /** @var \Drupal\language\Config\LanguageConfigFactoryOverrideInterface $config_factory_override */
    $config_factory_override = \Drupal::service('language.config_factory_override');
    $override = $config_factory_override
      ->getOverride('fr', 'foo.bar');
    $override
      ->setData($override_data)
      ->save();
    $collection = $storage
      ->createCollection($override
      ->getStorage()
      ->getCollectionName());
    $this
      ->assertEquals($override_data, $collection
      ->read('foo.bar'));
    \Drupal::configFactory()
      ->rename('foo.bar', 'bar.baz');
    $this
      ->assertEquals($data, $storage
      ->read('bar.baz'));
    $this
      ->assertFalse($storage
      ->exists('foo.bar'));

    // @todo Add test coverage when https://www.drupal.org/project/drupal/issues/2981444
    // is fixed.
    // $this->assertEquals($override_data, $collection->read('bar.baz'));
    $this
      ->assertFalse($collection
      ->exists('foo.bar'));
  }

  /**
   * @covers \Drupal\tome_sync\Exporter::getContentToExport
   */
  public function testExcludedTypes() {
    $this
      ->enableModules([
      'content_moderation',
      'workflows',
    ]);
    $this
      ->installEntitySchema('content_moderation_state');
    $this
      ->assertArrayNotHasKey('content_moderation_state', \Drupal::service('tome_sync.exporter')
      ->getContentToExport());
  }

}

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.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExporterTest::$modules public static property Modules to enable. Overrides TestBase::$modules
ExporterTest::setUp public function Overrides TestBase::setUp
ExporterTest::testDeleteConfigExport public function @covers \Drupal\tome_sync\EventSubscriber\ConfigEventSubscriber::configDelete @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configDelete
ExporterTest::testDeleteContentExport public function @covers \Drupal\tome_sync\Exporter::deleteContentExport
ExporterTest::testExcludedTypes public function @covers \Drupal\tome_sync\Exporter::getContentToExport
ExporterTest::testExportConfig public function @covers \Drupal\tome_sync\EventSubscriber\ConfigEventSubscriber::configSave @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configSave
ExporterTest::testExportContent public function @covers \Drupal\tome_sync\Exporter::exportContent
ExporterTest::testRenameConfig public function @covers \Drupal\tome_sync\EventSubscriber\ConfigEventSubscriber::configRename @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configSave @covers \Drupal\tome_sync\EventSubscriber\LanguageConfigEventSubscriber::configDelete
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::$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.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. Overrides KernelTestBase::$strictConfigSchema
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.