class TaxonomyTermTest in Commerce Migrate 3.0.x

Upgrade taxonomy terms.

@requires module migrate_source_csv

@group commerce_migrate_csv_example

Hierarchy

• class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
  • class \Drupal\Tests\migrate\Kernel\MigrateTestBase implements MigrateMessageInterface
    • class \Drupal\Tests\commerce_migrate\Kernel\CsvTestBase
      • class \Drupal\Tests\commerce_migrate_csv_example\Kernel\Migrate\TaxonomyTermTest uses CommerceMigrateTestTrait

File

modules/csv_example/tests/src/Kernel/Migrate/TaxonomyTermTest.php, line 17

Namespace

Drupal\Tests\commerce_migrate_csv_example\Kernel\Migrate

class TaxonomyTermTest extends CsvTestBase {
  use CommerceMigrateTestTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'commerce_migrate_csv_example',
    'taxonomy',
    'text',
    'user',
  ];

  /**
   * {@inheritdoc}
   */
  protected $fixtures = [
    __DIR__ . '/../../../fixtures/csv/example-products.csv',
  ];

  /**
   * The cached taxonomy tree items, keyed by vid and tid.
   *
   * @var array
   */
  protected $treeData = [];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->createVocabularies([
      'Category',
      'Season',
    ]);
    $this
      ->executeMigration('csv_example_taxonomy_term');
  }

  /**
   * Validate a migrated term contains the expected values.
   *
   * @param string $id
   *   Entity ID to load and check.
   * @param string $expected_label
   *   The label the migrated entity should have.
   * @param string $expected_vid
   *   The parent vocabulary the migrated entity should have.
   * @param string $expected_description
   *   The description the migrated entity should have.
   * @param string $expected_format
   *   The format the migrated entity should have.
   * @param int $expected_weight
   *   The weight the migrated entity should have.
   * @param array $expected_parents
   *   The parent terms the migrated entity should have.
   * @param int $expected_field_integer_value
   *   The value the migrated entity field should have.
   * @param int $expected_term_reference_tid
   *   The term reference id the migrated entity field should have.
   * @param bool $expected_container_flag
   *   The term should be a container entity.
   */
  protected function assertEntity($id, $expected_label, $expected_vid, $expected_description = '', $expected_format = NULL, $expected_weight = 0, array $expected_parents = [], $expected_field_integer_value = NULL, $expected_term_reference_tid = NULL, $expected_container_flag = FALSE) {

    /** @var \Drupal\taxonomy\TermInterface $entity */
    $entity = Term::load($id);
    $this
      ->assertInstanceOf(TermInterface::class, $entity);
    $this
      ->assertEquals($expected_label, $entity
      ->label());
    $this
      ->assertEquals($expected_vid, $entity
      ->bundle());
    $this
      ->assertEquals($expected_description, $entity
      ->getDescription());
    $this
      ->assertEquals($expected_format, $entity
      ->getFormat());
    $this
      ->assertEquals($expected_weight, $entity
      ->getWeight());
    $this
      ->assertEquals($expected_parents, $this
      ->getParentIDs($id));
    $this
      ->assertHierarchy($expected_vid, $id, $expected_parents);
    if (!is_null($expected_field_integer_value)) {
      $this
        ->assertTrue($entity
        ->hasField('field_integer'));
      $this
        ->assertEquals($expected_field_integer_value, $entity->field_integer->value);
    }
    if (!is_null($expected_term_reference_tid)) {
      $this
        ->assertTrue($entity
        ->hasField('field_integer'));
      $this
        ->assertEquals($expected_term_reference_tid, $entity->field_term_reference->target_id);
    }
    if ($entity
      ->hasField('forum_container')) {
      $this
        ->assertEquals($expected_container_flag, $entity->forum_container->value);
    }
  }

  /**
   * Tests the taxonomy term migration.
   */
  public function testTaxonomyTerms() {
    $this
      ->assertEntity(1, 'Wetsuit', 'category', '', NULL, 0);
    $this
      ->assertEntity(2, 'Summer', 'season', '', NULL, 0);
    $this
      ->assertEntity(3, 'Winter', 'season', '', NULL, 0);
    $this
      ->assertEntity(4, 'Misc', 'category', '', NULL, 0);
    $this
      ->assertEntity(5, 'Camera', 'category', '', NULL, 0);
    $this
      ->assertEntity(6, 'All', 'season', '', NULL, 0);
  }

  /**
   * Retrieves the parent term IDs for a given term.
   *
   * @param int $tid
   *   ID of the term to check.
   *
   * @return array
   *   List of parent term IDs.
   */
  protected function getParentIds($tid) {
    return array_keys(\Drupal::entityTypeManager()
      ->getStorage('taxonomy_term')
      ->loadParents($tid));
  }

  /**
   * Assert that a term is present in the tree storage, with the right parents.
   *
   * @param string $vid
   *   Vocabulary ID.
   * @param int $tid
   *   ID of the term to check.
   * @param array $parent_ids
   *   The expected parent term IDs.
   */
  protected function assertHierarchy($vid, $tid, array $parent_ids) {
    if (!isset($this->treeData[$vid])) {
      $tree = \Drupal::entityTypeManager()
        ->getStorage('taxonomy_term')
        ->loadTree($vid);
      $this->treeData[$vid] = [];
      foreach ($tree as $item) {
        $this->treeData[$vid][$item->tid] = $item;
      }
    }
    $this
      ->assertArrayHasKey($tid, $this->treeData[$vid], "Term {$tid} exists in taxonomy tree");
    $term = $this->treeData[$vid][$tid];
    $this
      ->assertEquals($parent_ids, array_filter($term->parents), "Term {$tid} has correct parents in taxonomy tree");
  }

}

Members

Name	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
CommerceMigrateTestTrait::assertAddressField	public	function	Asserts an address field.
CommerceMigrateTestTrait::assertAddressItem	public	function	Asserts an address field.
CommerceMigrateTestTrait::assertAdjustment	public	function	Assert an adjustment.
CommerceMigrateTestTrait::assertAdjustments	public	function	Assert multiple adjustments.
CommerceMigrateTestTrait::assertCurrencyEntity	public	function	Asserts a Currency entity.
CommerceMigrateTestTrait::assertDefaultStore	public	function	Assert a default store exists.
CommerceMigrateTestTrait::assertOrder	public	function	Asserts an order entity.
CommerceMigrateTestTrait::assertOrderItem	public	function	Asserts an order item.
CommerceMigrateTestTrait::assertOrderItemType	public	function	Asserts an order item type configuration entity.
CommerceMigrateTestTrait::assertPaymentEntity	private	function	Asserts a payment entity.	1
CommerceMigrateTestTrait::assertPaymentGatewayEntity	private	function	Asserts a payment gateway entity.	1
CommerceMigrateTestTrait::assertPrice	public	function	Assert a price.
CommerceMigrateTestTrait::assertProductAttributeEntity	protected	function	Asserts a product attribute entity.
CommerceMigrateTestTrait::assertProductAttributeValueEntity	protected	function	Asserts a product attribute value entity.
CommerceMigrateTestTrait::assertProductEntity	public	function	Asserts a product.
CommerceMigrateTestTrait::assertProductTypeEntity	public	function	Asserts a product type entity.
CommerceMigrateTestTrait::assertProductVariationEntity	public	function	Asserts a product variation.
CommerceMigrateTestTrait::assertProductVariationTypeEntity	public	function	Asserts a product variation type.
CommerceMigrateTestTrait::assertProfile	public	function	Asserts a profile entity.
CommerceMigrateTestTrait::assertProfileEntity	public	function	Asserts a profile.
CommerceMigrateTestTrait::assertProfileRevision	public	function	Asserts a profile revision.
CommerceMigrateTestTrait::assertProfileType	public	function	Asserts a profile type configuration entity.
CommerceMigrateTestTrait::assertShippingMethod	public	function	Asserts a shipping method.
CommerceMigrateTestTrait::assertStoreEntity	public	function	Asserts a store entity.
CommerceMigrateTestTrait::assertTaxType	public	function	Asserts a tax type.
CommerceMigrateTestTrait::assertUbercartOrder	public	function	Asserts an order entity.
CommerceMigrateTestTrait::createDefaultStore	protected	function	Creates a default store.
CommerceMigrateTestTrait::executeRollback	protected	function	Executes rollback on a single migration.
CommerceMigrateTestTrait::executeRollbacks	protected	function	Executes a set of migrations in dependency order.
CommerceMigrateTestTrait::formatNumber	public	function	Formats a price number.
CommerceMigrateTestTrait::productTest	public	function	Helper to test a product and its variations.
CommerceMigrateTestTrait::productVariationTest	public	function	Helper to test a product is linked to its variations.
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.
CsvTestBase::$csvPath	protected	property	Basename of the directory used in the migration 'path:' configuration.
CsvTestBase::$fs	protected	property	File system active during the test.
CsvTestBase::createAttribute	protected	function	Creates attributes.
CsvTestBase::createVocabularies	protected	function	Creates vocabularies.
CsvTestBase::fileMigrationSetup	protected	function	Prepares a public file directory for the migration.
CsvTestBase::getFixtureFilePath	protected	function	Gets the path to the fixture file.
CsvTestBase::loadFixture	protected	function	Copy the source CSV files to the path in the migration.
CsvTestBase::recurseCopy	private	function	Helper to copy directory tree.
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::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.
MigrateTestBase::$collectMessages	protected	property	TRUE to collect messages instead of displaying them.
MigrateTestBase::$logger	protected	property	A logger prophecy object.	2
MigrateTestBase::$migrateMessages	protected	property	A two dimensional array of messages.
MigrateTestBase::$migration	protected	property	The primary migration being tested.	1
MigrateTestBase::$sourceDatabase	protected	property	The source database connection.
MigrateTestBase::cleanupMigrateConnection	private	function	Cleans up the test migrate connection.
MigrateTestBase::createMigrationConnection	private	function	Changes the database connection to the prefixed one.
MigrateTestBase::display	public	function	Displays a migrate message. Overrides MigrateMessageInterface::display
MigrateTestBase::executeMigration	protected	function	Executes a single migration.
MigrateTestBase::executeMigrations	protected	function	Executes a set of migrations in dependency order.
MigrateTestBase::getMigration	protected	function	Gets the migration plugin.
MigrateTestBase::mockFailure	protected	function	Records a failure in the map table of a specific migration.
MigrateTestBase::prepareMigration	protected	function	Modify a migration's configuration before executing it.
MigrateTestBase::prepareMigrations	protected	function	Prepare any dependent migrations.
MigrateTestBase::setTestLogger	protected	function	Injects the test logger into the container.
MigrateTestBase::startCollectingMessages	public	function	Start collecting messages and erase previous messages.
MigrateTestBase::stopCollectingMessages	public	function	Stop collecting messages.
MigrateTestBase::tearDown	protected	function	Overrides KernelTestBase::tearDown
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.
TaxonomyTermTest::$fixtures	protected	property	The relative path to each test fixture needed for the test. Overrides CsvTestBase::$fixtures
TaxonomyTermTest::$modules	public static	property	Modules to enable. Overrides CsvTestBase::$modules
TaxonomyTermTest::$treeData	protected	property	The cached taxonomy tree items, keyed by vid and tid.
TaxonomyTermTest::assertEntity	protected	function	Validate a migrated term contains the expected values.
TaxonomyTermTest::assertHierarchy	protected	function	Assert that a term is present in the tree storage, with the right parents.
TaxonomyTermTest::getParentIds	protected	function	Retrieves the parent term IDs for a given term.
TaxonomyTermTest::setUp	protected	function	Overrides CsvTestBase::setUp
TaxonomyTermTest::testTaxonomyTerms	public	function	Tests the taxonomy term migration.
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.