You are here

class XBBCodeAdminTest in Extensible BBCode 8.3

Same name and namespace in other branches
  1. 4.0.x tests/src/Functional/XBBCodeAdminTest.php \Drupal\Tests\xbbcode\Functional\XBBCodeAdminTest

Test the administrative interface.

@group xbbcode

Hierarchy

Expanded class hierarchy of XBBCodeAdminTest

File

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

Namespace

Drupal\Tests\xbbcode\Functional
View source
class XBBCodeAdminTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'block',
    'filter',
    'node',
    'xbbcode',
    'xbbcode_test_plugin',
  ];

  /**
   * Default theme.
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * Admin user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $adminUser;

  /**
   * User who can create pages.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $webUser;

  /**
   * A custom tag definition.
   *
   * @var array
   */
  protected $customTag;

  /**
   * {@inheritdoc}
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
    ]);
    $this->adminUser = $this
      ->drupalCreateUser([
      'administer filters',
      'administer custom BBCode tags',
      'administer BBCode tag sets',
      'access site reports',
    ]);
    $this->webUser = $this
      ->drupalCreateUser([
      'create page content',
      'edit own page content',
    ]);
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalPlaceBlock('local_actions_block');
    $this->customTag = $this
      ->createCustomTag(FALSE);
  }

  /**
   * Generate a custom tag and return it.
   *
   * @param bool $save
   *   Set to false to skip the save operation.
   *
   * @return array
   *   Information about the created tag.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  private function createCustomTag($save = TRUE) : array {
    $name = mb_strtolower($this
      ->randomMachineName());
    $option = $this
      ->randomString();
    $tag = [
      'id' => mb_strtolower($this
        ->randomMachineName()),
      'label' => $this
        ->randomString(),
      'description' => $this
        ->randomString(),
      'name' => $name,
      'sample' => "[{$name}='{$option}']" . $this
        ->randomMachineName() . "[/{$name}]",
      'template_code' => '[' . $this
        ->randomMachineName() . '|{{ tag.option }}|{{ tag.content }}]',
      'attached[library]' => "xbbcode/tag-form\nxbbcode_test_plugin/test-library",
    ];
    if ($save) {
      $this
        ->drupalPostForm('admin/config/content/xbbcode/tags/add', $tag, t('Save'));
      $this
        ->assertSession()
        ->responseContains((string) new FormattableMarkup('The BBCode tag %tag has been created.', [
        '%tag' => $tag['label'],
      ]));
    }
    return $tag;
  }

  /**
   * Test the custom tag page.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testCustomTags() : void {
    $this
      ->drupalGet('admin/config/content/xbbcode/tags');
    $this
      ->assertSession()
      ->pageTextContains('Test Tag Label');
    $this
      ->assertSession()
      ->pageTextContains('Test Tag Description');
    $this
      ->assertSession()
      ->pageTextContains('[test_tag]Content[/test_tag]');

    // Check that the tag can't be edited or deleted.
    $this
      ->assertSession()
      ->linkByHrefNotExists('admin/config/content/xbbcode/tags/manage/test_tag_id/edit');
    $this
      ->assertSession()
      ->linkByHrefNotExists('admin/config/content/xbbcode/tags/manage/test_tag_id/delete');
    $this
      ->drupalGet('admin/config/content/xbbcode/tags/manage/test_tag_id/edit');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalGet('admin/config/content/xbbcode/tags/manage/test_tag_id/delete');
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Check for the View operation.
    $this
      ->drupalGet('admin/config/content/xbbcode/tags');
    $this
      ->assertSession()
      ->linkByHrefExists('admin/config/content/xbbcode/tags/manage/test_tag_external/view');
    $this
      ->drupalGet('admin/config/content/xbbcode/tags/manage/test_tag_external/view');
    $template = <<<'EOD'
{#
/**
 * @file
 * Test template.
 */
