class TaxonomyTermUpdatePathTest

Tests the upgrade path for taxonomy terms.

@group taxonomy @group Update @group legacy

Hierarchy

Expanded class hierarchy of TaxonomyTermUpdatePathTest

File

core/modules/taxonomy/tests/src/Functional/Update/TaxonomyTermUpdatePathTest.php, line 18

Namespace

Drupal\Tests\taxonomy\Functional\Update
View source
class TaxonomyTermUpdatePathTest extends UpdatePathTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setDatabaseDumpFiles() {
        $this->databaseDumpFiles = [
            __DIR__ . '/../../../../../system/tests/fixtures/update/drupal-8.filled.standard.php.gz',
            __DIR__ . '/../../../fixtures/update/drupal-8.views-taxonomy-term-publishing-status-2981887.php',
            __DIR__ . '/../../../fixtures/update/drupal-8.taxonomy-term-publishing-status-ui-2899923.php',
            __DIR__ . '/../../../fixtures/update/drupal-8.taxonomy-term-null-data-3056543.php',
        ];
    }
    
    /**
     * Tests the conversion of taxonomy terms to be publishable.
     *
     * @see taxonomy_update_8601()
     */
    public function testPublishable() {
        $this->runUpdates();
        // Log in as user 1.
        $account = User::load(1);
        $account->passRaw = 'drupal';
        $this->drupalLogin($account);
        // Make sure our vocabulary exists.
        $this->drupalGet('admin/structure/taxonomy/manage/test_vocabulary/overview');
        // Make sure our terms exist.
        $assert_session = $this->assertSession();
        $assert_session->pageTextContains('Test root term');
        $assert_session->pageTextContains('Test child term');
        $this->drupalGet('taxonomy/term/3');
        $assert_session->statusCodeEquals('200');
        // Make sure the terms are still translated.
        $this->drupalGet('taxonomy/term/2/translations');
        $assert_session->linkExists('Test root term - Spanish');
        $storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        // Check that the 'content_translation_status' field has been updated
        // correctly.
        
        /** @var \Drupal\taxonomy\TermInterface $term */
        $term = $storage->load(2);
        $translation = $term->getTranslation('es');
        $this->assertTrue($translation->isPublished());
        // Check that taxonomy terms can be created, saved and then loaded.
        $term = $storage->create([
            'name' => 'Test term',
            'vid' => 'tags',
        ]);
        $term->save();
        $term = $storage->loadUnchanged($term->id());
        $this->assertEquals('Test term', $term->label());
        $this->assertEquals('tags', $term->bundle());
        $this->assertTrue($term->isPublished());
        // Check that the term can be unpublished.
        $term->setUnpublished();
        $term->save();
        $term = $storage->loadUnchanged($term->id());
        $this->assertFalse($term->isPublished());
        // Test the update does not run when a status field already exists.
        module_load_install('taxonomy');
        $this->assertEquals('The publishing status field has <strong>not</strong> been added to taxonomy terms. See <a href="https://www.drupal.org/node/2985366">this page</a> for more information on how to install it.', (string) taxonomy_update_8601());
        // Test the message can be overridden.
        \Drupal::state()->set('taxonomy_update_8601_skip_message', 'Another message');
        $this->assertEquals('Another message', (string) taxonomy_update_8601());
    }
    
    /**
     * Tests taxonomy term views updates succeed even if Views is not installed.
     */
    public function testPublishingStatusUpdateForTaxonomyTermViewsWithoutViews() {
        // Uninstalling Views will trigger some activity in the menu tree storage
        // system, which will cause errors until system_update_8001() is run. This
        // is because, in the drupal-8.filled.standard database fixture used for
        // this update test, the menu link titles are not serialized (this is what
        // gets done by system_update_8001()). Since this method is not testing
        // anything relating to menu links, it's OK to just truncate the menu_tree
        // table before uninstalling Views.
        $this->container
            ->get('database')
            ->truncate('menu_tree')
            ->execute();
        $this->container
            ->get('module_installer')
            ->uninstall([
            'views',
        ]);
        $this->runUpdates();
    }
    
    /**
     * Tests handling of the publishing status in taxonomy term views updates.
     *
     * @see taxonomy_post_update_handle_publishing_status_addition_in_views()
     */
    public function testPublishingStatusUpdateForTaxonomyTermViews() {
        // Check that the test view was previously using the
        // 'content_translation_status' field.
        $config = \Drupal::config('views.view.test_taxonomy_term_view_with_content_translation_status');
        $display_options = $config->get('display.default.display_options');
        $this->assertEquals('content_translation_status', $display_options['fields']['content_translation_status']['field']);
        $this->assertEquals('content_translation_status', $display_options['filters']['content_translation_status']['field']);
        $this->assertEquals('content_translation_status', $display_options['sorts']['content_translation_status']['field']);
        // Check a test view without any filter.
        $config = \Drupal::config('views.view.test_taxonomy_term_view_without_content_translation_status');
        $display_options = $config->get('display.default.display_options');
        $this->assertEmpty($display_options['filters']);
        $this->runUpdates();
        // Check that a view which had a field, filter and a sort on the
        // 'content_translation_status' field has been updated to use the new
        // 'status' field.
        $view = View::load('test_taxonomy_term_view_with_content_translation_status');
        foreach ($view->get('display') as $display) {
            $this->assertEquals('status', $display['display_options']['fields']['content_translation_status']['field']);
            $this->assertEquals('status', $display['display_options']['sorts']['content_translation_status']['field']);
            $this->assertEquals('status', $display['display_options']['filters']['content_translation_status']['field']);
        }
        // Check that a view without any filters has been updated to include a
        // filter for the 'status' field.
        $view = View::load('test_taxonomy_term_view_without_content_translation_status');
        foreach ($view->get('display') as $display) {
            $this->assertNotEmpty($display['display_options']['filters']);
            $this->assertEquals('status', $display['display_options']['filters']['status']['field']);
        }
    }
    
    /**
     * Tests the conversion of taxonomy terms to be revisionable.
     *
     * @see taxonomy_post_update_make_taxonomy_term_revisionable()
     */
    public function testConversionToRevisionable() {
        // Set the batch size to 1 to test multiple steps.
        drupal_rewrite_settings([
            'settings' => [
                'update_sql_batch_size' => (object) [
                    'value' => 1,
                    'required' => TRUE,
                ],
            ],
        ]);
        // Check that there are broken terms in the taxonomy tables, initially.
        $this->assertTermName(997, '');
        $this->assertTermName(998, '');
        $this->assertTermName(999, 'tag999-es');
        $this->runUpdates();
        // Check that the update function returned the expected message.
        $this->assertSession()
            ->pageTextContains('Taxonomy terms have been converted to be revisionable. 2 terms with data integrity issues were restored. More details have been logged.');
        // Check the database tables and the field storage definitions.
        $schema = \Drupal::database()->schema();
        $this->assertTrue($schema->tableExists('taxonomy_term_data'));
        $this->assertTrue($schema->tableExists('taxonomy_term_field_data'));
        $this->assertTrue($schema->tableExists('taxonomy_term_revision'));
        $this->assertTrue($schema->tableExists('taxonomy_term_field_revision'));
        $field_storage_definitions = \Drupal::service('entity.last_installed_schema.repository')->getLastInstalledFieldStorageDefinitions('taxonomy_term');
        $this->assertTrue($field_storage_definitions['langcode']->isRevisionable());
        $this->assertTrue($field_storage_definitions['name']->isRevisionable());
        $this->assertTrue($field_storage_definitions['description']->isRevisionable());
        $this->assertTrue($field_storage_definitions['changed']->isRevisionable());
        // Log in as user 1.
        $account = User::load(1);
        $account->passRaw = 'drupal';
        $this->drupalLogin($account);
        // Make sure our vocabulary exists.
        $this->drupalGet('admin/structure/taxonomy/manage/test_vocabulary/overview');
        // Make sure our terms exist.
        $assert_session = $this->assertSession();
        $assert_session->pageTextContains('Test root term');
        $assert_session->pageTextContains('Test child term');
        $this->drupalGet('taxonomy/term/3');
        $assert_session->statusCodeEquals('200');
        // Make sure the terms are still translated.
        $this->drupalGet('taxonomy/term/2/translations');
        $assert_session->linkExists('Test root term - Spanish');
        $storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        // Check that taxonomy terms can be created, saved and then loaded.
        
        /** @var \Drupal\taxonomy\TermInterface $term */
        $term = $storage->create([
            'name' => 'Test term',
            'vid' => 'article',
            'revision_log_message' => 'Initial revision.',
        ]);
        $term->save();
        $storage->resetCache();
        $term = $storage->loadRevision($term->getRevisionId());
        $this->assertEquals('Test term', $term->label());
        $this->assertEquals('article', $term->bundle());
        $this->assertEquals('Initial revision.', $term->getRevisionLogMessage());
        $this->assertTrue($term->isPublished());
        // Check that two terms were restored and one was ignored. The latter cannot
        // be manually restored, since we would end up with two data table records
        // having "default_langcode" equalling 1, which would not make sense.
        $this->assertTermName(997, 'tag997');
        $this->assertTermName(998, 'tag998');
        $this->assertTermName(999, 'tag999-es');
    }
    
    /**
     * Assert that a term name matches the expectation.
     *
     * @param string $id
     *   The term ID.
     * @param string $expected_name
     *   The expected term name.
     */
    protected function assertTermName($id, $expected_name) {
        $database = \Drupal::database();
        $query = $database->select('taxonomy_term_field_data', 'd');
        $query->join('taxonomy_term_data', 't', 't.tid = d.tid AND d.default_langcode = 1');
        $name = $query->fields('d', [
            'name',
        ])
            ->condition('d.tid', $id)
            ->execute()
            ->fetchField();
        $this->assertSame($expected_name, $name ?: '');
    }
    
    /**
     * Test the update hook requirements check for revisionable terms.
     *
     * @see taxonomy_post_update_make_taxonomy_term_revisionable()
     * @see taxonomy_requirements()
     */
    public function testMissingDataUpdateRequirementsCheck() {
        // Insert invalid data for a non-existent taxonomy term.
        Database::getConnection()->insert('taxonomy_term_data')
            ->fields([
            'tid' => '6',
            'vid' => 'tags',
            'uuid' => 'd5fd282b-df66-4d50-b0d1-76bf9eede9c5',
            'langcode' => 'en',
        ])
            ->execute();
        $this->writeSettings([
            'settings' => [
                'update_free_access' => (object) [
                    'value' => TRUE,
                    'required' => TRUE,
                ],
            ],
        ]);
        $this->drupalGet($this->updateUrl);
        $this->assertSession()
            ->pageTextContains('Errors found');
        $this->assertSession()
            ->elementTextContains('css', '.system-status-report__entry--error', 'The make_taxonomy_term_revisionable database update cannot be run until the data has been fixed.');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function replaceUser1() {
        // Do not replace the user from our dump.
    }
    
    /**
     * Tests that the taxonomy_term entity form has the status checkbox.
     *
     * @see taxonomy_post_update_configure_status_field_widget()
     */
    public function testStatusCheckbox() {
        $ids = \Drupal::entityQuery('entity_form_display')->condition('targetEntityType', 'taxonomy_term')
            ->execute();
        // Make sure we have the expected values before the update.
        $config_keys = [];
        foreach ($ids as $id) {
            $config_keys[] = 'core.entity_form_display.' . $id;
        }
        
        /* @var \Drupal\Core\Config\ImmutableConfig[] $form_display_configs */
        $form_display_configs = $this->container
            ->get('config.factory')
            ->loadMultiple($config_keys);
        foreach ($form_display_configs as $config) {
            $status_config = $config->get('content.status');
            if ($config->getName() == 'core.entity_form_display.taxonomy_term.tags.default') {
                $this->assertNotNull($status_config);
                $this->assertEquals([
                    'display_label' => FALSE,
                ], $status_config['settings']);
            }
            else {
                $this->assertNull($status_config);
            }
        }
        // Run updates.
        $this->runUpdates();
        
        /* @var \Drupal\Core\Entity\Display\EntityDisplayInterface[] $form_displays */
        $form_displays = EntityFormDisplay::loadMultiple($ids);
        foreach ($form_displays as $form_display) {
            $component = $form_display->getComponent('status');
            if ($form_display->id() == 'taxonomy_term.tags.default') {
                // Display label should not have been set to TRUE by the upgrade path.
                $this->assertEquals([
                    'display_label' => FALSE,
                ], $component['settings']);
            }
            else {
                $this->assertEquals('boolean_checkbox', $component['type']);
                $this->assertEquals([
                    'display_label' => TRUE,
                ], $component['settings']);
            }
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
RequirementsPageTrait::assertWarningSummaries protected function Assert the given warning summaries are present on the page.
RequirementsPageTrait::continueOnExpectedWarnings protected function Continues installation when the expected warnings are found.
RequirementsPageTrait::updateRequirementsProblem protected function Handles the update requirements page.
SchemaCheckTestTrait::assertConfigSchema public function Asserts the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTestTrait::assertConfigSchemaByName public function Asserts configuration, specified by name, has a valid schema.
SchemaCheckTrait::$configName protected property The configuration object name under test.
SchemaCheckTrait::$schema protected property The config schema wrapper object for the configuration object under test.
SchemaCheckTrait::checkConfigSchema public function Checks the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTrait::checkValue protected function Helper method to check data type.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TaxonomyTermUpdatePathTest::assertTermName protected function Assert that a term name matches the expectation.
TaxonomyTermUpdatePathTest::replaceUser1 protected function Replace User 1 with the user created here. Overrides UpdatePathTestBase::replaceUser1
TaxonomyTermUpdatePathTest::setDatabaseDumpFiles protected function Set database dump files to be used. Overrides UpdatePathTestBase::setDatabaseDumpFiles
TaxonomyTermUpdatePathTest::testConversionToRevisionable public function Tests the conversion of taxonomy terms to be revisionable.
TaxonomyTermUpdatePathTest::testMissingDataUpdateRequirementsCheck public function Test the update hook requirements check for revisionable terms.
TaxonomyTermUpdatePathTest::testPublishable public function Tests the conversion of taxonomy terms to be publishable.
TaxonomyTermUpdatePathTest::testPublishingStatusUpdateForTaxonomyTermViews public function Tests handling of the publishing status in taxonomy term views updates.
TaxonomyTermUpdatePathTest::testPublishingStatusUpdateForTaxonomyTermViewsWithoutViews public function Tests taxonomy term views updates succeed even if Views is not installed.
TaxonomyTermUpdatePathTest::testStatusCheckbox public function Tests that the taxonomy_term entity form has the status checkbox.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UpdatePathTestBase::$databaseDumpFiles protected property The file path(s) to the dumped database(s) to load into the child site.
UpdatePathTestBase::$installProfile protected property The install profile used in the database dump file. 1
UpdatePathTestBase::$loadedModules protected property Array of modules loaded when the test starts.
UpdatePathTestBase::$modules protected static property Modules to enable after the database is loaded. Overrides BrowserTestBase::$modules 14
UpdatePathTestBase::$pendingUpdates protected property Flag to indicate whether there are pending updates or not.
UpdatePathTestBase::$strictConfigSchema protected property Disable strict config schema checking. Overrides TestSetupTrait::$strictConfigSchema
UpdatePathTestBase::$updateUrl protected property The update URL.
UpdatePathTestBase::$upgradedSite protected property Flag that indicates whether the child site has been updated.
UpdatePathTestBase::$upgradeErrors protected property Array of errors triggered during the update process.
UpdatePathTestBase::$zlibInstalled protected property Flag to indicate whether zlib is installed or not.
UpdatePathTestBase::doInstall protected function Execute the non-interactive installer. Overrides FunctionalTestSetupTrait::doInstall
UpdatePathTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
UpdatePathTestBase::installDrupal public function Installs Drupal into the Simpletest site. Overrides BrowserTestBase::installDrupal
UpdatePathTestBase::prepareSettings protected function Add settings that are missed since the installer isn&#039;t run. Overrides FunctionalTestSetupTrait::prepareSettings
UpdatePathTestBase::runDbTasks protected function Runs the install database tasks for the driver used by the test runner.
UpdatePathTestBase::runUpdates protected function Helper function to run pending database updates.
UpdatePathTestBase::setUp protected function Overrides WebTestBase::setUp() for update testing. Overrides BrowserTestBase::setUp 12
UpdatePathTestBase::__construct public function Constructs an UpdatePathTestCase object. Overrides BrowserTestBase::__construct
UpdatePathTestTrait::$checkFailedUpdates protected property Fail the test if there are failed updates.
UpdatePathTestTrait::doSelectionTest protected function Tests the selection page. 3
UpdatePathTestTrait::ensureUpdatesToRun protected function Installs the update_script_test module and makes an update available.
UpdatePathTestTrait::runUpdates protected function Helper function to run pending database updates. Aliased as: doRunUpdates
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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