You are here

Home » API reference » Commerce Core 8.2 » AddressBookTest.php

class AddressBookTest in Commerce Core 8.2

Same name in this branch
  1. 8.2 modules/order/tests/src/FunctionalJavascript/AddressBookTest.php \Drupal\Tests\commerce_order\FunctionalJavascript\AddressBookTest
  2. 8.2 modules/order/tests/src/Kernel/AddressBookTest.php \Drupal\Tests\commerce_order\Kernel\AddressBookTest

Tests the address book pages.

@group commerce

Hierarchy

Expanded class hierarchy of AddressBookTest

File

modules/order/tests/src/FunctionalJavascript/AddressBookTest.php, line 14

Namespace

Drupal\Tests\commerce_order\FunctionalJavascript
View source 
class AddressBookTest extends OrderWebDriverTestBase {

  /**
   * The first test address.
   *
   * @var array
   */
  protected $firstAddress = [
    'country_code' => 'US',
    'administrative_area' => 'SC',
    'locality' => 'Greenville',
    'postal_code' => '29616',
    'address_line1' => '9 Drupal Ave',
    'given_name' => 'Bryan',
    'family_name' => 'Centarro',
  ];

  /**
   * The second test address.
   *
   * @var array
   */
  protected $secondAddress = [
    'country_code' => 'US',
    'administrative_area' => 'CA',
    'locality' => 'Mountain View',
    'postal_code' => '94043',
    'address_line1' => '1098 Alta Ave',
    'organization' => 'Google Inc.',
    'given_name' => 'John',
    'family_name' => 'Smith',
  ];

  /**
   * The third test address.
   *
   * @var array
   */
  protected $thirdAddress = [
    'country_code' => 'US',
    'postal_code' => '53177',
    'locality' => 'Milwaukee',
    'address_line1' => 'Pabst Blue Ribbon Dr',
    'administrative_area' => 'WI',
    'given_name' => 'Frederick',
    'family_name' => 'Pabst',
  ];

  /**
   * The fourth test address.
   *
   * @var array
   */
  protected $fourthAddress = [
    'country_code' => 'FR',
    'locality' => 'Paris',
    'postal_code' => '75002',
    'address_line1' => '38 Rue du Sentier',
    'given_name' => 'Leon',
    'family_name' => 'Blum',
  ];

