You are here

Home » API reference » Entity Usage 8.3 » EntityUsageTest.php

class EntityUsageTest in Entity Usage 8.3

Same name and namespace in other branches
  1. 8.4 tests/src/Kernel/EntityUsageTest.php \Drupal\Tests\entity_usage\Kernel\EntityUsageTest
  2. 8 tests/src/Kernel/EntityUsageTest.php \Drupal\Tests\entity_usage\Kernel\EntityUsageTest
  3. 8.2 tests/src/Kernel/EntityUsageTest.php \Drupal\Tests\entity_usage\Kernel\EntityUsageTest

Tests the basic API operations of our tracking service.

@group entity_usage

@package Drupal\Tests\entity_usage\Kernel

Hierarchy

Expanded class hierarchy of EntityUsageTest

File

tests/src/Kernel/EntityUsageTest.php, line 18

Namespace

Drupal\Tests\entity_usage\Kernel
View source 
class EntityUsageTest extends EntityKernelTestBase {

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

  /**
   * The entity type used in this test.
   *
   * @var string
   */
  protected $entityType = 'entity_test';

  /**
   * The bundle used in this test.
   *
   * @var string
   */
  protected $bundle = 'entity_test';

  /**
   * Some test entities.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected $testEntities;

  /**
   * The injected database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $injectedDatabase;

  /**
   * The name of the table that stores entity usage information.
   *
   * @var string
   */
  protected $tableName;

  /**
   * State service for recording information received by event listeners.
   *
   * @var \Drupal\Core\State\State
   */
  protected $state;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->injectedDatabase = $this->container
      ->get('database');
    $this
      ->installSchema('entity_usage', [
      'entity_usage',
    ]);
    $this->tableName = 'entity_usage';

