You are here

Home » API reference » Entity Construction Kit (ECK) 8 » NavigationalStructureTest.php

class NavigationalStructureTest in Entity Construction Kit (ECK) 8

Test Entity Construction Kit's navigational structure.

This includes routing, paths, breadcrumbs and page titles.

@group eck

Hierarchy

Expanded class hierarchy of NavigationalStructureTest

File

tests/src/Functional/NavigationalStructureTest.php, line 17

Namespace

Drupal\Tests\eck\Functional
View source 
class NavigationalStructureTest extends FunctionalTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'node',
    'block',
    'field',
  ];

  /**
   * The base breadcrumb labels.
   *
   * @var string[]
   */
  private $baseCrumbs = [
    'Home',
    'Administration',
  ];

  /**
   * The entity type machine name.
   *
   * @var string
   */
  private $entityTypeMachineName;

  /**
   * The entity type label.
   *
   * @var string
   */
  private $entityTypeLabel;

  /**
   * The entity bundle machine name.
   *
   * @var string
   */
  private $entityBundleMachineName;

  /**
   * The entity bundle label.
   *
   * @var string
   */
  private $entityBundleLabel;

  /**
   * {@inheritdoc}
   */
  protected function getAdministratorPermissions() {
    return array_merge([
      'access administration pages',
      'access content overview',
    ], parent::getAdministratorPermissions());
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function setUp() {
    parent::setUp();
    $entity_type = $this
      ->createEntityType();
    $this->entityTypeMachineName = $entity_type['id'];
    $this->entityTypeLabel = $entity_type['label'];
    $bundle = $this
      ->createEntityBundle($this->entityTypeMachineName);
    $this->entityBundleMachineName = $bundle['type'];
    $this->entityBundleLabel = $bundle['name'];
    $this
      ->placeBlock('system_breadcrumb_block');
    $this
      ->placeBlock('page_title_block');
  }

  /**
   * Retrieves the entity storage handler.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   The entity storage handler.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  private function getEntityStorageHandler() {
    return \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeMachineName);
  }

  /**
   * Asserts that the page on a given route contains all the elements we expect.
   *
   * @param string $route
   *   The route to test.
   * @param array $routeArguments
   *   Arguments for the route to test.
   * @param string $expectedUrl
   *   The expected url.
   * @param string $expectedTitle
   *   The expected title.
   * @param array $crumbs
   *   The expected breadcrumbs after the base crumbs.
   */
  private function assertCorrectPageOnRoute($route, array $routeArguments, $expectedUrl, $expectedTitle, array $crumbs = []) {
    $url = Url::fromRoute($route, $routeArguments);
    self::assertEquals($expectedUrl, $url
      ->getInternalPath());
    $this
      ->drupalGet($url);
    $this
      ->assertTitleEquals($expectedTitle);
    $this
      ->assertBreadcrumbsVisible(array_merge($this->baseCrumbs, $crumbs));
  }

  /**
   * Asserts that the title of a page contains a given value.
   *
   * @param string $expectedTitle
   *   The expected title.
   */
  private function assertTitleEquals($expectedTitle) {
    $titleElement = $this
      ->getSession()
      ->getPage()
      ->find('css', '.page-title');
    $actualTitle = $titleElement instanceof NodeElement ? $titleElement
      ->getText() : '';
    $this
      ->assertEquals($expectedTitle, $actualTitle);
  }

  /**
   * Asserts that the given breadcrumbs are visible.
   *
   * @param string[] $expectedBreadcrumbs
   *   The expected breadcrumbs.
   */
  private function assertBreadcrumbsVisible(array $expectedBreadcrumbs) {
    $breadcrumbs = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.breadcrumb a');
    $actualCrumbs = [];
    do {
      $actualCrumbs[] = array_shift($breadcrumbs)
        ->getText();
    } while (!empty($breadcrumbs));
    self::assertEquals($expectedBreadcrumbs, $actualCrumbs);
  }

  /**
   * Tests entity type listing.
   *
   * @test
   */
  public function entityTypeList() {
    $route = 'eck.entity_type.list';
    $routeArguments = [];
    $expectedUrl = 'admin/structure/eck';
    $expectedTitle = 'ECK Entity Types';
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, [
      'Structure',
    ]);
  }

  /**
   * Tests entity type creation.
   *
   * @test
   */
  public function entityTypeAdd() {
    $routeArguments = [];
    $route = 'eck.entity_type.add';
    $expectedUrl = 'admin/structure/eck/add';
    $expectedTitle = 'Add entity type';
    $crumbs = [
      'Structure',
      'ECK Entity Types',
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity type edit.
   *
   * @test
   */
  public function entityTypeEdit() {
    $route = 'entity.eck_entity_type.edit_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}";
    $expectedTitle = 'Edit entity type';
    $crumbs = [
      'Structure',
      'ECK Entity Types',
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity type deletion.
   *
   * @test
   *
   * @throws \Behat\Mink\Exception\ResponseTextException
   */
  public function entityTypeDelete() {
    $route = 'entity.eck_entity_type.delete_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/delete";
    $expectedTitle = "Are you sure you want to delete entity type {$this->entityTypeLabel}?";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
    $this
      ->assertSession()
      ->pageTextContains("Configuration deletions The listed configuration will be deleted.{$this->entityTypeLabel} type");
    $this
      ->assertSession()
      ->pageTextContains($this->entityBundleLabel);
  }

  /**
   * Tests entity type deletion with multiple bundles.
   *
   * @test
   *
   * @throws \Behat\Mink\Exception\ResponseTextException
   */
  public function entityTypeDeleteWithMultipleBundles() {

    // Create a randomly named bundle.
    $extra_bundle = $this
      ->createEntityBundle($this->entityTypeMachineName);
    $extra_bundle_label = $extra_bundle['name'];
    $route = 'entity.eck_entity_type.delete_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/delete";
    $expectedTitle = "Are you sure you want to delete entity type {$this->entityTypeLabel}?";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
    $this
      ->assertSession()
      ->pageTextContains("Configuration deletions The listed configuration will be deleted.{$this->entityTypeLabel} type");
    $this
      ->assertSession()
      ->pageTextContains($extra_bundle_label);
    $this
      ->assertSession()
      ->pageTextContains($this->entityBundleLabel);
  }

  /**
   * Tests entity type deletion with matching bundle.
   *
   * @test
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function entityTypeDeleteWithMatchingBundle() {
    $this
      ->createEntityBundle($this->entityTypeMachineName, $this->entityTypeLabel);
    $this->entityBundleMachineName = $this->entityTypeMachineName;
    $this->entityBundleLabel = $this->entityTypeLabel;
    \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeMachineName . '_type')
      ->load($this->entityBundleMachineName)
      ->delete();
    $route = 'entity.eck_entity_type.delete_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/delete";
    $expectedTitle = "Are you sure you want to delete entity type {$this->entityTypeLabel}?";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
    $this
      ->assertSession()
      ->pageTextContains("This action cannot be undone.");

    // Delete the entity.
    $this
      ->submitForm([], 'Delete entity type');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Try to load the deleted entity.
    $entity_type = \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeMachineName)
      ->load($this->entityTypeMachineName);

    // Make sure the entity is deleted.
    $this
      ->assertNull($entity_type);
    $this
      ->entityTypeList();
  }

  /**
   * Tests entity type deletion if fields are present.
   *
   * @test
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function entityTypeDeleteWithField() {

    // Delete the original bundle.
    \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeMachineName . '_type')
      ->load($this->entityBundleMachineName)
      ->delete();

    // Create a bundle with matching name.
    $this->entityBundleMachineName = $this->entityTypeMachineName;
    $this->entityBundleLabel = $this->entityTypeLabel;
    $this
      ->createEntityBundle($this->entityTypeMachineName, $this->entityBundleLabel);
    FieldStorageConfig::create([
      'entity_type' => $this->entityTypeMachineName,
      'field_name' => 'field_decimal',
      'type' => 'decimal',
    ])
      ->save();
    FieldConfig::create([
      'entity_type' => $this->entityTypeMachineName,
      'field_name' => 'field_decimal',
      'bundle' => $this->entityBundleMachineName,
    ])
      ->save();
    $route = 'entity.eck_entity_type.delete_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/delete";
    $expectedTitle = "Are you sure you want to delete entity type {$this->entityTypeLabel}?";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
    $this
      ->assertSession()
      ->pageTextContains("This action cannot be undone.");
    $this
      ->assertSession()
      ->pageTextContains("Configuration deletions The listed configuration will be deleted.{$this->entityTypeLabel} type{$this->entityTypeLabel}Fieldfield_decimal");

    // Delete the entity.
    $this
      ->submitForm([], 'Delete entity type');
    $this
      ->assertSession()
      ->responseContains('The eck entity type <em class="placeholder">' . $this->entityTypeLabel . '</em> has been deleted.');

    // Try to load the deleted entity type definition.
    $entity_type = \Drupal::entityTypeManager()
      ->clearCachedDefinitions();
    \Drupal::entityTypeManager()
      ->getDefinition($this->entityTypeMachineName, FALSE);

    // Make sure the entity type is deleted.
    $this
      ->assertNull($entity_type);
    $this
      ->entityTypeList();
  }

  /**
   * Tests entity type deletion if content is available.
   *
   * @test
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Exception
   */
  public function entityTypeDeleteWithContent() {
    $field_machine_name = strtolower($this
      ->randomMachineName());

    // Create a field.
    FieldStorageConfig::create([
      'entity_type' => $this->entityTypeMachineName,
      'field_name' => $field_machine_name,
      'type' => 'decimal',
    ])
      ->save();
    FieldConfig::create([
      'entity_type' => $this->entityTypeMachineName,
      'field_name' => $field_machine_name,
      'bundle' => $this->entityBundleMachineName,
    ])
      ->save();

    // Create an entity.
    \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeMachineName)
      ->create([
      'type' => $this->entityBundleMachineName,
      $field_machine_name => random_int(1, 1000),
    ])
      ->save();
    $route = 'entity.eck_entity_type.delete_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/delete";
    $expectedTitle = "Delete entity type";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
    $this
      ->assertSession()
      ->pageTextContains("There is 1 {$this->entityTypeLabel} entity. You can not remove this entity type until you have removed all of the {$this->entityTypeLabel} entities.");

    // Create a second entity.
    \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeMachineName)
      ->create([
      'type' => $this->entityBundleMachineName,
      $field_machine_name => random_int(1, 1000),
    ])
      ->save();
    $route = 'entity.eck_entity_type.delete_form';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/delete";
    $expectedTitle = "Delete entity type";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
    $this
      ->assertSession()
      ->pageTextContains("There are 2 {$this->entityTypeLabel} entities. You may not remove {$this->entityTypeLabel} until you have removed all of the {$this->entityTypeLabel} entities.");
  }

  /**
   * Tests the entity listing page.
   *
   * @test
   */
  public function entityList() {
    $route = "eck.entity.{$this->entityTypeMachineName}.list";
    $routeArguments = [];
    $expectedUrl = "admin/content/{$this->entityTypeMachineName}";
    $expectedTitle = ucfirst("{$this->entityTypeLabel} content");
    $crumbs = [
      'Content',
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests the entity add page.
   *
   * @test
   */
  public function entityAddPage() {
    $route = 'eck.entity.add_page';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
    ];
    $expectedUrl = "admin/content/{$this->entityTypeMachineName}/add";
    $expectedTitle = "Add {$this->entityTypeLabel} content";
    $crumbs = [
      'Content',
      ucfirst("{$this->entityTypeLabel} content"),
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Test entity creation.
   *
   * @test
   */
  public function entityAdd() {
    $route = 'eck.entity.add';
    $routeArguments = [
      'eck_entity_type' => $this->entityTypeMachineName,
      'eck_entity_bundle' => $this->entityBundleMachineName,
    ];
    $expectedUrl = "admin/content/{$this->entityTypeMachineName}/add/{$this->entityBundleMachineName}";
    $expectedTitle = "Add {$this->entityBundleLabel} content";
    $crumbs = [
      'Content',
      ucfirst("{$this->entityTypeLabel} content"),
      "Add {$this->entityTypeLabel} content",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Test entity viewing.
   *
   * @test
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function entityView() {
    $entityTitle = $this
      ->randomString();
    $entity = $this
      ->getEntityStorageHandler()
      ->create([
      'type' => $this->entityBundleMachineName,
      'title' => $entityTitle,
    ]);
    $entity
      ->save();
    $route = "entity.{$this->entityTypeMachineName}.canonical";
    $routeArguments = [
      $this->entityTypeMachineName => $entity
        ->id(),
    ];
    $expectedUrl = "{$this->entityTypeMachineName}/{$entity->id()}";
    $expectedTitle = $entityTitle;
    $this->baseCrumbs = [
      "Home",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle);
  }

  /**
   * Tests entity editing.
   *
   * @test
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function entityEdit() {
    $entityTitle = $this
      ->randomString();
    $entity = $this
      ->getEntityStorageHandler()
      ->create([
      'type' => $this->entityBundleMachineName,
      'title' => $entityTitle,
    ]);
    $entity
      ->save();
    $route = "entity.{$this->entityTypeMachineName}.edit_form";
    $routeArguments = [
      $this->entityTypeMachineName => $entity
        ->id(),
    ];
    $expectedUrl = "{$this->entityTypeMachineName}/{$entity->id()}/edit";
    $expectedTitle = "Edit {$this->entityBundleLabel} {$entityTitle}";
    $this->baseCrumbs = [
      'Home',
    ];
    $crumbs = [
      $entityTitle,
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity deletion.
   *
   * @test
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function entityDelete() {
    $entityTitle = $this
      ->randomString();
    $entity_type_label = strtolower($this->entityTypeLabel);
    $entity = $this
      ->getEntityStorageHandler()
      ->create([
      'type' => $this->entityBundleMachineName,
      'title' => $entityTitle,
    ]);
    $entity
      ->save();
    $route = "entity.{$this->entityTypeMachineName}.delete_form";
    $routeArguments = [
      $this->entityTypeMachineName => $entity
        ->id(),
    ];
    $expectedUrl = "{$this->entityTypeMachineName}/{$entity->id()}/delete";
    $expectedTitle = "Are you sure you want to delete the {$entity_type_label} {$entityTitle}?";
    $this->baseCrumbs = [
      'Home',
    ];
    $crumbs = [
      $entityTitle,
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity bundle listing.
   *
   * @test
   */
  public function entityBundleList() {
    $route = "eck.entity.{$this->entityTypeMachineName}_type.list";
    $routeArguments = [];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/bundles";
    $expectedTitle = ucfirst("{$this->entityTypeLabel} bundles");
    $crumbs = [
      'Structure',
      "ECK Entity Types",
      "Edit entity type",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity bundle creation.
   *
   * @test
   */
  public function entityBundleAdd() {
    $route = "eck.entity.{$this->entityTypeMachineName}_type.add";
    $routeArguments = [];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/bundles/add";
    $expectedTitle = "Add {$this->entityTypeLabel} bundle";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
      ucfirst("{$this->entityTypeLabel} bundles"),
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity bundle editing.
   *
   * @test
   */
  public function entityBundleEdit() {
    $route = "entity.{$this->entityTypeMachineName}_type.edit_form";
    $routeArguments = [
      "{$this->entityTypeMachineName}_type" => $this->entityBundleMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/bundles/{$this->entityBundleMachineName}";
    $expectedTitle = "Edit {$this->entityTypeLabel} bundle";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
      ucfirst("{$this->entityTypeLabel} bundles"),
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

  /**
   * Tests entity bundle deletion.
   *
   * @test
   */
  public function entityBundleDelete() {
    $route = "entity.{$this->entityTypeMachineName}_type.delete_form";
    $routeArguments = [
      "{$this->entityTypeMachineName}_type" => $this->entityBundleMachineName,
    ];
    $expectedUrl = "admin/structure/eck/{$this->entityTypeMachineName}/bundles/{$this->entityBundleMachineName}/delete";
    $expectedTitle = "Are you sure you want to delete the entity bundle {$this->entityBundleLabel}?";
    $crumbs = [
      'Structure',
      'ECK Entity Types',
      "Edit entity type",
      ucfirst("{$this->entityTypeLabel} bundles"),
      "Edit {$this->entityTypeLabel} bundle",
    ];
    $this
      ->assertCorrectPageOnRoute($route, $routeArguments, $expectedUrl, $expectedTitle, $crumbs);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestBase::$adminUser protected property The admin user.
FunctionalTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FunctionalTestBase::createEntity protected function Creates a new entity.
FunctionalTestBase::createEntityBundle protected function Adds a bundle for a given entity type.
FunctionalTestBase::createEntityType protected function Creates an entity type with a given label and/or enabled base fields.
FunctionalTestBase::editEntityBundle protected function Edits a bundle for a given entity type.
FunctionalTestBase::getConfigurableBaseFields protected function Returns an array of the configurable base fields.
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.
NavigationalStructureTest::$baseCrumbs private property The base breadcrumb labels.
NavigationalStructureTest::$entityBundleLabel private property The entity bundle label.
NavigationalStructureTest::$entityBundleMachineName private property The entity bundle machine name.
NavigationalStructureTest::$entityTypeLabel private property The entity type label.
NavigationalStructureTest::$entityTypeMachineName private property The entity type machine name.
NavigationalStructureTest::$modules protected static property Modules to enable. Overrides FunctionalTestBase::$modules
NavigationalStructureTest::assertBreadcrumbsVisible private function Asserts that the given breadcrumbs are visible.
NavigationalStructureTest::assertCorrectPageOnRoute private function Asserts that the page on a given route contains all the elements we expect.
NavigationalStructureTest::assertTitleEquals private function Asserts that the title of a page contains a given value.
NavigationalStructureTest::entityAdd public function Test entity creation.
NavigationalStructureTest::entityAddPage public function Tests the entity add page.
NavigationalStructureTest::entityBundleAdd public function Tests entity bundle creation.
NavigationalStructureTest::entityBundleDelete public function Tests entity bundle deletion.
NavigationalStructureTest::entityBundleEdit public function Tests entity bundle editing.
NavigationalStructureTest::entityBundleList public function Tests entity bundle listing.
NavigationalStructureTest::entityDelete public function Tests entity deletion.
NavigationalStructureTest::entityEdit public function Tests entity editing.
NavigationalStructureTest::entityList public function Tests the entity listing page.
NavigationalStructureTest::entityTypeAdd public function Tests entity type creation.
NavigationalStructureTest::entityTypeDelete public function Tests entity type deletion.
NavigationalStructureTest::entityTypeDeleteWithContent public function Tests entity type deletion if content is available.
NavigationalStructureTest::entityTypeDeleteWithField public function Tests entity type deletion if fields are present.
NavigationalStructureTest::entityTypeDeleteWithMatchingBundle public function Tests entity type deletion with matching bundle.
NavigationalStructureTest::entityTypeDeleteWithMultipleBundles public function Tests entity type deletion with multiple bundles.
NavigationalStructureTest::entityTypeEdit public function Tests entity type edit.
NavigationalStructureTest::entityTypeList public function Tests entity type listing.
NavigationalStructureTest::entityView public function Test entity viewing.
NavigationalStructureTest::getAdministratorPermissions protected function Overrides FunctionalTestBase::getAdministratorPermissions
NavigationalStructureTest::getEntityStorageHandler private function Retrieves the entity storage handler.
NavigationalStructureTest::setUp public function Overrides FunctionalTestBase::setUp
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.