  /**
   * Gets the permissions for the admin user.
   *
   * @return string[]
   *   The permissions.
   */
  protected function getAdministratorPermissions() {
    return [
      'view the administration theme',
      'access administration pages',
      'access commerce administration pages',
      'access user profiles',
      'administer commerce_currency',
      'administer commerce_store',
      'administer commerce_store_type',
      'administer profile',
      'administer profile types',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Log out of the admin user.
    $this
      ->drupalLogout();
  }

  /**
   * Tests the overview access checking.
   */
  public function testOverviewAccess() {

    // Confirm that the anonymous user doesn't have an address book.
    $this
      ->drupalGet('user/0/address-book');
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => 0,
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Access Denied');

    // Confirm that no address book is available when the user can't view
    // the user's canonical page ("/user/{user}").
    $customer = $this
      ->createUser([
      'view any customer profile',
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet($this->adminUser
      ->toUrl('canonical'));
    $this
      ->assertSession()
      ->pageTextContains('Access denied');
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $this->adminUser
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Access Denied');

    // Confirm that no address book is available when the user can't view
    // any profile types.
    $customer = $this
      ->createUser([
      'access user profiles',
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet($this->adminUser
      ->toUrl('canonical'));
    $this
      ->assertSession()
      ->pageTextNotContains('Access denied');
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $this->adminUser
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Access Denied');

    // Confirm that the address book is visible when the user can view
    // at least one profile type.
    $customer = $this
      ->createUser([
      'access user profiles',
      'view any customer profile',
    ]);
    $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->secondAddress,
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet($this->adminUser
      ->toUrl('canonical'));
    $this
      ->assertSession()
      ->pageTextNotContains('Access denied');
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $this->adminUser
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextNotContains('Access Denied');
    $this
      ->assertSession()
      ->pageTextContains('1098 Alta Ave');

    // Confirm that the local task is present.
    $this
      ->assertSession()
      ->linkExists('Address book');
    $this
      ->assertSession()
      ->linkNotExists('Billing information');
  }

  /**
   * Tests the add form access checking.
   */
  public function testCreateAccess() {
    $first_user = $this
      ->createUser([
      'view own customer profile',
    ]);
    $second_user = $this
      ->createUser([
      'create customer profile',
      'view any profile',
      'access user profiles',
    ]);
    $third_user = $this
      ->createUser([
      'administer profile',
      'access user profiles',
    ]);
    $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $first_user
        ->id(),
      'address' => $this->firstAddress,
      'status' => TRUE,
    ]);
    $overview_url = Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $first_user
        ->id(),
    ]);

    // Confirm that the user with only "view" permissions can see
    // the overview page, but not the "add" page.
    $this
      ->drupalLogin($first_user);
    $this
      ->drupalGet($overview_url);
    $this
      ->assertSession()
      ->pageTextNotContains('Access Denied');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->assertSession()
      ->linkNotExists('Add address');
    $add_url = Url::fromRoute('commerce_order.address_book.add_form', [
      'user' => $first_user
        ->id(),
      'profile_type' => 'customer',
    ]);
    $this
      ->drupalGet($add_url);
    $this
      ->assertSession()
      ->pageTextContains('Access denied');

    // Confirm that the second user can't add a profile for the first user.
    $this
      ->drupalLogin($second_user);
    $this
      ->drupalGet($overview_url);
    $this
      ->assertSession()
      ->pageTextNotContains('Access Denied');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->assertSession()
      ->linkNotExists('Add address');
    $this
      ->drupalGet($add_url);
    $this
      ->assertSession()
      ->pageTextContains('Access denied');

    // Confirm that the third user can add a profile for the first user.
    $this
      ->drupalLogin($third_user);
    $this
      ->drupalGet($overview_url);
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->assertSession()
      ->linkExists('Add address');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add address');
    $this
      ->getSession()
      ->getPage()
      ->fillField('address[0][address][country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->fourthAddress as $property => $value) {
      $this
        ->getSession()
        ->getPage()
        ->fillField("address[0][address][{$property}]", $value);
    }
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Saved the 38 Rue du Sentier address.');
    $profile = Profile::load('2');
    $this
      ->assertNotEmpty($profile);
    $this
      ->assertEquals('38 Rue du Sentier', $profile
      ->get('address')->address_line1);
    $this
      ->assertEquals($first_user
      ->id(), $profile
      ->getOwnerId());
    $this
      ->drupalGet($add_url);
    $this
      ->assertSession()
      ->pageTextNotContains('Access denied');

    // Confirm that no further profiles can be added if the profile type
    // only allows a single profile per user.
    $profile = ProfileType::load('customer');
    $profile
      ->setMultiple(FALSE);
    $profile
      ->save();
    $this
      ->drupalGet($add_url);
    $this
      ->assertSession()
      ->pageTextContains('Access denied');
  }

  /**
   * Tests the fallback to the default profile UI.
   *
   * When there's only one profile type, and it only allows one profile per
   * customer, the address book should not be available, and profile module's
   * default UI should be used instead.
   */
  public function testFallback() {
    $profile = ProfileType::load('customer');
    $profile
      ->setMultiple(FALSE);
    $profile
      ->save();
    \Drupal::service('router.builder')
      ->rebuild();
    $customer = $this
      ->createUser([
      'access user profiles',
      'view own customer profile',
      'update own customer profile',
    ]);
    $profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $customer
        ->id(),
      'address' => $this->firstAddress,
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Access Denied');
    $this
      ->drupalGet($customer
      ->toUrl());
    $this
      ->assertSession()
      ->linkNotExists('Address book');

    // The local task provided by profile module should be visible.
    $this
      ->assertSession()
      ->linkExists('Customer information');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Customer information');
    $this
      ->saveHtmlOutput();

    // Confirm that the profile can be updated.
    foreach ($this->firstAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("address[0][address][{$property}]", $value);
    }
    $this
      ->submitForm([
      'address[0][address][address_line1]' => '10 Drupal Ave',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The profile has been saved.');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);
    $this
      ->assertEquals('10 Drupal Ave', $profile
      ->get('address')->address_line1);
  }

  /**
   * Tests the address book overview page with the default profile type.
   */
  public function testDefaultOverview() {
    $customer = $this
      ->createUser([
      'access user profiles',
      'create customer profile',
      'update own customer profile',
      'delete own customer profile',
      'view own customer profile',
      'administer profile',
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('There are no addresses yet.');

    // Confirm that a profile can be created.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add address');
    $this
      ->getSession()
      ->getPage()
      ->fillField('address[0][address][country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->fourthAddress as $property => $value) {
      $this
        ->getSession()
        ->getPage()
        ->fillField("address[0][address][{$property}]", $value);
    }
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Saved the 38 Rue du Sentier address.');
    $rendered_address = $this
      ->getSession()
      ->getPage()
      ->find('css', 'p.address');
    $this
      ->assertNotEmpty($rendered_address);
    $this
      ->assertStringContainsString('38 Rue du Sentier', $rendered_address
      ->getText());

    // Confirm that a profile can be edited.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Edit');
    foreach ($this->fourthAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("address[0][address][{$property}]", $value);
    }
    $this
      ->submitForm([
      'address[0][address][address_line1]' => '39 Rue du Sentier',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Saved the 39 Rue du Sentier address.');
    $rendered_address = $this
      ->getSession()
      ->getPage()
      ->find('css', 'p.address');
    $this
      ->assertNotEmpty($rendered_address);
    $this
      ->assertStringContainsString('39 Rue du Sentier', $rendered_address
      ->getText());

    // Confirm that a profile can be set as default.

    /** @var \Drupal\profile\Entity\ProfileInterface $second_profile */
    $second_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $customer
        ->id(),
      'address' => $this->secondAddress,
    ]);
    $this
      ->assertFalse($second_profile
      ->isDefault());
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('39 Rue du Sentier');
    $this
      ->assertSession()
      ->pageTextContains($this->secondAddress['address_line1']);
    $set_default_links = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.address-book__set-default-link');
    $this
      ->assertCount(1, $set_default_links);
    $set_default_link = reset($set_default_links);
    $set_default_link
      ->click();
    $this
      ->assertSession()
      ->pageTextContains($this->secondAddress['address_line1'] . ' is now the default address.');
    $set_default_links = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.address-book__set-default-link');
    $this
      ->assertCount(1, $set_default_links);
    $set_default_link = reset($set_default_links);
    $set_default_link
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('39 Rue du Sentier is now the default address.');

    // Confirm that a profile can be deleted.
    $delete_links = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.address-book__delete-link');
    $this
      ->assertCount(2, $delete_links);
    $delete_link = reset($delete_links);
    $delete_link
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to delete the 39 Rue du Sentier address?');
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->pageTextContains('The 39 Rue du Sentier address has been deleted.');
  }

  /**
   * Tests the address book overview page with several profile types.
   */
  public function testExtendedOverview() {
    $customer_profile_type = ProfileType::load('customer');
    $bundle_entity_duplicator = $this->container
      ->get('entity.bundle_entity_duplicator');
    $bundle_entity_duplicator
      ->duplicate($customer_profile_type, [
      'id' => 'customer_shipping',
      'label' => 'Customer (Shipping)',
      'display_label' => 'Shipping information',
      'multiple' => TRUE,
    ]);
    $customer_profile_type
      ->setDisplayLabel('Billing information');
    $customer_profile_type
      ->setMultiple(FALSE);
    $customer_profile_type
      ->save();
    $customer_profile_type = ProfileType::load('customer');
    $bundle_entity_duplicator = $this->container
      ->get('entity.bundle_entity_duplicator');
    $bundle_entity_duplicator
      ->duplicate($customer_profile_type, [
      'id' => 'customer_test',
      'label' => 'Customer (Test)',
      'display_label' => 'Test information',
    ]);
    $customer = $this
      ->createUser([
      'access user profiles',
      'create customer profile',
      'update own customer profile',
      'delete own customer profile',
      'delete own customer_shipping profile',
      'view own customer profile',
      'view own customer_shipping profile',
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Billing information');

    // Confirm that there is no empty text for billing information, because
    // there is an add link.
    $container = $this
      ->getSession()
      ->getPage()
      ->find('css', '.address-book__container--customer');
    $this
      ->assertStringNotContainsString('There are no addresses yet.', $container
      ->getText());
    $add_link = $this
      ->getSession()
      ->getPage()
      ->find('css', '.address-book__container--customer .address-book__add-link');
    $this
      ->assertNotEmpty($add_link);
    $add_link
      ->click();
    $this
      ->assertSession()
      ->fieldExists('address[0][address][address_line1]');

    // Confirm that there is only an edit link after a profile has been created,
    // since the profile type doesn't allow multiple profiles per customer.
    $billing_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $customer
        ->id(),
      'address' => $this->firstAddress,
    ]);
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->elementNotExists('css', '.address-book__container--customer .address-book__add-link');
    $this
      ->assertSession()
      ->elementExists('css', '.address-book__container--customer .address-book__edit-link');
    $this
      ->assertSession()
      ->elementNotExists('css', '.address-book__container--customer .address-book__delete-link');
    $this
      ->assertSession()
      ->elementNotExists('css', '.address-book__container--customer .address-book__set-default-link');

    // Confirm that the add form isn't available directly either.
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.add_form', [
      'user' => $customer
        ->id(),
      'profile_type' => 'customer',
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Access Denied');
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');

    // Confirm that there is empty text for shipping information, because
    // there is no add link (due to lack of access).
    $add_link = $this
      ->getSession()
      ->getPage()
      ->find('css', '.address-book__container--customer_shipping .address-book__add-link');
    $this
      ->assertEmpty($add_link);
    $container = $this
      ->getSession()
      ->getPage()
      ->find('css', '.address-book__container--customer_shipping');
    $this
      ->assertStringContainsString('There are no addresses yet.', $container
      ->getText());
    $this
      ->createEntity('profile', [
      'type' => 'customer_shipping',
      'uid' => $customer
        ->id(),
      'address' => $this->secondAddress,
    ]);
    $this
      ->createEntity('profile', [
      'type' => 'customer_shipping',
      'uid' => $customer
        ->id(),
      'address' => $this->thirdAddress,
    ]);
    $this
      ->drupalGet(Url::fromRoute('commerce_order.address_book.overview', [
      'user' => $customer
        ->id(),
    ]));

    // Confirm that the empty text is gone.
    $container = $this
      ->getSession()
      ->getPage()
      ->find('css', '.address-book__container--customer_shipping');
    $this
      ->assertStringNotContainsString('There are no addresses yet.', $container
      ->getText());

    // Confirm that there are no edit/set default links, due to lack of access.
    $edit_links = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.address-book__container--customer_shipping .address-book__edit-link');
    $this
      ->assertEmpty($edit_links);
    $set_default_links = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.address-book__container--customer_shipping .address-book__set-default-link');
    $this
      ->assertEmpty($set_default_links);
    $delete_links = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.address-book__container--customer_shipping .address-book__delete-link');
    $this
      ->assertNotEmpty($delete_links);

    // Confirm that the profile types are filtered by access, and that
    // the customer_test profile type is not displayed.
    $this
      ->createEntity('profile', [
      'type' => 'customer_test',
      'uid' => $customer
        ->id(),
      'address' => $this->fourthAddress,
    ]);
    $this
      ->assertSession()
      ->pageTextNotContains('Test information');
    $this
      ->assertSession()
      ->pageTextNotContains($this->fourthAddress['address_line1']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddressBookTest::$firstAddress protected property The first test address.
AddressBookTest::$fourthAddress protected property The fourth test address.
AddressBookTest::$secondAddress protected property The second test address.
AddressBookTest::$thirdAddress protected property The third test address.
AddressBookTest::getAdministratorPermissions protected function Gets the permissions for the admin user. Overrides OrderWebDriverTestBase::getAdministratorPermissions
AddressBookTest::setUp protected function Overrides OrderWebDriverTestBase::setUp
AddressBookTest::testCreateAccess public function Tests the add form access checking.
AddressBookTest::testDefaultOverview public function Tests the address book overview page with the default profile type.
AddressBookTest::testExtendedOverview public function Tests the address book overview page with several profile types.
AddressBookTest::testFallback public function Tests the fallback to the default profile UI.
AddressBookTest::testOverviewAccess public function Tests the overview access checking.
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.
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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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.
CommerceBrowserTestTrait::assertFieldValues protected function Asserts that the passed field values are correct.
CommerceBrowserTestTrait::createEntity protected function Creates a new entity.
CommerceBrowserTestTrait::reloadEntity protected function Reloads the entity after clearing the static cache.
CommerceBrowserTestTrait::saveHtmlOutput protected function Debugger method to save additional HTML output.
CommerceWebDriverTestBase::$adminUser protected property A test user with administrative privileges.
CommerceWebDriverTestBase::$countryList protected property The country list.
CommerceWebDriverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 3
CommerceWebDriverTestBase::$store protected property The store entity.
CommerceWebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE. Overrides WebDriverTestBase::assertJsCondition
CommerceWebDriverTestBase::assertRenderedAddress protected function Asserts that the given address is rendered on the page.
CommerceWebDriverTestBase::setRawFieldValue protected function Sets an input field's raw value.
CommerceWebDriverTestBase::tearDown protected function Overrides WebDriverTestBase::tearDown
CommerceWebDriverTestBase::waitForAjaxToFinish Deprecated protected function Waits for jQuery to become active and animations to complete.
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
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
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::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
OrderWebDriverTestBase::$modules public static property Modules to enable. Overrides CommerceWebDriverTestBase::$modules 2
OrderWebDriverTestBase::$variation protected property The variation to test against.
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.
StoreCreationTrait::createStore protected function Creates a store for the test.
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.