You are here

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

class PaymentCheckoutTest in Commerce Core 8.2

Tests the integration between payments and checkout.

@group commerce

Hierarchy

Expanded class hierarchy of PaymentCheckoutTest

File

modules/payment/tests/src/FunctionalJavascript/PaymentCheckoutTest.php, line 19

Namespace

Drupal\Tests\commerce_payment\FunctionalJavascript
View source 
class PaymentCheckoutTest extends CommerceWebDriverTestBase {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

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

  /**
   * A non-reusable order payment method.
   *
   * @var \Drupal\commerce_payment\Entity\PaymentMethodInterface
   */
  protected $orderPaymentMethod;

  /**
   * 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;

  /**
   * A test user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $user;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'commerce_product',
    'commerce_cart',
    'commerce_checkout',
    'commerce_payment',
    'commerce_payment_example',
  ];

  /**
   * {@inheritdoc}
   */
  protected function getAdministratorPermissions() {
    return array_merge([
      'administer profile',
    ], parent::getAdministratorPermissions());
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->store
      ->set('billing_countries', [
      'FR',
      'US',
    ]);
    $this->store
      ->save();
    $variation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => strtolower($this
        ->randomMachineName()),
      'price' => [
        'number' => '39.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,
      ],
    ]);

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $skipped_gateway */
    $skipped_gateway = PaymentGateway::create([
      'id' => 'onsite_skipped',
      'label' => 'On-site Skipped',
      'plugin' => 'example_onsite',
      'configuration' => [
        'api_key' => '2342fewfsfs',
        'payment_method_types' => [
          'credit_card',
        ],
      ],
      'conditions' => [
        [
          'plugin' => 'order_total_price',
          'configuration' => [
            'operator' => '<',
            'amount' => [
              'number' => '1.00',
              'currency_code' => 'USD',
            ],
          ],
        ],
      ],
    ]);
    $skipped_gateway
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = PaymentGateway::create([
      'id' => 'onsite',
      'label' => 'On-site',
      'plugin' => 'example_onsite',
      'configuration' => [
        'api_key' => '2342fewfsfs',
        'payment_method_types' => [
          'credit_card',
        ],
      ],
    ]);
    $payment_gateway
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = PaymentGateway::create([
      'id' => 'offsite',
      'label' => 'Off-site',
      'plugin' => 'example_offsite_redirect',
      'configuration' => [
        'redirect_method' => 'post',
        'payment_method_types' => [
          'credit_card',
        ],
      ],
    ]);
    $payment_gateway
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = PaymentGateway::create([
      'id' => 'stored_offsite',
      'label' => 'Stored off-site',
      'plugin' => 'example_stored_offsite_redirect',
      'configuration' => [
        'redirect_method' => 'post',
        'payment_method_types' => [
          'credit_card',
        ],
      ],
    ]);
    $payment_gateway
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = PaymentGateway::create([
      'id' => 'manual',
      'label' => 'Manual',
      'plugin' => 'manual',
      'configuration' => [
        'display_label' => 'Cash on delivery',
        'instructions' => [
          'value' => 'Sample payment instructions.',
          'format' => 'plain_text',
        ],
      ],
    ]);
    $payment_gateway
      ->save();
    $this->defaultProfile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->defaultAddress,
    ]);
    $profile = $this
      ->createEntity('profile', [
      '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',
      ],
    ]);
    $payment_method = $this
      ->createEntity('commerce_payment_method', [
      'uid' => $this->adminUser
        ->id(),
      'type' => 'credit_card',
      'payment_gateway' => 'onsite',
      'card_type' => 'visa',
      'card_number' => '1111',
      'billing_profile' => $profile,
      'reusable' => TRUE,
      'expires' => strtotime('2028/03/24'),
    ]);
    $payment_method
      ->setBillingProfile($profile);
    $payment_method
      ->save();
    $this->orderPaymentMethod = $this
      ->createEntity('commerce_payment_method', [
      'type' => 'credit_card',
      'payment_gateway' => 'onsite',
      'card_type' => 'visa',
      'card_number' => '9999',
      'reusable' => FALSE,
    ]);
    $this->user = $this
      ->createUser([
      'view commerce_product',
      'access checkout',
    ]);
  }

  /**
   * Tests the structure of the PaymentInformation checkout pane.
   */
  public function testPaymentInformation() {
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');

    // The order's payment method must always be available in the pane.
    $order = Order::load(1);
    $order->payment_method = $this->orderPaymentMethod;
    $order
      ->save();
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $expected_options = [
      'Visa ending in 1111',
      'Visa ending in 9999',
      'Credit card',
      'Example',
    ];
    $page = $this
      ->getSession()
      ->getPage();
    foreach ($expected_options as $expected_option) {
      $radio_button = $page
        ->findField($expected_option);
      $this
        ->assertNotNull($radio_button);
    }
    $default_radio_button = $page
      ->findField('Visa ending in 9999');
    $this
      ->assertNotEmpty($default_radio_button
      ->getAttribute('checked'));

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = PaymentGateway::create([
      'id' => 'onsite2',
      'label' => 'On-site 2',
      'plugin' => 'example_onsite',
    ]);
    $payment_gateway
      ->setPluginConfiguration([
      'api_key' => '2342fewfsfs',
      'payment_method_types' => [
        'credit_card',
      ],
    ]);
    $payment_gateway
      ->save();
    $first_onsite_gateway = PaymentGateway::load('onsite');
    $first_onsite_gateway
      ->setStatus(FALSE);
    $first_onsite_gateway
      ->save();
    $second_onsite_gateway = PaymentGateway::load('onsite2');
    $second_onsite_gateway
      ->setStatus(FALSE);
    $second_onsite_gateway
      ->save();
    $manual_gateway = PaymentGateway::load('manual');
    $manual_gateway
      ->setStatus(FALSE);
    $manual_gateway
      ->save();
    $stored_offsite_gateway = PaymentGateway::load('stored_offsite');
    $stored_offsite_gateway
      ->setStatus(FALSE);
    $stored_offsite_gateway
      ->save();

    // A single radio button should be selected and hidden.
    $this
      ->drupalGet('checkout/1');
    $radio_button = $page
      ->findField('Example');
    $this
      ->assertNull($radio_button);
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
  }

  /**
   * Tests checkout with a new payment method.
   */
  public function testCheckoutWithNewPaymentMethod() {

    // Note that we test with a different user with less rights to ensure
    // the billing profile can be viewed on the review step.
    $this
      ->drupalLogin($this->user);
    $this->defaultProfile
      ->setOwner($this->user);
    $this->defaultProfile
      ->save();

    // Test the 'capture' setting of PaymentProcess while here.

    /** @var \Drupal\commerce_checkout\Entity\CheckoutFlow $checkout_flow */
    $checkout_flow = CheckoutFlow::load('default');
    $plugin = $checkout_flow
      ->getPlugin();
    $configuration = $plugin
      ->getConfiguration();
    $configuration['panes']['payment_process']['capture'] = FALSE;
    $plugin
      ->setConfiguration($configuration);
    $checkout_flow
      ->save();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Credit card');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[add_payment_method][billing_information]');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([
      'payment_information[add_payment_method][payment_details][number]' => '4012888888881881',
      'payment_information[add_payment_method][payment_details][expiration][month]' => '02',
      'payment_information[add_payment_method][payment_details][expiration][year]' => '2024',
      'payment_information[add_payment_method][payment_details][security_code]' => '123',
      '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
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 1881');
    $this
      ->assertSession()
      ->pageTextContains('Expires 2/2024');
    $this
      ->assertSession()
      ->pageTextContains('Johnny Appleseed');
    $this
      ->assertSession()
      ->pageTextContains('123 New York Drive');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $order = Order::load(1);
    $this
      ->assertFalse($order
      ->isLocked());
    $this
      ->assertEquals('onsite', $order
      ->get('payment_gateway')->target_id);

    /** @var \Drupal\profile\Entity\ProfileInterface $order_billing_profile */
    $order_billing_profile = $order
      ->getBillingProfile();

    /** @var \Drupal\commerce_payment\Entity\PaymentMethodInterface $payment_method */
    $payment_method = $order
      ->get('payment_method')->entity;
    $this
      ->assertEquals('1881', $payment_method
      ->get('card_number')->value);

    // Confirm that the billing profile has the expected address.
    $expected_address = [
      'given_name' => 'Johnny',
      'family_name' => 'Appleseed',
      'address_line1' => '123 New York Drive',
      'locality' => 'New York City',
      'administrative_area' => 'NY',
      'postal_code' => '10001',
      'country_code' => 'US',
    ];
    $payment_method_profile = $payment_method
      ->getBillingProfile();
    $this
      ->assertEquals($expected_address, array_filter($payment_method_profile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertNotEmpty($payment_method_profile
      ->getData('address_book_profile_id'));
    $this
      ->assertEmpty($payment_method_profile
      ->getData('copy_to_address_book'));

    // Verify that the billing information was copied to the order.
    $this
      ->assertEquals($expected_address, array_filter($order_billing_profile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertNotEquals($order_billing_profile
      ->id(), $payment_method_profile
      ->id());
    $this
      ->assertNotEmpty($order_billing_profile
      ->getData('address_book_profile_id'));
    $this
      ->assertEmpty($order_billing_profile
      ->getData('copy_to_address_book'));

    // Confirm that the address book profile was updated.
    $this->defaultProfile = $this
      ->reloadEntity($this->defaultProfile);
    $this
      ->assertEquals($expected_address, array_filter($this->defaultProfile
      ->get('address')
      ->first()
      ->toArray()));

    // Verify that a payment was created.
    $payment = Payment::load(1);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals($payment
      ->getAmount(), $order
      ->getTotalPrice());
    $this
      ->assertEquals('authorization', $payment
      ->getState()
      ->getId());
    $this
      ->assertEquals('A', $payment
      ->getAvsResponseCode());
    $this
      ->assertEquals('Address', $payment
      ->getAvsResponseCodeLabel());
  }

  /**
   * Tests checkout with an existing payment method.
   */
  public function testCheckoutWithExistingPaymentMethod() {
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');

    // Make the order partially paid, to confirm that checkout only charges
    // for the remaining amount.
    $payment = Payment::create([
      'type' => 'payment_default',
      'payment_gateway' => 'onsite',
      'order_id' => '1',
      'amount' => new Price('20', 'USD'),
      'state' => 'completed',
    ]);
    $payment
      ->save();
    $order = Order::load(1);

    // Save the order to recalculate the balance.
    $order
      ->save();
    $this
      ->assertEquals(new Price('20', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('19.99', 'USD'), $order
      ->getBalance());
    $this
      ->submitForm([
      'payment_information[payment_method]' => '1',
    ], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 1111');
    $this
      ->assertSession()
      ->pageTextContains('Expires 3/2028');
    $this
      ->assertSession()
      ->pageTextContains('Frederick Pabst');
    $this
      ->assertSession()
      ->pageTextContains('Pabst Blue Ribbon Dr');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_order')
      ->resetCache([
      1,
    ]);
    $order = Order::load(1);
    $this
      ->assertEquals('onsite', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertEquals('1', $order
      ->get('payment_method')->target_id);
    $this
      ->assertFalse($order
      ->isLocked());

    // Verify that a completed payment was made.
    $payment = Payment::load(2);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals('completed', $payment
      ->getState()
      ->getId());
    $this
      ->assertEquals(new Price('19.99', 'USD'), $payment
      ->getAmount());
    $this
      ->assertEquals(new Price('39.99', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('0', 'USD'), $order
      ->getBalance());
    $this
      ->assertEquals('A', $payment
      ->getAvsResponseCode());
    $this
      ->assertEquals('Address', $payment
      ->getAvsResponseCodeLabel());

    /** @var \Drupal\profile\Entity\ProfileInterface $order_billing_profile */
    $order_billing_profile = $order
      ->getBillingProfile();

    /** @var \Drupal\commerce_payment\Entity\PaymentMethodInterface $payment_method */
    $payment_method = $order
      ->get('payment_method')->entity;

    /** @var \Drupal\profile\Entity\ProfileInterface $payment_method_profile */
    $payment_method_profile = $payment_method
      ->getBillingProfile();

    // Verify that the billing information was copied to the order.
    $this
      ->assertTrue($order_billing_profile
      ->equalToProfile($payment_method_profile));
    $this
      ->assertNotEquals($order_billing_profile
      ->id(), $payment_method_profile
      ->id());
  }

  /**
   * Tests that a declined payment does not complete checkout.
   */
  public function testCheckoutWithDeclinedPaymentMethod() {
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Credit card');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[add_payment_method][billing_information]');
    $this
      ->getSession()
      ->getPage()
      ->fillField('payment_information[add_payment_method][billing_information][select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([
      'payment_information[add_payment_method][payment_details][number]' => '4111111111111111',
      'payment_information[add_payment_method][payment_details][expiration][month]' => '02',
      'payment_information[add_payment_method][payment_details][expiration][year]' => '2024',
      'payment_information[add_payment_method][payment_details][security_code]' => '123',
      '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]' => 'Somewhere',
      'payment_information[add_payment_method][billing_information][address][0][address][administrative_area]' => 'WI',
      'payment_information[add_payment_method][billing_information][address][0][address][postal_code]' => '53140',
    ], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 1111');
    $this
      ->assertSession()
      ->pageTextContains('Expires 2/2024');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextNotContains('Your order number is 1. You can view your order on your account page when logged in.');
    $this
      ->assertSession()
      ->pageTextContains('We encountered an error processing your payment method. Please verify your details and try again.');
    $this
      ->assertSession()
      ->addressEquals('checkout/1/order_information');
    $order = Order::load(1);
    $this
      ->assertFalse($order
      ->isLocked());

    /** @var \Drupal\commerce_payment\Entity\PaymentMethodInterface $payment_method */
    $payment_method = $order
      ->get('payment_method')->entity;
    $this
      ->assertEquals('123 New York Drive', $payment_method
      ->getBillingProfile()
      ->get('address')->address_line1);

    // Confirm that the address book profile was not updated.
    $this->defaultProfile = $this
      ->reloadEntity($this->defaultProfile);
    $this
      ->assertEquals('9 Drupal Ave', $this->defaultProfile
      ->get('address')->address_line1);

    // Verify a payment was not created.
    $payment = Payment::load(1);
    $this
      ->assertNull($payment);
  }

  /**
   * Tests checkout with an off-site gateway (POST redirect method).
   */
  public function testCheckoutWithOffsiteRedirectPost() {
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Example');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Bryan Centarro');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $order = Order::load(1);
    $this
      ->assertFalse($order
      ->isLocked());
    $this
      ->assertEquals('offsite', $order
      ->get('payment_gateway')->target_id);

    /** @var \Drupal\profile\Entity\ProfileInterface $billing_profile */
    $billing_profile = $order
      ->getBillingProfile();
    $this
      ->assertEquals('9 Drupal Ave', $billing_profile
      ->get('address')->address_line1);

    // Verify that a payment was created.
    $payment = Payment::load(1);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals($payment
      ->getAmount(), $order
      ->getTotalPrice());
  }

  /**
   * Tests checkout with an off-site gateway (POST redirect method, manual).
   *
   * In this scenario the customer must click the submit button on the payment
   * page in order to proceed to the gateway.
   */
  public function testCheckoutWithOffsiteRedirectPostManual() {
    $payment_gateway = PaymentGateway::load('offsite');
    $payment_gateway
      ->setPluginConfiguration([
      'redirect_method' => 'post_manual',
      'payment_method_types' => [
        'credit_card',
      ],
    ]);
    $payment_gateway
      ->save();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Example');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Bryan Centarro');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->addressEquals('checkout/1/payment');
    $order = Order::load(1);
    $this
      ->assertTrue($order
      ->isLocked());
    $this
      ->assertEquals('offsite', $order
      ->get('payment_gateway')->target_id);
    $this
      ->submitForm([], 'Proceed to Example');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_order')
      ->resetCache([
      '1',
    ]);
    $order = Order::load(1);
    $this
      ->assertEquals('offsite', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertFalse($order
      ->isLocked());

    // Verify that a payment was created.
    $payment = Payment::load(1);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals($payment
      ->getAmount(), $order
      ->getTotalPrice());
  }

  /**
   * Tests checkout with an off-site gateway (GET redirect method).
   */
  public function testCheckoutWithOffsiteRedirectGet() {

    // Checkout must work when the off-site gateway is alone, and the
    // radio button hidden.
    $onsite_gateway = PaymentGateway::load('onsite');
    $onsite_gateway
      ->setStatus(FALSE);
    $onsite_gateway
      ->save();
    $manual_gateway = PaymentGateway::load('manual');
    $manual_gateway
      ->setStatus(FALSE);
    $manual_gateway
      ->save();
    $offiste_stored_gateway = PaymentGateway::load('stored_offsite');
    $offiste_stored_gateway
      ->setStatus(FALSE);
    $offiste_stored_gateway
      ->save();
    $payment_gateway = PaymentGateway::load('offsite');
    $payment_gateway
      ->setPluginConfiguration([
      'redirect_method' => 'get',
      'payment_method_types' => [
        'credit_card',
      ],
    ]);
    $payment_gateway
      ->save();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Bryan Centarro');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $order = Order::load(1);
    $this
      ->assertEquals('offsite', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertFalse($order
      ->isLocked());

    // Verify that a payment was created.
    $payment = Payment::load(1);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals($payment
      ->getAmount(), $order
      ->getTotalPrice());
  }

  /**
   * Tests checkout with an off-site gateway (GET redirect method) that fails.
   *
   * The off-site form throws an exception, simulating an API fail.
   */
  public function testFailedCheckoutWithOffsiteRedirectGet() {
    $payment_gateway = PaymentGateway::load('offsite');
    $payment_gateway
      ->setPluginConfiguration([
      'redirect_method' => 'get',
      'payment_method_types' => [
        'credit_card',
      ],
    ]);
    $payment_gateway
      ->save();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Example');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([
      'payment_information[billing_information][address][0][address][family_name]' => 'FAIL',
    ], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Bryan FAIL');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextNotContains('Your order number is 1. You can view your order on your account page when logged in.');
    $this
      ->assertSession()
      ->pageTextContains('We encountered an unexpected error processing your payment. Please try again later.');
    $this
      ->assertSession()
      ->addressEquals('checkout/1/order_information');
    $order = Order::load(1);
    $this
      ->assertFalse($order
      ->isLocked());

    // Verify a payment was not created.
    $payment = Payment::load(1);
    $this
      ->assertNull($payment);
  }

  /**
   * Tests checkout with an off-site gateway that supports notifications.
   *
   * We simulate onNotify() being called before onReturn(), resulting in the
   * order being fully paid and placed before the customer returns to the site.
   */
  public function testCheckoutWithOffsitePaymentNotify() {
    $payment_gateway = PaymentGateway::load('offsite');
    $payment_gateway
      ->setPluginConfiguration([
      'redirect_method' => 'post_manual',
      'payment_method_types' => [
        'credit_card',
      ],
    ]);
    $payment_gateway
      ->save();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Example');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Bryan Centarro');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->addressEquals('checkout/1/payment');

    // Simulate the order being paid in full.
    $payment = Payment::create([
      'type' => 'payment_default',
      'payment_gateway' => 'offsite',
      'order_id' => '1',
      'amount' => new Price('39.99', 'USD'),
      'state' => 'completed',
    ]);
    $payment
      ->save();
    $order = Order::load(1);

    // Save the order to recalculate the balance.
    $order
      ->save();
    $this
      ->assertTrue($order
      ->isPaid());
    $this
      ->assertFalse($order
      ->isLocked());

    // Go to the return url and confirm that it works.
    $this
      ->drupalGet('checkout/1/payment/return');
    $this
      ->assertSession()
      ->addressEquals('checkout/1/complete');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');

    /** @var \Drupal\commerce_payment\PaymentStorageInterface $payment_storage */
    $payment_storage = \Drupal::entityTypeManager()
      ->getStorage('commerce_payment');

    // Confirm that only one payment was made.
    $payments = $payment_storage
      ->loadMultipleByOrder($order);
    $this
      ->assertCount(1, $payments);
  }

  /**
   * Tests checkout with a stored off-site gateway (POST redirect method).
   */
  public function testCheckoutWithStoredOffsiteRedirectPost() {

    // Remove the initial test payment methods.
    PaymentMethod::load(1)
      ->delete();
    PaymentMethod::load(2)
      ->delete();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->fieldNotExists('Visa ending in 1111');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Credit card (Example Stored Offsite)');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Bryan Centarro');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $order = Order::load(1);
    $this
      ->assertFalse($order
      ->isLocked());
    $this
      ->assertEquals('stored_offsite', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertEquals(3, $order
      ->get('payment_method')->target_id);
    $payment = Payment::load(1);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals($payment
      ->getAmount(), $order
      ->getTotalPrice());

    // Verify that a reusable payment method was created.
    $payment_method = $payment
      ->getPaymentMethod();
    $this
      ->assertEquals(TRUE, $payment_method
      ->isReusable());
    $this
      ->assertEquals('stored_offsite', $payment_method
      ->getPaymentGatewayId());
    $this
      ->assertEquals(3, $payment_method
      ->id());

    // Assert that the created payment method can be loaded.
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->createScreenshot('../checkout_1.png');
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->createScreenshot('../checkout_2.png');
    $this
      ->drupalGet('checkout/2');
    $this
      ->createScreenshot('../checkout_3.png');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Visa ending in 1111');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 2. You can view your order on your account page when logged in.');
    $order = Order::load(2);
    $this
      ->assertFalse($order
      ->isLocked());
    $this
      ->assertEquals('stored_offsite', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertEquals(3, $order
      ->get('payment_method')->target_id);
    $payment = Payment::load(1);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals($payment
      ->getAmount(), $order
      ->getTotalPrice());
    $this
      ->assertEquals('Z', $payment
      ->getAvsResponseCode());
    $this
      ->assertEquals('ZIP', $payment
      ->getAvsResponseCodeLabel());
    $this
      ->assertEquals(3, $payment
      ->get('payment_method')->target_id);
  }

  /**
   * Tests checkout with a manual gateway.
   */
  public function testManual() {
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');

    // Make the order partially paid, to confirm that checkout only charges
    // for the remaining amount.
    $payment = Payment::create([
      'type' => 'payment_manual',
      'payment_gateway' => 'manual',
      'order_id' => '1',
      'amount' => new Price('20', 'USD'),
      'state' => 'completed',
    ]);
    $payment
      ->save();
    $order = Order::load(1);

    // Save the order to recalculate the balance.
    $order
      ->save();
    $this
      ->assertEquals(new Price('20', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('19.99', 'USD'), $order
      ->getBalance());
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Cash on delivery');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Cash on delivery');
    $this
      ->assertSession()
      ->pageTextContains('Bryan Centarro');
    $this
      ->assertSession()
      ->pageTextContains('9 Drupal Ave');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $this
      ->assertSession()
      ->pageTextContains('Sample payment instructions.');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_order')
      ->resetCache([
      1,
    ]);
    $order = Order::load(1);
    $this
      ->assertEquals('manual', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertFalse($order
      ->isLocked());

    // Verify that a pending payment was created, and that the totals are
    // still unchanged.
    $payment = Payment::load(2);
    $this
      ->assertNotNull($payment);
    $this
      ->assertEquals('pending', $payment
      ->getState()
      ->getId());
    $this
      ->assertEquals(new Price('19.99', 'USD'), $payment
      ->getAmount());
    $this
      ->assertEquals(new Price('20', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('19.99', 'USD'), $order
      ->getBalance());
  }

  /**
   * Tests checkout with a manual gateway, without billing information.
   */
  public function testManualWithoutBilling() {
    $payment_gateway = PaymentGateway::load('manual');
    $payment_gateway
      ->setPluginConfiguration([
      'collect_billing_information' => FALSE,
      'display_label' => 'Cash on delivery',
      'instructions' => [
        'value' => 'You will pay for order #[commerce_order:order_id] in [commerce_payment:amount:currency_code].',
        'format' => 'plain_text',
      ],
    ]);
    $payment_gateway
      ->save();
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Cash on delivery');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextNotContains('Country');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Cash on delivery');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');

    // Confirm token replacement works.
    $this
      ->assertSession()
      ->pageTextContains('You will pay for order #1 in USD.');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_order')
      ->resetCache([
      1,
    ]);
    $order = Order::load(1);
    $this
      ->assertEquals('manual', $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertNull($order
      ->getBillingProfile());
    $this
      ->assertFalse($order
      ->isLocked());
  }

  /**
   * Tests a free order, where only the billing information is collected.
   */
  public function testFreeOrder() {

    // Prepare a different address book profile to test switching.
    $new_address = [
      'given_name' => 'Johnny',
      'family_name' => 'Appleseed',
      'address_line1' => '123 New York Drive',
      'locality' => 'New York City',
      'administrative_area' => 'NY',
      'postal_code' => '10001',
      'country_code' => 'US',
    ];
    $new_address_book_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $new_address,
    ]);
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');

    // Add an adjustment to zero out the order total.
    $order = Order::load(1);
    $order
      ->addAdjustment(new Adjustment([
      'type' => 'custom',
      'label' => 'Surprise, it is free!',
      'amount' => $order
        ->getTotalPrice()
        ->multiply('-1'),
      'locked' => TRUE,
    ]));
    $order
      ->save();
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->pageTextContains('Billing information');
    $this
      ->assertSession()
      ->pageTextNotContains('Payment information');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->getSession()
      ->getPage()
      ->fillField('payment_information[billing_information][select_address]', $new_address_book_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($new_address, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Billing information');
    $this
      ->assertSession()
      ->pageTextNotContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Johnny Appleseed');
    $this
      ->assertSession()
      ->pageTextContains('123 New York Drive');
    $this
      ->submitForm([], 'Complete checkout');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
  }

  /**
   * Tests a paid order, where only the billing information is collected.
   */
  public function testPaidOrder() {

    // Prepare a different address book profile to test switching.
    $new_address = [
      'given_name' => 'Johnny',
      'family_name' => 'Appleseed',
      'address_line1' => '123 New York Drive',
      'locality' => 'New York City',
      'administrative_area' => 'NY',
      'postal_code' => '10001',
      'country_code' => 'US',
    ];
    $new_address_book_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $new_address,
    ]);
    $this
      ->drupalGet($this->product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $order = Order::load(1);
    $order
      ->setTotalPaid($order
      ->getTotalPrice());
    $order
      ->save();
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->pageTextContains('Billing information');
    $this
      ->assertSession()
      ->pageTextNotContains('Payment information');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[billing_information]');
    $this
      ->getSession()
      ->getPage()
      ->fillField('payment_information[billing_information][select_address]', $new_address_book_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($new_address, 'payment_information[billing_information]');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Billing information');
    $this
      ->assertSession()
      ->pageTextNotContains('Payment information');
    $this
      ->assertSession()
      ->pageTextContains('Example');
    $this
      ->assertSession()
      ->pageTextContains('Johnny Appleseed');
    $this
      ->assertSession()
      ->pageTextContains('123 New York Drive');
    $this
      ->submitForm([], 'Complete checkout');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommerceBrowserTestTrait::assertFieldValues protected function Asserts that the passed field values are correct.
CommerceBrowserTestTrait::createEntity protected function Creates a new entity.
CommerceBrowserTestTrait::reloadEntity protected function Reloads the entity after clearing the static cache.
CommerceBrowserTestTrait::saveHtmlOutput protected function Debugger method to save additional HTML output.
CommerceWebDriverTestBase::$adminUser protected property A test user with administrative privileges.
CommerceWebDriverTestBase::$countryList protected property The country list.
CommerceWebDriverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 3
CommerceWebDriverTestBase::$store protected property The store entity.
CommerceWebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE. Overrides WebDriverTestBase::assertJsCondition
CommerceWebDriverTestBase::assertRenderedAddress protected function Asserts that the given address is rendered on the page.
CommerceWebDriverTestBase::setRawFieldValue protected function Sets an input field's raw value.
CommerceWebDriverTestBase::tearDown protected function Overrides WebDriverTestBase::tearDown
CommerceWebDriverTestBase::waitForAjaxToFinish Deprecated protected function Waits for jQuery to become active and animations to complete.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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
PaymentCheckoutTest::$account protected property The current user.
PaymentCheckoutTest::$defaultAddress protected property The default profile's address.
PaymentCheckoutTest::$defaultProfile protected property The default profile.
PaymentCheckoutTest::$modules public static property Modules to enable. Overrides CommerceWebDriverTestBase::$modules
PaymentCheckoutTest::$orderPaymentMethod protected property A non-reusable order payment method.
PaymentCheckoutTest::$product protected property The product.
PaymentCheckoutTest::$user protected property A test user.
PaymentCheckoutTest::getAdministratorPermissions protected function Gets the permissions for the admin user. Overrides CommerceWebDriverTestBase::getAdministratorPermissions
PaymentCheckoutTest::setUp protected function Overrides CommerceWebDriverTestBase::setUp
PaymentCheckoutTest::testCheckoutWithDeclinedPaymentMethod public function Tests that a declined payment does not complete checkout.
PaymentCheckoutTest::testCheckoutWithExistingPaymentMethod public function Tests checkout with an existing payment method.
PaymentCheckoutTest::testCheckoutWithNewPaymentMethod public function Tests checkout with a new payment method.
PaymentCheckoutTest::testCheckoutWithOffsitePaymentNotify public function Tests checkout with an off-site gateway that supports notifications.
PaymentCheckoutTest::testCheckoutWithOffsiteRedirectGet public function Tests checkout with an off-site gateway (GET redirect method).
PaymentCheckoutTest::testCheckoutWithOffsiteRedirectPost public function Tests checkout with an off-site gateway (POST redirect method).
PaymentCheckoutTest::testCheckoutWithOffsiteRedirectPostManual public function Tests checkout with an off-site gateway (POST redirect method, manual).
PaymentCheckoutTest::testCheckoutWithStoredOffsiteRedirectPost public function Tests checkout with a stored off-site gateway (POST redirect method).
PaymentCheckoutTest::testFailedCheckoutWithOffsiteRedirectGet public function Tests checkout with an off-site gateway (GET redirect method) that fails.
PaymentCheckoutTest::testFreeOrder public function Tests a free order, where only the billing information is collected.
PaymentCheckoutTest::testManual public function Tests checkout with a manual gateway.
PaymentCheckoutTest::testManualWithoutBilling public function Tests checkout with a manual gateway, without billing information.
PaymentCheckoutTest::testPaidOrder public function Tests a paid order, where only the billing information is collected.
PaymentCheckoutTest::testPaymentInformation public function Tests the structure of the PaymentInformation checkout pane.
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.