You are here

class NameAdminTest in Name Field 8

Tests for the admin settings and custom format page.

@group name

Hierarchy

Expanded class hierarchy of NameAdminTest

File

tests/src/Functional/NameAdminTest.php, line 15

Namespace

Drupal\Tests\name\Functional
View source
class NameAdminTest extends NameTestBase {

  /**
   * Misc tests related to adding, updating and removing formats.
   */
  public function testAdminFormatSettings() {

    // Default settings and system settings.
    $this
      ->drupalLogin($this->adminUser);

    // The default installed formats.
    $this
      ->drupalGet('admin/config/regional/name');
    $row_template = [
      'title' => '//tbody/tr[{row}]/td[1]',
      'machine' => '//tbody/tr[{row}]/td[2]',
      'pattern' => '//tbody/tr[{row}]/td[3]',
      'formatted' => '//tbody/tr[{row}]/td[4]',
      'edit' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "edit")]/a',
      'edit link' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "edit")]/a/@href',
      'delete' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "delete")]/a',
      'delete link' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "delete")]/a/@href',
    ];
    $all_values = [
      1 => [
        'title' => t('Default'),
        'machine' => 'default',
        'pattern' => '((((t+ig)+im)+if)+is)+jc',
        'formatted' => '(1) Mr John Peter Mark Doe Jnr., B.Sc., Ph.D. (2) JOAN SUE SMITH (3) Prince',
      ],
      2 => [
        'title' => t('Family'),
        'machine' => 'family',
        'pattern' => 'f',
        'formatted' => '(1) Doe (2) SMITH (3) <<empty>>',
        'edit link' => Url::fromRoute('entity.name_format.edit_form', [
          'name_format' => 'family',
        ])
          ->toString(),
        'delete link' => Url::fromRoute('entity.name_format.delete_form', [
          'name_format' => 'family',
        ])
          ->toString(),
      ],
      3 => [
        'title' => t('Full'),
        'machine' => 'full',
        'pattern' => '((((t+ig)+im)+if)+is)+jc',
        'formatted' => '(1) Mr John Peter Mark Doe Jnr., B.Sc., Ph.D. (2) JOAN SUE SMITH (3) Prince',
        'edit' => t('Edit'),
        'edit link' => Url::fromRoute('entity.name_format.edit_form', [
          'name_format' => 'full',
        ])
          ->toString(),
        'delete' => t('Delete'),
        'delete link' => Url::fromRoute('entity.name_format.delete_form', [
          'name_format' => 'full',
        ])
          ->toString(),
      ],
      4 => [
        'title' => t('Given'),
        'machine' => 'given',
        'pattern' => 'g',
        'formatted' => '(1) John (2) JOAN (3) Prince',
        'edit' => t('Edit'),
        'edit link' => Url::fromRoute('entity.name_format.edit_form', [
          'name_format' => 'given',
        ])
          ->toString(),
        'delete' => t('Delete'),
        'delete link' => Url::fromRoute('entity.name_format.delete_form', [
          'name_format' => 'given',
        ])
          ->toString(),
      ],
      5 => [
        'title' => t('Given Family'),
        'machine' => 'short_full',
        'pattern' => 'g+if',
        'formatted' => '(1) John Doe (2) JOAN SMITH (3) Prince',
        'edit link' => Url::fromRoute('entity.name_format.edit_form', [
          'name_format' => 'short_full',
        ])
          ->toString(),
        'delete link' => Url::fromRoute('entity.name_format.delete_form', [
          'name_format' => 'short_full',
        ])
          ->toString(),
      ],
      6 => [
        'title' => t('Title Family'),
        'machine' => 'formal',
        'pattern' => 't+if',
        'formatted' => '(1) Mr Doe (2) SMITH (3) <<empty>>',
        'edit link' => Url::fromRoute('entity.name_format.edit_form', [
          'name_format' => 'formal',
        ])
          ->toString(),
        'delete link' => Url::fromRoute('entity.name_format.delete_form', [
          'name_format' => 'formal',
        ])
          ->toString(),
      ],
    ];
    foreach ($all_values as $id => $row) {
      $this
        ->assertRow($row, $row_template, $id);
    }

    // Load the name settings form.
    $this
      ->drupalGet('admin/config/regional/name/settings');
    $default_values = [
      'name_settings[sep1]' => ' ',
      'name_settings[sep2]' => ', ',
      'name_settings[sep3]' => '',
    ];
    foreach ($default_values as $name => $value) {
      $this
        ->assertField($name, $value);
    }

    // ID example.
    $this
      ->assertFieldById('edit-name-settings-sep1', ' ', t('Sep 1 default value.'));
    $test_values = [
      'name_settings[sep1]' => '~',
      'name_settings[sep2]' => '^',
      'name_settings[sep3]' => '-',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/settings', $test_values, t('Save configuration'));
    $this
      ->assertText(t('The configuration options have been saved.'));
    foreach ($test_values as $name => $value) {
      $this
        ->assertField($name, $value);
    }

    // Delete all existing formats.
    $formats = NameFormat::loadMultiple();
    array_walk($formats, function (NameFormatInterface $format) {
      if (!$format
        ->isLocked()) {
        $format
          ->delete();
      }
    });
    $this
      ->drupalGet('admin/config/regional/name/add');
    $this
      ->assertRaw('Format string help', 'Testing the help fieldgroup');
    $values = [
      'label' => '',
      'id' => '',
      'pattern' => '',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/add', $values, t('Save format'));
    foreach ([
      t('Name'),
      t('Machine-readable name'),
      t('Format'),
    ] as $title) {
      $this
        ->assertText(t('@field field is required', [
        '@field' => $title,
      ]));
    }
    $values = [
      'label' => 'given',
      'id' => '1234567890abcdefghijklmnopqrstuvwxyz_',
      'pattern' => 'a',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/add', $values, t('Save format'));
    $this
      ->assertNoText(t('@field field is required', [
      '@field' => t('Format'),
    ]));
    $this
      ->assertNoText(t('@field field is required', [
      '@field' => t('Machine-readable name'),
    ]));
    $values = [
      'label' => 'given',
      'id' => '%&*(',
      'pattern' => 'a',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/add', $values, t('Save format'));
    $this
      ->assertText(t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
    $values = [
      'label' => 'default',
      'id' => 'default',
      'pattern' => 'a',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/add', $values, t('Save format'));
    $this
      ->assertText(t('The machine-readable name is already in use. It must be unique.'));
    $values = [
      'label' => 'Test',
      'id' => 'test',
      'pattern' => '\\a\\bc',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/add', $values, t('Save format'));
    $this
      ->assertText(t('Name format Test added.'));
    $row = [
      'title' => 'Test',
      'machine' => 'test',
      'pattern' => '\\a\\bc',
      'formatted' => '(1) abB.Sc., Ph.D. (2) ab (3) ab',
      'edit link' => Url::fromRoute('entity.name_format.edit_form', [
        'name_format' => 'test',
      ])
        ->toString(),
      'delete link' => Url::fromRoute('entity.name_format.delete_form', [
        'name_format' => 'test',
      ])
        ->toString(),
    ];
    $this
      ->assertRow($row, $row_template, 3);
    $values = [
      'label' => 'new name',
      'pattern' => 'f+g',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/manage/test', $values, t('Save format'));
    $this
      ->assertText(t('Name format new name has been updated.'));
    $row = [
      'label' => $values['label'],
      'id' => 'test',
      'pattern' => $values['pattern'],
    ];
    $this
      ->assertRow($row, $row_template, 3);
    $this
      ->drupalGet('admin/config/regional/name/manage/60');
    $this
      ->assertResponse(404);
    $this
      ->drupalGet('admin/config/regional/name/manage/60/delete');
    $this
      ->assertResponse(404);
    $this
      ->drupalGet('admin/config/regional/name/manage/test/delete');
    $this
      ->assertText(t('Are you sure you want to delete the custom format @title?', [
      '@title' => $values['label'],
    ]));
    $this
      ->drupalPostForm(NULL, [], t('Delete'));
    $this
      ->assertText(t('The name format @title has been deleted.', [
      '@title' => $values['label'],
    ]));
  }

  /**
   * Misc tests related to adding, updating and removing formats.
   */
  public function testAdminListFormatSettings() {

    // Default settings and system settings.
    $this
      ->drupalLogin($this->adminUser);

    // The default installed formats.
    $this
      ->drupalGet('admin/config/regional/name/list');
    $row_template = [
      'title' => '//tbody/tr[{row}]/td[1]',
      'machine' => '//tbody/tr[{row}]/td[2]',
      'settings' => '//tbody/tr[{row}]/td[3]',
      // 'examples'   => '//tbody/tr[{row}]/td[4]',
      'edit' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "edit")]/a',
      'edit link' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "edit")]/a/@href',
      'delete' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "delete")]/a',
      'delete link' => '//tbody/tr[{row}]/td[5]//li[contains(@class, "delete")]/a/@href',
    ];
    $all_values = [
      1 => [
        'title' => t('Default'),
        'machine' => 'default',
        // 'examples' => 'todo',
        'edit link' => Url::fromRoute('entity.name_list_format.edit_form', [
          'name_list_format' => 'default',
        ])
          ->toString(),
      ],
    ];
    foreach ($all_values as $id => $row) {
      $this
        ->assertRow($row, $row_template, $id);
    }
    $this
      ->drupalGet('admin/config/regional/name/list/add');

    // All bar delimiter are required.
    $values = [
      'label' => '',
      'id' => '',
      'delimiter' => '',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/list/add', $values, t('Save list format'));
    $labels = [
      t('Name'),
      t('Machine-readable name'),
    ];
    foreach ($labels as $title) {
      $this
        ->assertText(t('@field field is required', [
        '@field' => $title,
      ]));
    }
    $values = [
      'label' => 'comma',
      'id' => '1234567890abcdefghijklmnopqrstuvwxyz_',
      'delimiter' => ', ',
      'and' => 'text',
      'delimiter_precedes_last' => 'always',
      'el_al_min' => '14',
      'el_al_first' => '5',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/list/add', $values, t('Save list format'));
    $this
      ->assertNoText(t('@field field is required', [
      '@field' => t('Last delimiter type'),
    ]));
    $this
      ->assertNoText(t('@field field is required', [
      '@field' => t('Machine-readable name'),
    ]));
    $values['id'] = '%&*(';
    $this
      ->drupalPostForm('admin/config/regional/name/list/add', $values, t('Save list format'));
    $this
      ->assertText(t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
    $values = [
      'label' => 'default',
      'id' => 'default',
      'delimiter' => 'a',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/list/add', $values, t('Save list format'));
    $this
      ->assertText(t('The machine-readable name is already in use. It must be unique.'));
    $values = [
      'label' => 'Test label',
      'id' => 'test',
      'delimiter' => ' / ',
      'and' => 'symbol',
      'delimiter_precedes_last' => 'contextual',
      'el_al_min' => '3',
      'el_al_first' => '1',
    ];
    $this
      ->drupalPostForm('admin/config/regional/name/list/add', $values, t('Save list format'));
    $this
      ->assertText(t('Name list format Test label added.'));
    $row = [
      'title' => 'Test label',
      'machine' => 'test',
      'delimiter' => ' / ',
      'edit link' => Url::fromRoute('entity.name_list_format.edit_form', [
        'name_list_format' => 'test',
      ])
        ->toString(),
      'delete link' => Url::fromRoute('entity.name_list_format.delete_form', [
        'name_list_format' => 'test',
      ])
        ->toString(),
    ];
    $this
      ->assertRow($row, $row_template, 3);
    $summary_text = [
      'Delimiters: " / " and Ampersand (&)',
      'Reduce after 3 items and show 1 items followed by el al.',
      'Last delimiter: Contextual',
    ];
    $this
      ->assertRowContains([
      'settings' => $summary_text,
    ], $row_template, 3);
    $this
      ->drupalGet('admin/config/regional/name/list/manage/60');
    $this
      ->assertResponse(404);
    $this
      ->drupalGet('admin/config/regional/name/list/manage/60/delete');
    $this
      ->assertResponse(404);
    $this
      ->drupalGet('admin/config/regional/name/list/manage/test/delete');
    $this
      ->assertText(t('Are you sure you want to delete the custom list format @title?', [
      '@title' => $values['label'],
    ]));
    $this
      ->drupalPostForm(NULL, [], t('Delete'));
    $this
      ->assertText(t('The name list format @title has been deleted.', [
      '@title' => $values['label'],
    ]));
  }

  /**
   * Helper function to test a table cell via its expected value.
   *
   * @param array $row
   *   Table rows to test.
   * @param array $row_template
   *   The parameters used for each row test.
   * @param int $id
   *   The row ID.
   */
  public function assertRow(array $row, array $row_template, $id) {
    foreach ($row as $cell_code => $value) {
      if (isset($row_template[$cell_code])) {
        $xpath = str_replace('{row}', $id, $row_template[$cell_code]);
        $elements = $this
          ->xpath($xpath);

        // Check URLs with or without the ?destination= query parameter.
        if (strpos($row_template[$cell_code], '/a/@href')) {
          $results = isset($elements[0]) ? $elements[0]
            ->getHtml() : '';
          $message = "Testing {$cell_code} on row {$id} using '{$xpath}' and expecting '" . Html::escape($value) . "', got '" . Html::escape($results) . "'.";
          if ($results == $value || strpos($results, $value . '?destination=') === 0) {
            $this
              ->pass($message);
          }
          else {
            $this
              ->fail($message);
          }
        }
        else {
          $results = $this
            ->normalizeOutput($elements);
          $message = "Testing {$cell_code} on row {$id} using '{$xpath}' and expecting '" . Html::escape($value) . "', got '" . Html::escape($results) . "'.";
          $this
            ->assertEquals($results, $value, $message);
        }
      }
    }
  }

  /**
   * Helper function to test a table cell via its expected value.
   *
   * @param array $row
   *   Table rows to test.
   * @param array $row_template
   *   The parameters used for each row test.
   * @param int $id
   *   The row ID.
   */
  public function assertRowContains(array $row, array $row_template, $id) {
    foreach ($row as $cell_code => $values) {
      if (isset($row_template[$cell_code])) {
        $xpath = str_replace('{row}', $id, $row_template[$cell_code]);
        $raw_xpath = $this
          ->xpath($xpath);
        $results = $this
          ->normalizeOutput($raw_xpath);
        $values = (array) $values;
        foreach ($values as $value) {
          $message = "{$cell_code} [{$id}] '{$xpath}': testing '{$value}'; got '{$results}'.";
          $this
            ->assertTrue(strpos($results, $value) !== FALSE, $message);
        }
      }
    }
  }

  /**
   * Helper function to normalize output for testing results.
   *
   * Normalizes text by:
   * - gets complete HTML structure of the child nodes.
   * - ensures whitespace around any HTML tags.
   * - removes newlines and ensures single whitespaces.
   * - trims the string for trailing whitespace.
   *
   * @param array|false $elements
   *   Raw results from the XML Path lookup.
   *
   * @return string
   *   A normalized string.
   */
  protected function normalizeOutput($elements = []) {
    if (!is_array($elements)) {
      return '__MISSING__';
    }
    $results = '';
    foreach ($elements as $element) {
      $results .= $element
        ->getHtml();
    }

    // Insert a single whitespace in front of all opening HTML tags.
    $results = preg_replace('/<(?!\\/)/', ' <', $results);

    // Normalize any newlines.
    $results = str_replace([
      "\r",
      "\n",
    ], [
      "\n",
      " ",
    ], $results);
    $results = strip_tags($results);

    // Normalize any remaining whitespaces into a single space.
    $results = preg_replace('/\\s+/', ' ', $results);
    return trim($results);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
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'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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
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::$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::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::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::__construct public function 1
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 'apcu_ensure_unique_prefix' 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 "#1" 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. 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::prepareSettings protected function Prepares site settings and services before installation. 2
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.
NameAdminTest::assertRow public function Helper function to test a table cell via its expected value.
NameAdminTest::assertRowContains public function Helper function to test a table cell via its expected value.
NameAdminTest::normalizeOutput protected function Helper function to normalize output for testing results.
NameAdminTest::testAdminFormatSettings public function Misc tests related to adding, updating and removing formats.
NameAdminTest::testAdminListFormatSettings public function Misc tests related to adding, updating and removing formats.
NameTestBase::$adminUser protected property Admin user to run the tests for.
NameTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NameTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 4
NameTestBase::$webUser protected property Web user to run the tests for.
NameTestBase::assertFieldCheckedByName protected function Helper function.
NameTestBase::assertNameFormat protected function Helper function.
NameTestBase::assertNameFormats protected function Helper function.
NameTestBase::assertNoFieldCheckedByName protected function Helper function.
NameTestBase::setUp public 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
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
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. 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::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
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.
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.