#}
<em>{{ tag.content }}</em>
EOD;
    $this
      ->assertSession()
      ->fieldValueEquals('template_code', rtrim($template));

    // The read-only form has no save button.
    $fields = $this
      ->xpath($this
      ->assertSession()
      ->buildXPathQuery('//input[@name=:name][@value=:value]', [
      ':name' => 'op',
      ':value' => 'Save',
    ]));
    $this
      ->assertEmpty($fields);
    $this
      ->clickLink('Copy');
    $this
      ->assertSession()
      ->addressEquals('admin/config/content/xbbcode/tags/manage/test_tag_external/copy');
    $this
      ->assertSession()
      ->fieldValueEquals('label', 'Test External Template 2');
    $this
      ->assertNotEmpty($this
      ->xpath($this
      ->assertSession()
      ->buildXPathQuery('//input[@name=:name][@value=:value]', [
      ':name' => 'op',
      ':value' => 'Save',
    ])));

    // No copy button on a new tag.
    $this
      ->assertSession()
      ->linkNotExists('Copy');
    $this
      ->drupalGet('admin/config/content/xbbcode/tags');
    $this
      ->clickLink('Create custom tag');
    $edit = $this
      ->createCustomTag();

    // We should have been redirected to the tag list.
    // Our new custom tag is there.
    $this
      ->assertSession()
      ->assertEscaped($edit['label']);
    $this
      ->assertSession()
      ->assertEscaped($edit['description']);
    $this
      ->assertSession()
      ->assertEscaped($edit['sample']);

    // And so is the old one.
    $this
      ->assertSession()
      ->pageTextContains('[test_tag]Content[/test_tag]');
    $this
      ->assertSession()
      ->linkByHrefExists('admin/config/content/xbbcode/tags/manage/' . $edit['id'] . '/edit');
    $this
      ->assertSession()
      ->linkByHrefExists('admin/config/content/xbbcode/tags/manage/' . $edit['id'] . '/delete');
    $this
      ->clickLink('Edit');

    // Check that the stylesheet is included when rendering the preview.
    $this
      ->assertSession()
      ->responseContains('xbbcode_test_plugin/assets/test.css');

    // Check the contents of the library field.
    $this
      ->assertSession()
      ->fieldValueEquals('attached[library]', $edit['attached[library]']);

    // Check for the delete link on the editing form.
    $this
      ->assertSession()
      ->linkByHrefExists('admin/config/content/xbbcode/tags/manage/' . $edit['id'] . '/delete');
    $this
      ->assertSession()
      ->linkExists('Copy (discard unsaved changes)');
    $name = mb_strtolower($this
      ->randomMachineName());

    // Edit the description and the name.
    $new_edit = [
      'label' => $this
        ->randomString(),
      'description' => $this
        ->randomString(),
      'name' => $name,
      'sample' => str_replace($edit['name'], $name, $edit['sample']),
    ];
    $this
      ->drupalPostForm(NULL, $new_edit, t('Save'));
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('The BBCode tag %tag has been updated.', [
      '%tag' => $new_edit['label'],
    ]));
    $this
      ->assertSession()
      ->assertNoEscaped($edit['description']);
    $this
      ->assertSession()
      ->assertEscaped($new_edit['description']);
    $this
      ->assertSession()
      ->assertEscaped($new_edit['sample']);

    // Delete the tag.
    $this
      ->clickLink('Delete');
    $this
      ->drupalPostForm(NULL, [], t('Delete'));
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('The custom tag %tag has been deleted.', [
      '%tag' => $new_edit['label'],
    ]));

    // It's gone.
    $this
      ->assertSession()
      ->linkByHrefNotExists('admin/config/content/xbbcode/tags/manage/' . $edit['id'] . '/edit');
    $this
      ->assertSession()
      ->assertNoEscaped($new_edit['description']);

    // And the ID is available for re-use.
    $this
      ->clickLink('Create custom tag');
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // And it's back.
    $this
      ->assertSession()
      ->assertEscaped($edit['description']);
    $this
      ->assertSession()
      ->linkByHrefExists('admin/config/content/xbbcode/tags/manage/' . $edit['id'] . '/edit');
    $invalid_edit['name'] = $this
      ->randomMachineName() . 'A';
    $this
      ->clickLink('Edit');
    $this
      ->drupalPostForm(NULL, $invalid_edit, t('Save'));
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('%name field is not in the right format.', [
      '%name' => 'Default name',
    ]));
    $invalid_edit['name'] = mb_strtolower($this
      ->randomMachineName()) . '!';
    $this
      ->drupalPostForm(NULL, $invalid_edit, t('Save'));
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('%name field is not in the right format.', [
      '%name' => 'Default name',
    ]));
  }

  /**
   * Test the global default plugins.
   *
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testGlobalPlugins() : void {

    // By default, we have the tags from the test module.
    $this
      ->drupalGet('filter/tips');
    $this
      ->assertSession()
      ->pageTextContains('You may use the following BBCode tags:');
    $this
      ->assertSession()
      ->pageTextContains('[test_plugin]');
    $this
      ->assertSession()
      ->pageTextContains('[test_tag]');
    $this
      ->assertSession()
      ->pageTextContains('[test_template]');
    $tag = $this
      ->createCustomTag();

    // Newly created tags are enabled by default.
    $this
      ->drupalGet('filter/tips');
    $this
      ->assertSession()
      ->pageTextContains((string) $tag['name']);
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/add/page');

    // BBCode is the only format available:
    $this
      ->assertSession()
      ->pageTextContains('You may use the following BBCode tags:');
    $this
      ->assertSession()
      ->pageTextContains('[test_plugin]');
  }

  /**
   * Create and edit a tag set.
   *
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testTagSet() : void {
    $tag = $this
      ->createCustomTag();
    $tags = [
      'test_plugin_id' => 'test_plugin',
      'xbbcode_tag:test_tag_id' => 'test_tag',
      'xbbcode_tag:test_tag_external' => 'test_template',
      "xbbcode_tag:{$tag['id']}" => $tag['name'],
    ];
    $this
      ->drupalGet('admin/config/content/xbbcode/sets');

    // Drupal 8.6.0 made a string change.
    if (Semver::satisfies(Drupal::VERSION, '^8.6')) {
      $this
        ->assertSession()
        ->pageTextContains('There are no tag sets yet.');
    }
    else {
      $this
        ->assertSession()
        ->pageTextContains('There is no tag set yet.');
    }
    $this
      ->clickLink('Create tag set');

    // There is a checkbox for the format.
    $this
      ->assertSession()
      ->checkboxNotChecked('formats[xbbcode]');
    foreach ($tags as $id => $name) {
      $this
        ->assertSession()
        ->checkboxNotChecked("_tags[available:{$id}]");
      $this
        ->assertSession()
        ->fieldValueEquals("_settings[available:{$id}][name]", $name);
    }
    $tag_set = [
      'label' => $this
        ->randomString(),
      'id' => mb_strtolower($this
        ->randomMachineName()),
      'formats[xbbcode]' => 1,
    ];
    $this
      ->drupalPostForm(NULL, $tag_set, t('Save'));
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('The BBCode tag set %set has been created.', [
      '%set' => $tag_set['label'],
    ]));
    $this
      ->assertSession()
      ->pageTextContains('None');

    // The empty tag set is now selected in the format.
    $this
      ->drupalGet('filter/tips');
    $this
      ->assertSession()
      ->pageTextContains('BBCode is active, but no tags are available.');
    $this
      ->drupalGet('admin/config/content/xbbcode/sets');
    $this
      ->clickLink('Edit');

    // The format is checked now.
    $this
      ->assertSession()
      ->checkboxChecked('formats[xbbcode]');
    $invalid_edit = [
      '_settings[available:test_plugin_id][name]' => mb_strtolower($this
        ->randomMachineName()) . 'A',
    ];
    $this
      ->drupalPostForm(NULL, $invalid_edit, t('Save'));
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('%name field is not in the right format.', [
      '%name' => 'Tag name',
    ]));

    // Give the four available plugins two names, and enable the first three.
    $invalid_edit = [];
    foreach (array_keys($tags) as $i => $id) {
      $invalid_edit["_settings[available:{$id}][name]"] = $i >= 2 ? 'def' : 'abc';
      $invalid_edit["_tags[available:{$id}]"] = $i <= 2;
    }
    $this
      ->drupalPostForm(NULL, $invalid_edit, t('Save'));

    // Only enabled plugins need unique names.
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('The name [@name] is used by multiple tags.', [
      '@name' => 'abc',
    ]));
    $this
      ->assertSession()
      ->responseNotContains((string) new FormattableMarkup('The name [@name] is used by multiple tags.', [
      '@name' => 'def',
    ]));
    $this
      ->drupalGet('admin/config/content/xbbcode/sets');
    $this
      ->clickLink('Edit');

    // Enable only our custom tag.
    $edit = [
      "_tags[available:xbbcode_tag:{$tag['id']}]" => 1,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('The BBCode tag set %set has been updated.', [
      '%set' => $tag_set['label'],
    ]));
    $this
      ->assertSession()
      ->pageTextContains("[{$tag['name']}]");
    $this
      ->assertSession()
      ->pageTextNotContains('[test_tag]');
    $this
      ->assertSession()
      ->pageTextNotContains('[test_template]');
    $this
      ->assertSession()
      ->pageTextNotContains('[test_plugin]');

    // The filter tips are updated; only the custom tag is enabled.
    $this
      ->drupalGet('filter/tips');
    $this
      ->assertSession()
      ->responseContains("<strong>[{$tag['name']}]</strong>");
    $this
      ->assertSession()
      ->pageTextContains($tag['sample']);
    $this
      ->assertSession()
      ->pageTextContains($tag['description']);
    $this
      ->assertSession()
      ->pageTextNotContains('[test_tag]');
    $this
      ->assertSession()
      ->pageTextNotContains('[test_template]');
    $this
      ->assertSession()
      ->pageTextNotContains('[test_plugin]');
    $this
      ->drupalLogin($this->webUser);
    $this
      ->drupalGet('node/add/page');

    // BBCode is the only format available:
    $this
      ->assertSession()
      ->pageTextContains('You may use the following BBCode tags:');
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('<abbr title="@desc">[@name]</abbr>', [
      '@desc' => $tag['description'],
      '@name' => $tag['name'],
    ]));

    // Delete the tag set.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/config/content/xbbcode/sets');
    $this
      ->clickLink('Delete');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertSession()
      ->responseContains((string) new FormattableMarkup('The tag set %name has been deleted.', [
      '%name' => $tag_set['label'],
    ]));

    // Without a tag set, all tags are enabled again.
    $this
      ->drupalGet('filter/tips');
    $this
      ->assertSession()
      ->responseContains("<strong>[{$tag['name']}]</strong>");
    $this
      ->assertSession()
      ->pageTextContains($tag['sample']);
    $this
      ->assertSession()
      ->pageTextContains($tag['description']);
    $this
      ->assertSession()
      ->pageTextContains('[test_tag]');
    $this
      ->assertSession()
      ->pageTextContains('[test_template]');
    $this
      ->assertSession()
      ->pageTextContains('[test_plugin]');
  }

}

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.
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.
XBBCodeAdminTest::$adminUser protected property Admin user.
XBBCodeAdminTest::$customTag protected property A custom tag definition.
XBBCodeAdminTest::$defaultTheme protected property Default theme. Overrides BrowserTestBase::$defaultTheme
XBBCodeAdminTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
XBBCodeAdminTest::$webUser protected property User who can create pages.
XBBCodeAdminTest::createCustomTag private function Generate a custom tag and return it.
XBBCodeAdminTest::setUp protected function Overrides BrowserTestBase::setUp
XBBCodeAdminTest::testCustomTags public function Test the custom tag page.
XBBCodeAdminTest::testGlobalPlugins public function Test the global default plugins.
XBBCodeAdminTest::testTagSet public function Create and edit a tag set.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.