You are here

class EntityStorageTest in Multiversion 8

Test the content entity storage controller.

@group multiversion

Hierarchy

Expanded class hierarchy of EntityStorageTest

File

tests/src/Functional/EntityStorageTest.php, line 14

Namespace

Drupal\Tests\multiversion\Functional
View source
class EntityStorageTest extends MultiversionFunctionalTestBase {

  /**
   * The entity types to test.
   *
   * @var array
   */
  protected $entityTypes = [
    'entity_test' => [
      'info' => [],
      'data_table' => 'entity_test',
      'revision_table' => 'entity_test_revision',
      'id' => 'id',
    ],
    'entity_test_rev' => [
      'info' => [],
      'data_table' => 'entity_test_rev',
      'revision_table' => 'entity_test_rev_revision',
      'id' => 'id',
    ],
    'entity_test_mul' => [
      'info' => [],
      'data_table' => 'entity_test_mul_property_data',
      'revision_table' => 'entity_test_mul_field_revision',
      'id' => 'id',
    ],
    'entity_test_mulrev' => [
      'info' => [],
      'data_table' => 'entity_test_mulrev_property_data',
      'revision_table' => 'entity_test_mulrev_property_revision',
      'id' => 'id',
    ],
    'node' => [
      'info' => [
        'type' => 'article',
        'title' => 'New article',
      ],
      'data_table' => 'node_field_data',
      'revision_table' => 'node_field_revision',
      'id' => 'nid',
    ],
    'taxonomy_term' => [
      'info' => [
        'name' => 'A term',
        'vid' => 123,
      ],
      'data_table' => 'taxonomy_term_field_data',
      'revision_table' => 'taxonomy_term_field_revision',
      'id' => 'tid',
    ],
    'comment' => [
      'info' => [
        'entity_type' => 'node',
        'field_name' => 'comment',
        'subject' => 'How much wood would a woodchuck chuck',
        'mail' => 'someone@example.com',
      ],
      'data_table' => 'comment_field_data',
      'revision_table' => 'comment_field_revision',
      'id' => 'cid',
    ],
    'block_content' => [
      'info' => [
        'info' => 'New block',
        'type' => 'basic',
      ],
      'data_table' => 'block_content_field_data',
      'revision_table' => 'block_content_field_revision',
      'id' => 'id',
    ],
    'menu_link_content' => [
      'info' => [
        'menu_name' => 'menu_test',
        'bundle' => 'menu_link_content',
        'link' => [
          [
            'uri' => 'user-path:/',
          ],
        ],
      ],
      'data_table' => 'menu_link_content_data',
      'revision_table' => 'menu_link_content_field_revision',
      'id' => 'id',
    ],
    'shortcut' => [
      'info' => [
        'shortcut_set' => 'default',
        'title' => 'Llama',
        'weight' => 0,
        'link' => [
          [
            'uri' => 'internal:/admin',
          ],
        ],
      ],
      'data_table' => 'shortcut_field_data',
      'revision_table' => 'shortcut_field_revision',
      'id' => 'id',
    ],
    'file' => [
      'info' => [
        'uid' => 1,
        'filename' => 'drupal.txt',
        'uri' => 'public://drupal.txt',
        'filemime' => 'text/plain',
        'status' => 1,
      ],
      'data_table' => 'file_managed',
      'revision_table' => 'file_revision',
      'id' => 'fid',
    ],
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    foreach ($this->entityTypes as $entity_type_id => $info) {
      $this->entityTypes[$entity_type_id]['revision_id'] = $entity_type_id == 'node' ? 'vid' : 'revision_id';
      if ($entity_type_id == 'node' || $entity_type_id == 'menu_link_content') {
        $this->entityTypes[$entity_type_id]['name'] = 'title';
      }
      elseif ($entity_type_id == 'block_content') {
        $this->entityTypes[$entity_type_id]['name'] = 'info';
      }
      else {
        $this->entityTypes[$entity_type_id]['name'] = 'name';
      }
      if ($entity_type_id == 'file') {
        file_put_contents($info['info']['uri'], 'Hello world!');
        $this
          ->assertTrue($info['info']['uri'], t('The test file has been created.'));
      }
    }
  }
  public function testEntityStorage() {

    // Test save and load.
    foreach ($this->entityTypes as $entity_type_id => $info) {
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
      $message = "{$entity_type_id} has the correct storage handler.";
      if ($storage instanceof ContentEntityStorageInterface) {
        $this
          ->pass($message);
      }
      else {
        $this
          ->fail($message);

        // No idea to continue because things will completely blow up.
        continue;
      }
      $ids = [];
      $entity = $storage
        ->create($info['info']);
      $return = $entity
        ->save();
      $this
        ->assertEqual($return, SAVED_NEW, "{$entity_type_id} was saved.");
      $ids[] = $entity
        ->id();
      $loaded = $storage
        ->load($ids[0]);
      $this
        ->assertEqual($ids[0], $loaded
        ->id(), "Single {$entity_type_id} was loaded.");

      // Load the entity with EntityRepository::loadEntityByUuid().
      $loaded = \Drupal::service('entity.repository')
        ->loadEntityByUuid($entity_type_id, $entity
        ->uuid());
      $this
        ->assertEqual($ids[0], $loaded
        ->id(), "Single {$entity_type_id} was loaded with loadEntityByUuid().");

      // Update and save a new revision.
      $entity->{$info['name']} = $this
        ->randomMachineName();
      $entity
        ->save();

      // For user entity type we should have 4 entities: anonymous, root
      // user, test user and the new created user. For other entity types we should have
      // just the new created entity.
      $revision_id = 1;

      /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */
      $revision = $storage
        ->loadRevision($revision_id);
      $this
        ->assertTrue($revision
        ->getRevisionId() == $revision_id && !$revision
        ->isDefaultRevision(), "Old revision of {$entity_type_id} was loaded.");
      $entity = $storage
        ->create($info['info']);
      $entity
        ->save();
      $ids[] = $entity
        ->id();
      $entities = $storage
        ->loadMultiple($ids);
      $this
        ->assertEqual(count($entities), 2, "Multiple {$entity_type_id} was loaded.");

      // Test delete.
      $entity = $storage
        ->create($info['info']);
      $entity
        ->save();
      $id = $entity
        ->id();
      $revision_id = $entity
        ->getRevisionId();
      $entities = $storage
        ->loadMultiple([
        $id,
      ]);
      $storage
        ->delete($entities);
      $connection = Database::getConnection();
      $record = $connection
        ->select($info['revision_table'], 'e')
        ->fields('e')
        ->condition('e.' . $info['id'], $id)
        ->condition('e.' . $info['revision_id'], $revision_id + 1)
        ->execute()
        ->fetchObject();
      $this
        ->assertEqual($record->_deleted, 1, "Deleted {$entity_type_id} is still stored but flagged as deleted");
      $entity = $storage
        ->load($id);
      $this
        ->assertTrue(empty($entity), "Deleted {$entity_type_id} did not load with entity_load() function.");
      $entity = $storage
        ->loadDeleted($id);
      $this
        ->assertTrue(!empty($entity), "Deleted {$entity_type_id} loaded with loadDeleted() method.");
      $this
        ->assertNotEqual($revision_id, $entity
        ->getRevisionId(), "New revision was generated when deleting {$entity_type_id}.");
      $entities = $storage
        ->loadMultipleDeleted([
        $id,
      ]);
      $this
        ->assertTrue(!empty($entities), "Deleted {$entity_type_id} loaded with loadMultipleDeleted() method.");

      // Test revisions.
      $entity = $storage
        ->create($info['info']);
      $entity
        ->save();
      $id = $entity
        ->id();
      $revision_id = $entity
        ->getRevisionId();
      $revision = $storage
        ->loadRevision($revision_id);
      $this
        ->assertEqual($revision_id, $revision
        ->getRevisionId(), "{$entity_type_id} revision was loaded");
      $entities = $storage
        ->loadMultiple([
        $id,
      ]);
      $storage
        ->delete($entities);
      $new_revision_id = $revision_id + 1;
      $revision = $storage
        ->loadRevision($new_revision_id);
      $this
        ->assertTrue($revision->_deleted->value == TRUE && $revision
        ->getRevisionId() == $new_revision_id, "Deleted {$entity_type_id} was loaded.");

      // Test exceptions.
      $entity_type = $this->entityTypeManager
        ->getDefinition($entity_type_id);
      $id_key = $entity_type
        ->getKey('id');

      // Test with exception upon first save.
      $entity = $storage
        ->create($info['info']);
      $uuid = $entity->uuid->value;
      try {

        // Trigger an error by setting the ID too large.
        $entity->{$id_key}->value = PHP_INT_MAX;
        $entity
          ->save();
        $this
          ->fail('Exception was not generated.');
      } catch (\Exception $e) {
        $first_rev = $entity->_rev->value;
        $rev_info = $this->revIndex
          ->get("{$uuid}:{$first_rev}");
        $this
          ->assertEqual($rev_info['status'], 'indexed', 'First revision was indexed after exception on first save.');
      }

      // Re-save the same entity with a valid ID.
      $entity->{$id_key}->value = NULL;
      $entity
        ->save();
      $second_rev = $entity->_rev->value;
      $this
        ->assertEqual($first_rev, $second_rev, 'New revision was not generated after first re-save.');
      $rev_info = $this->revIndex
        ->get("{$uuid}:{$first_rev}");
      $this
        ->assertEqual($rev_info['status'], 'available', 'First revision is available after first re-save.');
      $default_branch = $this->revTree
        ->getDefaultBranch($uuid);
      $expected_default_branch = [
        $first_rev => 'available',
      ];
      $this
        ->assertEqual($default_branch, $expected_default_branch, 'Default branch was built after exception on first save followed by re-save.');

      // Test with exception upon second save.
      $entity = $storage
        ->create($info['info']);
      $uuid = $entity->uuid->value;
      $entity
        ->save();
      $first_id = $entity
        ->id();
      $first_rev = $entity->_rev->value;
      try {

        // Trigger an error by setting the ID too large.
        $entity->{$id_key}->value = PHP_INT_MAX;
        $entity
          ->save();
        $this
          ->fail('Exception was not generated.');
      } catch (\Exception $e) {
        $second_rev = $entity->_rev->value;
        $rev_info = $this->revIndex
          ->get("{$uuid}:{$second_rev}");
        $this
          ->assertEqual($rev_info['status'], 'indexed', 'Second revision was indexed after exception on second save.');
      }

      // Re-save the same entity with a valid ID.
      $entity->{$id_key}->value = $first_id;
      $entity
        ->save();
      $third_rev = $entity->_rev->value;
      $this
        ->assertEqual($second_rev, $third_rev, 'New revision was not generated after second re-save.');
      $rev_info = $this->revIndex
        ->get("{$uuid}:{$second_rev}");
      $this
        ->assertEqual($rev_info['status'], 'available', 'Third revision is available after second re-save.');
      $default_branch = $this->revTree
        ->getDefaultBranch($uuid);
      $expected_default_branch = [
        $first_rev => 'available',
        $second_rev => 'available',
      ];
      $this
        ->assertEqual($default_branch, $expected_default_branch, 'Default branch was built after exception on second save followed by re-save.');

      // Test workspace.
      if ($entity_type
        ->get('workspace') !== FALSE) {
        $entity = $storage
          ->create($info['info']);
        $entity
          ->save();
        $entity_id = $entity
          ->id();
        $this
          ->assertEqual($entity->workspace->target_id, 1, "The workspace reference was saved for {$entity_type_id}.");
        $record = $connection
          ->select($info['data_table'], 'e')
          ->fields('e')
          ->condition('e.' . $info['id'], $entity
          ->id())
          ->condition('e.' . $info['revision_id'], $entity
          ->getRevisionId())
          ->execute()
          ->fetchObject();
        $this
          ->assertEqual($record->workspace, 1, "The workspace reference was stored for saved {$entity_type_id}.");
        $entities = $storage
          ->loadMultiple([
          $entity_id,
        ]);
        $storage
          ->delete($entities);
        $entity = $storage
          ->loadDeleted($entity_id);
        $this
          ->assertEqual($entity->workspace->target_id, 1, "The workspace reference is retained for deleted {$entity_type_id}.");
        $record = $connection
          ->select($info['data_table'], 'e')
          ->fields('e')
          ->condition('e.' . $info['id'], $entity
          ->id())
          ->condition('e.' . $info['revision_id'], $entity
          ->getRevisionId())
          ->execute()
          ->fetchObject();
        $this
          ->assertEqual($record->workspace, 1, "The workspace reference was stored for deleted {$entity_type_id}.");
      }
    }

    // Test saving entities in a different workspace.
    // Create a new workspace and switch to it.
    $workspace = Workspace::create([
      'machine_name' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomMachineName(),
      'type' => 'basic',
    ]);
    $workspace
      ->save();
    $this->workspaceManager
      ->setActiveWorkspace($workspace);
    foreach ($this->entityTypes as $entity_type_id => $info) {
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
      $entity = $storage
        ->create($info['info']);
      $entity
        ->save();
      if ($entity
        ->getEntityType()
        ->get('workspace') !== FALSE) {
        $this
          ->assertEqual($entity->workspace->target_id, $workspace
          ->id(), "{$entity_type_id} was saved in new workspace.");
      }
    }
    $uuids = [];
    $ids = [];
    foreach ($this->entityTypes as $entity_type_id => $info) {
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
      $entity = $storage
        ->create($info['info']);
      $entity
        ->save();
      $uuids[$entity_type_id] = $entity
        ->uuid();
      $ids[$entity_type_id] = $entity
        ->id();
      $entity = $storage
        ->load($ids[$entity_type_id]);
      $this
        ->assertTrue(!empty($entity), "{$entity_type_id} was loaded in the workspace it belongs to.");
    }

    // Switch back to the original workspace and check that the entities does
    // NOT exists here.
    $this->multiversionManager
      ->setActiveWorkspaceId(1);
    foreach ($this->entityTypes as $entity_type_id => $info) {
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
      $entity = $storage
        ->load($ids[$entity_type_id]);
      $this
        ->assertTrue(empty($entity), "{$entity_type_id} was not loaded in a workspace it does not belongs to.");
    }

    // Test saving the same entity in two workspaces. This is a simplified
    // simulation of replication.
    $source = Workspace::create([
      'machine_name' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomMachineName(),
      'type' => 'basic',
    ]);
    $source
      ->save();
    $target = Workspace::create([
      'machine_name' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomMachineName(),
      'type' => 'basic',
    ]);
    $target
      ->save();

    // Save an initial set of entities on source.
    $this->workspaceManager
      ->setActiveWorkspace($source);
    $entities = [];
    foreach ($this->entityTypes as $entity_type_id => $info) {
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
      $entity = $storage
        ->create($info['info']);
      $entity
        ->save();
      $entities[$entity_type_id][$entity
        ->uuid()] = $entity;
    }

    // Save the same entities on target as new entities, but with the same UUID.
    $this->workspaceManager
      ->setActiveWorkspace($target);
    foreach ($this->entityTypes as $entity_type_id => $info) {

      /** @var \Drupal\Core\Entity\ContentEntityInterface $source_entity */
      foreach ($entities[$entity_type_id] as $source_entity) {
        if ($source_entity
          ->getEntityType()
          ->get('workspace') !== FALSE) {
          $target_entity = clone $source_entity;

          // Reset the ID and assign the new workspace.
          $target_entity->{$info['id']}->value = NULL;
          $target_entity
            ->enforceIsNew(TRUE);
          $target_entity->workspace->target_id = $target
            ->id();

          // Save the new entity
          $target_entity
            ->save();
          $this
            ->assertTrue(!empty($target_entity
            ->id()), "{$entity_type_id} in the target workspace got a new entity ID");
          $this
            ->assertEqual($target_entity
            ->uuid(), $source_entity
            ->uuid(), "Entities from source and target share the same UUID");
          $this
            ->assertNotEqual($target_entity
            ->id(), $source_entity
            ->id(), "Entities from source and target does not share the same local ID");
          $this
            ->assertEqual($target_entity->workspace->entity
            ->id(), $target
            ->id(), "Entity in target workspace");
        }
      }
    }
  }

}

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::$defaultTheme protected property The theme to install as the default for testing. 1,597
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.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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
EntityStorageTest::$entityTypes protected property The entity types to test.
EntityStorageTest::setUp protected function Overrides MultiversionFunctionalTestBase::setUp
EntityStorageTest::testEntityStorage public function
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.
MultiversionFunctionalTestBase::$entityDefinitionUpdateManager protected property The entity definition update manager.
MultiversionFunctionalTestBase::$entityTypeManager protected property The entity type manager service.
MultiversionFunctionalTestBase::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 4
MultiversionFunctionalTestBase::$multiversionManager protected property The multiversion manager.
MultiversionFunctionalTestBase::$revIndex protected property
MultiversionFunctionalTestBase::$revTree protected property
MultiversionFunctionalTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. Overrides TestSetupTrait::$strictConfigSchema 1
MultiversionFunctionalTestBase::$uuidIndex protected property
MultiversionFunctionalTestBase::$workspaceManager protected property The workspace manager. 2
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::$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.