You are here

Home » API reference » Drupal 8 » ConfigEntityTest.php

class ConfigEntityTest in Drupal 8

Same name in this branch
  1. 8 core/modules/config/tests/src/Functional/ConfigEntityTest.php \Drupal\Tests\config\Functional\ConfigEntityTest
  2. 8 core/modules/config/tests/src/FunctionalJavascript/ConfigEntityTest.php \Drupal\Tests\config\FunctionalJavascript\ConfigEntityTest
Same name and namespace in other branches
  1. 9 core/modules/config/tests/src/Functional/ConfigEntityTest.php \Drupal\Tests\config\Functional\ConfigEntityTest
  2. 10 core/modules/config/tests/src/Functional/ConfigEntityTest.php \Drupal\Tests\config\Functional\ConfigEntityTest

Tests configuration entities.

@group config

Hierarchy

Expanded class hierarchy of ConfigEntityTest

File

core/modules/config/tests/src/Functional/ConfigEntityTest.php, line 19

Namespace

Drupal\Tests\config\Functional
View source 
class ConfigEntityTest extends BrowserTestBase {

  /**
   * The maximum length for the entity storage used in this test.
   */
  const MAX_ID_LENGTH = ConfigEntityStorage::MAX_ID_LENGTH;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'config_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Tests CRUD operations.
   */
  public function testCRUD() {
    $default_langcode = \Drupal::languageManager()
      ->getDefaultLanguage()
      ->getId();

    // Verify default properties on a newly created empty entity.
    $storage = \Drupal::entityTypeManager()
      ->getStorage('config_test');
    $empty = $storage
      ->create();
    $this
      ->assertIdentical($empty->label, NULL);
    $this
      ->assertIdentical($empty->style, NULL);
    $this
      ->assertIdentical($empty
      ->language()
      ->getId(), $default_langcode);

    // Verify ConfigEntity properties/methods on the newly created empty entity.
    $this
      ->assertIdentical($empty
      ->isNew(), TRUE);
    $this
      ->assertIdentical($empty
      ->getOriginalId(), NULL);
    $this
      ->assertIdentical($empty
      ->bundle(), 'config_test');
    $this
      ->assertIdentical($empty
      ->id(), NULL);
    $this
      ->assertTrue(Uuid::isValid($empty
      ->uuid()));
    $this
      ->assertIdentical($empty
      ->label(), NULL);
    $this
      ->assertIdentical($empty
      ->get('id'), NULL);
    $this
      ->assertTrue(Uuid::isValid($empty
      ->get('uuid')));
    $this
      ->assertIdentical($empty
      ->get('label'), NULL);
    $this
      ->assertIdentical($empty
      ->get('style'), NULL);
    $this
      ->assertIdentical($empty
      ->language()
      ->getId(), $default_langcode);

    // Verify Entity properties/methods on the newly created empty entity.
    $this
      ->assertIdentical($empty
      ->getEntityTypeId(), 'config_test');

    // The URI can only be checked after saving.
    try {
      $empty
        ->toUrl();
      $this
        ->fail('EntityMalformedException was thrown.');
    } catch (EntityMalformedException $e) {

      // Expected exception; just continue testing.
    }

    // Verify that an empty entity cannot be saved.
    try {
      $empty
        ->save();
      $this
        ->fail('EntityMalformedException was thrown.');
    } catch (EntityMalformedException $e) {

      // Expected exception; just continue testing.
    }

    // Verify that an entity with an empty ID string is considered empty, too.
    $empty_id = $storage
      ->create([
      'id' => '',
    ]);
    $this
      ->assertIdentical($empty_id
      ->isNew(), TRUE);
    try {
      $empty_id
        ->save();
      $this
        ->fail('EntityMalformedException was thrown.');
    } catch (EntityMalformedException $e) {

      // Expected exception; just continue testing.
    }

    // Verify properties on a newly created entity.
    $config_test = $storage
      ->create($expected = [
      'id' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomString(),
      'style' => $this
        ->randomMachineName(),
    ]);
    $this
      ->assertNotEqual($config_test
      ->uuid(), $empty
      ->uuid());
    $this
      ->assertIdentical($config_test->label, $expected['label']);
    $this
      ->assertIdentical($config_test->style, $expected['style']);
    $this
      ->assertIdentical($config_test
      ->language()
      ->getId(), $default_langcode);

    // Verify methods on the newly created entity.
    $this
      ->assertIdentical($config_test
      ->isNew(), TRUE);
    $this
      ->assertIdentical($config_test
      ->getOriginalId(), $expected['id']);
    $this
      ->assertIdentical($config_test
      ->id(), $expected['id']);
    $this
      ->assertTrue(Uuid::isValid($config_test
      ->uuid()));
    $expected['uuid'] = $config_test
      ->uuid();
    $this
      ->assertIdentical($config_test
      ->label(), $expected['label']);

    // Verify that the entity can be saved.
    try {
      $status = $config_test
        ->save();
    } catch (EntityMalformedException $e) {
      $this
        ->fail('EntityMalformedException was not thrown.');
    }

    // The entity path can only be checked after saving.
    $this
      ->assertIdentical($config_test
      ->toUrl()
      ->toString(), Url::fromRoute('entity.config_test.edit_form', [
      'config_test' => $expected['id'],
    ])
      ->toString());

    // Verify that the correct status is returned and properties did not change.
    $this
      ->assertIdentical($status, SAVED_NEW);
    $this
      ->assertIdentical($config_test
      ->id(), $expected['id']);
    $this
      ->assertIdentical($config_test
      ->uuid(), $expected['uuid']);
    $this
      ->assertIdentical($config_test
      ->label(), $expected['label']);
    $this
      ->assertIdentical($config_test
      ->isNew(), FALSE);
    $this
      ->assertIdentical($config_test
      ->getOriginalId(), $expected['id']);

    // Save again, and verify correct status and properties again.
    $status = $config_test
      ->save();
    $this
      ->assertIdentical($status, SAVED_UPDATED);
    $this
      ->assertIdentical($config_test
      ->id(), $expected['id']);
    $this
      ->assertIdentical($config_test
      ->uuid(), $expected['uuid']);
    $this
      ->assertIdentical($config_test
      ->label(), $expected['label']);
    $this
      ->assertIdentical($config_test
      ->isNew(), FALSE);
    $this
      ->assertIdentical($config_test
      ->getOriginalId(), $expected['id']);

    // Verify that a configuration entity can be saved with an ID of the
    // maximum allowed length, but not longer.
    // Test with a short ID.
    $id_length_config_test = $storage
      ->create([
      'id' => $this
        ->randomMachineName(8),
    ]);
    try {
      $id_length_config_test
        ->save();
    } catch (ConfigEntityIdLengthException $e) {
      $this
        ->fail($e
        ->getMessage());
    }

    // Test with an ID of the maximum allowed length.
    $id_length_config_test = $storage
      ->create([
      'id' => $this
        ->randomMachineName(static::MAX_ID_LENGTH),
    ]);
    try {
      $id_length_config_test
        ->save();
    } catch (ConfigEntityIdLengthException $e) {
      $this
        ->fail($e
        ->getMessage());
    }

    // Test with an ID exceeding the maximum allowed length.
    $id_length_config_test = $storage
      ->create([
      'id' => $this
        ->randomMachineName(static::MAX_ID_LENGTH + 1),
    ]);
    try {
      $status = $id_length_config_test
        ->save();
      $this
        ->fail(new FormattableMarkup("config_test entity with ID length @length exceeding the maximum allowed length of @max saved successfully", [
        '@length' => strlen($id_length_config_test
          ->id()),
        '@max' => static::MAX_ID_LENGTH,
      ]));
    } catch (ConfigEntityIdLengthException $e) {

      // Expected exception; just continue testing.
    }

    // Ensure that creating an entity with the same id as an existing one is not
    // possible.
    $same_id = $storage
      ->create([
      'id' => $config_test
        ->id(),
    ]);
    $this
      ->assertIdentical($same_id
      ->isNew(), TRUE);
    try {
      $same_id
        ->save();
      $this
        ->fail('Not possible to overwrite an entity entity.');
    } catch (EntityStorageException $e) {

      // Expected exception; just continue testing.
    }

    // Verify that renaming the ID returns correct status and properties.
    $ids = [
      $expected['id'],
      'second_' . $this
        ->randomMachineName(4),
      'third_' . $this
        ->randomMachineName(4),
    ];
    for ($i = 1; $i < 3; $i++) {
      $old_id = $ids[$i - 1];
      $new_id = $ids[$i];

      // Before renaming, everything should point to the current ID.
      $this
        ->assertIdentical($config_test
        ->id(), $old_id);
      $this
        ->assertIdentical($config_test
        ->getOriginalId(), $old_id);

      // Rename.
      $config_test
        ->set('id', $new_id);
      $this
        ->assertIdentical($config_test
        ->id(), $new_id);
      $status = $config_test
        ->save();
      $this
        ->assertIdentical($status, SAVED_UPDATED);
      $this
        ->assertIdentical($config_test
        ->isNew(), FALSE);

      // Verify that originalID points to new ID directly after renaming.
      $this
        ->assertIdentical($config_test
        ->id(), $new_id);
      $this
        ->assertIdentical($config_test
        ->getOriginalId(), $new_id);
    }

    // Test config entity prepopulation.
    \Drupal::state()
      ->set('config_test.prepopulate', TRUE);
    $config_test = $storage
      ->create([
      'foo' => 'bar',
    ]);
    $this
      ->assertEquals('baz', $config_test
      ->get('foo'), 'Initial value correctly populated');
  }

  /**
   * Tests CRUD operations through the UI.
   */
  public function testCRUDUI() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer site configuration',
    ]));
    $id = strtolower($this
      ->randomMachineName());
    $label1 = $this
      ->randomMachineName();
    $label2 = $this
      ->randomMachineName();
    $label3 = $this
      ->randomMachineName();
    $message_insert = new FormattableMarkup('%label configuration has been created.', [
      '%label' => $label1,
    ]);
    $message_update = new FormattableMarkup('%label configuration has been updated.', [
      '%label' => $label2,
    ]);
    $message_delete = new FormattableMarkup('The test configuration %label has been deleted.', [
      '%label' => $label2,
    ]);

    // Create a configuration entity.
    $edit = [
      'id' => $id,
      'label' => $label1,
    ];
    $this
      ->drupalPostForm('admin/structure/config_test/add', $edit, 'Save');
    $this
      ->assertUrl('admin/structure/config_test');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertRaw($message_insert);
    $this
      ->assertNoRaw($message_update);
    $this
      ->assertLinkByHref("admin/structure/config_test/manage/{$id}");

    // Update the configuration entity.
    $edit = [
      'label' => $label2,
    ];
    $this
      ->drupalPostForm("admin/structure/config_test/manage/{$id}", $edit, 'Save');
    $this
      ->assertUrl('admin/structure/config_test');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertNoRaw($message_insert);
    $this
      ->assertRaw($message_update);
    $this
      ->assertLinkByHref("admin/structure/config_test/manage/{$id}");
    $this
      ->assertLinkByHref("admin/structure/config_test/manage/{$id}/delete");

    // Delete the configuration entity.
    $this
      ->drupalGet("admin/structure/config_test/manage/{$id}");
    $this
      ->clickLink(t('Delete'));
    $this
      ->assertUrl("admin/structure/config_test/manage/{$id}/delete");
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertUrl('admin/structure/config_test');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertNoRaw($message_update);
    $this
      ->assertRaw($message_delete);
    $this
      ->assertNoText($label1);
    $this
      ->assertNoLinkByHref("admin/structure/config_test/manage/{$id}");

    // Re-create a configuration entity.
    $edit = [
      'id' => $id,
      'label' => $label1,
    ];
    $this
      ->drupalPostForm('admin/structure/config_test/add', $edit, 'Save');
    $this
      ->assertUrl('admin/structure/config_test');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertText($label1);
    $this
      ->assertLinkByHref("admin/structure/config_test/manage/{$id}");

    // Rename the configuration entity's ID/machine name.
    $edit = [
      'id' => strtolower($this
        ->randomMachineName()),
      'label' => $label3,
    ];
    $this
      ->drupalPostForm("admin/structure/config_test/manage/{$id}", $edit, 'Save');
    $this
      ->assertUrl('admin/structure/config_test');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertNoText($label1);
    $this
      ->assertNoText($label2);
    $this
      ->assertText($label3);
    $this
      ->assertNoLinkByHref("admin/structure/config_test/manage/{$id}");
    $id = $edit['id'];
    $this
      ->assertLinkByHref("admin/structure/config_test/manage/{$id}");

    // Create a configuration entity with '0' machine name.
    $edit = [
      'id' => '0',
      'label' => '0',
    ];
    $this
      ->drupalPostForm('admin/structure/config_test/add', $edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $message_insert = new FormattableMarkup('%label configuration has been created.', [
      '%label' => $edit['label'],
    ]);
    $this
      ->assertRaw($message_insert);
    $this
      ->assertLinkByHref('admin/structure/config_test/manage/0');
    $this
      ->assertLinkByHref('admin/structure/config_test/manage/0/delete');
    $this
      ->drupalPostForm('admin/structure/config_test/manage/0/delete', [], 'Delete');
    $storage = \Drupal::entityTypeManager()
      ->getStorage('config_test');
    $this
      ->assertNull($storage
      ->load(0), 'Test entity deleted');

    // Create a configuration entity with a property that uses AJAX to show
    // extra form elements. Test this scenario in a non-JS case by using a
    // 'js-hidden' submit button.
    // @see \Drupal\Tests\config\FunctionalJavascript\ConfigEntityTest::testAjaxOnAddPage()
    $this
      ->drupalGet('admin/structure/config_test/add');
    $id = strtolower($this
      ->randomMachineName());
    $edit = [
      'id' => $id,
      'label' => $this
        ->randomString(),
      'size' => 'custom',
    ];
    $this
      ->assertFieldByName('size');
    $this
      ->assertNoFieldByName('size_value');
    $this
      ->drupalPostForm(NULL, $edit, 'Change size');
    $this
      ->assertFieldByName('size');
    $this
      ->assertFieldByName('size_value');

    // Submit the form with the regular 'Save' button and check that the entity
    // values are correct.
    $edit += [
      'size_value' => 'medium',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $entity = $storage
      ->load($id);
    $this
      ->assertEquals('custom', $entity
      ->get('size'));
    $this
      ->assertEquals('medium', $entity
      ->get('size_value'));
  }

}

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::setUp protected function 475
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.
ConfigEntityTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigEntityTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
ConfigEntityTest::MAX_ID_LENGTH constant The maximum length for the entity storage used in this test.
ConfigEntityTest::testCRUD public function Tests CRUD operations.
ConfigEntityTest::testCRUDUI public function Tests CRUD operations through the UI.
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.