You are here

class CustomerProfileTest in Commerce Core 8.2

Tests the customer_profile inline form.

@group commerce

Hierarchy

Expanded class hierarchy of CustomerProfileTest

File

modules/order/tests/src/FunctionalJavascript/CustomerProfileTest.php, line 13

Namespace

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

  /**
   * An empty address.
   *
   * @var array
   */
  protected $emptyAddress = [
    'country_code' => 'RS',
    'locality' => '',
    'postal_code' => '',
    'address_line1' => '',
    'given_name' => '',
    'family_name' => '',
  ];

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

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

  /**
   * An incomplete HU address.
   *
   * @var array
   */
  protected $huAddress = [
    'country_code' => 'HU',
    'locality' => 'Vecsés',
    'postal_code' => '',
    'address_line1' => 'Árpád u. 6.',
    'given_name' => 'Péter',
    'family_name' => 'Tordai',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->store
      ->set('address', [
      'country_code' => 'RS',
      'postal_code' => '11000',
      'locality' => 'Belgrade',
      'address_line1' => 'Cetinjska 15',
    ]);
    $this->store
      ->save();
  }

  /**
   * Tests the country handling.
   */
  public function testCountries() {

    // Confirm that the country list has been restricted to available countries.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $options = $this
      ->xpath('//select[@name="profile[address][0][address][country_code]"]/option');
    $this
      ->assertCount(4, $options);
    $this
      ->assertEquals('FR', $options[0]
      ->getValue());
    $this
      ->assertEquals('HU', $options[1]
      ->getValue());
    $this
      ->assertEquals('RS', $options[2]
      ->getValue());
    $this
      ->assertEquals('US', $options[3]
      ->getValue());

    // Confirm that the store default is selected when available.
    $this
      ->assertNotEmpty($options[2]
      ->getAttribute('selected'));

    // Confirm that it is possible to change the country and submit the form.
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[address][0][address][country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'Leon',
      'profile[address][0][address][family_name]' => 'Blum',
      'profile[address][0][address][address_line1]' => '38 Rue du Sentier',
      'profile[address][0][address][postal_code]' => '75002',
      'profile[address][0][address][locality]' => 'Paris',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR.');
  }

  /**
   * Tests the address book in "multiple" mode, on a new profile entity.
   */
  public function testMultipleNew() {

    // Test the initial state, with no address book profiles available.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->assertSession()
      ->fieldNotExists('select_address');
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains('Save to my address book');
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "Cetinjska 13" and the country code is RS. Address book: Yes');
    $us_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->usAddress,
    ]);
    $us_profile
      ->save();
    sleep(1);
    $french_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->frenchAddress,
    ]);
    $french_profile
      ->save();

    // Confirm that the US profile is first and selected, since it is
    // the default.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $options = $this
      ->xpath('//select[@name="profile[select_address]"]/option');
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals($this->usAddress['address_line1'], $options[0]
      ->getText());
    $this
      ->assertEquals($this->frenchAddress['address_line1'], $options[1]
      ->getText());
    $this
      ->assertEquals('+ Enter a new address', $options[2]
      ->getText());
    $this
      ->assertNotEmpty($options[0]
      ->getAttribute('selected'));

    // Confirm that the US profile is shown rendered.
    $this
      ->assertRenderedAddress($this->usAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "9 Drupal Ave" and the country code is US. Address book: No');

    // Confirm that it is possible to edit and submit the US profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->usAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }

    // The checkbox should be hidden and TRUE for every edit operation.
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '10 Drupal Ave',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "10 Drupal Ave" and the country code is US. Address book: Yes');

    // Confirm that selecting "Enter a new address" clears the form.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->usAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->saveHtmlOutput();
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "Cetinjska 13" and the country code is RS. Address book: Yes');

    // Confirm that it is possible to select the French profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $french_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to select and edit the French profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $french_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: Yes');

    // Confirm that selecting a different address reverts to render mode.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->usAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $french_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->frenchAddress);

    // Confirm that it is possible to add a new profile.
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains('Save to my address book');
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "Cetinjska 13" and the country code is RS. Address book: Yes');
  }

  /**
   * Tests the address book in "multiple" mode, on an existing profile entity.
   */
  public function testMultipleExisting() {

    // One-off profile, with no address book profiles available.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->assertSession()
      ->fieldNotExists('select_address');

    // Confirm that the french address is shown rendered.
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }

    // Confirm that since the profile was never copied to the address book,
    // it is still possible to do so.
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains('Save to my address book');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: No');

    // Profile that is flagged for copying (simulating edit within checkout).
    $profile
      ->setData('copy_to_address_book', TRUE);
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: Yes');

    // Confirm that it is possible to edit the copy checkbox.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->checkboxChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains('Save to my address book');
    $this
      ->submitForm([
      'profile[copy_to_address_book]' => FALSE,
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');
    $us_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->usAddress,
    ]);
    $us_profile
      ->save();
    sleep(1);
    $french_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->frenchAddress,
    ]);
    $french_profile
      ->save();

    // Populated from the French profile, which is still identical.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->populateFromProfile($french_profile);
    $profile
      ->setData('address_book_profile_id', $french_profile
      ->id());
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());

    // Confirm that there is no _original option, since the profile still
    // matches the address book profile.
    $options = $this
      ->xpath('//select[@name="profile[select_address]"]/option');
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals($this->usAddress['address_line1'], $options[0]
      ->getText());
    $this
      ->assertEquals($this->frenchAddress['address_line1'], $options[1]
      ->getText());
    $this
      ->assertEquals('+ Enter a new address', $options[2]
      ->getText());

    // Confirm that the address book profile is selected.
    $this
      ->assertNotEmpty($options[1]
      ->getAttribute('selected'));
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: Yes');

    // Populated from the French profile, which has changed since, and has
    // a different street address.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->setData('address_book_profile_id', $french_profile
      ->id());
    $profile
      ->save();
    $new_french_address = [
      'country_code' => 'FR',
      'locality' => 'Paris',
      'postal_code' => '75002',
      'address_line1' => '39 Rue du Sentier',
      'given_name' => 'Leon',
      'family_name' => 'Blum',
    ];
    $french_profile
      ->set('address', $new_french_address);
    $french_profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());

    // Confirm that the _original option is present and selected.
    $options = $this
      ->xpath('//select[@name="profile[select_address]"]/option');
    $this
      ->assertCount(4, $options);
    $this
      ->assertEquals($this->usAddress['address_line1'], $options[0]
      ->getText());
    $this
      ->assertEquals($new_french_address['address_line1'], $options[1]
      ->getText());
    $this
      ->assertEquals($this->frenchAddress['address_line1'], $options[2]
      ->getText());
    $this
      ->assertEquals('+ Enter a new address', $options[3]
      ->getText());
    $this
      ->assertNotEmpty($options[2]
      ->getAttribute('selected'));
    $this
      ->assertEquals('_original', $options[2]
      ->getValue());
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to switch to a different profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $french_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($new_french_address);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "39 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to switch to a different profile, and back.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $french_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($new_french_address);
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', '_original');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    // Editing the profile should not result in an address book copy, since
    // the source address book profile is now out of sync.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: No');

    // Populated from the French profile, which has changed since, but has
    // the same street address / label.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->setData('address_book_profile_id', $french_profile
      ->id());
    $profile
      ->save();
    $new_french_address = [
      'country_code' => 'FR',
      'locality' => 'Paris',
      'postal_code' => '75002',
      'address_line1' => '38 Rue du Sentier',
      'given_name' => 'Leon',
      'family_name' => 'Leon',
    ];
    $french_profile
      ->set('address', $new_french_address);
    $french_profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());

    // Confirm that the _original option is present and selected, and that it
    // has the expected suffix.
    $options = $this
      ->xpath('//select[@name="profile[select_address]"]/option');
    $this
      ->assertCount(4, $options);
    $this
      ->assertEquals($this->usAddress['address_line1'], $options[0]
      ->getText());
    $this
      ->assertEquals($this->frenchAddress['address_line1'], $options[1]
      ->getText());
    $this
      ->assertEquals($this->frenchAddress['address_line1'] . ' (current version)', $options[2]
      ->getText());
    $this
      ->assertEquals('+ Enter a new address', $options[3]
      ->getText());
    $this
      ->assertNotEmpty($options[2]
      ->getAttribute('selected'));
    $this
      ->assertEquals('_original', $options[2]
      ->getValue());
    $this
      ->assertRenderedAddress($new_french_address);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    // Editing the profile should not result in an address book copy, since
    // the source address book profile is now out of sync.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: No');

    // Populated from a deleted address book profile.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->setData('address_book_profile_id', '999');
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->assertSession()
      ->fieldValueEquals('profile[select_address]', '_original');
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    // Since there's no matching address book profile ID, the profile should
    // be treated as a one-off (with the checkbox shown to allow copying again).
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains('Save to my address book');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: No');
  }

  /**
   * Tests the address book in "multiple" mode, for administrators.
   */
  public function testMultipleAdministrator() {

    // Start from a one-off profile, then add it to the address book.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains("Save to the customer's address book");
    $this
      ->submitForm([
      'profile[copy_to_address_book]' => TRUE,
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR.');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);
    $this
      ->assertNotEmpty($profile
      ->getData('address_book_profile_id'));
    $address_book_profile_id = $profile
      ->getData('address_book_profile_id');
    $address_book_profile = Profile::load($address_book_profile_id);
    $this
      ->assertTrue($address_book_profile
      ->isDefault());
    $this
      ->assertEquals($this->frenchAddress, array_filter($address_book_profile
      ->get('address')
      ->first()
      ->toArray()));

    // Update the profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }

    // The copy checkbox should be hidden and checked.
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR.');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);

    /** @var \Drupal\profile\Entity\ProfileInterface $address_book_profile */
    $address_book_profile = $this
      ->reloadEntity($address_book_profile);
    $this
      ->assertEquals('37 Rue du Sentier', $profile
      ->get('address')
      ->first()
      ->getAddressLine1());
    $this
      ->assertEquals('37 Rue du Sentier', $address_book_profile
      ->get('address')
      ->first()
      ->getAddressLine1());

    // Replace the profile with a new one.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains("Save to the customer's address book");
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
      'profile[copy_to_address_book]' => TRUE,
    ], 'Submit');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);

    /** @var \Drupal\profile\Entity\ProfileInterface $address_book_profile */
    $address_book_profile = $this
      ->reloadEntity($address_book_profile);
    $new_address_book_profile_id = $profile
      ->getData('address_book_profile_id');
    $new_address_book_profile = Profile::load($new_address_book_profile_id);

    // Confirm that the previous address book profile is unchanged.
    $this
      ->assertEquals('37 Rue du Sentier', $address_book_profile
      ->get('address')
      ->first()
      ->getAddressLine1());
    $this
      ->assertNotEquals($new_address_book_profile
      ->id(), $address_book_profile
      ->id());

    // Confirm that the profile and the new address book profile have the
    // expected values.
    $this
      ->assertEquals('Cetinjska 13', $profile
      ->get('address')
      ->first()
      ->getAddressLine1());
    $this
      ->assertEquals('Cetinjska 13', $new_address_book_profile
      ->get('address')
      ->first()
      ->getAddressLine1());

    // Confirm that both address book profiles are now present in the dropdown.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $options = $this
      ->xpath('//select[@name="profile[select_address]"]/option');
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('37 Rue du Sentier', $options[0]
      ->getText());
    $this
      ->assertEquals('Cetinjska 13', $options[1]
      ->getText());
    $this
      ->assertEquals('+ Enter a new address', $options[2]
      ->getText());
    $this
      ->assertNotEmpty($options[1]
      ->getAttribute('selected'));

    // Confirm that a deleted address book profile is detected.
    $new_address_book_profile
      ->delete();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $options = $this
      ->xpath('//select[@name="profile[select_address]"]/option');
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('37 Rue du Sentier', $options[0]
      ->getText());
    $this
      ->assertEquals('Cetinjska 13', $options[1]
      ->getText());
    $this
      ->assertEquals('+ Enter a new address', $options[2]
      ->getText());
    $this
      ->assertNotEmpty($options[1]
      ->getAttribute('selected'));
    $this
      ->assertEquals('_original', $options[1]
      ->getValue());
    $rendered_address = [
      'country_code' => 'RS',
      'locality' => 'Belgrade',
      'address_line1' => 'Cetinjska 13',
      'given_name' => 'John',
      'family_name' => 'Smith',
    ];
    $this
      ->assertRenderedAddress($rendered_address);
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains("Save to the customer's address book");
  }

  /**
   * Tests the address book in "single" mode, on a new profile entity.
   */
  public function testSingleNew() {

    /** @var \Drupal\profile\Entity\ProfileTypeInterface $profile_type */
    $profile_type = ProfileType::load('customer');
    $profile_type
      ->setMultiple(FALSE);
    $profile_type
      ->save();

    // Confirm that without a default profile, an empty form is shown.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');

    // Confirm that the form can be submitted.
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "Cetinjska 13" and the country code is RS. Address book: Yes');

    // Create a default profile for the current user.
    $default_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->frenchAddress,
    ]);
    $default_profile
      ->save();

    // Confirm that the profile is rendered, and no address fields are present.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: Yes');
  }

  /**
   * Tests the address book in "single" mode, on an existing profile entity.
   *
   * In "single" mode the default address book profile always contains the last
   * entered address, requiring every customer edit to result in a copy, even if
   * the profile was standalone, or referencing a deleted address book profile.
   */
  public function testSingleExisting() {

    /** @var \Drupal\profile\Entity\ProfileTypeInterface $profile_type */
    $profile_type = ProfileType::load('customer');
    $profile_type
      ->setMultiple(FALSE);
    $profile_type
      ->save();

    // Standalone profile.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->assertSession()
      ->fieldNotExists('select_address');

    // Confirm that the french address is shown rendered.
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that the profile can be edited.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: Yes');
    $us_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->usAddress,
    ]);
    $us_profile
      ->save();
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
    ]);
    $profile
      ->populateFromProfile($us_profile);
    $profile
      ->setData('address_book_profile_id', $us_profile
      ->id());
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->assertSession()
      ->fieldNotExists('select_address');

    // Confirm that the US address is shown rendered.
    $this
      ->assertRenderedAddress($this->usAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "9 Drupal Ave" and the country code is US. Address book: No');

    // Confirm that the profile can be edited.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->usAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '10 Drupal Ave',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "10 Drupal Ave" and the country code is US. Address book: Yes');

    // Populated from a deleted address book profile.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->setData('address_book_profile_id', '999');
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->assertSession()
      ->fieldNotExists('select_address');
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR. Address book: No');

    // Confirm that it is possible to edit the profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('select_address');
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR. Address book: Yes');
  }

  /**
   * Tests the address book in "single" mode, for administrators.
   */
  public function testSingleAdministrator() {

    /** @var \Drupal\profile\Entity\ProfileTypeInterface $profile_type */
    $profile_type = ProfileType::load('customer');
    $profile_type
      ->setMultiple(FALSE);
    $profile_type
      ->save();

    // Start from a one-off profile, then add it to the address book.
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $this->frenchAddress,
    ]);
    $profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $this
      ->assertSession()
      ->fieldNotExists('select_address');
    $this
      ->assertRenderedAddress($this->frenchAddress);
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains("Save to the customer's address book");
    $this
      ->submitForm([
      'profile[copy_to_address_book]' => '1',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "38 Rue du Sentier" and the country code is FR.');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);
    $this
      ->assertNotEmpty($profile
      ->getData('address_book_profile_id'));
    $address_book_profile_id = $profile
      ->getData('address_book_profile_id');
    $address_book_profile = Profile::load($address_book_profile_id);
    $this
      ->assertTrue($address_book_profile
      ->isDefault());
    $this
      ->assertEquals($this->frenchAddress, array_filter($address_book_profile
      ->get('address')
      ->first()
      ->toArray()));

    // Update the profile.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $this
      ->assertSession()
      ->fieldNotExists('select_address');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->frenchAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains("Also update the address in the customer's address book");
    $this
      ->submitForm([
      'profile[address][0][address][address_line1]' => '37 Rue du Sentier',
      'profile[copy_to_address_book]' => TRUE,
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "37 Rue du Sentier" and the country code is FR.');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);

    /** @var \Drupal\profile\Entity\ProfileInterface $address_book_profile */
    $address_book_profile = $this
      ->reloadEntity($address_book_profile);
    $this
      ->assertEquals('37 Rue du Sentier', $profile
      ->get('address')
      ->first()
      ->getAddressLine1());
    $this
      ->assertEquals('37 Rue du Sentier', $address_book_profile
      ->get('address')
      ->first()
      ->getAddressLine1());

    // Confirm that a deleted address book profile is detected.
    $address_book_profile
      ->delete();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $profile
      ->id() . '/TRUE');
    $rendered_address = [
      'address_line1' => '37 Rue du Sentier',
    ] + $this->frenchAddress;
    $this
      ->assertRenderedAddress($rendered_address);
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->checkboxNotChecked('profile[copy_to_address_book]');
    $this
      ->assertSession()
      ->pageTextContains("Save to the customer's address book");
  }

  /**
   * Tests the address book for anonymous customers.
   */
  public function testAnonymous() {
    $this
      ->drupalLogout();

    // Test the address book form when multiple profiles are allowed.
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');
    $this
      ->assertSession()
      ->fieldNotExists('select_address');

    // Confirm that the address fields are shown and not pre-filled.
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');

    // Confirm value.
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "Cetinjska 13" and the country code is RS. Address book: Yes');

    // Test the address book form when only a single profile is allowed.

    /** @var \Drupal\profile\Entity\ProfileTypeInterface $profile_type */
    $profile_type = ProfileType::load('customer');
    $profile_type
      ->setMultiple(FALSE);
    $profile_type
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form');

    // Confirm that the address fields are shown and not pre-filled.
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }
    $this
      ->assertSession()
      ->fieldNotExists('profile[copy_to_address_book]');

    // Confirm value.
    $this
      ->submitForm([
      'profile[address][0][address][given_name]' => 'John',
      'profile[address][0][address][family_name]' => 'Smith',
      'profile[address][0][address][address_line1]' => 'Cetinjska 13',
      'profile[address][0][address][locality]' => 'Belgrade',
    ], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('The street is "Cetinjska 13" and the country code is RS. Address book: Yes');
  }

  /**
   * Tests switching between incomplete profiles.
   */
  public function testIncompleteProfiles() {
    $us_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->usAddress,
    ]);
    $us_profile
      ->save();
    $empty_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->emptyAddress,
    ]);
    $empty_profile
      ->save();
    $hu_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->huAddress,
    ]);
    $hu_profile
      ->save();
    $this
      ->drupalGet('/commerce_order_test/customer_profile_test_form/' . $us_profile
      ->id() . '/TRUE');
    $this
      ->assertRenderedAddress($this->usAddress);

    // Switch to empty address.
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $empty_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }

    // Switch to Hungarian incomplete profile.
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $hu_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->huAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }

    // Switch to creating new profile.
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->emptyAddress as $property => $value) {
      $this
        ->assertSession()
        ->fieldValueEquals("profile[address][0][address][{$property}]", $value);
    }

    // Switch back to US address.
    $this
      ->getSession()
      ->getPage()
      ->fillField('profile[select_address]', $us_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->usAddress);
  }

}

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.
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
CustomerProfileTest::$emptyAddress protected property An empty address.
CustomerProfileTest::$frenchAddress protected property A French address.
CustomerProfileTest::$huAddress protected property An incomplete HU address.
CustomerProfileTest::$usAddress protected property A US address.
CustomerProfileTest::setUp protected function Overrides OrderWebDriverTestBase::setUp
CustomerProfileTest::testAnonymous public function Tests the address book for anonymous customers.
CustomerProfileTest::testCountries public function Tests the country handling.
CustomerProfileTest::testIncompleteProfiles public function Tests switching between incomplete profiles.
CustomerProfileTest::testMultipleAdministrator public function Tests the address book in "multiple" mode, for administrators.
CustomerProfileTest::testMultipleExisting public function Tests the address book in "multiple" mode, on an existing profile entity.
CustomerProfileTest::testMultipleNew public function Tests the address book in "multiple" mode, on a new profile entity.
CustomerProfileTest::testSingleAdministrator public function Tests the address book in "single" mode, for administrators.
CustomerProfileTest::testSingleExisting public function Tests the address book in "single" mode, on an existing profile entity.
CustomerProfileTest::testSingleNew public function Tests the address book in "single" mode, on a new profile entity.
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.
OrderWebDriverTestBase::getAdministratorPermissions protected function Gets the permissions for the admin user. Overrides CommerceWebDriverTestBase::getAdministratorPermissions 3
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.