You are here

Home » API reference » Default Content for D8 2.0.x » ExporterIntegrationTest.php

class ExporterIntegrationTest in Default Content for D8 2.0.x

Same name and namespace in other branches
  1. 8 tests/src/Kernel/ExporterIntegrationTest.php \Drupal\Tests\default_content\Kernel\ExporterIntegrationTest

Tests export functionality.

@coversDefaultClass \Drupal\default_content\Exporter @group default_content

Hierarchy

Expanded class hierarchy of ExporterIntegrationTest

File

tests/src/Kernel/ExporterIntegrationTest.php, line 23

Namespace

Drupal\Tests\default_content\Kernel
View source 
class ExporterIntegrationTest extends KernelTestBase {
  use EntityReferenceTestTrait;
  use TestFileCreationTrait;

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

  /**
   * The tested default content exporter.
   *
   * @var \Drupal\default_content\Exporter
   */
  protected $exporter;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('file');
  }

  /**
   * Tests exportContent().
   */
  public function testExportContent() {
    \Drupal::service('module_installer')
      ->install([
      'taxonomy',
      'default_content',
    ]);
    $this->exporter = \Drupal::service('default_content.exporter');
    $vocabulary = Vocabulary::create([
      'vid' => 'test',
    ]);
    $vocabulary
      ->save();
    $term = Term::create([
      'vid' => $vocabulary
        ->id(),
      'name' => 'test_name',
      'description' => [
        'value' => 'The description',
        'format' => 'plain_text',
      ],
    ]);
    $term
      ->save();
    $term = Term::load($term
      ->id());
    $exported = $this->exporter
      ->exportContent('taxonomy_term', $term
      ->id());
    $exported_decoded = Yaml::decode($exported);

    // Assert the meta data and field values.
    $meta = [
      'version' => '1.0',
      'entity_type' => 'taxonomy_term',
      'uuid' => $term
        ->uuid(),
      'bundle' => $term
        ->bundle(),
      'default_langcode' => $term
        ->language()
        ->getId(),
    ];
    $this
      ->assertEquals($meta, $exported_decoded['_meta']);
    $this
      ->assertEquals($term
      ->label(), $exported_decoded['default']['name'][0]['value']);
    $expected_description = [
      [
        'value' => 'The description',
        'format' => 'plain_text',
      ],
    ];
    $this
      ->assertEqual($expected_description, $exported_decoded['default']['description']);

    // Tests export of taxonomy parent field.
    $child_term = Term::create([
      'vid' => $vocabulary
        ->id(),
      'name' => 'child_name',
      'parent' => $term
        ->id(),
    ]);
    $child_term
      ->save();

    // Make sure parent relation is exported.
    $exported = $this->exporter
      ->exportContent('taxonomy_term', $child_term
      ->id());
    $exported_decoded = Yaml::decode($exported);
    $this
      ->assertEquals($term
      ->uuid(), $exported_decoded['default']['parent'][0]['entity']);
    $this
      ->assertEquals('taxonomy_term', $exported_decoded['_meta']['depends'][$term
      ->uuid()]);
  }

  /**
   * Tests exportContentWithReferences().
   */
  public function testExportWithReferences() {
    \Drupal::service('module_installer')
      ->install([
      'node',
      'default_content',
    ]);
    $this->exporter = \Drupal::service('default_content.exporter');
    $role = Role::create([
      'id' => 'example_role',
    ]);
    $role
      ->save();
    $user = User::create([
      'name' => 'my username',
      'uid' => 2,
      'roles' => $role
        ->id(),
    ]);
    $user
      ->save();

    // Reload the user to get the proper casted values from the DB.
    $user = User::load($user
      ->id());
    $node_type = NodeType::create([
      'type' => 'test',
    ]);
    $node_type
      ->save();
    $node = Node::create([
      'type' => $node_type
        ->id(),
      'title' => 'test node',
      'uid' => $user
        ->id(),
    ]);
    $node
      ->save();

    // Reload the node to get the proper casted values from the DB.
    $node = Node::load($node
      ->id());
    $exported_by_entity_type = $this->exporter
      ->exportContentWithReferences('node', $node
      ->id());

    // Ensure that the node type is not tryed to be exported.
    $this
      ->assertEqual(array_keys($exported_by_entity_type), [
      'node',
      'user',
    ]);

    // Ensure the right UUIDs are exported.
    $this
      ->assertEqual([
      $node
        ->uuid(),
    ], array_keys($exported_by_entity_type['node']));
    $this
      ->assertEqual([
      $user
        ->uuid(),
    ], array_keys($exported_by_entity_type['user']));

    // Compare the actual serialized data.
    $meta = [
      'version' => '1.0',
      'entity_type' => 'node',
      'uuid' => $node
        ->uuid(),
      'bundle' => $node
        ->bundle(),
      'default_langcode' => $node
        ->language()
        ->getId(),
      'depends' => [
        $user
          ->uuid() => 'user',
      ],
    ];
    $exported_node = Yaml::decode($exported_by_entity_type['node'][$node
      ->uuid()]);
    $this
      ->assertEquals($meta, $exported_node['_meta']);
    $this
      ->assertEquals($node
      ->label(), $exported_node['default']['title'][0]['value']);
    $meta = [
      'version' => '1.0',
      'entity_type' => 'user',
      'uuid' => $user
        ->uuid(),
      'default_langcode' => $node
        ->language()
        ->getId(),
    ];
    $exported_user = Yaml::decode($exported_by_entity_type['user'][$user
      ->uuid()]);
    $this
      ->assertEquals($meta, $exported_user['_meta']);
    $this
      ->assertEquals($user
      ->label(), $exported_user['default']['name'][0]['value']);
    $this
      ->assertEquals($role
      ->id(), $exported_user['default']['roles'][0]['target_id']);

    // Ensure no recursion on export.
    $field_name = 'field_test_self_ref';
    $this
      ->createEntityReferenceField('node', $node_type
      ->id(), $field_name, 'Self reference field', 'node');
    $node1 = Node::create([
      'type' => $node_type
        ->id(),
      'title' => 'ref 1->3',
    ]);
    $node1
      ->save();
    $node2 = Node::create([
      'type' => $node_type
        ->id(),
      'title' => 'ref 2->1',
      $field_name => $node1
        ->id(),
    ]);
    $node2
      ->save();
    $node3 = Node::create([
      'type' => $node_type
        ->id(),
      'title' => 'ref 3->2',
      $field_name => $node2
        ->id(),
    ]);
    $node3
      ->save();

    // Loop reference.
    $node1->{$field_name}->target_id = $node3
      ->id();
    $node1
      ->save();
    $exported_by_entity_type = $this->exporter
      ->exportContentWithReferences('node', $node3
      ->id());

    // Ensure all 3 nodes are exported.
    $this
      ->assertEquals(3, count($exported_by_entity_type['node']));
  }

  /**
   * Tests exportModuleContent().
   */
  public function testModuleExport() {
    \Drupal::service('module_installer')
      ->install([
      'node',
      'default_content',
      'default_content_export_test',
    ]);
    $this->exporter = \Drupal::service('default_content.exporter');
    $test_uuid = '0e45d92f-1919-47cd-8b60-964a8a761292';
    $node_type = NodeType::create([
      'type' => 'test',
    ]);
    $node_type
      ->save();
    $user = User::create([
      'name' => 'owner',
    ]);
    $user
      ->save();
    $node = Node::create([
      'type' => $node_type
        ->id(),
      'title' => 'test node',
      'uid' => $user
        ->id(),
    ]);
    $node->uuid = $test_uuid;
    $node
      ->save();

    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::load($node
      ->id());
    $expected_node = [
      '_meta' => [
        'version' => '1.0',
        'entity_type' => 'node',
        'uuid' => '0e45d92f-1919-47cd-8b60-964a8a761292',
        'bundle' => 'test',
        'default_langcode' => 'en',
      ],
      'default' => [
        'revision_uid' => [
          0 => [
            'target_id' => $node
              ->getOwner()
              ->id(),
          ],
        ],
        'status' => [
          0 => [
            'value' => TRUE,
          ],
        ],
        'uid' => [
          0 => [
            'target_id' => $node
              ->getOwner()
              ->id(),
          ],
        ],
        'title' => [
          0 => [
            'value' => 'test node',
          ],
        ],
        'created' => [
          0 => [
            'value' => $node
              ->getCreatedTime(),
          ],
        ],
        'promote' => [
          0 => [
            'value' => TRUE,
          ],
        ],
        'sticky' => [
          0 => [
            'value' => FALSE,
          ],
        ],
        'revision_translation_affected' => [
          0 => [
            'value' => TRUE,
          ],
        ],
      ],
    ];
    $content = $this->exporter
      ->exportModuleContent('default_content_export_test');
    $this
      ->assertEquals($expected_node, Yaml::decode($content['node'][$test_uuid]));
  }

  /**
   * Tests exportModuleContent()
   */
  public function testModuleExportException() {
    \Drupal::service('module_installer')
      ->install([
      'node',
      'default_content',
      'default_content_export_test',
    ]);
    \Drupal::service('router.builder')
      ->rebuild();
    $this->defaultContentManager = \Drupal::service('default_content.exporter');
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage(sprintf('Entity "%s" with UUID "%s" does not exist', 'node', '0e45d92f-1919-47cd-8b60-964a8a761292'));

    // Should throw an exception for missing uuid for the testing module.
    $this->defaultContentManager
      ->exportModuleContent('default_content_export_test');
  }

  /**
   * Tests exporting files.
   */
  public function testExportFiles() {
    \Drupal::service('module_installer')
      ->install([
      'default_content',
    ]);
    $this->exporter = \Drupal::service('default_content.exporter');
    $test_files = $this
      ->getTestFiles('image');
    $test_file = reset($test_files);

    /** @var \Drupal\file\FileInterface $file */
    $file = File::create([
      'uri' => $test_file->uri,
      'status' => \FILE_STATUS_PERMANENT,
    ]);
    $file
      ->save();
    $folder = 'temporary://default_content';
    $exported_by_entity_type = $this->exporter
      ->exportContentWithReferences('file', $file
      ->id(), $folder);
    $normalized_file = Yaml::decode($exported_by_entity_type['file'][$file
      ->uuid()]);
    $expected = [
      '_meta' => [
        'version' => '1.0',
        'entity_type' => 'file',
        'uuid' => $file
          ->uuid(),
        'default_langcode' => 'en',
      ],
      'default' => [
        'filename' => [
          0 => [
            'value' => $file
              ->getFilename(),
          ],
        ],
        'uri' => [
          0 => [
            'value' => $file
              ->getFileUri(),
          ],
        ],
        'filemime' => [
          0 => [
            'value' => $file
              ->getMimeType(),
          ],
        ],
        'filesize' => [
          0 => [
            'value' => $file
              ->getSize(),
          ],
        ],
        'status' => [
          0 => [
            'value' => TRUE,
          ],
        ],
        'created' => [
          0 => [
            'value' => $file
              ->getCreatedTime(),
          ],
        ],
      ],
    ];
    $this
      ->assertEquals($expected, $normalized_file);
    $this
      ->assertFileExists($folder . '/file/' . $file
      ->uuid() . '.yml');
    $this
      ->assertFileExists($folder . '/file/' . $file
      ->getFilename());
  }

}

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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
ExporterIntegrationTest::$exporter protected property The tested default content exporter.
ExporterIntegrationTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ExporterIntegrationTest::setUp protected function Overrides KernelTestBase::setUp
ExporterIntegrationTest::testExportContent public function Tests exportContent().
ExporterIntegrationTest::testExportFiles public function Tests exporting files.
ExporterIntegrationTest::testExportWithReferences public function Tests exportContentWithReferences().
ExporterIntegrationTest::testModuleExport public function Tests exportModuleContent().
ExporterIntegrationTest::testModuleExportException public function Tests exportModuleContent()
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
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.