    // Create two test entities.
    $this->testEntities = $this
      ->getTestEntities();
    $this->state = $this->container
      ->get('state');
    $event_dispatcher = $this->container
      ->get('event_dispatcher');
    $event_dispatcher
      ->addListener(Events::USAGE_REGISTER, [
      $this,
      'usageRegisterEventRecorder',
    ]);
    $event_dispatcher
      ->addListener(Events::USAGE_DELETE, [
      $this,
      'usageDeleteEventRecorder',
    ]);
    $event_dispatcher
      ->addListener(Events::DELETE_BY_SOURCE_ENTITY, [
      $this,
      'usageDeleteBySourceEntityEventRecorder',
    ]);
    $event_dispatcher
      ->addListener(Events::DELETE_BY_TARGET_ENTITY, [
      $this,
      'usageDeleteByTargetEntityEventRecorder',
    ]);
    $event_dispatcher
      ->addListener(Events::BULK_DELETE_DESTINATIONS, [
      $this,
      'usageBulkTargetDeleteEventRecorder',
    ]);
    $event_dispatcher
      ->addListener(Events::BULK_DELETE_SOURCES, [
      $this,
      'usageBulkSourceDeleteEventRecorder',
    ]);
  }

  /**
   * Tests the listSources() and listTargets() method.
   *
   * @covers \Drupal\entity_usage\EntityUsage::listSources
   * @covers \Drupal\entity_usage\EntityUsage::listTargets
   */
  public function testlistSources() {

    /** @var \Drupal\Core\Entity\EntityInterface $target_entity */
    $target_entity = $this->testEntities[0];

    /** @var \Drupal\Core\Entity\EntityInterface $source_entity */
    $source_entity = $this->testEntities[1];
    $source_vid = $source_entity instanceof RevisionableInterface && $source_entity
      ->getRevisionId() ? $source_entity
      ->getRevisionId() : 0;
    $this->injectedDatabase
      ->insert($this->tableName)
      ->fields([
      'target_id' => $target_entity
        ->id(),
      'target_type' => $target_entity
        ->getEntityTypeId(),
      'source_id' => $source_entity
        ->id(),
      'source_type' => $source_entity
        ->getEntityTypeId(),
      'source_langcode' => $source_entity
        ->language()
        ->getId(),
      'source_vid' => $source_vid,
    ])
      ->execute();

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');
    $real_source_list = $entity_usage
      ->listSources($target_entity);
    $expected_source_list = [
      $source_entity
        ->getEntityTypeId() => [
        (string) $source_entity
          ->id() => [
          0 => [
            'source_langcode' => $source_entity
              ->language()
              ->getId(),
            'source_vid' => $source_entity
              ->getRevisionId() ?: 0,
          ],
        ],
      ],
    ];
    $this
      ->assertEquals($expected_source_list, $real_source_list);
    $real_target_list = $entity_usage
      ->listTargets($source_entity);
    $expected_target_list = [
      $target_entity
        ->getEntityTypeId() => [
        (string) $target_entity
          ->id(),
      ],
    ];
    $this
      ->assertEquals($expected_target_list, $real_target_list);

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
  }

  /**
   * Tests the registerUsage() and deleteUsage() methods.
   *
   * @covers \Drupal\entity_usage\EntityUsage::registerUsage
   * @covers \Drupal\entity_usage\EntityUsage::deleteUsage
   */
  public function testRegisterUsage() {
    $entity = $this->testEntities[0];

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');

    // Register a new usage.
    $entity_usage
      ->registerUsage($entity
      ->id(), $entity
      ->getEntityTypeId(), 1, 'foo', 'en', 1);
    $event = \Drupal::state()
      ->get('entity_usage_events_test.usage_register', []);
    $this
      ->assertSame($event['event_name'], Events::USAGE_REGISTER);
    $this
      ->assertSame($event['target_id'], $entity
      ->id());
    $this
      ->assertSame($event['target_type'], $entity
      ->getEntityTypeId());
    $this
      ->assertSame($event['source_id'], 1);
    $this
      ->assertSame($event['source_type'], 'foo');
    $this
      ->assertSame($event['source_langcode'], 'en');
    $this
      ->assertSame($event['source_vid'], 1);
    $real_usage = $this->injectedDatabase
      ->select($this->tableName, 'e')
      ->fields('e', [])
      ->condition('e.target_id', $entity
      ->id())
      ->condition('e.target_type', $entity
      ->getEntityTypeId())
      ->execute()
      ->fetchAll();
    $this
      ->assertEquals(1, count($real_usage));

    // Check that trying to register an existing record does not fatal out.
    $entity_usage
      ->registerUsage($entity
      ->id(), $entity
      ->getEntityTypeId(), 1, 'foo', 'en', 1);

    // Delete the record.
    $entity_usage
      ->deleteUsage($entity
      ->id(), $entity
      ->getEntityTypeId(), 1, 'foo', 'en', 1);
    $real_usage = $this->injectedDatabase
      ->select($this->tableName, 'e')
      ->fields('e', [])
      ->condition('e.target_id', $entity
      ->id())
      ->condition('e.target_type', $entity
      ->getEntityTypeId())
      ->execute()
      ->fetchAll();
    $this
      ->assertSame(0, count($real_usage));

    // Test that config settings are respected.
    $this->container
      ->get('config.factory')
      ->getEditable('entity_usage.settings')
      ->set('track_enabled_target_entity_types', [])
      ->save();
    drupal_flush_all_caches();
    $this->container
      ->get('entity_usage.usage')
      ->registerUsage($entity
      ->id(), $entity
      ->getEntityTypeId(), 1, 'foo', 'en', 1);
    $real_usage = $this->injectedDatabase
      ->select($this->tableName, 'e')
      ->fields('e', [])
      ->condition('e.target_id', $entity
      ->id())
      ->condition('e.target_type', $entity
      ->getEntityTypeId())
      ->execute()
      ->fetchAll();
    $this
      ->assertSame(0, count($real_usage));

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
  }

  /**
   * Tests that our hook correctly blocks a usage from being tracked.
   */
  public function testEntityUsageBlockTrackingHook() {

    // The entity_usage_test_entity_usage_block_tracking() implementation is
    // making sure all usage records are blocked when this is set.
    \Drupal::state()
      ->set('entity_usage_kernel_test_block_usage_tracking', TRUE);
    $this->container
      ->get('module_installer')
      ->install([
      'path',
      'views',
      'entity_usage_test',
    ]);
    $entity = $this->testEntities[0];

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');
    $entity_usage
      ->registerUsage($entity
      ->id(), $entity
      ->getEntityTypeId(), 1, 'foo', 'en', 0);
    $real_usage = $this->injectedDatabase
      ->select($this->tableName, 'e')
      ->fields('e', [])
      ->condition('e.target_id', $entity
      ->id())
      ->execute()
      ->fetchAll();
    $this
      ->assertEquals(0, count($real_usage));

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
    \Drupal::state()
      ->set('entity_usage_kernel_test_block_usage_tracking', FALSE);
  }

  /**
   * Tests the bulkDeleteTargets() method.
   *
   * @covers \Drupal\entity_usage\EntityUsage::bulkDeleteTargets
   */
  public function testBulkDeleteTargets() {
    $entity_type = $this->testEntities[0]
      ->getEntityTypeId();

    // Create 2 fake registers on the database table, one for each entity.
    foreach ($this->testEntities as $entity) {
      $this->injectedDatabase
        ->insert($this->tableName)
        ->fields([
        'target_id' => $entity
          ->id(),
        'target_type' => $entity_type,
        'source_id' => 1,
        'source_type' => 'foo',
        'source_langcode' => 'en',
        'source_vid' => 1,
      ])
        ->execute();
    }

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');
    $entity_usage
      ->bulkDeleteTargets($entity_type);
    $event = \Drupal::state()
      ->get('entity_usage_events_test.usage_bulk_delete_targets', []);
    $this
      ->assertSame($event['event_name'], Events::BULK_DELETE_DESTINATIONS);
    $this
      ->assertSame($event['target_id'], NULL);
    $this
      ->assertSame($event['target_type'], $entity_type);
    $this
      ->assertSame($event['source_id'], NULL);
    $this
      ->assertSame($event['source_type'], NULL);
    $this
      ->assertSame($event['source_langcode'], NULL);
    $this
      ->assertSame($event['source_vid'], NULL);

    // Check if there are no records left.
    $usages = $this->injectedDatabase
      ->select($this->tableName, 'e')
      ->fields('e', [])
      ->condition('e.target_type', $entity_type)
      ->execute()
      ->fetchAll();
    $this
      ->assertSame(0, count($usages));

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
  }

  /**
   * Tests the bulkDeleteSources() method.
   *
   * @covers \Drupal\entity_usage\EntityUsage::bulkDeleteSources
   */
  public function testBulkDeleteSources() {
    $entity_type = $this->testEntities[0]
      ->getEntityTypeId();

    // Create 2 fake registers on the database table, one for each entity.
    foreach ($this->testEntities as $entity) {
      $source_vid = $entity instanceof RevisionableInterface && $entity
        ->getRevisionId() ? $entity
        ->getRevisionId() : 0;
      $this->injectedDatabase
        ->insert($this->tableName)
        ->fields([
        'target_id' => 1,
        'target_type' => 'foo',
        'source_id' => $entity
          ->id(),
        'source_type' => $entity_type,
        'source_langcode' => $entity
          ->language()
          ->getId(),
        'source_vid' => $source_vid,
      ])
        ->execute();
    }

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');
    $entity_usage
      ->bulkDeleteSources($entity_type);
    $event = \Drupal::state()
      ->get('entity_usage_events_test.usage_bulk_delete_sources', []);
    $this
      ->assertSame($event['event_name'], Events::BULK_DELETE_SOURCES);
    $this
      ->assertSame($event['target_id'], NULL);
    $this
      ->assertSame($event['target_type'], NULL);
    $this
      ->assertSame($event['source_id'], NULL);
    $this
      ->assertSame($event['source_type'], $entity_type);
    $this
      ->assertSame($event['source_langcode'], NULL);
    $this
      ->assertSame($event['source_vid'], NULL);

    // Check if there are no records left.
    $usages = $this->injectedDatabase
      ->select($this->tableName, 'e')
      ->fields('e', [])
      ->condition('e.source_type', $entity_type)
      ->execute()
      ->fetchAll();
    $this
      ->assertSame(0, count($usages));

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
  }

  /**
   * Tests the deleteBySourceEntity() method.
   *
   * @covers \Drupal\entity_usage\EntityUsage::deleteBySourceEntity
   */
  public function testDeleteBySourceEntity() {

    // Create 2 fake registers on the database table, one for each entity.
    $i = 0;
    foreach ($this->testEntities as $entity) {
      $i++;
      $source_vid = $entity instanceof RevisionableInterface && $entity
        ->getRevisionId() ? $entity
        ->getRevisionId() : 0;
      $this->injectedDatabase
        ->insert($this->tableName)
        ->fields([
        'target_id' => $i,
        'target_type' => 'fake_type_' . $i,
        'source_id' => $entity
          ->id(),
        'source_type' => $entity
          ->getEntityTypeId(),
        'source_langcode' => $entity
          ->language()
          ->getId(),
        'source_vid' => $source_vid,
      ])
        ->execute();
    }

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');

    // Delete only one of them, by source.
    $entity_usage
      ->deleteBySourceEntity($this->testEntities[0]
      ->id(), $this->testEntities[0]
      ->getEntityTypeId());
    $event = \Drupal::state()
      ->get('entity_usage_events_test.usage_delete_by_source_entity', []);
    $this
      ->assertSame($event['event_name'], Events::DELETE_BY_SOURCE_ENTITY);
    $this
      ->assertSame($event['target_id'], NULL);
    $this
      ->assertSame($event['target_type'], NULL);
    $this
      ->assertSame($event['source_id'], $this->testEntities[0]
      ->id());
    $this
      ->assertSame($event['source_type'], $this->testEntities[0]
      ->getEntityTypeId());
    $this
      ->assertSame($event['source_langcode'], NULL);
    $this
      ->assertSame($event['source_vid'], NULL);

    // The non-affected record is still there.
    $real_target_list = $entity_usage
      ->listTargets($this->testEntities[1]);
    $expected_target_list = [
      'fake_type_2' => [
        '2',
      ],
    ];
    $this
      ->assertEquals($expected_target_list, $real_target_list);

    // The affected record is gone.
    $real_target_list = $entity_usage
      ->listSources($this->testEntities[0]);
    $this
      ->assertEquals([], $real_target_list);

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
  }

  /**
   * Tests the deleteByTargetEntity() method.
   *
   * @covers \Drupal\entity_usage\EntityUsage::deleteByTargetEntity
   */
  public function testDeleteByTargetEntity() {

    // Create 2 fake registers on the database table, one for each entity.
    $i = 0;
    foreach ($this->testEntities as $entity) {
      $i++;
      $this->injectedDatabase
        ->insert($this->tableName)
        ->fields([
        'target_id' => $entity
          ->id(),
        'target_type' => $entity
          ->getEntityTypeId(),
        'source_id' => $i,
        'source_type' => 'fake_type_' . $i,
        'source_langcode' => 'en',
        'source_vid' => $i,
      ])
        ->execute();
    }

    /** @var \Drupal\entity_usage\EntityUsage $entity_usage */
    $entity_usage = $this->container
      ->get('entity_usage.usage');

    // Delete only one of them, by target.
    $entity_usage
      ->deleteByTargetEntity($this->testEntities[0]
      ->id(), $this->testEntities[0]
      ->getEntityTypeId());
    $event = \Drupal::state()
      ->get('entity_usage_events_test.usage_delete_by_target_entity', []);
    $this
      ->assertSame($event['event_name'], Events::DELETE_BY_TARGET_ENTITY);
    $this
      ->assertSame($event['target_id'], $this->testEntities[0]
      ->id());
    $this
      ->assertSame($event['target_type'], $this->testEntities[0]
      ->getEntityTypeId());
    $this
      ->assertSame($event['source_id'], NULL);
    $this
      ->assertSame($event['source_type'], NULL);
    $this
      ->assertSame($event['source_langcode'], NULL);

    // The non-affected record is still there.
    $real_source_list = $entity_usage
      ->listSources($this->testEntities[1]);
    $expected_source_list = [
      'fake_type_2' => [
        '2' => [
          0 => [
            'source_langcode' => 'en',
            'source_vid' => '2',
          ],
        ],
      ],
    ];
    $this
      ->assertEquals($expected_source_list, $real_source_list);

    // The affected record is gone.
    $real_source_list = $entity_usage
      ->listSources($this->testEntities[0]);
    $this
      ->assertEquals([], $real_source_list);

    // Clean back the environment.
    $this->injectedDatabase
      ->truncate($this->tableName);
  }

  /**
   * Creates two test entities.
   *
   * @return array
   *   An array of entity objects.
   */
  protected function getTestEntities() {
    $content_entity_1 = EntityTest::create([
      'name' => $this
        ->randomMachineName(),
    ]);
    $content_entity_1
      ->save();
    $content_entity_2 = EntityTest::create([
      'name' => $this
        ->randomMachineName(),
    ]);
    $content_entity_2
      ->save();
    return [
      $content_entity_1,
      $content_entity_2,
    ];
  }

  /**
   * Reacts to a register event.
   *
   * @param \Drupal\entity_usage\Events\EntityUsageEvent $event
   *   The entity usage event.
   * @param string $name
   *   The name of the event.
   */
  public function usageRegisterEventRecorder(EntityUsageEvent $event, $name) {
    $this->state
      ->set('entity_usage_events_test.usage_register', [
      'event_name' => $name,
      'target_id' => $event
        ->getTargetEntityId(),
      'target_type' => $event
        ->getTargetEntityType(),
      'source_id' => $event
        ->getSourceEntityId(),
      'source_type' => $event
        ->getSourceEntityType(),
      'source_langcode' => $event
        ->getSourceEntityLangcode(),
      'source_vid' => $event
        ->getSourceEntityRevisionId(),
    ]);
  }

  /**
   * Reacts to a usage deletion event.
   *
   * @param \Drupal\entity_usage\Events\EntityUsageEvent $event
   *   The entity usage event.
   * @param string $name
   *   The name of the event.
   */
  public function usageDeleteEventRecorder(EntityUsageEvent $event, $name) {
    $this->state
      ->set('entity_usage_events_test.usage_delete_by_field', [
      'event_name' => $name,
      'target_id' => $event
        ->getTargetEntityId(),
      'target_type' => $event
        ->getTargetEntityType(),
      'source_id' => $event
        ->getSourceEntityId(),
      'source_type' => $event
        ->getSourceEntityType(),
      'source_langcode' => $event
        ->getSourceEntityLangcode(),
      'source_vid' => $event
        ->getSourceEntityRevisionId(),
    ]);
  }

  /**
   * Reacts to delete by source entity event.
   *
   * @param \Drupal\entity_usage\Events\EntityUsageEvent $event
   *   The entity usage event.
   * @param string $name
   *   The name of the event.
   */
  public function usageDeleteBySourceEntityEventRecorder(EntityUsageEvent $event, $name) {
    $this->state
      ->set('entity_usage_events_test.usage_delete_by_source_entity', [
      'event_name' => $name,
      'target_id' => $event
        ->getTargetEntityId(),
      'target_type' => $event
        ->getTargetEntityType(),
      'source_id' => $event
        ->getSourceEntityId(),
      'source_type' => $event
        ->getSourceEntityType(),
      'source_langcode' => $event
        ->getSourceEntityLangcode(),
      'source_vid' => $event
        ->getSourceEntityRevisionId(),
    ]);
  }

  /**
   * Reacts to delete by target entity event.
   *
   * @param \Drupal\entity_usage\Events\EntityUsageEvent $event
   *   The entity usage event.
   * @param string $name
   *   The name of the event.
   */
  public function usageDeleteByTargetEntityEventRecorder(EntityUsageEvent $event, $name) {
    $this->state
      ->set('entity_usage_events_test.usage_delete_by_target_entity', [
      'event_name' => $name,
      'target_id' => $event
        ->getTargetEntityId(),
      'target_type' => $event
        ->getTargetEntityType(),
      'source_id' => $event
        ->getSourceEntityId(),
      'source_type' => $event
        ->getSourceEntityType(),
      'source_langcode' => $event
        ->getSourceEntityLangcode(),
      'source_vid' => $event
        ->getSourceEntityRevisionId(),
    ]);
  }

  /**
   * Reacts to bulk target delete event.
   *
   * @param \Drupal\entity_usage\Events\EntityUsageEvent $event
   *   The entity usage event.
   * @param string $name
   *   The name of the event.
   */
  public function usageBulkTargetDeleteEventRecorder(EntityUsageEvent $event, $name) {
    $this->state
      ->set('entity_usage_events_test.usage_bulk_delete_targets', [
      'event_name' => $name,
      'target_id' => $event
        ->getTargetEntityId(),
      'target_type' => $event
        ->getTargetEntityType(),
      'source_id' => $event
        ->getSourceEntityId(),
      'source_type' => $event
        ->getSourceEntityType(),
      'source_langcode' => $event
        ->getSourceEntityLangcode(),
      'source_vid' => $event
        ->getSourceEntityRevisionId(),
    ]);
  }

  /**
   * Reacts to bulk source delete event.
   *
   * @param \Drupal\entity_usage\Events\EntityUsageEvent $event
   *   The entity usage event.
   * @param string $name
   *   The name of the event.
   */
  public function usageBulkSourceDeleteEventRecorder(EntityUsageEvent $event, $name) {
    $this->state
      ->set('entity_usage_events_test.usage_bulk_delete_sources', [
      'event_name' => $name,
      'target_id' => $event
        ->getTargetEntityId(),
      'target_type' => $event
        ->getTargetEntityType(),
      'source_id' => $event
        ->getSourceEntityId(),
      'source_type' => $event
        ->getSourceEntityType(),
      'source_langcode' => $event
        ->getSourceEntityLangcode(),
      'source_vid' => $event
        ->getSourceEntityRevisionId(),
    ]);
  }

}

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.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityUsageTest::$bundle protected property The bundle used in this test.
EntityUsageTest::$entityType protected property The entity type used in this test.
EntityUsageTest::$injectedDatabase protected property The injected database connection.
EntityUsageTest::$modules public static property Modules to enable. Overrides EntityKernelTestBase::$modules
EntityUsageTest::$state protected property State service for recording information received by event listeners. Overrides EntityKernelTestBase::$state
EntityUsageTest::$tableName protected property The name of the table that stores entity usage information.
EntityUsageTest::$testEntities protected property Some test entities.
EntityUsageTest::getTestEntities protected function Creates two test entities.
EntityUsageTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityUsageTest::testBulkDeleteSources public function Tests the bulkDeleteSources() method.
EntityUsageTest::testBulkDeleteTargets public function Tests the bulkDeleteTargets() method.
EntityUsageTest::testDeleteBySourceEntity public function Tests the deleteBySourceEntity() method.
EntityUsageTest::testDeleteByTargetEntity public function Tests the deleteByTargetEntity() method.
EntityUsageTest::testEntityUsageBlockTrackingHook public function Tests that our hook correctly blocks a usage from being tracked.
EntityUsageTest::testlistSources public function Tests the listSources() and listTargets() method.
EntityUsageTest::testRegisterUsage public function Tests the registerUsage() and deleteUsage() methods.
EntityUsageTest::usageBulkSourceDeleteEventRecorder public function Reacts to bulk source delete event.
EntityUsageTest::usageBulkTargetDeleteEventRecorder public function Reacts to bulk target delete event.
EntityUsageTest::usageDeleteBySourceEntityEventRecorder public function Reacts to delete by source entity event.
EntityUsageTest::usageDeleteByTargetEntityEventRecorder public function Reacts to delete by target entity event.
EntityUsageTest::usageDeleteEventRecorder public function Reacts to a usage deletion event.
EntityUsageTest::usageRegisterEventRecorder public function Reacts to a register event.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser