class CheckoutPaneTest in Commerce Shipping 8.2

Tests the "Shipping information" checkout pane.

@group commerce_shipping

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_shipping\FunctionalJavascript\CheckoutPaneTest

Expanded class hierarchy of CheckoutPaneTest

File

tests/src/FunctionalJavascript/CheckoutPaneTest.php, line 24

Namespace

Drupal\Tests\commerce_shipping\FunctionalJavascript

View source

class CheckoutPaneTest extends CommerceWebDriverTestBase {

  /**
   * First sample product.
   *
   * @var \Drupal\commerce_product\Entity\ProductInterface
   */
  protected $firstProduct;

  /**
   * Second sample product.
   *
   * @var \Drupal\commerce_product\Entity\ProductInterface
   */
  protected $secondProduct;

  /**
   * First shipping method.
   *
   * @var \Drupal\commerce_shipping\Entity\ShippingMethodInterface
   */
  protected $firstShippingMethod;

  /**
   * Second shipping method.
   *
   * @var \Drupal\commerce_shipping\Entity\ShippingMethodInterface
   */
  protected $secondShippingMethod;

  /**
   * 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',
  ];

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'commerce_payment',
    'commerce_payment_example',
    'commerce_promotion',
    'commerce_shipping_test',
    'commerce_tax',
    'telephone',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

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

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

    // Limit the available countries.
    $this->store->shipping_countries = [
      'US',
      'FR',
      'DE',
    ];
    $this->store
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGateway $gateway */
    $gateway = PaymentGateway::create([
      'id' => 'example_onsite',
      'label' => 'Example',
      'plugin' => 'example_onsite',
    ]);
    $gateway
      ->getPlugin()
      ->setConfiguration([
      'api_key' => '2342fewfsfs',
      'payment_method_types' => [
        'credit_card',
      ],
    ]);
    $gateway
      ->save();
    $product_variation_type = ProductVariationType::load('default');
    $product_variation_type
      ->setTraits([
      'purchasable_entity_shippable',
    ]);
    $product_variation_type
      ->save();
    $order_type = OrderType::load('default');
    $order_type
      ->setThirdPartySetting('commerce_checkout', 'checkout_flow', 'shipping');
    $order_type
      ->setThirdPartySetting('commerce_shipping', 'shipment_type', 'default');
    $order_type
      ->save();

    // Create the order field.
    $field_definition = commerce_shipping_build_shipment_field_definition($order_type
      ->id());
    $this->container
      ->get('commerce.configurable_field_manager')
      ->createField($field_definition);

    // Install the variation trait.
    $trait_manager = $this->container
      ->get('plugin.manager.commerce_entity_trait');
    $trait = $trait_manager
      ->createInstance('purchasable_entity_shippable');
    $trait_manager
      ->installTrait($trait, 'commerce_product_variation', 'default');

