class CheckoutTest in Commerce Stripe 8

Tests checkout with Stripe.

@group commerce_stripe

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\FunctionalJavascriptTests\WebDriverTestBase
    • class \Drupal\Tests\commerce\FunctionalJavascript\CommerceWebDriverTestBase uses StoreCreationTrait, BlockCreationTrait, CommerceBrowserTestTrait, DeprecationSuppressionTrait
      • class \Drupal\Tests\commerce_stripe\FunctionalJavascript\CheckoutTest

File

tests/src/FunctionalJavascript/CheckoutTest.php, line 23

Namespace

Drupal\Tests\commerce_stripe\FunctionalJavascript

class CheckoutTest extends CommerceWebDriverTestBase {

  /**
   * The product.
   *
   * @var \Drupal\commerce_product\Entity\ProductInterface
   */
  protected $product;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'commerce_number_pattern',
    'commerce_product',
    'commerce_cart',
    'commerce_checkout',
    'commerce_stripe',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $variation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => strtolower($this
        ->randomMachineName()),
      'price' => [
        'number' => '9.99',
        'currency_code' => 'USD',
      ],
    ]);

    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
    $this->product = $this
      ->createEntity('commerce_product', [
      'type' => 'default',
      'title' => 'My product',
      'variations' => [
        $variation,
      ],
      'stores' => [
        $this->store
          ->id(),
      ],
    ]);
    $gateway = PaymentGateway::create([
      'id' => 'stripe_testing',
      'label' => 'Stripe',
      'plugin' => 'stripe',
      'configuration' => [
        'payment_method_types' => [
          'credit_card',
        ],
        'publishable_key' => StripeIntegrationTestBase::TEST_PUBLISHABLE_KEY,
        'secret_key' => StripeIntegrationTestBase::TEST_SECRET_KEY,
      ],
    ]);
    $gateway
      ->save();

    // Cheat so we don't need JS to interact w/ Address field widget.

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $customer_form_display */
    $customer_form_display = EntityFormDisplay::load('profile.customer.default');
    $address_component = $customer_form_display
      ->getComponent('address');
    $address_component['settings']['default_country'] = 'US';
    $customer_form_display
      ->setComponent('address', $address_component);
    $customer_form_display
      ->save();
    $this
      ->drupalLogout();
  }

  /**
   * Tests an anonymous customer can checkout.
   *
   * This uses a card which does not trigger SCA or 3DS authentication.
   *
   * @dataProvider dataProviderUserAuthenticated
   */
  public function testCheckoutAndPayment($authenticated) {
    if ($authenticated) {
      $customer = $this
        ->createUser();
      $this
        ->drupalLogin($customer);
    }
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    if (!$authenticated) {
      $this
        ->submitForm([], 'Continue as Guest');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email]', '[e-mail]');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email_confirm]', '[e-mail]');
    }
    $this
      ->fillCreditCardData('4242424242424242', '0322', '123');
    $this
      ->submitForm([
      'payment_information[add_payment_method][billing_information][address][0][address][given_name]' => 'Johnny',
      'payment_information[add_payment_method][billing_information][address][0][address][family_name]' => 'Appleseed',
      'payment_information[add_payment_method][billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'payment_information[add_payment_method][billing_information][address][0][address][locality]' => 'New York City',
      'payment_information[add_payment_method][billing_information][address][0][address][administrative_area]' => 'NY',
      'payment_information[add_payment_method][billing_information][address][0][address][postal_code]' => '10001',
    ], 'Continue to review');
    $this
      ->assertWaitForText('Visa ending in 4242');
    $this
      ->assertWaitForText('Expires 3/2022');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertWaitForText('Your order number is 1. You can view your order on your account page when logged in.');
  }

  /**
   * Tests checkout without billing information.
   *
   * This uses a card which does not trigger SCA or 3DS authentication.
   *
   * @dataProvider dataProviderUserAuthenticated
   */
  public function testNoBillingCheckout($authenticated) {
    $payment_gateway = PaymentGateway::load('stripe_testing');
    $configuration = $payment_gateway
      ->getPlugin()
      ->getConfiguration();
    $configuration['collect_billing_information'] = FALSE;
    $payment_gateway
      ->getPlugin()
      ->setConfiguration($configuration);
    $payment_gateway
      ->save();
    if ($authenticated) {
      $customer = $this
        ->createUser();
      $this
        ->drupalLogin($customer);
    }
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    if (!$authenticated) {
      $this
        ->submitForm([], 'Continue as Guest');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email]', '[e-mail]');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email_confirm]', '[e-mail]');
    }
    $this
      ->fillCreditCardData('4242424242424242', '0322', '123');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertWaitForText('Visa ending in 4242');
    $this
      ->assertWaitForText('Expires 3/2022');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertWaitForText('Your order number is 1. You can view your order on your account page when logged in.');
  }

  /**
   * Tests customer, with regulations, can checkout.
   *
   * This card requires authentication for one-time payments. However, if you
   * set up this card and use the saved card for subsequent off-session
   * payments, no further authentication is needed. In live mode, Stripe
   * dynamically determines when a particular transaction requires
   * authentication due to regional regulations such as
   * Strong Customer Authentication.
   *
   * @dataProvider dataProviderUserAuthenticatedAndCardAuthentication
   * @group threeds
   */
  public function testCheckoutAndPayPayment3ds($authenticated, $pass) {
    if ($authenticated) {
      $customer = $this
        ->createUser();
      $this
        ->drupalLogin($customer);
    }
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    if (!$authenticated) {
      $this
        ->submitForm([], 'Continue as Guest');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email]', '[e-mail]');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email_confirm]', '[e-mail]');
    }
    $this
      ->fillCreditCardData('4000002500003155', '0322', '123');
    $this
      ->submitForm([
      'payment_information[add_payment_method][billing_information][address][0][address][given_name]' => 'Johnny',
      'payment_information[add_payment_method][billing_information][address][0][address][family_name]' => 'Appleseed',
      'payment_information[add_payment_method][billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'payment_information[add_payment_method][billing_information][address][0][address][locality]' => 'New York City',
      'payment_information[add_payment_method][billing_information][address][0][address][administrative_area]' => 'NY',
      'payment_information[add_payment_method][billing_information][address][0][address][postal_code]' => '10001',
    ], 'Continue to review');
    $this
      ->assertWaitForText('Visa ending in 3155');
    $this
      ->assertWaitForText('Expires 3/2022');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Pay and complete purchase');
    $this
      ->complete3ds($pass);
    if ($pass) {
      $this
        ->assertWaitForText('Your order number is 1. You can view your order on your account page when logged in.');
    }
    else {
      $this
        ->assertWaitForText('We encountered an error processing your payment method. Please verify your details and try again.');
    }
  }

  /**
   * Tests customer, with regulations, can checkout.
   *
   * This card requires authentication on all transactions, regardless of how
   * the card is set up.
   *
   * @note: When always using SetupIntent, this would cause two authentication
   * modals. One when persisting the payment method and another when confirming
   * the payment intent.
   *
   * @dataProvider dataProviderUserAuthenticatedAndCardAuthentication
   * @group threeds
   */
  public function test3dsAlwaysAuthenticate($authenticated, $pass) {
    if ($authenticated) {
      $customer = $this
        ->createUser();
      $this
        ->drupalLogin($customer);
    }
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    if (!$authenticated) {
      $this
        ->submitForm([], 'Continue as Guest');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email]', '[e-mail]');
      $this
        ->getSession()
        ->getPage()
        ->fillField('contact_information[email_confirm]', '[e-mail]');
    }
    $this
      ->fillCreditCardData('4000002760003184', '0322', '123');
    $this
      ->submitForm([
      'payment_information[add_payment_method][billing_information][address][0][address][given_name]' => 'Johnny',
      'payment_information[add_payment_method][billing_information][address][0][address][family_name]' => 'Appleseed',
      'payment_information[add_payment_method][billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'payment_information[add_payment_method][billing_information][address][0][address][locality]' => 'New York City',
      'payment_information[add_payment_method][billing_information][address][0][address][administrative_area]' => 'NY',
      'payment_information[add_payment_method][billing_information][address][0][address][postal_code]' => '10001',
    ], 'Continue to review');
    $this
      ->assertWaitForText('Visa ending in 3184');
    $this
      ->assertWaitForText('Expires 3/2022');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Pay and complete purchase');
    $this
      ->complete3ds($pass);
    if ($pass) {
      $this
        ->assertWaitForText('Your order number is 1. You can view your order on your account page when logged in.');
    }
    else {
      $this
        ->assertWaitForText('We encountered an error processing your payment method. Please verify your details and try again.');
    }
  }

  /**
   * Tests checkout with a previously created payment method.
   *
   * @dataProvider dataProviderExistingPaymentMethodCardNumber
   * @group threeds
   * @group existing
   * @group on_session
   */
  public function testCheckoutWithExistingPaymentMethod($card_number) {
    $customer = $this
      ->createUser([
      'manage own commerce_payment_method',
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet(Url::fromRoute('entity.commerce_payment_method.add_form', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->fillCreditCardData($card_number, '0322', '123');
    $this
      ->submitForm([
      'add_payment_method[billing_information][address][0][address][given_name]' => 'Johnny',
      'add_payment_method[billing_information][address][0][address][family_name]' => 'Appleseed',
      'add_payment_method[billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'add_payment_method[billing_information][address][0][address][locality]' => 'New York City',
      'add_payment_method[billing_information][address][0][address][administrative_area]' => 'NY',
      'add_payment_method[billing_information][address][0][address][postal_code]' => '10001',
    ], 'Save');
    $this
      ->complete3ds(TRUE, FALSE);
    $this
      ->assertWaitForText('Visa ending in ' . substr($card_number, -4) . ' saved to your payment methods.');
    $this
      ->drupalGet(Url::fromRoute('entity.commerce_payment_method.collection', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in ' . substr($card_number, -4));
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in ' . substr($card_number, -4));
    $this
      ->assertSession()
      ->pageTextContains('Expires 3/2022');
    $this
      ->assertSession()
      ->pageTextContains('Order Summary');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Pay and complete purchase');
    $this
      ->complete3ds(TRUE);
    $this
      ->assertWaitForText('Your order number is 1. You can view your order on your account page when logged in.');
  }

  /**
   * Tests checkout with a previously created payment method.
   *
   * @dataProvider dataProviderExistingPaymentMethodCardNumber
   * @group threeds
   * @group existing
   * @group off_session
   */
  public function testCheckoutWithExistingPaymentMethodOffSession($card_number) {
    $customer = $this
      ->createUser([
      'manage own commerce_payment_method',
    ]);
    $this
      ->drupalLogin($customer);
    $this
      ->drupalGet(Url::fromRoute('entity.commerce_payment_method.add_form', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->fillCreditCardData($card_number, '0322', '123');
    $this
      ->submitForm([
      'add_payment_method[billing_information][address][0][address][given_name]' => 'Johnny',
      'add_payment_method[billing_information][address][0][address][family_name]' => 'Appleseed',
      'add_payment_method[billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'add_payment_method[billing_information][address][0][address][locality]' => 'New York City',
      'add_payment_method[billing_information][address][0][address][administrative_area]' => 'NY',
      'add_payment_method[billing_information][address][0][address][postal_code]' => '10001',
    ], 'Save');
    $this
      ->complete3ds(TRUE, FALSE);
    $this
      ->assertWaitForText('Visa ending in ' . substr($card_number, -4) . ' saved to your payment methods.');
    $this
      ->drupalGet(Url::fromRoute('entity.commerce_payment_method.collection', [
      'user' => $customer
        ->id(),
    ]));
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in ' . substr($card_number, -4));

    // Create an off_session order with the payment method generated.
    $cart_provider = $this->container
      ->get('commerce_cart.cart_provider');
    $cart_manager = $this->container
      ->get('commerce_cart.cart_manager');
    $cart = $cart_provider
      ->createCart('default', $this->store, $customer);
    $cart_manager
      ->addEntity($cart, $this->product
      ->getDefaultVariation());
    $gateway = PaymentGateway::load('stripe_testing');
    $payment_method = PaymentMethod::load(1);
    $cart
      ->set('billing_profile', $payment_method
      ->getBillingProfile());
    $cart
      ->set('payment_method', $payment_method);
    $cart
      ->set('payment_gateway', $gateway
      ->id());
    $cart
      ->save();
    $plugin = $gateway
      ->getPlugin();
    assert($plugin instanceof StripeInterface);
    $plugin
      ->createPaymentIntent($cart);
    $payment = Payment::create([
      'state' => 'new',
      'amount' => $cart
        ->getBalance(),
      'payment_gateway' => $gateway,
      'payment_method' => $payment_method,
      'order_id' => $cart,
    ]);

    // @todo 4000003800000446 _should_ not require authentication. Supposedly.
    // Discussed with Stripe support in IRC and they could not confirm.
    $this
      ->expectException(SoftDeclineException::class);
    $this
      ->expectExceptionMessage('The payment intent requires action by the customer for authentication');
    try {
      $plugin
        ->createPayment($payment);
    } catch (HardDeclineException $e) {
      $this
        ->fail($e
        ->getMessage());
    }
  }

  /**
   * Data provider to provide a pass or truthy data set.
   *
   * @return \Generator
   *   The data.
   */
  public function dataProviderUserAuthenticated() {
    (yield [
      TRUE,
    ]);
    (yield [
      FALSE,
    ]);
  }

  /**
   * Data provider for user authentication and card authentication.
   *
   * @return \Generator
   *   The data.
   */
  public function dataProviderUserAuthenticatedAndCardAuthentication() {

    // Logged in, card authorized.
    (yield [
      TRUE,
      TRUE,
    ]);

    // Anonymous, card authorized.
    (yield [
      FALSE,
      TRUE,
    ]);

    // Logged in, card unauthorized.
    (yield [
      TRUE,
      FALSE,
    ]);

    // Anonymous, card unauthorized.
    (yield [
      FALSE,
      FALSE,
    ]);
  }

  /**
   * Data provider for card numbers when testing existing payment methods.
   *
   * @return \Generator
   *   The data.
   */
  public function dataProviderExistingPaymentMethodCardNumber() {

    // These can be added, but must go through one authentication approval via
    // an on-session payment intent.
    (yield [
      '4000002500003155',
    ]);
    (yield [
      '4000002760003184',
    ]);

    // This card requires authentication for one-time and other on-session
    // payments. However, all off-session payments will succeed as if the card
    // has been previously set up.
    (yield [
      '4000003800000446',
    ]);
  }

  /**
   * Fills the credit card form inputs.
   *
   * @param string $card_number
   *   The card number.
   * @param string $card_exp
   *   The card expiration.
   * @param string $card_cvv
   *   The card CVV.
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \WebDriver\Exception
   */
  protected function fillCreditCardData($card_number, $card_exp, $card_cvv) {
    $this
      ->switchToElementFrame('card-number-element');
    $element = $this
      ->getSession()
      ->getPage()
      ->findField('cardnumber');
    $this
      ->fieldTypeInput($element, $card_number);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->assertSession()
      ->pageTextNotContains('Your card number is invalid.');
    $this
      ->switchToElementFrame('expiration-element');
    $element = $this
      ->getSession()
      ->getPage()
      ->findField('exp-date');
    $this
      ->fieldTypeInput($element, $card_exp);
    $this
      ->getSession()
      ->switchToIFrame();
    $this
      ->switchToElementFrame('security-code-element');
    $this
      ->getSession()
      ->getPage()
      ->fillField('cvc', $card_cvv);
    $this
      ->getSession()
      ->switchToIFrame();
  }

  /**
   * Fills an inputs values by simulated typing.
   *
   * @param \Behat\Mink\Element\NodeElement $element
   *   The element.
   * @param string $value
   *   The value.
   *
   * @throws \WebDriver\Exception
   */
  protected function fieldTypeInput(NodeElement $element, $value) {
    $driver = $this
      ->getSession()
      ->getDriver();
    $element
      ->click();
    if ($driver instanceof Selenium2Driver) {
      $wd_element = $driver
        ->getWebDriverSession()
        ->element('xpath', $element
        ->getXpath());
      foreach (str_split($value) as $char) {
        $wd_element
          ->postValue([
          'value' => [
            $char,
          ],
        ]);
        usleep(100);
      }
    }
    $element
      ->blur();
  }

  /**
   * Asserts text will become visible on the page.
   *
   * @param string $text
   *   The text.
   * @param int $wait
   *   The wait time, in seconds.
   *
   * @return bool
   *   Returns TRUE if operation succeeds.
   *
   * @throws \Exception
   */
  public function assertWaitForText($text, $wait = 20) {
    $last_exception = NULL;
    $stopTime = time() + $wait;
    while (time() < $stopTime) {
      try {
        $this
          ->assertSession()
          ->pageTextContains($text);
        return TRUE;
      } catch (\Exception $e) {

        // If the text has not been found, keep waiting.
        $last_exception = $e;
      }
      usleep(250000);
    }
    $this
      ->createScreenshot('../challenge_frame_wtf.png');
    throw $last_exception;
  }

  /**
   * Waits for a frame to become available and then switches to it.
   *
   * @param string $name
   *   The frame name.
   * @param int $wait
   *   The wait time, in seconds.
   *
   * @return bool
   *   Returns TRUE if operation succeeds.
   *
   * @throws \Exception
   */
  public function switchToFrame($name, $wait = 20) {
    $last_exception = NULL;
    $stopTime = time() + $wait;
    while (time() < $stopTime) {
      try {
        $element = $this
          ->assertSession()
          ->elementExists('xpath', "//iframe[@id='{$name}' or @name='{$name}' or starts-with(@name, '{$name}')]");
        $this
          ->getSession()
          ->switchToIFrame($element
          ->getAttribute('name'));
        sleep(1);
        return TRUE;
      } catch (\Exception $e) {

        // If the frame has not been found, keep waiting.
        $last_exception = $e;
      }
      usleep(250000);
    }
    throw $last_exception;
  }

  /**
   * Completes 3DS authentication using Stripe's modal.
   *
   * @param bool $pass
   *   Whether to pass or fail the 3DS authentication.
   * @param bool $payment
   *   Whether this is a payment or non-payment 3DS.
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   */
  protected function complete3ds($pass, $payment = TRUE) {
    $text = 'This is a 3D Secure non-payment authentication test page.';
    if ($payment) {
      $text = '3D Secure Test Payment Page';
    }
    $this
      ->waitForStripe();
    $this
      ->switchToFrame('__privateStripeFrame');
    $this
      ->switchToFrame('challengeFrame');
    $this
      ->switchToFrame('acsFrame');
    $this
      ->assertWaitForText($text);
    $button = $pass ? 'Complete authentication' : 'Fail authentication';
    $this
      ->getSession()
      ->getPage()
      ->pressButton($button);
    $this
      ->getSession()
      ->switchToWindow();
  }

  /**
   * Switch to the first iframe which ancestor is the given div element id.
   *
   * @param string $element_id
   *   The div element id.
   *
   * @throws \Exception
   */
  protected function switchToElementFrame(string $element_id) {
    $iframe = $this
      ->getSession()
      ->getPage()
      ->find('xpath', '//div[@id="' . $element_id . '"]//iframe')
      ->getAttribute('name');
    $this
      ->switchToFrame($iframe);
  }

  /**
   * Helper method to wait for Stripe actions on the client.
   */
  protected function waitForStripe() {

    // @todo better assertion to wait for the form to submit.
    sleep(6);
  }

}

Members

Name	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.
CheckoutTest::$modules	public static	property	Modules to enable. Overrides CommerceWebDriverTestBase::$modules
CheckoutTest::$product	protected	property	The product.
CheckoutTest::assertWaitForText	public	function	Asserts text will become visible on the page.
CheckoutTest::complete3ds	protected	function	Completes 3DS authentication using Stripe's modal.
CheckoutTest::dataProviderExistingPaymentMethodCardNumber	public	function	Data provider for card numbers when testing existing payment methods.
CheckoutTest::dataProviderUserAuthenticated	public	function	Data provider to provide a pass or truthy data set.
CheckoutTest::dataProviderUserAuthenticatedAndCardAuthentication	public	function	Data provider for user authentication and card authentication.
CheckoutTest::fieldTypeInput	protected	function	Fills an inputs values by simulated typing.
CheckoutTest::fillCreditCardData	protected	function	Fills the credit card form inputs.
CheckoutTest::setUp	protected	function	Overrides CommerceWebDriverTestBase::setUp
CheckoutTest::switchToElementFrame	protected	function	Switch to the first iframe which ancestor is the given div element id.
CheckoutTest::switchToFrame	public	function	Waits for a frame to become available and then switches to it.
CheckoutTest::test3dsAlwaysAuthenticate	public	function	Tests customer, with regulations, can checkout.
CheckoutTest::testCheckoutAndPayment	public	function	Tests an anonymous customer can checkout.
CheckoutTest::testCheckoutAndPayPayment3ds	public	function	Tests customer, with regulations, can checkout.
CheckoutTest::testCheckoutWithExistingPaymentMethod	public	function	Tests checkout with a previously created payment method.
CheckoutTest::testCheckoutWithExistingPaymentMethodOffSession	public	function	Tests checkout with a previously created payment method.
CheckoutTest::testNoBillingCheckout	public	function	Tests checkout without billing information.
CheckoutTest::waitForStripe	protected	function	Helper method to wait for Stripe actions on the client.
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::getAdministratorPermissions	protected	function	Gets the permissions for the admin user.	10
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
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.