You are here

Home » API reference » Relation 8.2 » RelationAPITest.php

class RelationAPITest in Relation 8.2

Same name and namespace in other branches
  1. 8 src/Tests/RelationAPITest.php \Drupal\relation\Tests\RelationAPITest

Test general API for Relation.

Create nodes, add relations and verify that they are related. This test suite also checks all methods available in RelationQuery.

@group Relation

Hierarchy

Expanded class hierarchy of RelationAPITest

File

src/Tests/RelationAPITest.php, line 17

Namespace

Drupal\relation\Tests
View source 
class RelationAPITest extends RelationTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'taxonomy',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {

    // This is necessary for the ->sort('created', 'DESC') test.
    $this->sleep = TRUE;
    parent::setUp();

    // Defines users and permissions.
    $permissions = [
      // Node.
      'create article content',
      'create page content',
      // Relation.
      'administer relation types',
      'administer relations',
      'access relations',
      'create relations',
      'edit relations',
      'delete relations',
    ];
    $this->web_user = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($this->web_user);
  }

  /**
   * Test relation helper functions.
   */
  public function testRelationHelpers() {

    // ## Test relationExists() method of entity repository relation service.
    // Where relation type is set.
    $exists = $this->container
      ->get('entity.repository.relation')
      ->relationExists($this->endpoints, $this->relation_type_symmetric);
    $this
      ->verbose(print_r($exists, TRUE));
    $this
      ->assertTrue(isset($exists[$this->relation_id_symmetric]), 'Relation exists.');

    // Where relation type is not set.
    $exists = $this->container
      ->get('entity.repository.relation')
      ->relationExists($this->endpoints_4);
    $this
      ->assertTrue(isset($exists[$this->relation_id_octopus]), 'Relation exists.');

    // Where endpoints does not exist.
    $endpoints_do_not_exist = $this->endpoints;
    $endpoints_do_not_exist[1]['target_type'] = $this
      ->randomMachineName();
    $this
      ->assertEqual(array(), $this->container
      ->get('entity.repository.relation')
      ->relationExists($endpoints_do_not_exist, $this->relation_type_symmetric), 'Relation with non-existant endpoint not found.');

    // Where there are too many endpoints.
    $endpoints_excessive = $this->endpoints;
    $endpoints_excessive[] = [
      'target_type' => $this
        ->randomMachineName(),
      'target_id' => 1000,
    ];
    $this
      ->assertEqual(array(), $this->container
      ->get('entity.repository.relation')
      ->relationExists($endpoints_do_not_exist, $this->relation_type_symmetric), 'Relation with too many endpoints not found.');

    // Where relation type is invalid.
    $this
      ->assertEqual(array(), $this->container
      ->get('entity.repository.relation')
      ->relationExists($this->endpoints, $this
      ->randomMachineName()), 'Relation with invalid relation type not found.');
  }

  /**
   * Tests all available methods in RelationQuery.
   *
   * Creates some nodes, add some relations and checks if they are related.
   */
  public function testRelationQuery() {
    $relations = Relation::loadMultiple(array_keys(relation_query('node', $this->node1
      ->id())
      ->execute()));

    // Check that symmetric relation is correctly related to node 4.
    $this
      ->assertEqual($relations[$this->relation_id_symmetric]->endpoints[1]->target_id, $this->node4
      ->id(), 'Correct entity is related: ' . $relations[$this->relation_id_symmetric]->endpoints[1]->target_id . '==' . $this->node4
      ->id());

    // Symmetric relation is Article 1 <--> Page 4
    // @see https://drupal.org/node/1760026
    $endpoints = [
      [
        'target_type' => 'node',
        'target_id' => $this->node4
          ->id(),
      ],
      [
        'target_type' => 'node',
        'target_id' => $this->node4
          ->id(),
      ],
    ];
    $exists = $this->container
      ->get('entity.repository.relation')
      ->relationExists($endpoints, 'symmetric');
    $this
      ->assertTrue(empty($exists), 'node4 is not related to node4.');

    // Get relations for node 1, should return 3 relations.
    $count = count($relations);
    $this
      ->assertEqual($count, 3);

    // Get number of relations for node 4, should return 6 relations.
    $count = relation_query('node', $this->node4
      ->id())
      ->count()
      ->execute();
    $this
      ->assertEqual($count, 6);

    // Get number of relations for node 5, should return 2 relations.
    $count = relation_query('node', $this->node5
      ->id())
      ->count()
      ->execute();
    $this
      ->assertEqual($count, 2);

    // Get relations between entities 2 and 5 (none).
    $query = relation_query('node', $this->node2
      ->id());
    $count = relation_query_add_related($query, 'node', $this->node5
      ->id())
      ->count()
      ->execute();
    $this
      ->assertFalse($count);

    // Get directed relations for node 3 using index, should return 2 relations.
    // The other node 3 relation has a delta 0.
    $relations = relation_query('node', $this->node3
      ->id(), 1)
      ->execute();
    $this
      ->assertEqual(count($relations), 3);
    $this
      ->assertTrue(isset($relations[$this->relation_id_directional]), 'Got the correct directional relation for nid=3.');

    // Get relations between entities 2 and 3 (octopus).
    $query = relation_query('node', $this->node2
      ->id());
    $relations = relation_query_add_related($query, 'node', $this->node3
      ->id())
      ->execute();
    $count = count($relations);
    $this
      ->assertEqual($count, 1);

    // Check that we have the correct relations.
    $this
      ->assertEqual(isset($relations[$this->relation_id_octopus]), 'Got one correct relation.');

    // Get relations for node 1 (symmetric, directional, octopus), limit to
    // directional and octopus with relation_type().
    $relations = relation_query('node', $this->node1
      ->id());
    $or_condition = $relations
      ->orConditionGroup()
      ->condition('relation_type', $this->relation_types['directional']['id'])
      ->condition('relation_type', $this->relation_types['octopus']['id']);
    $relations = $relations
      ->condition($or_condition)
      ->execute();
    $count = count($relations);
    $this
      ->assertEqual($count, 2);

    // Check that we have the correct relations.
    $this
      ->assertTrue(isset($relations[$this->relation_id_directional]), 'Got one correct relation.');
    $this
      ->assertTrue(isset($relations[$this->relation_id_octopus]), 'Got a second one.');

    // Get last two relations for node 1.
    $relations = relation_query('node', $this->node1
      ->id())
      ->range(1, 2)
      ->sort('relation_id', 'ASC')
      ->execute();
    $count = count($relations);
    $this
      ->assertEqual($count, 2);

    // Check that we have the correct relations.
    $this
      ->assertTrue(isset($relations[$this->relation_id_directional]), 'Got one correct relation.');
    $this
      ->assertTrue(isset($relations[$this->relation_id_octopus]), 'Got a second one.');

    // Get all relations on node 1 and sort them in reverse created order.
    $relations = relation_query('node', $this->node1
      ->id())
      ->sort('created', 'DESC')
      ->execute();
    $this
      ->assertEqual($relations, [
      $this->relation_id_octopus => $this->relation_id_octopus,
      $this->relation_id_directional => $this->relation_id_directional,
      $this->relation_id_symmetric => $this->relation_id_symmetric,
    ]);

    // Create 10 more symmetric relations and verify that the count works with
    // double digit counts as well.
    for ($i = 0; $i < 10; $i++) {
      $this
        ->createRelationSymmetric();
    }
    $count = relation_query('node', $this->node4
      ->id())
      ->count()
      ->execute();
    $this
      ->assertEqual($count, 16);
  }

  /**
   * Tests relation types.
   */
  public function testRelationTypes() {

    // Symmetric.
    $related = relation_get_related_entity('node', $this->node1
      ->id());
    $this
      ->assertEqual($this->node4
      ->id(), $related
      ->id());

    // Confirm this works once the related entity has been cached.
    $related = relation_get_related_entity('node', $this->node1
      ->id());
    $this
      ->assertEqual($this->node4
      ->id(), $related
      ->id());

    // Directional.
    // From Parent to Grandparent.
    $directional_relation_type = RelationType::load($this->relation_types['directional']['id']);
    $related = relation_get_related_entity('node', $this->node3
      ->id(), $directional_relation_type
      ->id(), 1);
    $this
      ->assertEqual($this->node1
      ->id(), $related
      ->id());

    // From Parent to Child.
    $related = relation_get_related_entity('node', $this->node3
      ->id(), $directional_relation_type
      ->id(), 0);
    $this
      ->assertEqual($this->node4
      ->id(), $related
      ->id());

    // Test labels.
    $this
      ->assertEqual($directional_relation_type
      ->label(), 'directional');
    $this
      ->assertEqual($directional_relation_type
      ->reverseLabel(), 'reverse_directional');
    $test_relation_type = RelationType::create([
      'id' => 'test_relation_type',
    ]);
    $test_relation_type
      ->save();
    $this
      ->assertEqual($test_relation_type
      ->label(), 'test_relation_type');
    $this
      ->assertEqual($test_relation_type
      ->reverseLabel(), 'test_relation_type');

    // Delete all relations related to node 4, then confirm that these can
    // no longer be found as related entities.
    $relation_ids = relation_query('node', $this->node4
      ->id())
      ->execute();
    foreach (Relation::loadMultiple($relation_ids) as $relation) {
      $relation
        ->delete();
    }
    $this
      ->assertFalse(relation_get_related_entity('node', $this->node4
      ->id()), 'The entity was not loaded after the relation was deleted.');

    // Test get available relation types .
    $available_articles = $this->container
      ->get('entity.repository.relation')
      ->getAvailable('node', 'article');
    $article_labels = [];
    foreach ($available_articles as $relation) {
      $article_labels[] = $relation
        ->label();
    }

    // Expect 3 available relation types for node article.
    $this
      ->assertEqual($article_labels, [
      'directional',
      'octopus',
      'symmetric',
    ]);
    $available_users = $this->container
      ->get('entity.repository.relation')
      ->getAvailable('user', '*');
    $user_labels = [];
    foreach ($available_users as $relation) {
      $user_labels[] = $relation
        ->label();
    }

    // Expect 2 available relation types for user.
    $this
      ->assertEqual($user_labels, [
      'directional_entitydifferent',
      'symmetric',
    ]);
  }

  /**
   * Tests saving of relations.
   */
  public function testRelationSave() {
    foreach ($this->relation_types as $value) {
      $relation_type = $value['id'];
      $endpoints = $this->endpoints;
      if (isset($value['min_arity'])) {
        $endpoints = $value['min_arity'] == 1 ? $this->endpoints_unary : $this->endpoints_4;
      }
      if ($relation_type == 'directional_entitydifferent') {
        $endpoints = $this->endpoints_entitydifferent;
      }
      $relation = Relation::create(array(
        'relation_type' => $relation_type,
      ));
      $relation->endpoints = $endpoints;
      $relation
        ->save();
      $this
        ->assertTrue($relation
        ->id(), 'Relation created.');
      $count = count($relation->endpoints);
      $this
        ->assertEqual($count, count($endpoints));
      $this
        ->assertEqual($relation->arity->value, count($endpoints));
      $this
        ->assertEqual($relation
        ->bundle(), $relation_type);
      foreach ($relation->endpoints as $endpoint) {
        $need_ids[$endpoint->target_id] = TRUE;
      }
      foreach ($relation->endpoints as $delta => $endpoint) {
        $this
          ->assertEqual($endpoint->target_type, $endpoints[$delta]['target_type'], 'The entity type is ' . $endpoints[$delta]['target_type'] . ': ' . $endpoint->target_type);
        $this
          ->assertTrue(isset($need_ids[$endpoint->target_id]), 'The entity ID is correct: ' . $need_ids[$endpoint->target_id]);
        unset($need_ids[$endpoint->target_id]);
      }
      $this
        ->assertFalse($need_ids, 'All ids found.');

      // Confirm the relation_id in revision table.
      $revision = \Drupal::database()
        ->select('relation_revision', 'v')
        ->fields('v', array(
        'relation_id',
      ))
        ->condition('revision_id', $relation
        ->getRevisionId())
        ->execute()
        ->fetchAllAssoc('relation_id');
      $this
        ->assertTrue(array_key_exists($relation
        ->id(), $revision), 'Relation revision created.');
    }
  }

  /**
   * Tests relation delete.
   */
  public function testRelationDelete() {

    // Invalid relations are deleted when any endpoint entity is deleted.
    // Octopus relation is valid with 3 endpoints, currently it has 4.
    $this->node1
      ->delete();
    $this
      ->assertTrue(Relation::load($this->relation_id_octopus), 'Relation is not deleted.');
    $this->node2
      ->delete();
    $this
      ->assertFalse(Relation::load($this->relation_id_octopus), 'Relation is deleted.');
  }

  /**
   * Tests relation revisions.
   */
  public function testRelationRevision() {

    /* todo Uncomment when revisions are fixed.
        $first_user = $this->drupalCreateUser(['edit relations']);
        $second_user = $this->drupalCreateUser(['edit relations']);

        $this->drupalLogin($first_user);
        $relation = Relation::create(array('relation_type' => $this->relation_type_octopus));
        $relation->endpoints = $this->endpoints_4;
        $relation->save();
        $relation_id = $relation->id();
        $this->assertEqual($relation->id(), $first_user->id(), 'Relation uid set to logged in user.');
        $revision_id = $relation->getRevisionId();

        // Relation should still be owned by the first user.
        $this->drupalLogin($second_user);
        $relation = Relation::load($relation_id);
        $relation = $this->container->get('entity_type.manager')->getStorage('relation')->load($relation_id);
        $relation->save();
        $this->assertEqual($relation->id(), $first_user->id(), 'Relation uid did not get changed to a user different to original.');

        // Relation revision authors should not be identical though.
        $first_revision = $this->container->get('entity_type.manager')->getStorage('relation')->loadRevision($revision_id);
        $second_revision = $this->container->get('entity_type.manager')->getStorage('relation')->loadRevision($relation->getRevisionId());
        $this->assertNotIdentical($first_revision->revision_uid, $second_revision->revision_uid, 'Each revision has a distinct user.');
        */
  }

  /**
   * Tests endpoints field validation.
   */
  public function testEndpointsFieldValidation() {
    \Drupal::entityTypeManager()
      ->getStorage('relation_type')
      ->create([
      'id' => 'test_relation_type',
      'label' => 'Test relation type',
      'source_bundles' => [
        'node:article',
      ],
    ])
      ->save();
    $relation = \Drupal::entityTypeManager()
      ->getStorage('relation')
      ->create([
      'relation_type' => 'test_relation_type',
    ]);
    $relation
      ->save();

    // Create relation with article node type.
    $relation->endpoints = [
      [
        'target_type' => 'node',
        'target_id' => $this->node1
          ->id(),
      ],
    ];
    $violations = $relation->endpoints
      ->validate();
    $this
      ->assertEqual(count($violations), 0, 'Allowed source bundle passed validation.');

    // Create relation with page node type.
    $relation->endpoints = [
      [
        'target_type' => 'node',
        'target_id' => $this->node3
          ->id(),
      ],
    ];
    $violations = $relation->endpoints
      ->validate();
    $this
      ->assertEqual(count($violations), 1);
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('Referenced entity %label does not belong to one of the supported bundles (%bundles).', [
      '%label' => $this->node3
        ->label(),
      '%bundles' => 'article',
    ]), 'Not allowed source bundle failed validation.');

    // Test endpoints with unsupported entity type.
    $vocabulary = \Drupal::entityTypeManager()
      ->getStorage('taxonomy_vocabulary')
      ->create([
      'vid' => 'test_vocabulary',
      'name' => $this
        ->randomMachineName(),
    ]);
    $vocabulary
      ->save();
    $term = \Drupal::entityTypeManager()
      ->getStorage('taxonomy_term')
      ->create([
      'name' => $this
        ->randomMachineName(),
      'vid' => $vocabulary
        ->id(),
    ]);
    $term
      ->save();
    $relation->endpoints = [
      [
        'target_type' => 'taxonomy_term',
        'target_id' => $term
          ->id(),
      ],
    ];
    $violations = $relation->endpoints
      ->validate();
    $this
      ->assertEqual(count($violations), 1);
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('No bundle is allowed for (%type)', [
      '%type' => 'taxonomy_term',
    ]), 'Not allowed entity failed validation.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags protected function Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
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
CronRunTrait::cronRun protected function Runs cron on the test site.
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
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.
GeneratePermutationsTrait::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
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
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
RelationAPITest::$modules public static property Load all dependencies since d.o testbot is fussy. Overrides RelationTestBase::$modules
RelationAPITest::setUp public function Sets up a Drupal site for running functional and integration tests. Overrides RelationTestBase::setUp
RelationAPITest::testEndpointsFieldValidation public function Tests endpoints field validation.
RelationAPITest::testRelationDelete public function Tests relation delete.
RelationAPITest::testRelationHelpers public function Test relation helper functions.
RelationAPITest::testRelationQuery public function Tests all available methods in RelationQuery.
RelationAPITest::testRelationRevision public function Tests relation revisions.
RelationAPITest::testRelationSave public function Tests saving of relations.
RelationAPITest::testRelationTypes public function Tests relation types.
RelationTestBase::$sleep protected property
RelationTestBase::createRelationDirectional protected function Creates a Directional relation.
RelationTestBase::createRelationEndPoints protected function Creates end points.
RelationTestBase::createRelationNodes protected function Creates nodes.
RelationTestBase::createRelationOctopus protected function Creates an Octopus (4-ary) relation.
RelationTestBase::createRelationSymmetric protected function Creates a Symmetric relation.
RelationTestBase::createRelationTypes protected function Creates a set of standard relation types.
RelationTestBase::createRelationUnary protected function Creates an Unary relation.
RelationTestBase::createRelationUsers protected function Create users for relation tests.
RelationTestBase::saveRelation protected function Saves a relation.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$results public property Current results of this test case.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::checkRequirements protected function Checks the matching requirements for Test. 1
TestBase::checkTestHierarchyMismatch public function Fail the test if it belongs to a PHPUnit-based framework.
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert Deprecated public static function Store an assertion from outside the testing context. 1
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests. Overrides TestSetupTrait::prepareDatabasePrefix
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 2
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database. 1
TestBase::verbose protected function Logs a verbose message in a text file.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name. Aliased as: drupalCompareFiles
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 1
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 2
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code. 1
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 1
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header. 1
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. 1
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 1
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::__construct public function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.