    // Create two products.
    $variation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => strtolower($this
        ->randomMachineName()),
      'price' => [
        'number' => '7.99',
        'currency_code' => 'USD',
      ],
    ]);

    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
    $this->firstProduct = $this
      ->createEntity('commerce_product', [
      'type' => 'default',
      'title' => 'Conference hat',
      'variations' => [
        $variation,
      ],
      'stores' => [
        $this->store,
      ],
    ]);
    $variation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => strtolower($this
        ->randomMachineName()),
      'price' => [
        'number' => '8.99',
        'currency_code' => 'USD',
      ],
    ]);

    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
    $this->secondProduct = $this
      ->createEntity('commerce_product', [
      'type' => 'default',
      'title' => 'Conference bow tie',
      'variations' => [
        $variation,
      ],
      'stores' => [
        $this->store,
      ],
    ]);

    /** @var \Drupal\commerce_shipping\Entity\PackageType $package_type */
    $package_type = $this
      ->createEntity('commerce_package_type', [
      'id' => 'package_type_a',
      'label' => 'Package Type A',
      'dimensions' => [
        'length' => 20,
        'width' => 20,
        'height' => 20,
        'unit' => 'mm',
      ],
      'weight' => [
        'number' => 20,
        'unit' => 'g',
      ],
    ]);
    $this->container
      ->get('plugin.manager.commerce_package_type')
      ->clearCachedDefinitions();

    // Create two flat rate shipping methods.
    $this->firstShippingMethod = $this
      ->createEntity('commerce_shipping_method', [
      'name' => 'Overnight shipping',
      'stores' => [
        $this->store
          ->id(),
      ],
      'plugin' => [
        'target_plugin_id' => 'flat_rate',
        'target_plugin_configuration' => [
          'default_package_type' => 'commerce_package_type:' . $package_type
            ->get('uuid'),
          'rate_label' => 'Overnight shipping',
          'rate_description' => 'At your door tomorrow morning',
          'rate_amount' => [
            'number' => '19.99',
            'currency_code' => 'USD',
          ],
        ],
      ],
    ]);
    $this->secondShippingMethod = $this
      ->createEntity('commerce_shipping_method', [
      'name' => 'Standard shipping',
      'stores' => [
        $this->store
          ->id(),
      ],
      // Ensure that Standard shipping shows before overnight shipping.
      'weight' => -10,
      'plugin' => [
        'target_plugin_id' => 'flat_rate',
        'target_plugin_configuration' => [
          'rate_label' => 'Standard shipping',
          'rate_amount' => [
            'number' => '9.99',
            'currency_code' => 'USD',
          ],
        ],
      ],
    ]);
    $second_store = $this
      ->createStore();

    // Should never be shown cause it doesn't belong to the order's store.
    $third_shipping_method = $this
      ->createEntity('commerce_shipping_method', [
      'name' => 'Secret shipping',
      'stores' => [
        $second_store
          ->id(),
      ],
      'plugin' => [
        'target_plugin_id' => 'flat_rate',
        'target_plugin_configuration' => [
          'rate_label' => 'Secret shipping',
          'rate_amount' => [
            'number' => '9.99',
            'currency_code' => 'USD',
          ],
        ],
      ],
    ]);
    $promotion = Promotion::create([
      'name' => 'Promotion 1',
      'order_types' => [
        'default',
      ],
      'stores' => [
        $this->store
          ->id(),
      ],
      'offer' => [
        'target_plugin_id' => 'shipment_fixed_amount_off',
        'target_plugin_configuration' => [
          'display_inclusive' => TRUE,
          'filter' => 'include',
          'shipping_methods' => [
            [
              'shipping_method' => $this->firstShippingMethod
                ->uuid(),
            ],
          ],
          'amount' => [
            'number' => '3.00',
            'currency_code' => 'USD',
          ],
        ],
      ],
      'status' => TRUE,
    ]);
    $promotion
      ->save();

    // Create a different shipping profile type, which also has a Phone field.
    $bundle_entity_duplicator = $this->container
      ->get('entity.bundle_entity_duplicator');
    $customer_profile_type = ProfileType::load('customer');
    $shipping_profile_type = $bundle_entity_duplicator
      ->duplicate($customer_profile_type, [
      'id' => 'customer_shipping',
      'label' => 'Customer (Shipping)',
    ]);

    // Add a telephone field to the new profile type.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'field_phone',
      'entity_type' => 'profile',
      'type' => 'telephone',
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => $shipping_profile_type
        ->id(),
      'label' => 'Phone',
    ]);
    $field
      ->save();
    $form_display = commerce_get_entity_display('profile', 'customer_shipping', 'form');
    $form_display
      ->setComponent('field_phone', [
      'type' => 'telephone_default',
    ]);
    $form_display
      ->save();
    $view_display = commerce_get_entity_display('profile', 'customer_shipping', 'view');
    $view_display
      ->setComponent('field_phone', [
      'type' => 'basic_string',
    ]);
    $view_display
      ->save();
    $checkout_flow = CheckoutFlow::load('shipping');
    $checkout_flow_configuration = $checkout_flow
      ->get('configuration');
    $checkout_flow_configuration['panes']['shipping_information']['auto_recalculate'] = FALSE;
    $checkout_flow
      ->set('configuration', $checkout_flow_configuration);
    $checkout_flow
      ->save();
  }

  /**
   * Tests checkout with a single shipment.
   */
  public function testSingleShipment() {

    // Create a default profile to confirm that it is used at checkout.
    $default_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->defaultAddress,
    ]);
    $this
      ->drupalGet($this->firstProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet($this->secondProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'shipping_information[shipping_profile]');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[add_payment_method][billing_information]');

    // Confirm that shipping method selection is available, because the
    // selected profile has a complete address.
    $this
      ->assertSession()
      ->pageTextContains('Shipping method');
    $page = $this
      ->getSession()
      ->getPage();
    $first_radio_button = $page
      ->findField('Standard shipping: $9.99');

    // The $19.99 is displayed crossed out, but Mink strips HTML.
    $second_radio_button = $page
      ->findField('Overnight shipping: $19.99 $16.99');
    $this
      ->assertNotNull($first_radio_button);
    $this
      ->assertNotNull($second_radio_button);
    $this
      ->assertNotEmpty($first_radio_button
      ->getAttribute('checked'));

    // Confirm that the description for overnight shipping is shown.
    $this
      ->assertSession()
      ->pageTextContains('At your door tomorrow morning');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $selector = '//div[@data-drupal-selector="edit-order-summary"]';
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $9.99');
    $second_radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $16.99');
    $first_radio_button
      ->click();
    $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',
    ], 'Continue to review');

    // Confirm that the review is rendered correctly.
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');
    foreach ($this->defaultAddress as $property => $value) {
      if ($property != 'country_code') {
        $this
          ->assertSession()
          ->pageTextContains($value);
      }
    }
    $this
      ->assertSession()
      ->pageTextContains('Standard shipping');
    $this
      ->assertSession()
      ->pageTextNotContains('Secret shipping');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $order = Order::load(1);

    // Confirm the integrity of the shipment.
    $shipments = $order
      ->get('shipments')
      ->referencedEntities();
    $this
      ->assertCount(1, $shipments);

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = reset($shipments);
    $this
      ->assertEquals('custom_box', $shipment
      ->getPackageType()
      ->getId());
    $this
      ->assertEquals('Standard shipping', $shipment
      ->getShippingMethod()
      ->label());
    $this
      ->assertEquals('default', $shipment
      ->getShippingService());
    $this
      ->assertEquals('9.99', $shipment
      ->getAmount()
      ->getNumber());
    $this
      ->assertCount(2, $shipment
      ->getItems());
    $this
      ->assertEquals('draft', $shipment
      ->getState()->value);

    // Confirm that the order total contains the shipment amount.
    $this
      ->assertEquals(new Price('26.97', 'USD'), $order
      ->getTotalPrice());

    // Confirm the integrity of the profiles.
    $billing_profile = $order
      ->getBillingProfile();
    $shipping_profile = $shipment
      ->getShippingProfile();
    $this
      ->assertNotEquals($billing_profile
      ->id(), $shipping_profile
      ->id());
    $this
      ->assertEquals($this->defaultAddress['address_line1'], $billing_profile
      ->get('address')->address_line1);
    $this
      ->assertEquals($this->defaultAddress['address_line1'], $shipping_profile
      ->get('address')->address_line1);
    $this
      ->assertEquals($default_profile
      ->id(), $billing_profile
      ->getData('address_book_profile_id'));
    $this
      ->assertEquals($default_profile
      ->id(), $shipping_profile
      ->getData('address_book_profile_id'));
    $this
      ->assertEmpty($billing_profile
      ->getData('copy_to_address_book'));
    $this
      ->assertEmpty($shipping_profile
      ->getData('copy_to_address_book'));
  }

  /**
   * Tests checkout with multiple shipments.
   */
  public function testMultipleShipments() {

    // Create a default profile to confirm that it is used at checkout.
    $default_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->defaultAddress,
    ]);
    $this
      ->drupalGet($this->firstProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet($this->secondProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'shipping_information[shipping_profile]');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'payment_information[add_payment_method][billing_information]');

    // Confirm that it is possible to enter a different address.
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $address = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => '38 rue du sentier',
      'locality' => 'Paris',
      'postal_code' => '75002',
    ];
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->fillField($address_prefix . '[country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($address as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    $page
      ->findButton('Recalculate shipping')
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ([
      0,
      1,
    ] as $shipment_index) {
      $label_index = $shipment_index + 1;
      $this
        ->assertSession()
        ->pageTextContains('Shipment #' . $label_index);
      $first_radio_button = $page
        ->findField('shipping_information[shipments][' . $shipment_index . '][shipping_method][0]');
      $second_radio_button = $page
        ->findField('shipping_information[shipments][' . $shipment_index . '][shipping_method][0]');
      $this
        ->assertNotNull($first_radio_button);
      $this
        ->assertNotNull($second_radio_button);

      // The radio buttons don't have access to their own labels.
      $selector = '//fieldset[@data-drupal-selector="edit-shipping-information-shipments-0-shipping-method-0"]';
      $this
        ->assertSession()
        ->elementTextContains('xpath', $selector, 'Standard shipping: $9.99');

      // The $19.99 is displayed crossed out, but Mink strips HTML.
      $this
        ->assertSession()
        ->elementTextContains('xpath', $selector, 'Overnight shipping: $19.99 $16.99');
      $this
        ->assertSession()
        ->elementTextContains('xpath', $selector, 'At your door tomorrow morning');
    }
    $this
      ->assertSession()
      ->pageTextContains('Shipment #1 $9.99');
    $this
      ->assertSession()
      ->pageTextContains('Shipment #2 $9.99');
    $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',
    ], 'Continue to review');

    // Confirm that the review is rendered correctly.
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');
    foreach ($address as $property => $value) {
      $this
        ->assertSession()
        ->pageTextContains($value);
    }
    $this
      ->assertSession()
      ->pageTextContains('Shipment #1');
    $this
      ->assertSession()
      ->pageTextContains('Shipment #2');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//div[@class="field__item" and .="Standard shipping"]', 2);

    // Confirm the integrity of the shipment.
    $this
      ->submitForm([], 'Pay and complete purchase');
    $order = Order::load(1);
    $billing_profile = $order
      ->getBillingProfile();
    $this
      ->assertNotEmpty($billing_profile);
    $this
      ->assertEquals('customer', $billing_profile
      ->bundle());
    $this
      ->assertEquals('Paris', $billing_profile
      ->get('address')->locality);

    // Confirm the integrity of the shipments.
    $shipments = $order
      ->get('shipments')
      ->referencedEntities();
    $this
      ->assertCount(2, $shipments);

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $first_shipment */
    $first_shipment = reset($shipments);
    $this
      ->assertEquals('custom_box', $first_shipment
      ->getPackageType()
      ->getId());
    $this
      ->assertEquals('Paris', $first_shipment
      ->getShippingProfile()
      ->get('address')->locality);
    $this
      ->assertEquals('Standard shipping', $first_shipment
      ->getShippingMethod()
      ->label());
    $this
      ->assertEquals('default', $first_shipment
      ->getShippingService());
    $this
      ->assertEquals('9.99', $first_shipment
      ->getAmount()
      ->getNumber());
    $this
      ->assertEquals('draft', $first_shipment
      ->getState()->value);
    $this
      ->assertCount(1, $first_shipment
      ->getItems());
    $items = $first_shipment
      ->getItems();
    $item = reset($items);
    $this
      ->assertEquals('Conference hat', $item
      ->getTitle());
    $this
      ->assertEquals(1, $item
      ->getQuantity());

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $second_shipment */
    $second_shipment = end($shipments);
    $this
      ->assertEquals('custom_box', $second_shipment
      ->getPackageType()
      ->getId());
    $this
      ->assertEquals('Paris', $second_shipment
      ->getShippingProfile()
      ->get('address')->locality);
    $this
      ->assertEquals('Standard shipping', $second_shipment
      ->getShippingMethod()
      ->label());
    $this
      ->assertEquals('default', $second_shipment
      ->getShippingService());
    $this
      ->assertEquals('9.99', $second_shipment
      ->getAmount()
      ->getNumber());
    $this
      ->assertEquals('draft', $second_shipment
      ->getState()->value);
    $this
      ->assertCount(1, $second_shipment
      ->getItems());
    $items = $second_shipment
      ->getItems();
    $item = reset($items);
    $this
      ->assertEquals('Conference bow tie', $item
      ->getTitle());
    $this
      ->assertEquals(1, $item
      ->getQuantity());

    // Confirm that the shipping profile is shared between shipments.
    $this
      ->assertEquals($first_shipment
      ->getShippingProfile()
      ->id(), $second_shipment
      ->getShippingProfile()
      ->id());

    // Confirm that the order total contains the shipment amounts.
    $this
      ->assertEquals(new Price('36.96', 'USD'), $order
      ->getTotalPrice());
  }

  /**
   * Tests checkout when the shipping profile is not required for showing rates.
   */
  public function testNoRequiredShippingProfile() {
    $checkout_flow = CheckoutFlow::load('shipping');
    $checkout_flow_configuration = $checkout_flow
      ->get('configuration');
    $checkout_flow_configuration['panes']['shipping_information']['require_shipping_profile'] = FALSE;

    // Confirm that enabling the auto recalculation doesn't have any effect
    // when a shipping profile is not required.
    $checkout_flow_configuration['panes']['shipping_information']['auto_recalculate'] = TRUE;
    $checkout_flow
      ->set('configuration', $checkout_flow_configuration);
    $checkout_flow
      ->save();
    $this
      ->drupalGet($this->firstProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet($this->secondProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');

    // Confirm that the shipping methods are shown without a profile.
    $this
      ->assertSession()
      ->pageTextContains('Shipping method');
    $page = $this
      ->getSession()
      ->getPage();
    $first_radio_button = $page
      ->findField('Standard shipping: $9.99');

    // The $19.99 is displayed crossed out, but Mink strips HTML.
    $second_radio_button = $page
      ->findField('Overnight shipping: $19.99 $16.99');
    $this
      ->assertNotNull($first_radio_button);
    $this
      ->assertNotNull($second_radio_button);
    $this
      ->assertNotEmpty($first_radio_button
      ->getAttribute('checked'));

    // Confirm that the description for overnight shipping is shown.
    $this
      ->assertSession()
      ->pageTextContains('At your door tomorrow morning');
    $selector = '//div[@data-drupal-selector="edit-order-summary"]';
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $9.99');

    // Complete the order information step.
    $address = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => '1098 Alta Ave',
      'locality' => 'Mountain View',
      'administrative_area' => 'CA',
      'postal_code' => '94043',
    ];
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';

    // Confirm that the country list has been restricted.
    $this
      ->assertOptions($address_prefix . '[country_code]', [
      'US',
      'FR',
      'DE',
    ]);
    $page
      ->fillField($address_prefix . '[country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($address as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    $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',
    ], 'Continue to review');

    // Confirm that the review is rendered correctly.
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');
    foreach ($address as $property => $value) {
      $this
        ->assertSession()
        ->pageTextContains($value);
    }
    $this
      ->assertSession()
      ->pageTextContains('Standard shipping');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $order = Order::load(1);

    // Confirm the integrity of the shipment.
    $shipments = $order
      ->get('shipments')
      ->referencedEntities();
    $this
      ->assertCount(1, $shipments);

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = reset($shipments);
    $this
      ->assertEquals('custom_box', $shipment
      ->getPackageType()
      ->getId());
    $this
      ->assertEquals('Mountain View', $shipment
      ->getShippingProfile()
      ->get('address')->locality);
    $this
      ->assertEquals('Standard shipping', $shipment
      ->getShippingMethod()
      ->label());
    $this
      ->assertEquals('default', $shipment
      ->getShippingService());
    $this
      ->assertEquals('9.99', $shipment
      ->getAmount()
      ->getNumber());
    $this
      ->assertCount(2, $shipment
      ->getItems());
    $this
      ->assertEquals('draft', $shipment
      ->getState()->value);

    // Confirm that the order total contains the shipment amounts.
    $this
      ->assertEquals(new Price('26.97', 'USD'), $order
      ->getTotalPrice());
  }

  /**
   * Test checkout with a custom shipping profile type.
   */
  public function testCustomShippingProfileType() {
    $shipment_type = ShipmentType::load('default');
    $shipment_type
      ->setProfileTypeId('customer_shipping');
    $shipment_type
      ->save();
    $this
      ->drupalGet($this->firstProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->getSession()
      ->getPage()
      ->uncheckField('payment_information[add_payment_method][billing_information][copy_fields][enable]');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');

    // Confirm that the phone field is present, but only for shipping.
    $this
      ->assertSession()
      ->fieldExists('shipping_information[shipping_profile][field_phone][0][value]');
    $this
      ->assertSession()
      ->fieldNotExists('payment_information[add_payment_method][billing_information][field_phone][0][value]');
    $address = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => '1098 Alta Ave',
      'locality' => 'Mountain View',
      'administrative_area' => 'CA',
      'postal_code' => '94043',
    ];
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';

    // Confirm that the country list has been restricted.
    $this
      ->assertOptions($address_prefix . '[country_code]', [
      'US',
      'FR',
      'DE',
    ]);
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->fillField($address_prefix . '[country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($address as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    $page
      ->fillField('shipping_information[shipping_profile][field_phone][0][value]', '202-555-0108');

    // Confirm that the shipping method selection was not initially available
    // because there was no address known.
    $this
      ->assertSession()
      ->pageTextNotContains('Shipping method');
    $page
      ->findButton('Recalculate shipping')
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Shipping method');
    $first_radio_button = $page
      ->findField('Standard shipping: $9.99');
    $this
      ->assertNotNull($first_radio_button);
    $this
      ->assertNotEmpty($first_radio_button
      ->getAttribute('checked'));
    $selector = '//div[@data-drupal-selector="edit-order-summary"]';
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $9.99');
    $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]' => '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');

    // Confirm that the review is rendered correctly.
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');
    foreach ($address as $property => $value) {
      $this
        ->assertSession()
        ->pageTextContains($value);
    }
    $this
      ->assertSession()
      ->pageTextContains('202-555-0108');
    $this
      ->assertSession()
      ->pageTextContains('Standard shipping');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $order = Order::load(1);
    $billing_profile = $order
      ->getBillingProfile();
    $this
      ->assertNotEmpty($billing_profile);
    $this
      ->assertEquals('customer', $billing_profile
      ->bundle());
    $this
      ->assertEquals('123 New York Drive', $billing_profile
      ->get('address')->address_line1);

    // Confirm that the billing profile was copied to the address book.
    $address_book_profile_id = $billing_profile
      ->getData('address_book_profile_id');
    $this
      ->assertNotEmpty($address_book_profile_id);
    $address_book_profile = Profile::load($address_book_profile_id);
    $this
      ->assertNotEmpty($address_book_profile);
    $this
      ->assertTrue($address_book_profile
      ->isDefault());
    $this
      ->assertEquals('123 New York Drive', $address_book_profile
      ->get('address')->address_line1);

    // Confirm the integrity of the shipment.
    $shipments = $order
      ->get('shipments')
      ->referencedEntities();
    $this
      ->assertCount(1, $shipments);

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = reset($shipments);
    $shipping_profile = $shipment
      ->getShippingProfile();
    $this
      ->assertNotEmpty($shipping_profile);
    $this
      ->assertEquals('customer_shipping', $shipping_profile
      ->bundle());
    $this
      ->assertEquals('1098 Alta Ave', $shipping_profile
      ->get('address')->address_line1);
    $this
      ->assertEquals('202-555-0108', $shipping_profile
      ->get('field_phone')->value);

    // Confirm that the shipping profile was copied to the address book.
    $address_book_profile_id = $shipping_profile
      ->getData('address_book_profile_id');
    $this
      ->assertNotEmpty($address_book_profile_id);
    $address_book_profile = Profile::load($address_book_profile_id);
    $this
      ->assertNotEmpty($address_book_profile);
    $this
      ->assertTrue($address_book_profile
      ->isDefault());
    $this
      ->assertEquals('1098 Alta Ave', $address_book_profile
      ->get('address')->address_line1);
    $this
      ->assertEquals('202-555-0108', $address_book_profile
      ->get('field_phone')->value);
  }

  /**
   * Tests checkout when no shipping options are available.
   *
   * It should prevent continuation but not crash.
   */
  public function testNoShippingOptions() {
    $third_store = $this
      ->createStore();
    $variation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => strtolower($this
        ->randomMachineName()),
      'price' => [
        'number' => '8.99',
        'currency_code' => 'USD',
      ],
    ]);

    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
    $third_product = $this
      ->createEntity('commerce_product', [
      'type' => 'default',
      'title' => 'Conference bow tie',
      'variations' => [
        $variation,
      ],
      'stores' => [
        $third_store,
      ],
    ]);
    $checkout_flow = CheckoutFlow::load('shipping');
    $checkout_flow_configuration = $checkout_flow
      ->get('configuration');
    $checkout_flow_configuration['panes']['shipping_information']['require_shipping_profile'] = FALSE;
    $checkout_flow
      ->set('configuration', $checkout_flow_configuration);
    $checkout_flow
      ->save();
    $this
      ->drupalGet($third_product
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertSession()
      ->pageTextContains('There are no shipping rates available for this address.');
    $page = $this
      ->getSession()
      ->getPage();

    // Complete the order information step.
    $address = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => '1098 Alta Ave',
      'locality' => 'Mountain View',
      'administrative_area' => 'CA',
      'postal_code' => '94043',
    ];
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';
    $page
      ->fillField($address_prefix . '[country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($address as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    $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',
    ], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('A valid shipping method must be selected in order to check out.');
  }

  /**
   * Tests the change of shipping rate options on checkout.
   *
   * @dataProvider shippingMethodOptionChangeProvider
   */
  public function testShippingMethodOptionChanges($auto_recalculate) {
    $checkout_flow = CheckoutFlow::load('shipping');
    $checkout_flow_configuration = $checkout_flow
      ->get('configuration');
    $checkout_flow_configuration['panes']['shipping_information']['auto_recalculate'] = $auto_recalculate;
    $checkout_flow
      ->set('configuration', $checkout_flow_configuration);
    $checkout_flow
      ->save();
    $address_fr = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => '38 rue du sentier',
      'locality' => 'Paris',
      'postal_code' => '75002',
      'country_code' => 'FR',
    ];
    $default_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->defaultAddress,
      'is_default' => TRUE,
    ]);
    $another_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $address_fr,
    ]);
    $conditions = [
      'target_plugin_id' => 'shipment_address',
      'target_plugin_configuration' => [
        'zone' => [
          'territories' => [
            [
              'country_code' => 'US',
            ],
          ],
        ],
      ],
    ];
    $this->firstShippingMethod
      ->set('conditions', $conditions)
      ->save();
    $conditions['target_plugin_configuration']['zone']['territories'][0]['country_code'] = 'FR';
    $this->secondShippingMethod
      ->set('conditions', $conditions)
      ->save();
    $this
      ->drupalGet($this->firstProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->assertRenderedAddress($this->defaultAddress, 'shipping_information[shipping_profile]');
    $this
      ->assertSession()
      ->pageTextContains('Overnight shipping: $19.99 $16.99');
    $this
      ->assertSession()
      ->pageTextNotContains('Standard shipping');
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][select_address]', 2);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($address_fr, 'shipping_information[shipping_profile]');
    if (!$auto_recalculate) {
      $this
        ->assertSession()
        ->pageTextNotContains('An illegal choice has been detected. Please contact the site administrator.');
      $page
        ->findButton('Recalculate shipping')
        ->click();
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest();
    }
    else {
      $this
        ->assertSession()
        ->waitForText('Standard shipping');
    }
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][select_address]', '_new');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $address_de = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => 'Hauptstrasse 38',
      'locality' => 'Berlin',
      'postal_code' => '75002',
    ];
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';
    $page
      ->fillField($address_prefix . '[country_code]', 'DE');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($address_de as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    if (!$auto_recalculate) {
      $page
        ->findButton('Recalculate shipping')
        ->click();
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest();
    }
    else {
      $this
        ->assertSession()
        ->waitForText('There are no shipping rates available for this address.');
    }
    $this
      ->assertSession()
      ->pageTextContains('There are no shipping rates available for this address.');
    $this
      ->assertSession()
      ->pageTextNotContains('An illegal choice has been detected. Please contact the site administrator.');
    $address_us = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => 'Main street 38',
      'locality' => 'Los Angeles',
      'administrative_area' => 'CA',
      'postal_code' => '90014',
    ];
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->fillField($address_prefix . '[country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    foreach ($address_us as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    if (!$auto_recalculate) {
      $page
        ->findButton('Recalculate shipping')
        ->click();
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest();
    }
    else {
      $this
        ->assertSession()
        ->waitForText('Overnight shipping');
    }
    $this
      ->assertSession()
      ->pageTextNotContains('An illegal choice has been detected. Please contact the site administrator.');
    $first_radio_button = $page
      ->findField('Standard shipping: $9.99');
    $second_radio_button = $page
      ->findField('Overnight shipping: $19.99 $16.99');
    $this
      ->assertNull($first_radio_button);
    $this
      ->assertNotNull($second_radio_button);
    $this
      ->assertNotEmpty($second_radio_button
      ->getAttribute('checked'));
    $selector = '//div[@data-drupal-selector="edit-order-summary"]';
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $16.99');

    // commerce_field_widget_form_alter() removes the description. Probably a
    // bug.
    $this
      ->assertSession()
      ->pageTextNotContains('At your door tomorrow morning');
    $address_prefix = 'shipping_information[shipping_profile][address][0][address]';
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->fillField($address_prefix . '[country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    unset($address_fr['country_code']);
    foreach ($address_fr as $property => $value) {
      $page
        ->fillField($address_prefix . '[' . $property . ']', $value);
    }
    if (!$auto_recalculate) {
      $page
        ->findButton('Recalculate shipping')
        ->click();
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest();
    }
    else {
      $this
        ->assertSession()
        ->waitForText('Standard shipping');
    }
    $this
      ->assertSession()
      ->pageTextNotContains('An illegal choice has been detected. Please contact the site administrator.');
    $first_radio_button = $page
      ->findField('Standard shipping: $9.99');
    $second_radio_button = $page
      ->findField('Overnight shipping: $19.99 $16.99');
    $this
      ->assertNotNull($first_radio_button);
    $this
      ->assertNull($second_radio_button);
    $this
      ->assertNotEmpty($first_radio_button
      ->getAttribute('checked'));
    $this
      ->assertSession()
      ->pageTextNotContains('At your door tomorrow morning');
  }

  /**
   * Data provider for ::testShippingMethodOptionChanges.
   *
   * @return array
   *   A list of testShippingMethodOptionChanges function arguments.
   */
  public function shippingMethodOptionChangeProvider() {
    return [
      [
        FALSE,
      ],
      [
        TRUE,
      ],
    ];
  }

  /**
   * Tests that the order summary is properly refreshed.
   */
  public function testOrderSummaryRefresh() {

    // Create a tax type that applies to French addresses, to ensure the tax
    // adjustment is shown in the order summary when selecting the FR address.

    /** @var \Drupal\commerce_tax\Entity\TaxTypeInterface $tax_type */
    $this->store
      ->set('tax_registrations', [
      'FR',
    ])
      ->save();
    $this
      ->createEntity('commerce_tax_type', [
      'id' => 'fr_vat',
      'label' => 'French VAT',
      'plugin' => 'custom',
      'configuration' => [
        'display_inclusive' => TRUE,
        'display_label' => 'vat',
        'round' => TRUE,
        'rates' => [
          [
            'id' => 'standard',
            'label' => 'Standard',
            'percentage' => '0.2',
          ],
        ],
        'territories' => [
          [
            'country_code' => 'FR',
          ],
        ],
      ],
      'status' => TRUE,
    ]);
    $address_fr = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'address_line1' => '38 rue du sentier',
      'locality' => 'Paris',
      'postal_code' => '75002',
      'country_code' => 'FR',
    ];
    $default_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->defaultAddress,
      'is_default' => TRUE,
    ]);
    $another_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $address_fr,
    ]);
    $this
      ->drupalGet($this->firstProduct
      ->toUrl()
      ->toString());
    $this
      ->submitForm([], 'Add to cart');
    $this
      ->drupalGet('checkout/1');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'shipping_information[shipping_profile]');
    $this
      ->assertSession()
      ->pageTextContains('Overnight shipping: $19.99 $16.99');
    $this
      ->assertSession()
      ->pageTextContains('Standard shipping');
    $selector = '//div[@data-drupal-selector="edit-order-summary"]';
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $9.99');
    $second_radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Overnight shipping: $19.99 $16.99');
    $second_radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $16.99');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('shipping_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][address][0][address][address_line1]', '9 Drupal Avenue');
    $this
      ->getSession()
      ->getPage()
      ->findButton('Recalculate shipping')
      ->click();
    $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]' => '2026',
      'payment_information[add_payment_method][payment_details][security_code]' => '123',
    ], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextNotContains('The content has either been modified by another user');
    foreach ($this->defaultAddress as $property => $value) {
      if ($property != 'country_code') {
        $this
          ->assertSession()
          ->pageTextContains($value);
      }
    }
    $this
      ->assertSession()
      ->pageTextContains('Overnight shipping');
    $this
      ->assertSession()
      ->pageTextNotContains('Standard shipping');
    $conditions = [
      'target_plugin_id' => 'shipment_address',
      'target_plugin_configuration' => [
        'zone' => [
          'territories' => [
            [
              'country_code' => 'US',
            ],
          ],
        ],
      ],
    ];
    $this->firstShippingMethod
      ->set('conditions', $conditions)
      ->save();
    $conditions['target_plugin_configuration']['zone']['territories'][0]['country_code'] = 'FR';
    $this->secondShippingMethod
      ->set('conditions', $conditions)
      ->save();
    $this
      ->assertSession()
      ->pageTextContains('Shipping information');

    // Go back to the order info page, attempt switching between different
    // addresses.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Go back');
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][select_address]', 2);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddress($address_fr, 'shipping_information[shipping_profile]');
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'Shipping $9.99');

    // Ensure the tax is properly displayed in the summary when switching to the
    // FR address and assert that it's removed after switching back to the US
    // address.
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'VAT $1.60');
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][select_address]', 1);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->elementTextNotContains('xpath', $selector, 'VAT $1.60');
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipping_information[shipping_profile][select_address]', 2);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'VAT $1.60');
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Standard shipping');
    $this
      ->assertSession()
      ->pageTextNotContains('Overnight shipping');
    $this
      ->assertSession()
      ->elementTextContains('xpath', $selector, 'VAT $1.60');
  }

  /**
   * Asserts that a select field has all of the provided options.
   *
   * Core only has assertOption(), this helper decreases the number of needed
   * assertions.
   *
   * @param string $id
   *   ID of select field to assert.
   * @param array $options
   *   Options to assert.
   * @param string $message
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
   */
  protected function assertOptions($id, array $options, $message = '') {
    $elements = $this
      ->xpath('//select[@name="' . $id . '"]/option');
    $found_options = [];
    foreach ($elements as $element) {
      if ($option = $element
        ->getValue()) {
        $found_options[] = $option;
      }
    }
    $this
      ->assertFieldValues($found_options, $options, $message);
  }

}

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.
CheckoutPaneTest::$defaultAddress	protected	property	The default profile's address.
CheckoutPaneTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides CommerceWebDriverTestBase::$defaultTheme
CheckoutPaneTest::$firstProduct	protected	property	First sample product.
CheckoutPaneTest::$firstShippingMethod	protected	property	First shipping method.
CheckoutPaneTest::$modules	public static	property	Modules to enable. Overrides CommerceWebDriverTestBase::$modules
CheckoutPaneTest::$secondProduct	protected	property	Second sample product.
CheckoutPaneTest::$secondShippingMethod	protected	property	Second shipping method.
CheckoutPaneTest::assertOptions	protected	function	Asserts that a select field has all of the provided options.
CheckoutPaneTest::getAdministratorPermissions	protected	function	Gets the permissions for the admin user. Overrides CommerceWebDriverTestBase::getAdministratorPermissions
CheckoutPaneTest::setUp	protected	function	Overrides CommerceWebDriverTestBase::setUp
CheckoutPaneTest::shippingMethodOptionChangeProvider	public	function	Data provider for ::testShippingMethodOptionChanges.
CheckoutPaneTest::testCustomShippingProfileType	public	function	Test checkout with a custom shipping profile type.
CheckoutPaneTest::testMultipleShipments	public	function	Tests checkout with multiple shipments.
CheckoutPaneTest::testNoRequiredShippingProfile	public	function	Tests checkout when the shipping profile is not required for showing rates.
CheckoutPaneTest::testNoShippingOptions	public	function	Tests checkout when no shipping options are available.
CheckoutPaneTest::testOrderSummaryRefresh	public	function	Tests that the order summary is properly refreshed.
CheckoutPaneTest::testShippingMethodOptionChanges	public	function	Tests the change of shipping rate options on checkout.
CheckoutPaneTest::testSingleShipment	public	function	Tests checkout with a single shipment.
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::$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
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.

You are here

class CheckoutPaneTest in Commerce Shipping 8.2

Hierarchy

File

Namespace

Members

API Navigation