You are here

class OrderTest in Ubercart 8.4

Tests for Ubercart orders.

@group ubercart

Hierarchy

Expanded class hierarchy of OrderTest

File

uc_order/tests/src/Functional/OrderTest.php, line 14

Namespace

Drupal\Tests\uc_order\Functional
View source
class OrderTest extends UbercartBrowserTestBase {

  /**
   * Authenticated but unprivileged user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $customer;

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

    // Need page_title_block because we test page titles.
    $this
      ->drupalPlaceBlock('page_title_block');

    // Create a simple customer user account.
    $this->customer = $this
      ->drupalCreateUser([
      'view own orders',
    ]);
  }

  /**
   * Tests order entity API functions.
   */
  public function testOrderApi() {

    // Test defaults.
    $order = Order::create();
    $order
      ->save();
    $this
      ->assertEquals(0, $order
      ->getOwnerId(), 'New order is anonymous.');
    $this
      ->assertEquals('in_checkout', $order
      ->getStatusId(), 'New order is in checkout.');
    $order = Order::create([
      'uid' => $this->customer
        ->id(),
      'order_status' => uc_order_state_default('completed'),
    ]);
    $order
      ->save();
    $this
      ->assertEquals($this->customer
      ->id(), $order
      ->getOwnerId(), 'New order has correct uid.');
    $this
      ->assertEquals('completed', $order
      ->getStatusId(), 'New order is marked completed.');

    // Test deletion.
    $order
      ->delete();
    $deleted_order = Order::load($order
      ->id());
    $this
      ->assertFalse($deleted_order, 'Order was successfully deleted');
  }

  /**
   * Tests order CRUD operations.
   */
  public function testOrderEntity() {
    $order = Order::create();
    $this
      ->assertEquals(0, $order
      ->getOwnerId(), 'New order is anonymous.');
    $this
      ->assertEquals('in_checkout', $order
      ->getStatusId(), 'New order is in checkout.');
    $name = $this
      ->randomMachineName();
    $order = Order::create([
      'uid' => $this->customer
        ->id(),
      'order_status' => 'completed',
      'billing_first_name' => $name,
      'billing_last_name' => $name,
    ]);
    $this
      ->assertEquals($this->customer
      ->id(), $order
      ->getOwnerId(), 'New order has correct uid.');
    $this
      ->assertEquals('completed', $order
      ->getStatusId(), 'New order is marked completed.');
    $this
      ->assertEquals($name, $order
      ->getAddress('billing')
      ->getFirstName(), 'New order has correct name.');
    $this
      ->assertEquals($name, $order
      ->getAddress('billing')
      ->getLastName(), 'New order has correct name.');

    // Test deletion.
    $order
      ->save();
    $storage = \Drupal::entityTypeManager()
      ->getStorage('uc_order');
    $entities = $storage
      ->loadMultiple([
      $order
        ->id(),
    ]);
    $storage
      ->delete($entities);
    $storage
      ->resetCache([
      $order
        ->id(),
    ]);
    $deleted_order = Order::load($order
      ->id());
    $this
      ->assertFalse($deleted_order, 'Order was successfully deleted');
  }

  /**
   * Tests order entity CRUD hooks.
   */
  public function testEntityHooks() {
    \Drupal::service('module_installer')
      ->install([
      'entity_crud_hook_test',
    ]);
    $GLOBALS['entity_crud_hook_test'] = [];
    $order = Order::create();
    $order
      ->save();
    $this
      ->assertHookMessage('entity_crud_hook_test_entity_presave called for type uc_order');
    $this
      ->assertHookMessage('entity_crud_hook_test_entity_insert called for type uc_order');
    $GLOBALS['entity_crud_hook_test'] = [];
    $order = Order::load($order
      ->id());
    $this
      ->assertHookMessage('entity_crud_hook_test_entity_load called for type uc_order');
    $GLOBALS['entity_crud_hook_test'] = [];
    $order
      ->save();
    $this
      ->assertHookMessage('entity_crud_hook_test_entity_presave called for type uc_order');
    $this
      ->assertHookMessage('entity_crud_hook_test_entity_update called for type uc_order');
    $GLOBALS['entity_crud_hook_test'] = [];
    $order
      ->delete();
    $this
      ->assertHookMessage('entity_crud_hook_test_entity_delete called for type uc_order');
  }

