class LocaleUpdateBase

Same name in other branches
  1. 8.9.x core/modules/locale/tests/src/Functional/LocaleUpdateBase.php \Drupal\Tests\locale\Functional\LocaleUpdateBase
  2. 10 core/modules/locale/tests/src/Functional/LocaleUpdateBase.php \Drupal\Tests\locale\Functional\LocaleUpdateBase
  3. 11.x core/modules/locale/tests/src/Functional/LocaleUpdateBase.php \Drupal\Tests\locale\Functional\LocaleUpdateBase

Base class for testing updates to string translations.

Hierarchy

Expanded class hierarchy of LocaleUpdateBase

File

core/modules/locale/tests/src/Functional/LocaleUpdateBase.php, line 15

Namespace

Drupal\Tests\locale\Functional
View source
abstract class LocaleUpdateBase extends BrowserTestBase {
    
    /**
     * Timestamp for an old translation.
     *
     * @var int
     */
    protected $timestampOld;
    
    /**
     * Timestamp for a medium aged translation.
     *
     * @var int
     */
    protected $timestampMedium;
    
    /**
     * Timestamp for a new translation.
     *
     * @var int
     */
    protected $timestampNew;
    
    /**
     * Timestamp for current time.
     *
     * @var int
     */
    protected $timestampNow;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'locale',
        'locale_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        // Setup timestamps to identify old and new translation sources.
        $this->timestampOld = REQUEST_TIME - 300;
        $this->timestampMedium = REQUEST_TIME - 200;
        $this->timestampNew = REQUEST_TIME - 100;
        $this->timestampNow = REQUEST_TIME;
        // Enable import of translations. By default this is disabled for automated
        // tests.
        $this->config('locale.settings')
            ->set('translation.import_enabled', TRUE)
            ->set('translation.use_source', LOCALE_TRANSLATION_USE_SOURCE_LOCAL)
            ->save();
    }
    
    /**
     * Sets the value of the default translations directory.
     *
     * @param string $path
     *   Path of the translations directory relative to the drupal installation
     *   directory.
     */
    protected function setTranslationsDirectory($path) {
        \Drupal::service('file_system')->prepareDirectory($path, FileSystemInterface::CREATE_DIRECTORY);
        $this->config('locale.settings')
            ->set('translation.path', $path)
            ->save();
    }
    
    /**
     * Adds a language.
     *
     * @param string $langcode
     *   The language code of the language to add.
     */
    protected function addLanguage($langcode) {
        $edit = [
            'predefined_langcode' => $langcode,
        ];
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add language');
        $this->container
            ->get('language_manager')
            ->reset();
        $this->assertNotEmpty(\Drupal::languageManager()->getLanguage($langcode), new FormattableMarkup('Language %langcode added.', [
            '%langcode' => $langcode,
        ]));
    }
    
    /**
     * Creates a translation file and tests its timestamp.
     *
     * @param string $path
     *   Path of the file relative to the public file path.
     * @param string $filename
     *   Name of the file to create.
     * @param int $timestamp
     *   (optional) Timestamp to set the file to. Defaults to current time.
     * @param array $translations
     *   (optional) Array of source/target value translation strings. Only
     *   singular strings are supported, no plurals. No double quotes are allowed
     *   in source and translations strings.
     */
    protected function makePoFile($path, $filename, $timestamp = NULL, array $translations = []) {
        $timestamp = $timestamp ? $timestamp : REQUEST_TIME;
        $path = 'public://' . $path;
        $text = '';
        $po_header = <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 8\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"

EOF;
        // Convert array of translations to Gettext source and translation strings.
        if ($translations) {
            foreach ($translations as $source => $target) {
                $text .= 'msgid "' . $source . '"' . "\n";
                $text .= 'msgstr "' . $target . '"' . "\n";
            }
        }
        \Drupal::service('file_system')->prepareDirectory($path, FileSystemInterface::CREATE_DIRECTORY);
        $file = File::create([
            'uid' => 1,
            'filename' => $filename,
            'uri' => $path . '/' . $filename,
            'filemime' => 'text/x-gettext-translation',
            'timestamp' => $timestamp,
        ]);
        $file->setPermanent();
        file_put_contents($file->getFileUri(), $po_header . $text);
        touch(\Drupal::service('file_system')->realpath($file->getFileUri()), $timestamp);
        $file->save();
    }
    
    /**
     * Setup the environment containing local and remote translation files.
     *
     * Update tests require a simulated environment for local and remote files.
     * Normally remote files are located at a remote server (e.g. ftp.drupal.org).
     * For testing we can not rely on this. A directory in the file system of the
     * test site is designated for remote files and is addressed using an absolute
     * URL. Because Drupal does not allow files with a po extension to be accessed
     * (denied in .htaccess) the translation files get a _po extension. Another
     * directory is designated for local translation files.
     *
     * The environment is set up with the following files. File creation times are
     * set to create different variations in test conditions.
     *   contrib_module_one
     *    - remote file: timestamp new
     *    - local file:  timestamp old
     *   contrib_module_two
     *    - remote file: timestamp old
     *    - local file:  timestamp new
     *   contrib_module_three
     *    - remote file: timestamp old
     *    - local file:  timestamp old
     *   custom_module_one
     *    - local file:  timestamp new
     * Time stamp of current translation set by setCurrentTranslations() is always
     * timestamp medium. This makes it easy to predict which translation will be
     * imported.
     */
    protected function setTranslationFiles() {
        $config = $this->config('locale.settings');
        // A flag is set to let the locale_test module replace the project data with
        // a set of test projects which match the below project files.
        \Drupal::state()->set('locale.test_projects_alter', TRUE);
        \Drupal::state()->set('locale.remove_core_project', FALSE);
        // Setup the environment.
        $public_path = PublicStream::basePath();
        $this->setTranslationsDirectory($public_path . '/local');
        $config->set('translation.default_filename', '%project-%version.%language._po')
            ->save();
        // Setting up sets of translations for the translation files.
        $translations_one = [
            'January' => 'Januar_1',
            'February' => 'Februar_1',
            'March' => 'Marz_1',
        ];
        $translations_two = [
            'February' => 'Februar_2',
            'March' => 'Marz_2',
            'April' => 'April_2',
        ];
        $translations_three = [
            'April' => 'April_3',
            'May' => 'Mai_3',
            'June' => 'Juni_3',
        ];
        // Add a number of files to the local file system to serve as remote
        // translation server and match the project definitions set in
        // locale_test_locale_translation_projects_alter().
        $this->makePoFile('remote/all/contrib_module_one', 'contrib_module_one-8.x-1.1.de._po', $this->timestampNew, $translations_one);
        $this->makePoFile('remote/all/contrib_module_two', 'contrib_module_two-8.x-2.0-beta4.de._po', $this->timestampOld, $translations_two);
        $this->makePoFile('remote/all/contrib_module_three', 'contrib_module_three-8.x-1.0.de._po', $this->timestampOld, $translations_three);
        // Add a number of files to the local file system to serve as local
        // translation files and match the project definitions set in
        // locale_test_locale_translation_projects_alter().
        $this->makePoFile('local', 'contrib_module_one-8.x-1.1.de._po', $this->timestampOld, $translations_one);
        $this->makePoFile('local', 'contrib_module_two-8.x-2.0-beta4.de._po', $this->timestampNew, $translations_two);
        $this->makePoFile('local', 'contrib_module_three-8.x-1.0.de._po', $this->timestampOld, $translations_three);
        $this->makePoFile('local', 'custom_module_one.de.po', $this->timestampNew);
    }
    
    /**
     * Sets up existing translations and their statuses in the database.
     */
    protected function setCurrentTranslations() {
        // Add non customized translations to the database.
        $langcode = 'de';
        $context = '';
        $non_customized_translations = [
            'March' => 'Marz',
            'June' => 'Juni',
        ];
        foreach ($non_customized_translations as $source => $translation) {
            $string = $this->container
                ->get('locale.storage')
                ->createString([
                'source' => $source,
                'context' => $context,
            ])
                ->save();
            $this->container
                ->get('locale.storage')
                ->createTranslation([
                'lid' => $string->getId(),
                'language' => $langcode,
                'translation' => $translation,
                'customized' => LOCALE_NOT_CUSTOMIZED,
            ])
                ->save();
        }
        // Add customized translations to the database.
        $customized_translations = [
            'January' => 'Januar_customized',
            'February' => 'Februar_customized',
            'May' => 'Mai_customized',
        ];
        foreach ($customized_translations as $source => $translation) {
            $string = $this->container
                ->get('locale.storage')
                ->createString([
                'source' => $source,
                'context' => $context,
            ])
                ->save();
            $this->container
                ->get('locale.storage')
                ->createTranslation([
                'lid' => $string->getId(),
                'language' => $langcode,
                'translation' => $translation,
                'customized' => LOCALE_CUSTOMIZED,
            ])
                ->save();
        }
        // Add a state of current translations in locale_files.
        $default = [
            'langcode' => $langcode,
            'uri' => '',
            'timestamp' => $this->timestampMedium,
            'last_checked' => $this->timestampMedium,
        ];
        $data[] = [
            'project' => 'contrib_module_one',
            'filename' => 'contrib_module_one-8.x-1.1.de._po',
            'version' => '8.x-1.1',
        ];
        $data[] = [
            'project' => 'contrib_module_two',
            'filename' => 'contrib_module_two-8.x-2.0-beta4.de._po',
            'version' => '8.x-2.0-beta4',
        ];
        $data[] = [
            'project' => 'contrib_module_three',
            'filename' => 'contrib_module_three-8.x-1.0.de._po',
            'version' => '8.x-1.0',
        ];
        $data[] = [
            'project' => 'custom_module_one',
            'filename' => 'custom_module_one.de.po',
            'version' => '',
        ];
        $connection = Database::getConnection();
        foreach ($data as $file) {
            $file = array_merge($default, $file);
            $connection->insert('locale_file')
                ->fields($file)
                ->execute();
        }
    }
    
    /**
     * Checks the translation of a string.
     *
     * @param string $source
     *   Translation source string.
     * @param string $translation
     *   Translation to check. Use empty string to check for a non-existent
     *   translation.
     * @param string $langcode
     *   Language code of the language to translate to.
     * @param string $message
     *   (optional) A message to display with the assertion.
     */
    protected function assertTranslation($source, $translation, $langcode, $message = '') {
        $query = Database::getConnection()->select('locales_target', 'lt');
        $query->innerJoin('locales_source', 'ls', '[ls].[lid] = [lt].[lid]');
        $db_translation = $query->fields('lt', [
            'translation',
        ])
            ->condition('ls.source', $source)
            ->condition('lt.language', $langcode)
            ->execute()
            ->fetchField();
        $db_translation = $db_translation == FALSE ? '' : $db_translation;
        $this->assertEquals($translation, $db_translation, $message ? $message : new FormattableMarkup('Correct translation of %source (%language)', [
            '%source' => $source,
            '%language' => $langcode,
        ]));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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::$defaultTheme protected property The theme to install as the default for testing. 1659
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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. 37
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
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. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 3
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. 1
LocaleUpdateBase::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 1
LocaleUpdateBase::$timestampMedium protected property Timestamp for a medium aged translation.
LocaleUpdateBase::$timestampNew protected property Timestamp for a new translation.
LocaleUpdateBase::$timestampNow protected property Timestamp for current time.
LocaleUpdateBase::$timestampOld protected property Timestamp for an old translation.
LocaleUpdateBase::addLanguage protected function Adds a language.
LocaleUpdateBase::assertTranslation protected function Checks the translation of a string.
LocaleUpdateBase::makePoFile protected function Creates a translation file and tests its timestamp.
LocaleUpdateBase::setCurrentTranslations protected function Sets up existing translations and their statuses in the database.
LocaleUpdateBase::setTranslationFiles protected function Setup the environment containing local and remote translation files.
LocaleUpdateBase::setTranslationsDirectory protected function Sets the value of the default translations directory.
LocaleUpdateBase::setUp protected function Overrides BrowserTestBase::setUp 4
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
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
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. 1
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
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.