class MigrateSearchPageTest

Same name in this branch
  1. 10 core/modules/search/tests/src/Kernel/Migrate/d6/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d6\MigrateSearchPageTest
Same name in other branches
  1. 9 core/modules/search/tests/src/Kernel/Migrate/d6/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d6\MigrateSearchPageTest
  2. 9 core/modules/search/tests/src/Kernel/Migrate/d7/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d7\MigrateSearchPageTest
  3. 8.9.x core/modules/search/tests/src/Kernel/Migrate/d6/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d6\MigrateSearchPageTest
  4. 8.9.x core/modules/search/tests/src/Kernel/Migrate/d7/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d7\MigrateSearchPageTest
  5. 11.x core/modules/search/tests/src/Kernel/Migrate/d6/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d6\MigrateSearchPageTest
  6. 11.x core/modules/search/tests/src/Kernel/Migrate/d7/MigrateSearchPageTest.php \Drupal\Tests\search\Kernel\Migrate\d7\MigrateSearchPageTest

Tests migration of search page status and settings.

@group migrate_drupal_7

Hierarchy

Expanded class hierarchy of MigrateSearchPageTest

File

core/modules/search/tests/src/Kernel/Migrate/d7/MigrateSearchPageTest.php, line 16

Namespace

Drupal\Tests\search\Kernel\Migrate\d7
View source
class MigrateSearchPageTest extends MigrateDrupal7TestBase {
    
    /**
     * The modules to be enabled during the test.
     *
     * {@inheritdoc}
     */
    protected static $modules = [
        'search',
    ];
    
    /**
     * Asserts various aspects of a SearchPage entity.
     *
     * @param string $id
     *   The expected search page ID.
     * @param string $path
     *   The expected path of the search page.
     * @param bool $status
     *   The expected status of the search page.
     * @param array $expected_config
     *   An array of expected configuration for the search page.
     *
     * @internal
     */
    protected function assertEntity(string $id, string $path, bool $status = FALSE, ?array $expected_config = NULL) : void {
        
        /** @var \Drupal\search\Entity\SearchPage $search_page */
        $search_page = SearchPage::load($id);
        $this->assertSame($id, $search_page->id());
        $this->assertSame($path, $search_page->getPath());
        $this->assertSame($status, $search_page->status());
        if (isset($expected_config)) {
            $configuration = $search_page->getPlugin()
                ->getConfiguration();
            $this->assertSame($expected_config, $configuration);
        }
    }
    
    /**
     * Tests migration of search status and settings to search page entity.
     */
    public function testSearchPage() : void {
        $this->enableModules([
            'node',
        ]);
        $this->installConfig([
            'search',
        ]);
        $this->executeMigration('d7_search_page');
        $configuration = [
            'rankings' => [
                'comments' => 0,
                'promote' => 0,
                'relevance' => 2,
                'sticky' => 0,
                'views' => 0,
            ],
        ];
        $this->assertEntity('node_search', 'node', TRUE, $configuration);
        $this->assertEntity('user_search', 'user');
        // Test that we can re-import using the EntitySearchPage destination.
        Database::getConnection('default', 'migrate')->update('variable')
            ->fields([
            'value' => serialize(4),
        ])
            ->condition('name', 'node_rank_comments')
            ->execute();
        
        /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
        $migration = $this->getMigration('d7_search_page');
        // Indicate we're rerunning a migration that's already run.
        $migration->getIdMap()
            ->prepareUpdate();
        $this->executeMigration($migration);
        $configuration['rankings']['comments'] = 4;
        $this->assertEntity('node_search', 'node', TRUE, $configuration);
        // Test that a configurable search without a configuration imports. Do this
        // by removing the node rankings from the source database.
        Database::getConnection('default', 'migrate')->delete('variable')
            ->condition('name', 'node_rank_%', 'LIKE')
            ->execute();
        $migration = $this->getMigration('d7_search_page');
        $migration->getIdMap()
            ->prepareUpdate();
        $this->executeMigration($migration);
        $configuration = [
            'rankings' => [],
        ];
        $this->assertEntity('node_search', 'node', TRUE, $configuration);
    }
    
    /**
     * Tests that search page is only migrated for modules enabled on D8 site.
     */
    public function testModuleExists() : void {
        $this->installConfig([
            'search',
        ]);
        $this->executeMigration('d7_search_page');
        $this->assertNull(SearchPage::load('node_search'));
        $this->assertEntity('user_search', 'user');
    }
    
    /**
     * Tests that a search page will be created if it does not exist.
     */
    public function testUserSearchCreate() : void {
        $this->enableModules([
            'node',
        ]);
        $this->installConfig([
            'search',
        ]);
        
        /** @var \Drupal\search\Entity\SearchPage $search_page */
        $search_page = SearchPage::load('user_search');
        $search_page->delete();
        $this->executeMigration('d7_search_page');
        $this->assertEntity('user_search', 'user');
    }

}

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::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.
MigrateDrupal7TestBase::getFixtureFilePath protected function Gets the path to the fixture file. 8
MigrateDrupal7TestBase::migrateCommentTypes protected function Migrates comment types.
MigrateDrupal7TestBase::migrateContent protected function Executes all content migrations.
MigrateDrupal7TestBase::migrateContentTypes protected function Migrates node types.
MigrateDrupal7TestBase::migrateFields protected function Executes all field migrations.
MigrateDrupal7TestBase::migrateTaxonomyTerms protected function Executes all taxonomy term migrations.
MigrateDrupal7TestBase::migrateUsers protected function Executes all user migrations.
MigrateDrupal7TestBase::setUp protected function Overrides MigrateDrupalTestBase::setUp 93
MigrateDrupalTestBase::loadFixture protected function Loads a database fixture into the source database connection.
MigrateSearchPageTest::$modules protected static property The modules to be enabled during the test. Overrides MigrateDrupalTestBase::$modules
MigrateSearchPageTest::assertEntity protected function Asserts various aspects of a SearchPage entity.
MigrateSearchPageTest::testModuleExists public function Tests that search page is only migrated for modules enabled on D8 site.
MigrateSearchPageTest::testSearchPage public function Tests migration of search status and settings to search page entity.
MigrateSearchPageTest::testUserSearchCreate public function Tests that a search page will be created if it does not exist.
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
NodeMigrateTypeTestTrait::$tableName public property The migrate_map table name.
NodeMigrateTypeTestTrait::getTableName protected function Gets the migrate_map table name.
NodeMigrateTypeTestTrait::makeNodeMigrateMapTable protected function Create a node migrate_map table.
NodeMigrateTypeTestTrait::nodeMigrateMapTableCount protected function Gets the numbers of complete and classic node migrate_map tables.
NodeMigrateTypeTestTrait::removeNodeMigrateMapTable protected function Remove the node migrate map table.
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::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.