  /**
   * Tests admin order creation.
   */
  public function testOrderCreation() {
    $this
      ->drupalLogin($this->adminUser);

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $edit = [
      'customer_type' => 'search',
      'customer[email]' => $this->customer->mail->value,
    ];
    $this
      ->drupalGet('admin/store/orders/create');
    $this
      ->submitForm($edit, 'Search');
    $edit['customer[uid]'] = $this->customer
      ->id();
    $this
      ->submitForm($edit, 'Create order');
    $assert
      ->pageTextContains('Order created by the administration.', 'Order created by the administration.');

    // Verify the customer UID appears on the page.
    $assert
      ->fieldValueEquals('uid_text', $this->customer
      ->id());
    $order_ids = \Drupal::entityQuery('uc_order')
      ->condition('uid', $this->customer
      ->id())
      ->execute();
    $order_id = reset($order_ids);
    $this
      ->assertTrue($order_id, format_string('Found order ID @order_id', [
      '@order_id' => $order_id,
    ]));
    $this
      ->drupalGet('admin/store/orders/view');
    $assert
      ->linkByHrefExists('admin/store/orders/' . $order_id, 0, 'View link appears on order list.');
    $assert
      ->pageTextContains('Pending', 'New order is "Pending".');
    $this
      ->drupalGet('admin/store/customers/orders/' . $this->customer
      ->id());
    $assert
      ->linkByHrefExists('admin/store/orders/' . $order_id, 0, 'View link appears on customer order list.');
    $this
      ->clickLink('Create order for this customer');
    $assert
      ->pageTextContains('Order created by the administration.');

    // Verify the customer UID appears on the page.
    $assert
      ->fieldValueEquals('uid_text', $this->customer
      ->id());
  }

  /**
   * Tests order admin View.
   */
  public function testOrderView() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $order = $this
      ->ucCreateOrder($this->customer);
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $billing_address = $order
      ->getAddress('billing');

    // Check for billing first name, billing last name, billing street1
    // and billing street2.
    $assert
      ->pageTextContains(mb_strtoupper($billing_address
      ->getFirstName()));
    $assert
      ->pageTextContains(mb_strtoupper($billing_address
      ->getLastName()));
    $assert
      ->pageTextContains(mb_strtoupper($billing_address
      ->getStreet1()));
    $assert
      ->pageTextContains(mb_strtoupper($billing_address
      ->getStreet2()));

    // Some country formats don't use City in addresses.
    $country = \Drupal::service('country_manager')
      ->getCountry($billing_address
      ->getCountry());
    if (strpos(implode('', $country
      ->getAddressFormat()), 'city') === FALSE) {

      // Check for billing city.
      $assert
        ->pageTextContains(mb_strtoupper($billing_address
        ->getCity()));
    }
    $delivery_address = $order
      ->getAddress('delivery');

