You are here

Home » API reference » Metatag Import Export CSV 8 » MetatagImportTest.php

class MetatagImportTest in Metatag Import Export CSV 8

Tests importing CSV data.

@group metatag_import_export_csv

Hierarchy

Expanded class hierarchy of MetatagImportTest

File

tests/src/Kernel/MetatagImportTest.php, line 14

Namespace

Drupal\Tests\metatag_import_export_csv\Kernel
View source 
class MetatagImportTest extends EntityKernelTestBase {

  /**
   * The modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'user',
    'token',
    'metatag',
    'metatag_import_export_csv',
    'language',
    'content_translation',
    'path',
    'path_alias',
    'node',
  ];

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->entityTypeManager = $this->container
      ->get('entity_type.manager');
    $this
      ->installSchema('node', 'node_access');
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('path_alias');
    $this
      ->installConfig([
      'language',
    ]);
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();

    // Setup an anonymous user, so URL operations work.
    // See https://www.drupal.org/project/drupal/issues/3056234.
    $this->entityTypeManager
      ->getStorage('user')
      ->create([
      'name' => '',
      'uid' => 0,
    ])
      ->save();

    // Create the node type.
    $node_type_storage = $this->entityTypeManager
      ->getStorage('node_type');
    $type = $node_type_storage
      ->create([
      'type' => 'page',
      'name' => 'Page',
    ]);
    $type
      ->save();

    // Create the metatags field.
    $field_name = 'field_metatags';
    $this->entityTypeManager
      ->getStorage('field_storage_config')
      ->create([
      'field_name' => $field_name,
      'entity_type' => 'node',
      'type' => 'metatag',
    ])
      ->save();
    $this->entityTypeManager
      ->getStorage('field_config')
      ->create([
      'field_name' => $field_name,
      'entity_type' => 'node',
      'bundle' => 'page',
    ])
      ->save();
  }

  /**
   * Test entities are updated from the CSV data.
   */
  public function testEntityUpdate() {
    $node_storage = $this->entityTypeManager
      ->getStorage('node');
    $nodes = [];

    // Simple node.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 1',
    ]);
    $node
      ->save();
    $nodes[1] = $node;

    // Node with an existing value.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 2',
      'field_metatags' => serialize([
        'abstract' => 'old value',
      ]),
    ]);
    $node
      ->save();
    $nodes[2] = $node;

    // Translated node, only changing the original language.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 3',
      'field_metatags' => serialize([
        'abstract' => 'old value',
      ]),
    ]);
    $node
      ->save();
    $nodes[3] = $node;
    $translation = $node
      ->addTranslation('fr', $node
      ->toArray());
    $translation->field_metatags = serialize([
      'abstract' => 'ancienne valeur',
    ]);
    $translation
      ->save();

    // Translated node, changing only the translation.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 4',
      'field_metatags' => serialize([
        'abstract' => 'old value',
      ]),
    ]);
    $node
      ->save();
    $nodes[4] = $node;
    $translation = $node
      ->addTranslation('fr', $node
      ->toArray());
    $translation->field_metatags = serialize([
      'abstract' => 'ancienne valeur',
    ]);
    $translation
      ->save();

    // Translated node, changing both languages.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 5',
      'field_metatags' => serialize([
        'abstract' => 'old value',
      ]),
    ]);
    $node
      ->save();
    $nodes[5] = $node;
    $translation = $node
      ->addTranslation('fr', $node
      ->toArray());
    $translation->field_metatags = serialize([
      'abstract' => 'ancienne valeur',
    ]);
    $translation
      ->save();

    // Node with a path alias.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 6',
      'path' => [
        'alias' => '/foo',
      ],
    ]);
    $node
      ->save();
    $nodes[6] = $node;

    // Node with translated path alias.
    $node = $node_storage
      ->create([
      'type' => 'page',
      'title' => 'Title 7',
      'path' => [
        'alias' => '/bar',
      ],
    ]);
    $node
      ->save();
    $nodes[7] = $node;
    $translation = $node
      ->addTranslation('fr', $node
      ->toArray());
    $translation->path->alias = '/toto';
    $translation
      ->save();

    // CSV data to import.
    $headers = [
      'entity_type',
      'entity_id',
      'path_alias',
      'language',
      'field_machine_name',
      'abstract',
    ];
    $data = [
      [
        'node',
        $nodes[1]
          ->id(),
        '',
        '',
        'field_metatags',
        'new value one',
      ],
      [
        'node',
        $nodes[2]
          ->id(),
        '',
        '',
        'field_metatags',
        'new value two',
      ],
      [
        'node',
        $nodes[3]
          ->id(),
        '',
        '',
        'field_metatags',
        'new value three',
      ],
      [
        'node',
        $nodes[4]
          ->id(),
        '',
        'fr',
        'field_metatags',
        'nouvelle valeur quatre',
      ],
      [
        'node',
        $nodes[5]
          ->id(),
        '',
        'en',
        'field_metatags',
        'new value five',
      ],
      [
        'node',
        $nodes[5]
          ->id(),
        '',
        'fr',
        'field_metatags',
        'nouvelle valeur cinq',
      ],
      [
        '',
        '',
        '/foo',
        '',
        'field_metatags',
        'new value six',
      ],
      [
        '',
        '',
        '/bar',
        'en',
        'field_metatags',
        'new value seven',
      ],
      [
        '',
        '',
        '/toto',
        'fr',
        'field_metatags',
        'nouvelle valeur sept',
      ],
    ];
    foreach ($data as $row) {
      MetatagImport::importCsvRow($headers, $row);
    }
    foreach ($nodes as $index => $node) {
      $nodes[$index] = $this
        ->reloadEntity($node);
    }
    $metatag_data = unserialize($nodes[1]->field_metatags->value);
    $this
      ->assertEquals('new value one', $metatag_data['abstract']);
    $metatag_data = unserialize($nodes[2]->field_metatags->value);
    $this
      ->assertEquals('new value two', $metatag_data['abstract']);

    // Original is affected.
    $metatag_data = unserialize($nodes[3]->field_metatags->value);
    $this
      ->assertEquals('new value three', $metatag_data['abstract']);

    // Translation is not affected.
    $metatag_data = unserialize($nodes[3]
      ->getTranslation('fr')->field_metatags->value);
    $this
      ->assertEquals('ancienne valeur', $metatag_data['abstract']);

    // Original is not affected.
    $metatag_data = unserialize($nodes[4]->field_metatags->value);
    $this
      ->assertEquals('old value', $metatag_data['abstract']);

    // Translation is updated.
    $metatag_data = unserialize($nodes[4]
      ->getTranslation('fr')->field_metatags->value);
    $this
      ->assertEquals('nouvelle valeur quatre', $metatag_data['abstract']);

    // Both translations are updated.
    $metatag_data = unserialize($nodes[5]->field_metatags->value);
    $this
      ->assertEquals('new value five', $metatag_data['abstract']);
    $metatag_data = unserialize($nodes[5]
      ->getTranslation('fr')->field_metatags->value);
    $this
      ->assertEquals('nouvelle valeur cinq', $metatag_data['abstract']);
    $metatag_data = unserialize($nodes[6]->field_metatags->value);
    $this
      ->assertEquals('new value six', $metatag_data['abstract']);

    // Both translations are updated.
    $metatag_data = unserialize($nodes[7]->field_metatags->value);
    $this
      ->assertEquals('new value seven', $metatag_data['abstract']);
    $metatag_data = unserialize($nodes[7]
      ->getTranslation('fr')->field_metatags->value);
    $this
      ->assertEquals('nouvelle valeur sept', $metatag_data['abstract']);

    // Check other field values are not changed.
    foreach ($nodes as $index => $node) {
      $this
        ->assertEquals("Title {$index}", $node->title->value);
    }
  }

  /**
   * Tests handling of badly-formed CSV data.
   *
   * @dataProvider providerBadData
   *
   * @param array $headers
   *   The row of CSV headers.
   * @param array $data
   *   A row of mocked CSV data.
   */
  public function testBadData($headers, $data) {
    $node = $this->entityTypeManager
      ->getStorage('node')
      ->create([
      'type' => 'page',
      'title' => 'Title',
    ]);
    $node
      ->save();
    $this
      ->expectException(\Exception::class);
    MetatagImport::importCsvRow($headers, $data);
  }

  /**
   * Data provider for testBadData();
   */
  public function providerBadData() {
    return [
      'missing entity type' => [
        [
          'entity_type',
          'entity_id',
          'path_alias',
          'field_machine_name',
          'abstract',
        ],
        [
          '',
          1,
          '',
          'field_metatags',
          'tag value',
        ],
      ],
      'missing entity ID' => [
        [
          'entity_type',
          'entity_id',
          'path_alias',
          'field_machine_name',
          'abstract',
        ],
        [
          'node',
          '',
          '',
          'field_metatags',
          'tag value',
        ],
      ],
      'missing any entity details' => [
        [
          'entity_type',
          'entity_id',
          'path_alias',
          'field_machine_name',
          'abstract',
        ],
        [
          '',
          '',
          '',
          'field_metatags',
          'tag value',
        ],
      ],
      'bad entity type' => [
        [
          'entity_type',
          'entity_id',
          'field_machine_name',
          'abstract',
        ],
        [
          'cake',
          1,
          'field_metatags',
          'tag value',
        ],
      ],
      'bad entity id' => [
        [
          'entity_type',
          'entity_id',
          'field_machine_name',
          'abstract',
        ],
        [
          'node',
          47,
          'field_metatags',
          'tag value',
        ],
      ],
      'bad language' => [
        [
          'entity_type',
          'entity_id',
          'language',
          'field_machine_name',
          'abstract',
        ],
        [
          'node',
          47,
          'klingon',
          'field_metatags',
          'tag value',
        ],
      ],
      'missing translation' => [
        [
          'entity_type',
          'entity_id',
          'language',
          'field_machine_name',
          'abstract',
        ],
        [
          'node',
          47,
          'fr',
          'field_metatags',
          'tag value',
        ],
      ],
      'bad field' => [
        [
          'entity_type',
          'entity_id',
          'language',
          'field_machine_name',
          'abstract',
        ],
        [
          'node',
          1,
          '',
          'bad_field',
          'tag value',
        ],
      ],
      'bad path alias' => [
        [
          'path_alias',
          'field_machine_name',
          'abstract',
        ],
        [
          '/bad-alias',
          'field_metatags',
          'tag value',
        ],
      ],
    ];
  }

}

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.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
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::__sleep public function Prevents serializing any properties.
MetatagImportTest::$entityTypeManager protected property The entity type manager. Overrides EntityKernelTestBase::$entityTypeManager
MetatagImportTest::$modules protected static property The modules to enable. Overrides EntityKernelTestBase::$modules
MetatagImportTest::providerBadData public function Data provider for testBadData();
MetatagImportTest::setUp protected function Overrides EntityKernelTestBase::setUp
MetatagImportTest::testBadData public function Tests handling of badly-formed CSV data.
MetatagImportTest::testEntityUpdate public function Test entities are updated from the CSV data.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser