class LocalePluralFormatTest in Zircon Profile 8

Tests plural handling for various languages.

@group locale

Hierarchy

• class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
  • class \Drupal\simpletest\WebTestBase uses AssertContentTrait, UserCreationTrait
    • class \Drupal\locale\Tests\LocalePluralFormatTest

File

core/modules/locale/src/Tests/LocalePluralFormatTest.php, line 18

Contains \Drupal\locale\Tests\LocalePluralFormatTest.

Namespace

Drupal\locale\Tests

class LocalePluralFormatTest extends WebTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'locale',
  );

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer languages',
      'translate interface',
      'access administration pages',
    ));
    $this
      ->drupalLogin($admin_user);
  }

  /**
   * Tests locale_get_plural() and \Drupal::translation()->formatPlural()
   * functionality.
   */
  public function testGetPluralFormat() {

    // Import some .po files with formulas to set up the environment.
    // These will also add the languages to the system.
    $this
      ->importPoFile($this
      ->getPoFileWithSimplePlural(), array(
      'langcode' => 'fr',
    ));
    $this
      ->importPoFile($this
      ->getPoFileWithComplexPlural(), array(
      'langcode' => 'hr',
    ));

    // Attempt to import some broken .po files as well to prove that these
    // will not overwrite the proper plural formula imported above.
    $this
      ->importPoFile($this
      ->getPoFileWithMissingPlural(), array(
      'langcode' => 'fr',
      'overwrite_options[not_customized]' => TRUE,
    ));
    $this
      ->importPoFile($this
      ->getPoFileWithBrokenPlural(), array(
      'langcode' => 'hr',
      'overwrite_options[not_customized]' => TRUE,
    ));

    // Reset static caches from locale_get_plural() to ensure we get fresh data.
    drupal_static_reset('locale_get_plural');
    drupal_static_reset('locale_get_plural:plurals');
    drupal_static_reset('locale');

    // Expected plural translation strings for each plural index.
    $plural_strings = array(
      // English is not imported in this case, so we assume built-in text
      // and formulas.
      'en' => array(
        0 => '1 hour',
        1 => '@count hours',
      ),
      'fr' => array(
        0 => '@count heure',
        1 => '@count heures',
      ),
      'hr' => array(
        0 => '@count sat',
        1 => '@count sata',
        2 => '@count sati',
      ),
      // Hungarian is not imported, so it should assume the same text as
      // English, but it will always pick the plural form as per the built-in
      // logic, so only index -1 is relevant with the plural value.
      'hu' => array(
        0 => '1 hour',
        -1 => '@count hours',
      ),
    );

    // Expected plural indexes precomputed base on the plural formulas with
    // given $count value.
    $plural_tests = array(
      'en' => array(
        1 => 0,
        0 => 1,
        5 => 1,
        123 => 1,
        235 => 1,
      ),
      'fr' => array(
        1 => 0,
        0 => 0,
        5 => 1,
        123 => 1,
        235 => 1,
      ),
      'hr' => array(
        1 => 0,
        21 => 0,
        0 => 2,
        2 => 1,
        8 => 2,
        123 => 1,
        235 => 2,
      ),
      'hu' => array(
        1 => -1,
        21 => -1,
        0 => -1,
      ),
    );
    foreach ($plural_tests as $langcode => $tests) {
      foreach ($tests as $count => $expected_plural_index) {

        // Assert that the we get the right plural index.
        $this
          ->assertIdentical(locale_get_plural($count, $langcode), $expected_plural_index, 'Computed plural index for ' . $langcode . ' for count ' . $count . ' is ' . $expected_plural_index);

        // Assert that the we get the right translation for that. Change the
        // expected index as per the logic for translation lookups.
        $expected_plural_index = $count == 1 ? 0 : $expected_plural_index;
        $expected_plural_string = str_replace('@count', $count, $plural_strings[$langcode][$expected_plural_index]);
        $this
          ->assertIdentical(\Drupal::translation()
          ->formatPlural($count, '1 hour', '@count hours', array(), array(
          'langcode' => $langcode,
        ))
          ->render(), $expected_plural_string, 'Plural translation of 1 hours / @count hours for count ' . $count . ' in ' . $langcode . ' is ' . $expected_plural_string);

        // DO NOT use translation to pass translated strings into
        // PluralTranslatableMarkup::createFromTranslatedString() this way. It
        // is designed to be used with *already* translated text like settings
        // from configuration. We use PHP translation here just because we have
        // the expected result data in that format.
        $translated_string = \Drupal::translation()
          ->translate('1 hour' . PluralTranslatableMarkup::DELIMITER . '@count hours', array(), array(
          'langcode' => $langcode,
        ));
        $plural = PluralTranslatableMarkup::createFromTranslatedString($count, $translated_string, array(), array(
          'langcode' => $langcode,
        ));
        $this
          ->assertIdentical($plural
          ->render(), $expected_plural_string);
      }
    }
  }

  /**
   * Tests plural editing of DateFormatter strings
   */
  public function testPluralEditDateFormatter() {

    // Import some .po files with formulas to set up the environment.
    // These will also add the languages to the system.
    $this
      ->importPoFile($this
      ->getPoFileWithSimplePlural(), array(
      'langcode' => 'fr',
    ));

    // Set French as the site default language.
    $this
      ->config('system.site')
      ->set('default_langcode', 'fr')
      ->save();

    // Visit User Info page before updating translation strings.
    $this
      ->drupalGet('user');

    // Member for time should be translated.
    $this
      ->assertText("seconde", "'Member for' text is translated.");
    $path = 'admin/config/regional/translate/';
    $search = array(
      'langcode' => 'fr',
      // Limit to only translated strings to ensure that database ordering does
      // not break the test.
      'translation' => 'translated',
    );
    $this
      ->drupalPostForm($path, $search, t('Filter'));

    // Plural values for the langcode fr.
    $this
      ->assertText('@count seconde');
    $this
      ->assertText('@count secondes');

    // Inject a plural source string to the database. We need to use a specific
    // langcode here because the language will be English by default and will
    // not save our source string for performance optimization if we do not ask
    // specifically for a language.
    \Drupal::translation()
      ->formatPlural(1, '1 second', '@count seconds', array(), array(
      'langcode' => 'fr',
    ))
      ->render();
    $lid = db_query("SELECT lid FROM {locales_source} WHERE source = :source AND context = ''", array(
      ':source' => "1 second" . LOCALE_PLURAL_DELIMITER . "@count seconds",
    ))
      ->fetchField();

    // Look up editing page for this plural string and check fields.
    $search = array(
      'string' => '1 second',
      'langcode' => 'fr',
    );
    $this
      ->drupalPostForm('admin/config/regional/translate', $search, t('Filter'));

    // Save complete translations for the string in langcode fr.
    $edit = array(
      "strings[{$lid}][translations][0]" => '1 seconde updated',
      "strings[{$lid}][translations][1]" => '@count secondes updated',
    );
    $this
      ->drupalPostForm($path, $edit, t('Save translations'));

    // User interface input for translating seconds should not be duplicated
    $this
      ->assertUniqueText('@count seconds', 'Interface translation input for @count seconds only appears once.');

    // Member for time should be translated.
    $this
      ->drupalGet('user');
    $this
      ->assertText("seconde", "'Member for' text is translated.");
  }

  /**
   * Tests plural editing and export functionality.
   */
  public function testPluralEditExport() {

    // Import some .po files with formulas to set up the environment.
    // These will also add the languages to the system.
    $this
      ->importPoFile($this
      ->getPoFileWithSimplePlural(), array(
      'langcode' => 'fr',
    ));
    $this
      ->importPoFile($this
      ->getPoFileWithComplexPlural(), array(
      'langcode' => 'hr',
    ));

    // Get the French translations.
    $this
      ->drupalPostForm('admin/config/regional/translate/export', array(
      'langcode' => 'fr',
    ), t('Export'));

    // Ensure we have a translation file.
    $this
      ->assertRaw('# French translation of Drupal', 'Exported French translation file.');

    // Ensure our imported translations exist in the file.
    $this
      ->assertRaw("msgid \"Monday\"\nmsgstr \"lundi\"", 'French translations present in exported file.');

    // Check for plural export specifically.
    $this
      ->assertRaw("msgid \"1 hour\"\nmsgid_plural \"@count hours\"\nmsgstr[0] \"@count heure\"\nmsgstr[1] \"@count heures\"", 'Plural translations exported properly.');

    // Get the Croatian translations.
    $this
      ->drupalPostForm('admin/config/regional/translate/export', array(
      'langcode' => 'hr',
    ), t('Export'));

    // Ensure we have a translation file.
    $this
      ->assertRaw('# Croatian translation of Drupal', 'Exported Croatian translation file.');

    // Ensure our imported translations exist in the file.
    $this
      ->assertRaw("msgid \"Monday\"\nmsgstr \"Ponedjeljak\"", 'Croatian translations present in exported file.');

    // Check for plural export specifically.
    $this
      ->assertRaw("msgid \"1 hour\"\nmsgid_plural \"@count hours\"\nmsgstr[0] \"@count sat\"\nmsgstr[1] \"@count sata\"\nmsgstr[2] \"@count sati\"", 'Plural translations exported properly.');

    // Check if the source appears on the translation page.
    $this
      ->drupalGet('admin/config/regional/translate');
    $this
      ->assertText("1 hour");
    $this
      ->assertText("@count hours");

    // Look up editing page for this plural string and check fields.
    $path = 'admin/config/regional/translate/';
    $search = array(
      'langcode' => 'hr',
    );
    $this
      ->drupalPostForm($path, $search, t('Filter'));

    // Labels for plural editing elements.
    $this
      ->assertText('Singular form');
    $this
      ->assertText('First plural form');
    $this
      ->assertText('2. plural form');
    $this
      ->assertNoText('3. plural form');

    // Plural values for langcode hr.
    $this
      ->assertText('@count sat');
    $this
      ->assertText('@count sata');
    $this
      ->assertText('@count sati');

    // Edit langcode hr translations and see if that took effect.
    $lid = db_query("SELECT lid FROM {locales_source} WHERE source = :source AND context = ''", array(
      ':source' => "1 hour" . LOCALE_PLURAL_DELIMITER . "@count hours",
    ))
      ->fetchField();
    $edit = array(
      "strings[{$lid}][translations][1]" => '@count sata edited',
    );
    $this
      ->drupalPostForm($path, $edit, t('Save translations'));
    $search = array(
      'langcode' => 'fr',
    );
    $this
      ->drupalPostForm('admin/config/regional/translate', $search, t('Filter'));

    // Plural values for the langcode fr.
    $this
      ->assertText('@count heure');
    $this
      ->assertText('@count heures');
    $this
      ->assertNoText('2. plural form');

    // Edit langcode fr translations and see if that took effect.
    $edit = array(
      "strings[{$lid}][translations][0]" => '@count heure edited',
    );
    $this
      ->drupalPostForm($path, $edit, t('Save translations'));

    // Inject a plural source string to the database. We need to use a specific
    // langcode here because the language will be English by default and will
    // not save our source string for performance optimization if we do not ask
    // specifically for a language.
    \Drupal::translation()
      ->formatPlural(1, '1 day', '@count days', array(), array(
      'langcode' => 'fr',
    ))
      ->render();
    $lid = db_query("SELECT lid FROM {locales_source} WHERE source = :source AND context = ''", array(
      ':source' => "1 day" . LOCALE_PLURAL_DELIMITER . "@count days",
    ))
      ->fetchField();

    // Look up editing page for this plural string and check fields.
    $search = array(
      'string' => '1 day',
      'langcode' => 'fr',
    );
    $this
      ->drupalPostForm('admin/config/regional/translate', $search, t('Filter'));

    // Save complete translations for the string in langcode fr.
    $edit = array(
      "strings[{$lid}][translations][0]" => '1 jour',
      "strings[{$lid}][translations][1]" => '@count jours',
    );
    $this
      ->drupalPostForm($path, $edit, t('Save translations'));

    // Save complete translations for the string in langcode hr.
    $search = array(
      'string' => '1 day',
      'langcode' => 'hr',
    );
    $this
      ->drupalPostForm('admin/config/regional/translate', $search, t('Filter'));
    $edit = array(
      "strings[{$lid}][translations][0]" => '@count dan',
      "strings[{$lid}][translations][1]" => '@count dana',
      "strings[{$lid}][translations][2]" => '@count dana',
    );
    $this
      ->drupalPostForm($path, $edit, t('Save translations'));

    // Get the French translations.
    $this
      ->drupalPostForm('admin/config/regional/translate/export', array(
      'langcode' => 'fr',
    ), t('Export'));

    // Check for plural export specifically.
    $this
      ->assertRaw("msgid \"1 hour\"\nmsgid_plural \"@count hours\"\nmsgstr[0] \"@count heure edited\"\nmsgstr[1] \"@count heures\"", 'Edited French plural translations for hours exported properly.');
    $this
      ->assertRaw("msgid \"1 day\"\nmsgid_plural \"@count days\"\nmsgstr[0] \"1 jour\"\nmsgstr[1] \"@count jours\"", 'Added French plural translations for days exported properly.');

    // Get the Croatian translations.
    $this
      ->drupalPostForm('admin/config/regional/translate/export', array(
      'langcode' => 'hr',
    ), t('Export'));

    // Check for plural export specifically.
    $this
      ->assertRaw("msgid \"1 hour\"\nmsgid_plural \"@count hours\"\nmsgstr[0] \"@count sat\"\nmsgstr[1] \"@count sata edited\"\nmsgstr[2] \"@count sati\"", 'Edited Croatian plural translations exported properly.');
    $this
      ->assertRaw("msgid \"1 day\"\nmsgid_plural \"@count days\"\nmsgstr[0] \"@count dan\"\nmsgstr[1] \"@count dana\"\nmsgstr[2] \"@count dana\"", 'Added Croatian plural translations exported properly.');
  }

  /**
   * Imports a standalone .po file in a given language.
   *
   * @param string $contents
   *   Contents of the .po file to import.
   * @param array $options
   *   Additional options to pass to the translation import form.
   */
  public function importPoFile($contents, array $options = array()) {
    $name = tempnam('temporary://', "po_") . '.po';
    file_put_contents($name, $contents);
    $options['files[file]'] = $name;
    $this
      ->drupalPostForm('admin/config/regional/translate/import', $options, t('Import'));
    drupal_unlink($name);
  }

  /**
   * Returns a .po file with a simple plural formula.
   */
  public function getPoFileWithSimplePlural() {
    return <<<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"

msgid "1 hour"
msgid_plural "@count hours"
msgstr[0] "@count heure"
msgstr[1] "@count heures"

msgid "1 second"
msgid_plural "@count seconds"
msgstr[0] "@count seconde"
msgstr[1] "@count secondes"

msgid "Monday"
msgstr "lundi"
EOF;
  }

  /**
   * Returns a .po file with a complex plural formula.
   */
  public function getPoFileWithComplexPlural() {
    return <<<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=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\\n"

msgid "1 hour"
msgid_plural "@count hours"
msgstr[0] "@count sat"
msgstr[1] "@count sata"
msgstr[2] "@count sati"

msgid "Monday"
msgstr "Ponedjeljak"
EOF;
  }

  /**
   * Returns a .po file with a missing plural formula.
   */
  public function getPoFileWithMissingPlural() {
    return <<<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"

msgid "Monday"
msgstr "lundi"
EOF;
  }

  /**
   * Returns a .po file with a broken plural formula.
   */
  public function getPoFileWithBrokenPlural() {
    return <<<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: broken, will not parse\\n"

msgid "Monday"
msgstr "Ponedjeljak"
EOF;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	2
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected	function	Casts MarkupInterface objects into strings.
LocalePluralFormatTest::$modules	public static	property	Modules to enable.
LocalePluralFormatTest::getPoFileWithBrokenPlural	public	function	Returns a .po file with a broken plural formula.
LocalePluralFormatTest::getPoFileWithComplexPlural	public	function	Returns a .po file with a complex plural formula.
LocalePluralFormatTest::getPoFileWithMissingPlural	public	function	Returns a .po file with a missing plural formula.
LocalePluralFormatTest::getPoFileWithSimplePlural	public	function	Returns a .po file with a simple plural formula.
LocalePluralFormatTest::importPoFile	public	function	Imports a standalone .po file in a given language.
LocalePluralFormatTest::setUp	protected	function	Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
LocalePluralFormatTest::testGetPluralFormat	public	function	Tests locale_get_plural() and \Drupal::translation()->formatPlural() functionality.
LocalePluralFormatTest::testPluralEditDateFormatter	public	function	Tests plural editing of DateFormatter strings
LocalePluralFormatTest::testPluralEditExport	public	function	Tests plural editing and export functionality.
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.
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.
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.
TestBase::$assertions	protected	property	Assertions thrown in that test case.
TestBase::$configImporter	protected	property	The config importer that can used in a test.	5
TestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestBase::$container	protected	property	The dependency injection container used in the test.
TestBase::$databasePrefix	protected	property	The database prefix of this test run.
TestBase::$dieOnFail	public	property	Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials	protected	property	HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod	protected	property	HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf	protected	property	The original configuration (variables), if available.
TestBase::$originalConfig	protected	property	The original configuration (variables).
TestBase::$originalConfigDirectories	protected	property	The original configuration directories.
TestBase::$originalContainer	protected	property	The original container.
TestBase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage	protected	property	The original language.
TestBase::$originalPrefix	protected	property	The original database prefix when running inside Simpletest.
TestBase::$originalProfile	protected	property	The original installation profile.
TestBase::$originalSessionName	protected	property	The name of the session cookie of the test-runner.
TestBase::$originalSettings	protected	property	The settings array.
TestBase::$originalSite	protected	property	The site directory of the original parent site.
TestBase::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestBase::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestBase::$results	public	property	Current results of this test case.
TestBase::$siteDirectory	protected	property	The site directory of this test run.
TestBase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	4
TestBase::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestBase::$testId	protected	property	The test run ID.
TestBase::$timeLimit	protected	property	Time limit for the test.
TestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
TestBase::$verbose	public	property	TRUE if verbose debugging is enabled.
TestBase::$verboseClassName	protected	property	Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory	protected	property	Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
TestBase::$verboseId	protected	property	Incrementing identifier for verbose output filenames.
TestBase::assert	protected	function	Internal helper: stores the assert.
TestBase::assertEqual	protected	function	Check to see if two values are equal.
TestBase::assertErrorLogged	protected	function	Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse	protected	function	Check to see if a value is false.
TestBase::assertIdentical	protected	function	Check to see if two values are identical.
TestBase::assertIdenticalObject	protected	function	Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged	protected	function	Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual	protected	function	Check to see if two values are not equal.
TestBase::assertNotIdentical	protected	function	Check to see if two values are not identical.
TestBase::assertNotNull	protected	function	Check to see if a value is not NULL.
TestBase::assertNull	protected	function	Check to see if a value is NULL.
TestBase::assertTrue	protected	function	Check to see if a value is not false.
TestBase::beforePrepareEnvironment	protected	function	Act on global state information before the environment is altered for a test.	1
TestBase::changeDatabasePrefix	private	function	Changes the database connection to the prefixed one.
TestBase::checkRequirements	protected	function	Checks the matching requirements for Test.	2
TestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter	public	function	Returns a ConfigImporter object to import test importing of configuration.	5
TestBase::copyConfig	public	function	Copies configuration objects from source storage to target storage.
TestBase::deleteAssert	public static	function	Delete an assertion record by message ID.
TestBase::error	protected	function	Fire an error assertion.	3
TestBase::errorHandler	public	function	Handle errors during test runs.
TestBase::exceptionHandler	protected	function	Handle exceptions.
TestBase::fail	protected	function	Fire an assertion that is always negative.
TestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix	public	function	Gets the database prefix.
TestBase::getTempFilesDirectory	public	function	Gets the temporary files directory.
TestBase::insertAssert	public static	function	Store an assertion from outside the testing context.
TestBase::pass	protected	function	Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix	private	function	Generates a database prefix for running tests.
TestBase::prepareEnvironment	private	function	Prepares the current environment for running the test.
TestBase::restoreEnvironment	private	function	Cleans up the test environment and restores the original environment.
TestBase::run	public	function	Run all tests in this class.	1
TestBase::settingsSet	protected	function	Changes in memory settings.
TestBase::storeAssertion	protected	function	Helper method to store an assertion record in the configured database.
TestBase::verbose	protected	function	Logs a verbose message in a text file.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions	protected	property	Additional cURL options.
WebTestBase::$assertAjaxHeader	protected	property	Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories	protected	property	The config directories used in this test.
WebTestBase::$cookieFile	protected	property	The current cookie file used by cURL.
WebTestBase::$cookies	protected	property	The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies	protected	property	Cookies to set on curl requests.
WebTestBase::$curlHandle	protected	property	The handle of the current cURL connection.
WebTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders	protected	property	Indicates that headers should be dumped if verbose output is enabled.	12
WebTestBase::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
WebTestBase::$headers	protected	property	The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel	protected	property	The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser	protected	property	The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects	protected	property	The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch	protected	property	The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks	protected	property	The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser	protected	property	The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile	protected	property	The profile to install as a basis for testing.	30
WebTestBase::$redirectCount	protected	property	The number of redirects followed during the handling of a request.
WebTestBase::$rootUser	protected	property	The "#1" admin user.
WebTestBase::$sessionId	protected	property	The current session ID, if available.
WebTestBase::$url	protected	property	The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations	protected	function	Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears	protected	function	Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext	protected	function	Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader	protected	function	Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail	protected	function	Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern	protected	function	Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString	protected	function	Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears	protected	function	Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext	protected	function	Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse	protected	function	Asserts the page did not return the specified response code.
WebTestBase::assertResponse	protected	function	Asserts the page responds with the specified response code.
WebTestBase::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl	protected	function	Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink	protected	function	Follows a link by complete name.
WebTestBase::clickLinkHelper	protected	function	Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName	protected	function	Follows a link by partial name.
WebTestBase::cronRun	protected	function	Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose	protected	function	Close the cURL handler and unset the handler.
WebTestBase::curlExec	protected	function	Initializes and executes a cURL request.	2
WebTestBase::curlHeaderCallback	protected	function	Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize	protected	function	Initializes the cURL connection.
WebTestBase::doInstall	protected	function	Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView	protected	function	Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles	protected	function	Compare two files based on size and file name.
WebTestBase::drupalCreateContentType	protected	function	Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode	protected	function	Creates a node based on default settings.
WebTestBase::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	1
WebTestBase::drupalGetAjax	protected	function	Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader	protected	function	Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders	protected	function	Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON	protected	function	Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails	protected	function	Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle		function	Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles	protected	function	Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat	protected	function	Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR	protected	function	Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead	protected	function	Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin	protected	function	Log in a user with the internal browser.
WebTestBase::drupalLogout	protected	function	Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock	protected	function	Creates a block instance based on default settings.
WebTestBase::drupalPost	protected	function	Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm	protected	function	Executes an Ajax form submission.
WebTestBase::drupalPostForm	protected	function	Executes a form submission.
WebTestBase::drupalPostWithFormat	protected	function	Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse	protected	function	Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
WebTestBase::findBlockInstance	protected	function	Find a block instance on the page.
WebTestBase::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData	protected	function	Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
WebTestBase::handleForm	protected	function	Handles form input related to drupalPostForm().
WebTestBase::initConfig	protected	function	Initialize various configurations post-installation.
WebTestBase::initKernel	protected	function	Initializes the kernel after installation.
WebTestBase::initSettings	protected	function	Initialize settings created during install.
WebTestBase::initUserSession	protected	function	Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.
WebTestBase::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	2
WebTestBase::isInChildSite	protected	function	Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings	protected	function	Prepares site settings and services before installation.	1
WebTestBase::rebuildAll	protected	function	Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
WebTestBase::resetAll	protected	function	Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch	protected	function	Restore the original batch.
WebTestBase::serializePostValues	protected	function	Serialize POST HTTP request values.
WebTestBase::setBatch	protected	function	Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter	protected	function	Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders	protected	function	Enables/disables the cacheability headers.
WebTestBase::tearDown	protected	function	Cleans up after testing. Overrides TestBase::tearDown	2
WebTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail	protected	function	Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations	protected	function	Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings	protected	function	Rewrites the settings.php file of the test site.
WebTestBase::__construct		function	Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct	1