class QueryBatchTest

Same name in this branch
  1. 10 core/modules/migrate/tests/modules/migrate_query_batch_test/src/Plugin/migrate/source/QueryBatchTest.php \Drupal\migrate_query_batch_test\Plugin\migrate\source\QueryBatchTest
Same name in other branches
  1. 9 core/modules/migrate/tests/src/Kernel/QueryBatchTest.php \Drupal\Tests\migrate\Kernel\QueryBatchTest
  2. 9 core/modules/migrate/tests/modules/migrate_query_batch_test/src/Plugin/migrate/source/QueryBatchTest.php \Drupal\migrate_query_batch_test\Plugin\migrate\source\QueryBatchTest
  3. 8.9.x core/modules/migrate/tests/src/Kernel/QueryBatchTest.php \Drupal\Tests\migrate\Kernel\QueryBatchTest
  4. 8.9.x core/modules/migrate/tests/modules/migrate_query_batch_test/src/Plugin/migrate/source/QueryBatchTest.php \Drupal\migrate_query_batch_test\Plugin\migrate\source\QueryBatchTest
  5. 11.x core/modules/migrate/tests/src/Kernel/QueryBatchTest.php \Drupal\Tests\migrate\Kernel\QueryBatchTest
  6. 11.x core/modules/migrate/tests/modules/migrate_query_batch_test/src/Plugin/migrate/source/QueryBatchTest.php \Drupal\migrate_query_batch_test\Plugin\migrate\source\QueryBatchTest

Tests query batching.

@covers \Drupal\migrate_query_batch_test\Plugin\migrate\source\QueryBatchTest @group migrate

Hierarchy

Expanded class hierarchy of QueryBatchTest

File

core/modules/migrate/tests/src/Kernel/QueryBatchTest.php, line 20

Namespace

Drupal\Tests\migrate\Kernel
View source
class QueryBatchTest extends KernelTestBase {
    
    /**
     * The mocked migration.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface|\Prophecy\Prophecy\ObjectProphecy
     */
    protected $migration;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'migrate',
        'migrate_query_batch_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create a mock migration. This will be injected into the source plugin
        // under test.
        $this->migration = $this->prophesize(MigrationInterface::class);
        $this->migration
            ->id()
            ->willReturn($this->randomMachineName(16));
        // Prophesize a useless ID map plugin and an empty set of destination IDs.
        // Calling code can override these prophecies later and set up different
        // behaviors.
        $this->migration
            ->getIdMap()
            ->willReturn($this->prophesize(MigrateIdMapInterface::class)
            ->reveal());
        $this->migration
            ->getDestinationIds()
            ->willReturn([]);
    }
    
    /**
     * Tests a negative batch size throws an exception.
     */
    public function testBatchSizeNegative() : void {
        $this->expectException(MigrateException::class);
        $this->expectExceptionMessage('batch_size must be greater than or equal to zero');
        $plugin = $this->getPlugin([
            'batch_size' => -1,
        ]);
        $plugin->next();
    }
    
    /**
     * Tests a non integer batch size throws an exception.
     */
    public function testBatchSizeNonInteger() : void {
        $this->expectException(MigrateException::class);
        $this->expectExceptionMessage('batch_size must be greater than or equal to zero');
        $plugin = $this->getPlugin([
            'batch_size' => '1',
        ]);
        $plugin->next();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function queryDataProvider() {
        // Define the parameters for building the data array. The first element is
        // the number of source data rows, the second is the batch size to set on
        // the plugin configuration.
        $test_parameters = [
            // Test when batch size is 0.
[
                200,
                0,
            ],
            // Test when rows mod batch size is 0.
[
                200,
                20,
            ],
            // Test when rows mod batch size is > 0.
[
                200,
                30,
            ],
            // Test when batch size = row count.
[
                200,
                200,
            ],
            // Test when batch size > row count.
[
                200,
                300,
            ],
        ];
        // Build the data provider array. The provider array consists of the source
        // data rows, the expected result data, the expected count, the plugin
        // configuration, the expected batch size and the expected batch count.
        $table = 'query_batch_test';
        $tests = [];
        $data_set = 0;
        foreach ($test_parameters as $data) {
            [
                $num_rows,
                $batch_size,
            ] = $data;
            for ($i = 0; $i < $num_rows; $i++) {
                $tests[$data_set]['source_data'][$table][] = [
                    'id' => $i,
                    'data' => Random::string(),
                ];
            }
            $tests[$data_set]['expected_data'] = $tests[$data_set]['source_data'][$table];
            $tests[$data_set][2] = $num_rows;
            // Plugin configuration array.
            $tests[$data_set][3] = [
                'batch_size' => $batch_size,
            ];
            // Expected batch size.
            $tests[$data_set][4] = $batch_size;
            // Expected batch count is 0 unless a batch size is set.
            $expected_batch_count = 0;
            if ($batch_size > 0) {
                $expected_batch_count = (int) ($num_rows / $batch_size);
                if ($num_rows % $batch_size) {
                    // If there is a remainder an extra batch is needed to get the
                    // remaining rows.
                    $expected_batch_count++;
                }
            }
            $tests[$data_set][5] = $expected_batch_count;
            $data_set++;
        }
        return $tests;
    }
    
    /**
     * Tests query batch size.
     *
     * @param array $source_data
     *   The source data, keyed by table name. Each table is an array containing
     *   the rows in that table.
     * @param array $expected_data
     *   The result rows the plugin is expected to return.
     * @param int $num_rows
     *   How many rows the source plugin is expected to return.
     * @param array $configuration
     *   Configuration for the source plugin specifying the batch size.
     * @param int $expected_batch_size
     *   The expected batch size, will be set to zero for invalid batch sizes.
     * @param int $expected_batch_count
     *   The total number of batches.
     *
     * @dataProvider queryDataProvider
     */
    public function testQueryBatch($source_data, $expected_data, $num_rows, $configuration, $expected_batch_size, $expected_batch_count) : void {
        $plugin = $this->getPlugin($configuration);
        // Since we don't yet inject the database connection, we need to use a
        // reflection hack to set it in the plugin instance.
        $reflector = new \ReflectionObject($plugin);
        $property = $reflector->getProperty('database');
        $connection = $this->getDatabase($source_data);
        $property->setValue($plugin, $connection);
        // Test the results.
        $i = 0;
        
        /** @var \Drupal\migrate\Row $row */
        foreach ($plugin as $row) {
            $expected = $expected_data[$i++];
            $actual = $row->getSource();
            foreach ($expected as $key => $value) {
                $this->assertArrayHasKey($key, $actual);
                $this->assertSame((string) $value, (string) $actual[$key]);
            }
        }
        // Test that all rows were retrieved.
        self::assertSame($num_rows, $i);
        // Test the batch size.
        if (is_null($expected_batch_size)) {
            $expected_batch_size = $configuration['batch_size'];
        }
        $property = $reflector->getProperty('batchSize');
        self::assertSame($expected_batch_size, $property->getValue($plugin));
        // Test the batch count.
        if (is_null($expected_batch_count)) {
            $expected_batch_count = intdiv($num_rows, $expected_batch_size);
            if ($num_rows % $configuration['batch_size']) {
                $expected_batch_count++;
            }
        }
        $property = $reflector->getProperty('batch');
        self::assertSame($expected_batch_count, $property->getValue($plugin));
    }
    
    /**
     * Instantiates the source plugin under test.
     *
     * @param array $configuration
     *   The source plugin configuration.
     *
     * @return \Drupal\migrate\Plugin\MigrateSourceInterface|object
     *   The fully configured source plugin.
     */
    protected function getPlugin($configuration) {
        
        /** @var \Drupal\migrate\Plugin\MigratePluginManager $plugin_manager */
        $plugin_manager = $this->container
            ->get('plugin.manager.migrate.source');
        $plugin = $plugin_manager->createInstance('query_batch_test', $configuration, $this->migration
            ->reveal());
        $this->migration
            ->getSourcePlugin()
            ->willReturn($plugin);
        return $plugin;
    }
    
    /**
     * Builds an in-memory SQLite database from a set of source data.
     *
     * @param array $source_data
     *   The source data, keyed by table name. Each table is an array containing
     *   the rows in that table.
     *
     * @return \Drupal\sqlite\Driver\Database\sqlite\Connection
     *   The SQLite database connection.
     */
    protected function getDatabase(array $source_data) {
        // Create an in-memory SQLite database. Plugins can interact with it like
        // any other database, and it will cease to exist when the connection is
        // closed.
        $connection_options = [
            'database' => ':memory:',
        ];
        $pdo = Connection::open($connection_options);
        $connection = new Connection($pdo, $connection_options);
        // Create the tables and fill them with data.
        foreach ($source_data as $table => $rows) {
            // Use the biggest row to build the table schema.
            $counts = array_map('count', $rows);
            asort($counts);
            $pilot = $rows[array_key_last($counts)];
            $connection->schema()
                ->createTable($table, [
                // SQLite uses loose affinity typing, so it's OK for every field to
                // be a text field.
'fields' => array_map(function () {
                    return [
                        'type' => 'text',
                    ];
                }, $pilot),
            ]);
            $fields = array_keys($pilot);
            $insert = $connection->insert($table)
                ->fields($fields);
            array_walk($rows, [
                $insert,
                'values',
            ]);
            $insert->execute();
        }
        return $connection;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 raw text IS NOT found escaped on 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::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.
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.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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 Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
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.
QueryBatchTest::$migration protected property The mocked migration.
QueryBatchTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
QueryBatchTest::getDatabase protected function Builds an in-memory SQLite database from a set of source data.
QueryBatchTest::getPlugin protected function Instantiates the source plugin under test.
QueryBatchTest::queryDataProvider public static function
QueryBatchTest::setUp protected function Overrides KernelTestBase::setUp
QueryBatchTest::testBatchSizeNegative public function Tests a negative batch size throws an exception.
QueryBatchTest::testBatchSizeNonInteger public function Tests a non integer batch size throws an exception.
QueryBatchTest::testQueryBatch public function Tests query batch size.
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.
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 Deprecated 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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.