class HighWaterTest in Drupal 9

Same name in this branch

9 core/modules/migrate/tests/src/Kernel/HighWaterTest.php \Drupal\Tests\migrate\Kernel\HighWaterTest
9 core/modules/migrate/tests/modules/migrate_high_water_test/src/Plugin/migrate/source/HighWaterTest.php \Drupal\migrate_high_water_test\Plugin\migrate\source\HighWaterTest

Same name and namespace in other branches

8 core/modules/migrate/tests/src/Kernel/HighWaterTest.php \Drupal\Tests\migrate\Kernel\HighWaterTest

Tests migration high water property.

@group migrate

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\migrate\Kernel\HighWaterTest

Expanded class hierarchy of HighWaterTest

File

core/modules/migrate/tests/src/Kernel/HighWaterTest.php, line 10

Namespace

Drupal\Tests\migrate\Kernel

View source

class HighWaterTest extends MigrateTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'user',
    'node',
    'migrate',
    'migrate_high_water_test',
    'field',
  ];

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

    // Create source test table.
    $this->sourceDatabase
      ->schema()
      ->createTable('high_water_node', [
      'fields' => [
        'id' => [
          'description' => 'Serial',
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ],
        'changed' => [
          'description' => 'Highwater',
          'type' => 'int',
          'unsigned' => TRUE,
        ],
        'title' => [
          'description' => 'Title',
          'type' => 'varchar',
          'length' => 128,
          'not null' => TRUE,
          'default' => '',
        ],
      ],
      'primary key' => [
        'id',
      ],
      'description' => 'Contains nodes to import',
    ]);

    // Add 3 items to source table.
    $this->sourceDatabase
      ->insert('high_water_node')
      ->fields([
      'title',
      'changed',
    ])
      ->values([
      'title' => 'Item 1',
      'changed' => 1,
    ])
      ->values([
      'title' => 'Item 2',
      'changed' => 2,
    ])
      ->values([
      'title' => 'Item 3',
      'changed' => 3,
    ])
      ->execute();
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('node', 'node_access');
    $this
      ->executeMigration('high_water_test');
  }

  /**
   * Tests high water property of SqlBase.
   */
  public function testHighWater() {

    // Assert all of the nodes have been imported.
    $this
      ->assertNodeExists('Item 1');
    $this
      ->assertNodeExists('Item 2');
    $this
      ->assertNodeExists('Item 3');

    // Update Item 1 setting its high_water_property to value that is below
    // current high water mark.
    $this->sourceDatabase
      ->update('high_water_node')
      ->fields([
      'title' => 'Item 1 updated',
      'changed' => 2,
    ])
      ->condition('title', 'Item 1')
      ->execute();

    // Update Item 2 setting its high_water_property to value equal to
    // current high water mark.
    $this->sourceDatabase
      ->update('high_water_node')
      ->fields([
      'title' => 'Item 2 updated',
      'changed' => 3,
    ])
      ->condition('title', 'Item 2')
      ->execute();

    // Update Item 3 setting its high_water_property to value that is above
    // current high water mark.
    $this->sourceDatabase
      ->update('high_water_node')
      ->fields([
      'title' => 'Item 3 updated',
      'changed' => 4,
    ])
      ->condition('title', 'Item 3')
      ->execute();

    // Execute migration again.
    $this
      ->executeMigration('high_water_test');

    // Item with lower highwater should not be updated.
    $this
      ->assertNodeExists('Item 1');
    $this
      ->assertNodeDoesNotExist('Item 1 updated');

    // Item with equal highwater should not be updated.
    $this
      ->assertNodeExists('Item 2');
    $this
      ->assertNodeDoesNotExist('Item 2 updated');

    // Item with greater highwater should be updated.
    $this
      ->assertNodeExists('Item 3 updated');
    $this
      ->assertNodeDoesNotExist('Item 3');
  }

  /**
   * Tests that the high water value can be 0.
   */
  public function testZeroHighwater() {

    // Assert all of the nodes have been imported.
    $this
      ->assertNodeExists('Item 1');
    $this
      ->assertNodeExists('Item 2');
    $this
      ->assertNodeExists('Item 3');
    $migration = $this->container
      ->get('plugin.manager.migration')
      ->CreateInstance('high_water_test', []);
    $source = $migration
      ->getSourcePlugin();
    $source
      ->rewind();
    $count = 0;
    while ($source
      ->valid()) {
      $count++;
      $source
        ->next();
    }

    // Expect no rows as everything is below the high water mark.
    $this
      ->assertSame(0, $count);

    // Test resetting the high water mark to 0.
    $this->container
      ->get('keyvalue')
      ->get('migrate:high_water')
      ->set('high_water_test', 0);
    $migration = $this->container
      ->get('plugin.manager.migration')
      ->CreateInstance('high_water_test', []);
    $source = $migration
      ->getSourcePlugin();
    $source
      ->rewind();
    $count = 0;
    while ($source
      ->valid()) {
      $count++;
      $source
        ->next();
    }
    $this
      ->assertSame(3, $count);
  }

  /**
   * Tests that deleting the high water value causes all rows to be reimported.
   */
  public function testNullHighwater() {

    // Assert all of the nodes have been imported.
    $this
      ->assertNodeExists('Item 1');
    $this
      ->assertNodeExists('Item 2');
    $this
      ->assertNodeExists('Item 3');
    $migration = $this->container
      ->get('plugin.manager.migration')
      ->CreateInstance('high_water_test', []);
    $source = $migration
      ->getSourcePlugin();
    $source
      ->rewind();
    $count = 0;
    while ($source
      ->valid()) {
      $count++;
      $source
        ->next();
    }

    // Expect no rows as everything is below the high water mark.
    $this
      ->assertSame(0, $count);

    // Test resetting the high water mark.
    $this->container
      ->get('keyvalue')
      ->get('migrate:high_water')
      ->delete('high_water_test');
    $migration = $this->container
      ->get('plugin.manager.migration')
      ->CreateInstance('high_water_test', []);
    $source = $migration
      ->getSourcePlugin();
    $source
      ->rewind();
    $count = 0;
    while ($source
      ->valid()) {
      $count++;
      $source
        ->next();
    }
    $this
      ->assertSame(3, $count);
  }

  /**
   * Tests high water property of SqlBase when rows marked for update.
   */
  public function testHighWaterUpdate() {

    // Assert all of the nodes have been imported.
    $this
      ->assertNodeExists('Item 1');
    $this
      ->assertNodeExists('Item 2');
    $this
      ->assertNodeExists('Item 3');

    // Update Item 1 setting its high_water_property to value that is below
    // current high water mark.
    $this->sourceDatabase
      ->update('high_water_node')
      ->fields([
      'title' => 'Item 1 updated',
      'changed' => 2,
    ])
      ->condition('title', 'Item 1')
      ->execute();

    // Update Item 2 setting its high_water_property to value equal to
    // current high water mark.
    $this->sourceDatabase
      ->update('high_water_node')
      ->fields([
      'title' => 'Item 2 updated',
      'changed' => 3,
    ])
      ->condition('title', 'Item 2')
      ->execute();

    // Update Item 3 setting its high_water_property to value that is above
    // current high water mark.
    $this->sourceDatabase
      ->update('high_water_node')
      ->fields([
      'title' => 'Item 3 updated',
      'changed' => 4,
    ])
      ->condition('title', 'Item 3')
      ->execute();

    // Set all rows as needing an update.
    $id_map = $this
      ->getMigration('high_water_test')
      ->getIdMap();
    $id_map
      ->prepareUpdate();
    $this
      ->executeMigration('high_water_test');

    // Item with lower highwater should be updated.
    $this
      ->assertNodeExists('Item 1 updated');
    $this
      ->assertNodeDoesNotExist('Item 1');

    // Item with equal highwater should be updated.
    $this
      ->assertNodeExists('Item 2 updated');
    $this
      ->assertNodeDoesNotExist('Item 2');

    // Item with greater highwater should be updated.
    $this
      ->assertNodeExists('Item 3 updated');
    $this
      ->assertNodeDoesNotExist('Item 3');
  }

  /**
   * Assert that node with given title exists.
   *
   * @param string $title
   *   Title of the node.
   */
  protected function assertNodeExists($title) {
    self::assertTrue($this
      ->nodeExists($title));
  }

  /**
   * Assert that node with given title does not exist.
   *
   * @param string $title
   *   Title of the node.
   */
  protected function assertNodeDoesNotExist($title) {
    self::assertFalse($this
      ->nodeExists($title));
  }

  /**
   * Checks if node with given title exists.
   *
   * @param string $title
   *   Title of the node.
   *
   * @return bool
   */
  protected function nodeExists($title) {
    $query = \Drupal::entityQuery('node')
      ->accessCheck(FALSE);
    $result = $query
      ->condition('title', $title)
      ->range(0, 1)
      ->execute();
    return !empty($result);
  }

}

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
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.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
HighWaterTest::$modules	protected static	property	Modules to enable. Overrides MigrateTestBase::$modules
HighWaterTest::assertNodeDoesNotExist	protected	function	Assert that node with given title does not exist.
HighWaterTest::assertNodeExists	protected	function	Assert that node with given title exists.
HighWaterTest::nodeExists	protected	function	Checks if node with given title exists.
HighWaterTest::setUp	protected	function	Overrides MigrateTestBase::setUp
HighWaterTest::testHighWater	public	function	Tests high water property of SqlBase.
HighWaterTest::testHighWaterUpdate	public	function	Tests high water property of SqlBase when rows marked for update.
HighWaterTest::testNullHighwater	public	function	Tests that deleting the high water value causes all rows to be reimported.
HighWaterTest::testZeroHighwater	public	function	Tests that the high water value can be 0.
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.
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.

You are here

class HighWaterTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation