You are here

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

class OrderAdminTest in Commerce Core 8.2

Same name in this branch
  1. 8.2 modules/log/tests/src/Functional/OrderAdminTest.php \Drupal\Tests\commerce_log\Functional\OrderAdminTest
  2. 8.2 modules/order/tests/src/FunctionalJavascript/OrderAdminTest.php \Drupal\Tests\commerce_order\FunctionalJavascript\OrderAdminTest

Tests the order admin UI.

@group commerce

Hierarchy

Expanded class hierarchy of OrderAdminTest

File

modules/order/tests/src/FunctionalJavascript/OrderAdminTest.php, line 17

Namespace

Drupal\Tests\commerce_order\FunctionalJavascript
View source 
class OrderAdminTest extends OrderWebDriverTestBase {
  use AssertMailTrait;

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

  /**
   * The default profile.
   *
   * @var \Drupal\profile\Entity\ProfileInterface
   */
  protected $defaultProfile;

  /**
   * The second variation.
   *
   * @var \Drupal\commerce_product\Entity\ProductVariationInterface
   */
  protected $secondVariation;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->store
      ->set('billing_countries', [
      'FR',
      'US',
    ]);
    $this->store
      ->save();
    $this->defaultProfile = Profile::create([
      'type' => 'customer',
      'uid' => $this->adminUser,
      'address' => $this->defaultAddress,
    ]);
    $this->defaultProfile
      ->save();

    // Create a product variation.
    $this->secondVariation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => $this
        ->randomMachineName(),
      'price' => [
        'number' => 5.55,
        'currency_code' => 'USD',
      ],
    ]);
    $product = $this->variation
      ->getProduct();
    $product
      ->addVariation($this->secondVariation);
    $product
      ->save();
  }

  /**
   * Tests creating an order.
   */
  public function testCreateOrder() {

    // Create an order through the add form.
    $this
      ->drupalGet('/admin/commerce/orders');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Create a new order');
    $user = $this->loggedInUser
      ->getAccountName() . ' (' . $this->loggedInUser
      ->id() . ')';
    $edit = [
      'customer_type' => 'existing',
      'uid' => $user,
    ];
    $this
      ->submitForm($edit, t('Create'));
    $this
      ->getSession()
      ->getPage()
      ->pressButton('add_billing_information');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->buttonExists('hide_profile_form');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'billing_profile[0][profile]');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('hide_profile_form');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();

    // Test that commerce_order_test_field_widget_form_alter() has the expected
    // outcome.
    $this
      ->assertSame([], \Drupal::state()
      ->get("commerce_order_test_field_widget_form_alter"));

    // Test creating order items.
    $page = $this
      ->getSession()
      ->getPage();

    // First item with overriding the price.
    $this
      ->getSession()
      ->getPage()
      ->checkField('Override the unit price');
    $purchased_entity_field = $this
      ->assertSession()
      ->waitForElement('css', '[name="order_items[form][0][purchased_entity][0][target_id]"].ui-autocomplete-input');
    $purchased_entity_field
      ->setValue(substr($this->variation
      ->getSku(), 0, 4));
    $this
      ->getSession()
      ->getDriver()
      ->keyDown($purchased_entity_field
      ->getXpath(), ' ');
    $this
      ->assertSession()
      ->waitOnAutocomplete();
    $this
      ->assertSession()
      ->pageTextContains($this->variation
      ->getSku());
    $this
      ->assertCount(1, $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.ui-autocomplete li'));
    $this
      ->getSession()
      ->getPage()
      ->find('css', '.ui-autocomplete li:first-child a')
      ->click();
    $this
      ->assertSession()
      ->fieldValueEquals('order_items[form][0][purchased_entity][0][target_id]', $this->variation
      ->getSku() . ': ' . $this->variation
      ->label() . ' (' . $this->variation
      ->id() . ')');
    $page
      ->fillField('order_items[form][0][quantity][0][value]', '1');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Create order item');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContainsOnce('Unit price must be a number.');
    $page
      ->fillField('order_items[form][0][unit_price][0][amount][number]', '9.99');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Create order item');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('9.99');

    // Second item without overriding the price.
    $entity2 = $this->secondVariation
      ->getSku() . ' (' . $this->secondVariation
      ->id() . ')';
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Add new order item');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $page
      ->fillField('order_items[form][1][purchased_entity][0][target_id]', $entity2);
    $page
      ->fillField('order_items[form][1][quantity][0][value]', '1');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Create order item');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('5.55');

    // Test editing an order item.
    $edit_buttons = $this
      ->xpath('//div[@data-drupal-selector="edit-order-items-wrapper"]//input[@value="Edit"]');
    $edit_button = reset($edit_buttons);
    $edit_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $page
      ->fillField('order_items[form][inline_entity_form][entities][0][form][quantity][0][value]', '3');
    $page
      ->fillField('order_items[form][inline_entity_form][entities][0][form][unit_price][0][amount][number]', '1.11');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Update order item');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('1.11');

    // There is no adjustment - the order should save successfully.
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The order has been successfully saved.');
    $order = Order::load(1);
    $this
      ->assertNull($order
      ->getBillingProfile());

    // Use an adjustment that is not locked by default.
    $this
      ->drupalGet($order
      ->toUrl('edit-form'));
    $this
      ->getSession()
      ->getPage()
      ->pressButton('add_billing_information');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'adjustments[0][type]' => 'fee',
      'adjustments[0][definition][label]' => '',
      'adjustments[0][definition][amount][number]' => '2.00',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The adjustment label field is required.');
    $edit['adjustments[0][definition][label]'] = 'Test fee';
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The order has been successfully saved.');
    $this
      ->drupalGet('/admin/commerce/orders');
    $order_number = $this
      ->getSession()
      ->getPage()
      ->findAll('css', 'tr td.views-field-order-number');
    $this
      ->assertEquals(1, count($order_number));
    $order = $this
      ->reloadEntity($order);
    $this
      ->assertEquals(2, count($order
      ->getItems()));
    $this
      ->assertEquals(new Price('10.88', 'USD'), $order
      ->getTotalPrice());
    $this
      ->assertCount(1, $order
      ->getAdjustments());
    $billing_profile = $order
      ->getBillingProfile();
    $this
      ->assertEquals($this->defaultAddress, array_filter($billing_profile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertEquals($this->defaultProfile
      ->id(), $billing_profile
      ->getData('address_book_profile_id'));
  }

  /**
   * Tests editing an order.
   */
  public function testEditOrder() {
    $address = [
      'country_code' => 'US',
      'postal_code' => '53177',
      'locality' => 'Milwaukee',
      'address_line1' => 'Pabst Blue Ribbon Dr',
      'administrative_area' => 'WI',
      'given_name' => 'Frederick',
      'family_name' => 'Pabst',
    ];
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => $address,
    ]);
    $profile
      ->save();
    $order_item = OrderItem::create([
      'type' => 'default',
      'unit_price' => [
        'number' => '999',
        'currency_code' => 'USD',
      ],
    ]);
    $order_item
      ->save();
    $order = Order::create([
      'type' => 'default',
      'store_id' => $this->store,
      'uid' => $this->adminUser,
      'billing_profile' => $profile,
      'order_items' => [
        $order_item,
      ],
      'state' => 'completed',
    ]);
    $order
      ->save();
    $adjustments = [];
    $adjustments[] = new Adjustment([
      'type' => 'custom',
      'label' => '10% off',
      'amount' => new Price('-1.00', 'USD'),
      'percentage' => '0.1',
    ]);
    $adjustments[] = new Adjustment([
      'type' => 'custom',
      'label' => 'Handling fee',
      'amount' => new Price('10.00', 'USD'),
    ]);
    $order
      ->addAdjustment($adjustments[0]);
    $order
      ->addAdjustment($adjustments[1]);
    $order
      ->save();
    $this
      ->drupalGet($order
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->buttonNotExists('hide_profile_form');
    $this
      ->assertSession()
      ->fieldValueEquals('adjustments[0][definition][label]', '10% off');
    $this
      ->assertSession()
      ->fieldValueEquals('adjustments[1][definition][label]', 'Handling fee');
    $this
      ->assertSession()
      ->optionExists('adjustments[2][type]', 'Custom');
    $this
      ->assertSession()
      ->optionNotExists('adjustments[2][type]', 'Test order adjustment type');
    $this
      ->assertRenderedAddress($address, 'billing_profile[0][profile]');

    // Select the default profile instead.
    $this
      ->getSession()
      ->getPage()
      ->fillField('billing_profile[0][profile][select_address]', $this->defaultProfile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'billing_profile[0][profile]');

    // Edit the default profile and change the street.
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($this->defaultAddress as $property => $value) {
      $prefix = 'billing_profile[0][profile][address][0][address]';
      $this
        ->assertSession()
        ->fieldValueEquals($prefix . '[' . $property . ']', $value);
    }

    // The copy checkbox should be hidden and checked.
    $this
      ->assertSession()
      ->fieldNotExists('billing_profile[0][profile][copy_to_address_book]');
    $this
      ->submitForm([
      'billing_profile[0][profile][address][0][address][address_line1]' => '10 Drupal Ave',
    ], 'Save');

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = $this
      ->reloadEntity($profile);
    $this->defaultProfile = $this
      ->reloadEntity($this->defaultProfile);
    $expected_address = [
      'address_line1' => '10 Drupal Ave',
    ] + $this->defaultAddress;
    $this
      ->assertEquals($expected_address, array_filter($profile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertEquals($expected_address, array_filter($this->defaultProfile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertEquals($this->defaultProfile
      ->id(), $profile
      ->getData('address_book_profile_id'));
  }

  /**
   * Tests editing an order after the customer was deleted.
   */
  public function testEditOrderWithDeletedCustomer() {
    $customer = $this
      ->drupalCreateUser();
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => 0,
      'address' => [
        'country_code' => 'US',
        'postal_code' => '53177',
        'locality' => 'Milwaukee',
        'address_line1' => 'Pabst Blue Ribbon Dr',
        'administrative_area' => 'WI',
        'given_name' => 'Frederick',
        'family_name' => 'Pabst',
      ],
    ]);
    $profile
      ->save();
    $order_item = OrderItem::create([
      'type' => 'default',
      'unit_price' => [
        'number' => '999',
        'currency_code' => 'USD',
      ],
    ]);
    $order_item
      ->save();
    $order = Order::create([
      'type' => 'default',
      'state' => 'completed',
      'uid' => $customer
        ->id(),
      'store_id' => $this->store,
      'billing_profile' => $profile,
      'order_items' => [
        $order_item,
      ],
    ]);
    $order
      ->save();
    $customer
      ->delete();
    $this
      ->drupalGet($order
      ->toUrl('edit-form'));
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The order has been successfully saved.');
  }

  /**
   * Tests deleting an order.
   */
  public function testDeleteOrder() {
    $order = $this
      ->createEntity('commerce_order', [
      'type' => 'default',
      'mail' => $this->loggedInUser
        ->getEmail(),
      'uid' => $this->loggedInUser,
      'store_id' => $this->store,
    ]);
    $this
      ->drupalGet($order
      ->toUrl('delete-form'));
    $this
      ->assertSession()
      ->pageTextContains(t('Are you sure you want to delete the order @label?', [
      '@label' => $order
        ->label(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('This action cannot be undone.');
    $this
      ->submitForm([], t('Delete'));
    $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_order')
      ->resetCache([
      $order
        ->id(),
    ]);
    $order_exists = (bool) Order::load($order
      ->id());
    $this
      ->assertEmpty($order_exists);
  }

  /**
   * Tests unlocking an order.
   */
  public function testUnlockOrder() {
    $order = $this
      ->createEntity('commerce_order', [
      'type' => 'default',
      'mail' => $this->loggedInUser
        ->getEmail(),
      'uid' => $this->loggedInUser,
      'store_id' => $this->store,
      'locked' => TRUE,
    ]);
    $this
      ->drupalGet($order
      ->toUrl('unlock-form'));
    $this
      ->assertSession()
      ->pageTextContains(t('Are you sure you want to unlock the order @label?', [
      '@label' => $order
        ->label(),
    ]));
    $this
      ->submitForm([], t('Unlock'));
    $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_order')
      ->resetCache([
      $order
        ->id(),
    ]);
    $order = Order::load($order
      ->id());
    $this
      ->assertFalse($order
      ->isLocked());
  }

  /**
   * Tests resending the order receipt.
   */
  public function testResendReceipt() {

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $this
      ->createEntity('commerce_order', [
      'type' => 'default',
      'mail' => $this->loggedInUser
        ->getEmail(),
      'uid' => $this->loggedInUser,
      'store_id' => $this->store,
      'locked' => TRUE,
    ]);

    // No access until the order has been placed.
    $this
      ->drupalGet($order
      ->toUrl('resend-receipt-form'));
    $this
      ->assertSession()
      ->pageTextContains('Access denied');

    // Placing the order sends the receipt.
    $transition = $order
      ->getState()
      ->getTransitions();
    $order
      ->getState()
      ->applyTransition($transition['place']);
    $order
      ->save();
    $emails = $this
      ->getMails();
    $this
      ->assertEquals(1, count($emails));
    $email = array_pop($emails);
    $this
      ->assertEquals('Order #' . $order
      ->getOrderNumber() . ' confirmed', $email['subject']);

    // Change the order number to differentiate from automatic email.
    $order
      ->setOrderNumber('2018/01');
    $order
      ->save();
    $this
      ->drupalGet($order
      ->toUrl('resend-receipt-form'));
    $this
      ->assertSession()
      ->pageTextContains(t('Are you sure you want to resend the receipt for order @label?', [
      '@label' => $order
        ->label(),
    ]));
    $this
      ->submitForm([], t('Resend receipt'));
    $emails = $this
      ->getMails();
    $this
      ->assertEquals(2, count($emails));
    $email = array_pop($emails);
    $this
      ->assertEquals('Order #2018/01 confirmed', $email['subject']);
    $this
      ->assertSession()
      ->pageTextContains("Order receipt resent.");
  }

  /**
   * Tests that an admin can view an order's details.
   */
  public function testAdminOrderView() {

    // Start from an order without any order items.

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $this
      ->createEntity('commerce_order', [
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'mail' => $this->loggedInUser
        ->getEmail(),
      'state' => 'draft',
      'uid' => $this->loggedInUser,
    ]);

    // First test that the current admin user can see the order.
    $this
      ->drupalGet($order
      ->toUrl()
      ->toString());
    $this
      ->assertSession()
      ->pageTextContains($this->loggedInUser
      ->getEmail());

    // Confirm that the order item table is showing the empty text.
    $this
      ->assertSession()
      ->pageTextContains('There are no order items yet.');
    $this
      ->assertSession()
      ->pageTextNotContains('Subtotal');

    // Confirm that the transition buttons are visible and functional.
    $workflow = $order
      ->getState()
      ->getWorkflow();
    $transitions = $workflow
      ->getAllowedTransitions($order
      ->getState()
      ->getId(), $order);
    foreach ($transitions as $transition) {
      $this
        ->assertSession()
        ->linkExists($transition
        ->getLabel());
    }
    $this
      ->click('a.button#edit-place');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to apply this transition?');
    $this
      ->assertSession()
      ->linkExists('Cancel');
    $this
      ->assertSession()
      ->buttonExists('Confirm');

    // Note, there is some odd behavior calling the `press()` method on the
    // button, so after asserting it exists, click via this method.
    $this
      ->click('button:contains("Confirm")');
    $this
      ->assertSession()
      ->linkNotExists('Place order');
    $this
      ->assertSession()
      ->linkNotExists('Cancel order');

    // The order was modified and needs to be reloaded.
    $order = $this
      ->reloadEntity($order);

    // Add an order item, confirm that it is displayed.
    $order_item = $this
      ->createEntity('commerce_order_item', [
      'type' => 'default',
      'unit_price' => [
        'number' => '999',
        'currency_code' => 'USD',
      ],
    ]);
    $order
      ->setItems([
      $order_item,
    ]);
    $order
      ->save();
    $this
      ->drupalGet($order
      ->toUrl()
      ->toString());
    $this
      ->assertSession()
      ->pageTextNotContains('There are no order items yet.');
    $this
      ->assertSession()
      ->pageTextContains('$999.00');
    $this
      ->assertSession()
      ->pageTextContains('Subtotal');

    // Logout and check that anonymous users cannot see the order admin screen.
    $this
      ->drupalLogout();
    $this
      ->drupalGet($order
      ->toUrl()
      ->toString());
    $this
      ->assertSession()
      ->pageTextContains('Access denied');
  }

}

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
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
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
OrderAdminTest::$defaultAddress protected property The default profile's address.
OrderAdminTest::$defaultProfile protected property The default profile.
OrderAdminTest::$secondVariation protected property The second variation.
OrderAdminTest::setUp protected function Overrides OrderWebDriverTestBase::setUp
OrderAdminTest::testAdminOrderView public function Tests that an admin can view an order's details.
OrderAdminTest::testCreateOrder public function Tests creating an order.
OrderAdminTest::testDeleteOrder public function Tests deleting an order.
OrderAdminTest::testEditOrder public function Tests editing an order.
OrderAdminTest::testEditOrderWithDeletedCustomer public function Tests editing an order after the customer was deleted.
OrderAdminTest::testResendReceipt public function Tests resending the order receipt.
OrderAdminTest::testUnlockOrder public function Tests unlocking an order.
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.