    // Check for delivery first name, delivery last name, delivery street1
    // and delivery street2.
    $assert
      ->pageTextContains(mb_strtoupper($delivery_address
      ->getFirstName()));
    $assert
      ->pageTextContains(mb_strtoupper($delivery_address
      ->getLastName()));
    $assert
      ->pageTextContains(mb_strtoupper($delivery_address
      ->getStreet1()));
    $assert
      ->pageTextContains(mb_strtoupper($delivery_address
      ->getStreet2()));
    $country = \Drupal::service('country_manager')
      ->getCountry($delivery_address
      ->getCountry());
    if (strpos(implode('', $country
      ->getAddressFormat()), 'city') === FALSE) {

      // Check for delivery city.
      $assert
        ->pageTextContains(mb_strtoupper($delivery_address
        ->getCity()));
    }
    $assert
      ->linkExists($order
      ->getOwnerId(), 0, 'Link to customer account page found.');
    $assert
      ->linkExists($order
      ->getEmail(), 0, 'Link to customer email address found.');
  }

  /**
   * Tests the customer View of the completed order.
   */
  public function testOrderCustomerView() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $order = $this
      ->ucCreateOrder($this->customer);

    // Update the status to pending, so the user can see the order on the
    // "My order history" page.
    $order
      ->setStatusId('pending');
    $order
      ->save();
    $this
      ->drupalLogin($this->customer);
    $this
      ->drupalGet('user/' . $this->customer
      ->id() . '/orders');
    $assert
      ->pageTextContains('My order history');
    $assert
      ->pageTextContains('Pending', 'Order status is visible to the customer.');
    $this
      ->drupalGet('user/' . $this->customer
      ->id() . '/orders/' . $order
      ->id());
    $assert
      ->statusCodeEquals(200, 'Customer can view their own order.');
    $address = $order
      ->getAddress('billing');

    // Check for customer first and last name.
    $assert
      ->pageTextContains(mb_strtoupper($address
      ->getFirstName()));
    $assert
      ->pageTextContains(mb_strtoupper($address
      ->getLastName()));
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $assert
      ->statusCodeEquals(403, 'Customer may not see the admin view of their order.');
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id() . '/edit');
    $assert
      ->statusCodeEquals(403, 'Customer may not edit orders.');
  }

  /**
   * Tests admin editing of orders.
   */
  public function testOrderEditing() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $order = $this
      ->ucCreateOrder($this->customer);
    $this
      ->drupalLogin($this->adminUser);
    $edit = [
      'billing[first_name]' => $this
        ->randomMachineName(8),
      'billing[last_name]' => $this
        ->randomMachineName(15),
    ];
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id() . '/edit');
    $this
      ->submitForm($edit, 'Save changes');
    $assert
      ->pageTextContains('Order changes saved.');

    // Verify that the billing first name changed.
    $assert
      ->fieldValueEquals('billing[first_name]', $edit['billing[first_name]']);

    // Verify that the billing last name changed.
    $assert
      ->fieldValueEquals('billing[last_name]', $edit['billing[last_name]']);
  }

  /**
   * Tests admin and automatic changing of order state and status.
   */
  public function testOrderState() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $this
      ->drupalLogin($this->adminUser);

    // Check that the default order state and status is correct.
    $this
      ->drupalGet('admin/store/config/orders');

    // Verify that state defaults to correct default status.
    $assert
      ->fieldValueEquals('order_states[in_checkout][default]', 'in_checkout');
    $this
      ->assertEquals('in_checkout', uc_order_state_default('in_checkout'), 'uc_order_state_default() returns correct default status.');
    $order = $this
      ->ucCreateOrder($this->customer);
    $this
      ->assertEquals('in_checkout', $order
      ->getStateId(), 'Order has correct default state.');
    $this
      ->assertEquals('in_checkout', $order
      ->getStatusId(), 'Order has correct default status.');

    // Create a custom "in checkout" order status with a lower weight.
    $this
      ->drupalGet('admin/store/config/orders');
    $this
      ->clickLink('Create custom order status');
    $edit = [
      'id' => strtolower($this
        ->randomMachineName()),
      'name' => $this
        ->randomMachineName(),
      'state' => 'in_checkout',
      'weight' => -15,
    ];
    $this
      ->submitForm($edit, 'Create');
    $this
      ->assertEquals($edit['id'], uc_order_state_default('in_checkout'), 'uc_order_state_default() returns lowest weight status.');

    // Set "in checkout" state to default to the new status.
    $this
      ->submitForm([
      'order_states[in_checkout][default]' => $edit['id'],
    ], 'Save configuration');

    // Verify that state defaults to custom status.
    $assert
      ->fieldValueEquals('order_states[in_checkout][default]', $edit['id']);
    $order = $this
      ->ucCreateOrder($this->customer);
    $this
      ->assertEquals($edit['id'], $order
      ->getStatusId(), 'Order has correct custom status.');
  }

  /**
   * Tests using custom order statuses.
   */
  public function testCustomOrderStatus() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $order = $this
      ->ucCreateOrder($this->customer);
    $this
      ->drupalLogin($this->adminUser);

    // Update an order status label.
    $this
      ->drupalGet('admin/store/config/orders');
    $title = $this
      ->randomMachineName();
    $edit = [
      'order_statuses[in_checkout][name]' => $title,
    ];
    $this
      ->submitForm($edit, 'Save configuration');

    // Verify that updated status title found.
    $assert
      ->fieldValueEquals('order_statuses[in_checkout][name]', $title);

    // Confirm the updated label is displayed.
    $this
      ->drupalGet('admin/store/orders/view');

    // Check that order displays updated status title.
    $assert
      ->pageTextContains($title);

    // Create a custom order status.
    $this
      ->drupalGet('admin/store/config/orders');
    $this
      ->clickLink('Create custom order status');
    $edit = [
      'id' => strtolower($this
        ->randomMachineName()),
      'name' => $this
        ->randomMachineName(),
      'state' => array_rand(uc_order_state_options_list()),
      'weight' => mt_rand(-10, 10),
    ];
    $this
      ->submitForm($edit, 'Create');
    $assert
      ->pageTextContains($edit['id'], 'Custom status ID found.');

    // Verify that custom status title found.
    $assert
      ->fieldValueEquals('order_statuses[' . $edit['id'] . '][name]', $edit['name']);

    // Verify that custom status weight found.
    $assert
      ->fieldValueEquals('order_statuses[' . $edit['id'] . '][weight]', $edit['weight']);

    // Set an order to the custom status.
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $this
      ->submitForm([
      'status' => $edit['id'],
    ], 'Update');
    $this
      ->drupalGet('admin/store/orders/view');
    $assert
      ->pageTextContains($edit['name'], 'Order displays custom status title.');

    // Delete the custom order status.
    $this
      ->drupalGet('admin/store/config/orders');
    $this
      ->submitForm([
      'order_statuses[' . $edit['id'] . '][remove]' => 1,
    ], 'Save configuration');
    $assert
      ->pageTextNotContains($edit['id'], 'Deleted status ID not found.');
  }

  /**
   * Helper function for creating an order programmatically.
   */
  protected function ucCreateOrder($customer) {
    $order = Order::create([
      'uid' => $customer
        ->id(),
    ]);
    $order
      ->save();
    uc_order_comment_save($order
      ->id(), 0, 'Order created programmatically.', 'admin');
    $order_ids = \Drupal::entityQuery('uc_order')
      ->condition('order_id', $order
      ->id())
      ->execute();
    $this
      ->assertTrue(in_array($order
      ->id(), $order_ids), format_string('Found order ID @order_id', [
      '@order_id' => $order
        ->id(),
    ]));
    $country_manager = \Drupal::service('country_manager');
    $country = array_rand($country_manager
      ->getEnabledList());
    $zones = $country_manager
      ->getZoneList($country);
    $delivery_address = Address::create();
    $delivery_address
      ->setFirstName($this
      ->randomMachineName(12))
      ->setLastName($this
      ->randomMachineName(12))
      ->setStreet1($this
      ->randomMachineName(12))
      ->setStreet2($this
      ->randomMachineName(12))
      ->setCity($this
      ->randomMachineName(12))
      ->setPostalCode(mt_rand(10000, 99999))
      ->setCountry($country);
    if (!empty($zones)) {
      $delivery_address
        ->setZone(array_rand($zones));
    }
    $billing_address = Address::create();
    $billing_address
      ->setFirstName($this
      ->randomMachineName(12))
      ->setLastName($this
      ->randomMachineName(12))
      ->setStreet1($this
      ->randomMachineName(12))
      ->setStreet2($this
      ->randomMachineName(12))
      ->setCity($this
      ->randomMachineName(12))
      ->setPostalCode(mt_rand(10000, 99999))
      ->setCountry($country);
    if (!empty($zones)) {
      $billing_address
        ->setZone(array_rand($zones));
    }
    $order
      ->setAddress('delivery', $delivery_address)
      ->setAddress('billing', $billing_address)
      ->save();

    // Force the order to load from the DB instead of the entity cache.
    $db_order = \Drupal::entityTypeManager()
      ->getStorage('uc_order')
      ->loadUnchanged($order
      ->id());

    // Compare delivery and billing addresses to those loaded from the database.
    $db_delivery_address = $db_order
      ->getAddress('delivery');
    $db_billing_address = $db_order
      ->getAddress('billing');
    $this
      ->assertEquals($db_delivery_address, $delivery_address, 'Delivery address is equal to delivery address in database.');
    $this
      ->assertEquals($db_billing_address, $billing_address, 'Billing address is equal to billing address in database.');
    return $order;
  }

  /**
   * Helper function for testing order entity CRUD hooks.
   */
  protected function assertHookMessage($text, $message = NULL, $group = 'Other') {
    if (!isset($message)) {
      $message = $text;
    }
    return $this
      ->assertNotSame(FALSE, array_search($text, $GLOBALS['entity_crud_hook_test']), $message, $group);
  }

}

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.
AttributeTestTrait::createAttribute protected function Creates an attribute.
AttributeTestTrait::createAttributeOption protected function Creates an attribute option.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
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
OrderTest::$customer protected property Authenticated but unprivileged user.
OrderTest::assertHookMessage protected function Helper function for testing order entity CRUD hooks.
OrderTest::setUp protected function Overrides UbercartBrowserTestBase::setUp
OrderTest::testCustomOrderStatus public function Tests using custom order statuses.
OrderTest::testEntityHooks public function Tests order entity CRUD hooks.
OrderTest::testOrderApi public function Tests order entity API functions.
OrderTest::testOrderCreation public function Tests admin order creation.
OrderTest::testOrderCustomerView public function Tests the customer View of the completed order.
OrderTest::testOrderEditing public function Tests admin editing of orders.
OrderTest::testOrderEntity public function Tests order CRUD operations.
OrderTest::testOrderState public function Tests admin and automatic changing of order state and status.
OrderTest::testOrderView public function Tests order admin View.
OrderTest::ucCreateOrder protected function Helper function for creating an order programmatically.
OrderTestTrait::createOrder protected function Creates a new order directly, without going through checkout.
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.
ProductTestTrait::createProduct protected function Creates a new product.
ProductTestTrait::createProductClass protected function Creates a new product node type, AKA 'product class'.
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.
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::$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
UbercartBrowserTestBase::$adminPermissions protected static property Permissions for administrator user. 11
UbercartBrowserTestBase::$adminUser protected property User with privileges to do everything.
UbercartBrowserTestBase::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 21
UbercartBrowserTestBase::$product protected property Test product.
UbercartBrowserTestBase::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile 1
UbercartBrowserTestBase::$strictConfigSchema protected property Don't check for or validate config schema. Overrides TestSetupTrait::$strictConfigSchema
UbercartBrowserTestBase::addToCart protected function Adds a product to the cart.
UbercartBrowserTestBase::assertNoMailString protected function Asserts that the most recently sent e-mails do not have the string in it.
UbercartBrowserTestBase::checkout protected function Executes the checkout process.
UbercartBrowserTestBase::createPaymentMethod protected function Defines a new payment method.
UbercartBrowserTestBase::populateCheckoutForm protected function Helper function to fill-in required fields on the checkout page. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.