You are here

Home » API reference » Commerce Shipping 8.2 » ShipmentAdminTest.php

class ShipmentAdminTest in Commerce Shipping 8.2

Tests the shipment admin UI.

@group commerce_shipping

Hierarchy

Expanded class hierarchy of ShipmentAdminTest

File

tests/src/FunctionalJavascript/ShipmentAdminTest.php, line 29

Namespace

Drupal\Tests\commerce_shipping\FunctionalJavascript
View source 
class ShipmentAdminTest extends CommerceWebDriverTestBase {
  use AssertMailTrait;

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

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

  /**
   * A sample order.
   *
   * @var \Drupal\commerce_order\Entity\OrderInterface
   */
  protected $order;

  /**
   * The base admin shipment uri.
   *
   * @var string
   */
  protected $shipmentUri;

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

  /**
   * {@inheritdoc}
   */
  protected function getAdministratorPermissions() {
    return array_merge([
      'administer commerce_order',
      'administer commerce_shipment',
      'administer commerce_shipment_type',
      'access commerce_order overview',
    ], parent::getAdministratorPermissions());
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $product_variation_type = ProductVariationType::load('default');
    $product_variation_type
      ->setTraits([
      'purchasable_entity_shippable',
    ]);
    $product_variation_type
      ->setGenerateTitle(FALSE);
    $product_variation_type
      ->save();
    $order_type = OrderType::load('default');
    $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());
    \Drupal::service('commerce.configurable_field_manager')
      ->createField($field_definition);

    // Install the variation trait.
    $trait_manager = \Drupal::service('plugin.manager.commerce_entity_trait');
    $trait = $trait_manager
      ->createInstance('purchasable_entity_shippable');
    $trait_manager
      ->installTrait($trait, 'commerce_product_variation', 'default');
    $variation = $this
      ->createEntity('commerce_product_variation', [
      'title' => $this
        ->randomMachineName(),
      'type' => 'default',
      'sku' => 'sku-' . $this
        ->randomMachineName(),
      'price' => [
        'number' => '7.99',
        'currency_code' => 'USD',
      ],
    ]);
    $order_item = $this
      ->createEntity('commerce_order_item', [
      'title' => $this
        ->randomMachineName(),
      'type' => 'default',
      'quantity' => 1,
      'unit_price' => new Price('10', 'USD'),
      'purchased_entity' => $variation,
    ]);
    $order_item
      ->save();
    $this->order = $this
      ->createEntity('commerce_order', [
      'uid' => $this->loggedInUser
        ->id(),
      'order_number' => '6',
      'type' => 'default',
      'state' => 'completed',
      'order_items' => [
        $order_item,
      ],
      'store_id' => $this->store,
      'mail' => $this->loggedInUser
        ->getEmail(),
    ]);
    $this->shipmentUri = Url::fromRoute('entity.commerce_shipment.collection', [
      'commerce_order' => $this->order
        ->id(),
    ])
      ->toString();

    /** @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',
      ],
    ]);
    \Drupal::service('plugin.manager.commerce_package_type')
      ->clearCachedDefinitions();
    $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
      ->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',
          ],
        ],
      ],
    ]);

    // 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();
    $shipment_type = ShipmentType::load('default');
    $shipment_type
      ->setProfileTypeId('customer_shipping');
    $shipment_type
      ->save();
    $this->defaultProfile = Profile::create([
      'type' => 'customer_shipping',
      'uid' => $this->adminUser,
      'address' => $this->defaultAddress,
      'field_phone' => '202-555-0108',
    ]);
    $this->defaultProfile
      ->save();
  }

  /**
   * Tests that Shipments tab and operation visibility.
   */
  public function testShipmentTabAndOperation() {
    $this
      ->drupalGet($this->order
      ->toUrl());
    $this
      ->assertSession()
      ->linkExists('Shipments');
    $this
      ->assertSession()
      ->linkByHrefExists($this->shipmentUri);

    // Make the order type non shippable, and make sure the "Shipments" tab
    // doesn't show up.
    $order_type = OrderType::load('default');
    $order_type
      ->unsetThirdPartySetting('commerce_shipping', 'shipment_type');
    $order_type
      ->save();
    $this
      ->drupalGet($this->order
      ->toUrl());
    $this
      ->assertSession()
      ->linkNotExists('Shipments');
    $this
      ->assertSession()
      ->linkByHrefNotExists($this->shipmentUri);
    $order_type
      ->setThirdPartySetting('commerce_shipping', 'shipment_type', 'default');
    $order_type
      ->save();
    $this
      ->drupalGet($this->order
      ->toUrl());
    $this
      ->assertSession()
      ->linkExists('Shipments');

    // Ensure the "Shipments" operation is shown on the listing page.
    $this
      ->drupalGet($this->order
      ->toUrl('collection'));
    $this
      ->assertSession()
      ->linkByHrefExists($this->shipmentUri);
    $order_edit_link = $this->order
      ->toUrl('edit-form')
      ->toString();
    $this
      ->assertSession()
      ->linkByHrefExists($order_edit_link);

    // Make sure the "Shipments" tab isn't shown for cart orders.
    $this->order
      ->set('cart', TRUE);
    $this->order
      ->save();
    $this
      ->drupalGet($this->order
      ->toUrl());
    $this
      ->assertSession()
      ->linkNotExists('Shipments');

    // Ensure the "Shipments" operation is not shown on the cart listing page.
    $this
      ->drupalGet($this->order
      ->toUrl('collection'));

    // The order will have moved to the cart listing.
    $this
      ->assertSession()
      ->linkByHrefNotExists($order_edit_link);
    $this
      ->clickLink('Carts');
    $this
      ->assertSession()
      ->linkByHrefExists($order_edit_link);
    $this
      ->assertSession()
      ->linkNotExists('Shipments');
    $this
      ->assertSession()
      ->linkByHrefNotExists($this->shipmentUri);
  }

  /**
   * Tests the Shipment add page.
   */
  public function testShipmentAddPage() {
    $this
      ->drupalGet($this->shipmentUri);
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Add shipment');
    $this
      ->assertSession()
      ->addressEquals($this->shipmentUri . '/add/default');
    $shipment_type = $this
      ->createEntity('commerce_shipment_type', [
      'id' => 'foo',
      'label' => 'FOO',
    ]);
    $shipment_type
      ->save();
    $order_type = OrderType::load('default');
    $order_type
      ->setThirdPartySetting('commerce_shipping', 'shipment_type', 'foo');
    $order_type
      ->save();
    $this
      ->drupalGet($this->shipmentUri);
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Add shipment');
    $this
      ->assertSession()
      ->addressEquals($this->shipmentUri . '/add/foo');
  }

  /**
   * Tests creating a shipment for an order.
   */
  public function testShipmentCreate() {
    $this
      ->drupalGet($this->shipmentUri);
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Add shipment');
    $this
      ->assertSession()
      ->addressEquals($this->shipmentUri . '/add/default');
    $this
      ->assertTrue($page
      ->hasSelect('package_type'));
    $this
      ->assertSession()
      ->optionExists('package_type', 'Custom box');
    $this
      ->assertSession()
      ->optionExists('package_type', 'Package Type A');
    $this
      ->assertTrue($page
      ->hasButton('Recalculate shipping'));
    $this
      ->assertSession()
      ->pageTextContains('Shipment items');
    list($order_item) = $this->order
      ->getItems();
    $this
      ->assertSession()
      ->pageTextContains($order_item
      ->label());
    $this
      ->assertRenderedAddress($this->defaultAddress, 'shipping_profile[0][profile]');
    $this
      ->assertSession()
      ->pageTextContains('202-555-0108');
    $this
      ->assertSession()
      ->pageTextContains('Shipping method');
    $first_radio_button = $page
      ->findField('Standard shipping: $9.99');
    $second_radio_button = $page
      ->findField('Overnight shipping: $19.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');
    $page
      ->findButton('Recalculate shipping')
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([
      'shipment_items[1]' => TRUE,
      'title[0][value]' => 'Test shipment',
    ], 'Save');
    $this
      ->assertSession()
      ->addressEquals($this->shipmentUri);
    $this
      ->assertSession()
      ->pageTextContains(t('Shipment for order @order created.', [
      '@order' => $this->order
        ->getOrderNumber(),
    ]));
    \Drupal::entityTypeManager()
      ->getStorage('commerce_order')
      ->resetCache([
      $this->order
        ->id(),
    ]);
    $this->order = Order::load($this->order
      ->id());

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = Shipment::load(1);
    $this
      ->assertEquals($this->order
      ->id(), $shipment
      ->getOrderId());
    $this
      ->assertEquals('9.99', $shipment
      ->getAmount()
      ->getNumber());
    $this
      ->assertSession()
      ->pageTextContains($shipment
      ->label());
    $shipping_profile = $shipment
      ->getShippingProfile();
    $this
      ->assertEquals('customer_shipping', $shipping_profile
      ->bundle());
    $this
      ->assertEquals('202-555-0108', $shipping_profile
      ->get('field_phone')->value);
    $this
      ->assertEquals($this->defaultAddress, array_filter($shipping_profile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertEquals($this->defaultProfile
      ->id(), $shipping_profile
      ->getData('address_book_profile_id'));
    $this
      ->assertSession()
      ->pageTextContains('$9.99');
    $this
      ->assertTrue($page
      ->hasLink('Finalize shipment'));
    $this
      ->assertTrue($page
      ->hasLink('Cancel shipment'));
    $adjustments = $this->order
      ->getAdjustments();
    $this
      ->assertCount(1, $adjustments);
    $this
      ->assertEquals($adjustments[0]
      ->getAmount(), $shipment
      ->getAmount());
  }

  /**
   * Tests editing a shipment.
   */
  public function testShipmentEdit() {
    $shipping_method = $this
      ->createEntity('commerce_shipping_method', [
      'name' => 'The best shipping',
      'stores' => [
        $this->store
          ->id(),
      ],
      'plugin' => [
        'target_plugin_id' => 'dynamic',
        'target_plugin_configuration' => [
          'rate_label' => 'The best shipping',
          'rate_amount' => [
            'number' => '7.99',
            'currency_code' => 'USD',
          ],
        ],
      ],
    ]);
    $this
      ->createEntity('commerce_shipping_method', [
      'name' => 'Wisconsin Express',
      'stores' => [
        $this->store
          ->id(),
      ],
      'plugin' => [
        'target_plugin_id' => 'flat_rate',
        'target_plugin_configuration' => [
          'rate_label' => 'Wisconsin Express',
          'rate_amount' => [
            'number' => '2.99',
            'currency_code' => 'USD',
          ],
        ],
      ],
      'conditions' => [
        [
          'target_plugin_id' => 'shipment_address',
          'target_plugin_configuration' => [
            'zone' => [
              'territories' => [
                [
                  'country_code' => 'US',
                  'administrative_area' => 'WI',
                ],
              ],
            ],
          ],
        ],
      ],
    ]);
    $this
      ->createEntity('commerce_shipping_method', [
      'name' => 'Carolina Special',
      'stores' => [
        $this->store
          ->id(),
      ],
      'plugin' => [
        'target_plugin_id' => 'flat_rate',
        'target_plugin_configuration' => [
          'rate_label' => 'Carolina Special',
          'rate_amount' => [
            'number' => '2.99',
            'currency_code' => 'USD',
          ],
        ],
      ],
      'conditions' => [
        [
          'target_plugin_id' => 'shipment_address',
          'target_plugin_configuration' => [
            'zone' => [
              'territories' => [
                [
                  'country_code' => 'US',
                  'administrative_area' => 'SC',
                ],
              ],
            ],
          ],
        ],
      ],
    ]);
    $address = [
      'country_code' => 'US',
      'postal_code' => '53177',
      'locality' => 'Milwaukee',
      'address_line1' => 'Pabst Blue Ribbon Dr',
      'administrative_area' => 'WI',
      'given_name' => 'Frederick',
      'family_name' => 'Pabst',
    ];
    $shipping_profile = Profile::create([
      'type' => 'customer_shipping',
      'uid' => 0,
      'address' => $address,
    ]);
    $shipping_profile
      ->save();

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = $this
      ->createEntity('commerce_shipment', [
      'type' => 'default',
      'title' => 'Test shipment',
      'order_id' => $this->order
        ->id(),
      'amount' => new Price('10', 'USD'),
      'items' => [
        new ShipmentItem([
          'order_item_id' => 1,
          'title' => 'Test shipment item label',
          'quantity' => 1,
          'weight' => new Weight(0, 'g'),
          'declared_value' => new Price('1', 'USD'),
        ]),
      ],
      'shipping_profile' => $shipping_profile,
    ]);

    /** @var \Drupal\commerce_shipping_test\Plugin\Commerce\ShippingMethod\DynamicRate $shipping_method_plugin */
    $shipping_method_plugin = \Drupal::service('plugin.manager.commerce_shipping_method')
      ->createInstance('dynamic');
    $shipping_services = $shipping_method_plugin
      ->getServices();
    $shipment
      ->setData('owned_by_packer', TRUE)
      ->setShippingMethod($shipping_method)
      ->setShippingService(key($shipping_services))
      ->save();
    $this
      ->assertEquals(new Price('10', 'USD'), $shipment
      ->getAmount());

    // Edit the shipment.
    $this
      ->assertSession()
      ->linkExists('Edit');
    $this
      ->drupalGet($shipment
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->fieldValueEquals('title[0][value]', $shipment
      ->label());
    $shipment_item_title = $shipment
      ->getItems()[0]
      ->getTitle();
    $this
      ->assertSession()
      ->fieldExists($shipment_item_title);

    // Assert shipping rates available on load and not lost when recalculated.
    $this
      ->assertNotEmpty($this
      ->getSession()
      ->getPage()
      ->findField('The best shipping: $7.99')
      ->getAttribute('checked'));
    $this
      ->assertSession()
      ->fieldExists('Overnight shipping: $19.99');
    $this
      ->assertSession()
      ->fieldExists('Standard shipping: $9.99');
    $this
      ->assertSession()
      ->fieldExists('The best shipping: $7.99');
    $this
      ->assertSession()
      ->fieldNotExists('Carolina Special: $2.99');
    $this
      ->assertSession()
      ->fieldExists('Wisconsin Express: $2.99');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Recalculate shipping');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertNotEmpty($this
      ->getSession()
      ->getPage()
      ->findField('The best shipping: $7.99')
      ->getAttribute('checked'));
    $this
      ->assertSession()
      ->fieldExists('Overnight shipping: $19.99');
    $this
      ->assertSession()
      ->fieldExists('Standard shipping: $9.99');
    $this
      ->assertSession()
      ->fieldExists('The best shipping: $7.99');
    $this
      ->assertSession()
      ->fieldNotExists('Carolina Special: $2.99');
    $this
      ->assertSession()
      ->fieldExists('Wisconsin Express: $2.99');
    $wi_express = $this
      ->getSession()
      ->getPage()
      ->findField('Wisconsin Express: $2.99');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption($wi_express
      ->getAttribute('id'), $wi_express
      ->getAttribute('value'));
    $this
      ->assertRenderedAddress($address, 'shipping_profile[0][profile]');

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

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

    // The copy checkbox should be hidden and checked.
    $this
      ->assertSession()
      ->fieldNotExists('shipping_profile[0][profile][copy_to_address_book]');

    // Change the package type.
    $package_type = PackageType::load('package_type_a');
    $this
      ->getSession()
      ->getPage()
      ->fillField('package_type', 'commerce_package_type:' . $package_type
      ->uuid());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Recalculate shipping');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->fieldExists('Overnight shipping: $19.99');
    $this
      ->assertSession()
      ->fieldExists('Standard shipping: $9.99');
    $this
      ->assertSession()
      ->fieldExists('The best shipping: $159.80');
    $this
      ->assertSession()
      ->fieldExists('Carolina Special: $2.99');
    $this
      ->assertSession()
      ->fieldNotExists('Wisconsin Express: $2.99');
    $this
      ->createScreenshot('../shipment_default_method.png');
    $this
      ->assertNotEmpty($this
      ->getSession()
      ->getPage()
      ->findField('The best shipping: $159.80')
      ->getAttribute('checked'));
    $this
      ->submitForm([], 'Save');

    // Ensure the shipment has been updated.
    $shipment = $this
      ->reloadEntity($shipment);
    $this
      ->assertEquals('commerce_package_type:' . $package_type
      ->uuid(), $shipment
      ->getPackageType()
      ->getId());
    $this
      ->assertFalse($shipment
      ->getData('owned_by_packer', TRUE));
    $this
      ->assertEquals(new Price('159.80', 'USD'), $shipment
      ->getAmount());
    $shipping_profile = $this
      ->reloadEntity($shipping_profile);
    $this
      ->assertEquals('customer_shipping', $shipping_profile
      ->bundle());
    $expected_address = [
      'address_line1' => '10 Drupal Ave',
    ] + $this->defaultAddress;
    $this
      ->assertEquals($expected_address, array_filter($shipping_profile
      ->get('address')
      ->first()
      ->toArray()));
    $this
      ->assertEquals($this->defaultProfile
      ->id(), $shipping_profile
      ->getData('address_book_profile_id'));

    // 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()));
  }

  /**
   * Tests deleting a shipment.
   */
  public function testShipmentDelete() {

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = $this
      ->createEntity('commerce_shipment', [
      'type' => 'default',
      'title' => 'Test shipment',
      'order_id' => $this->order
        ->id(),
      'amount' => new Price('10', 'USD'),
      'items' => [
        new ShipmentItem([
          'order_item_id' => 1,
          'title' => 'Test shipment item',
          'quantity' => 1,
          'weight' => new Weight(0, 'g'),
          'declared_value' => new Price('1', 'USD'),
        ]),
      ],
    ]);
    $this
      ->drupalGet($this->shipmentUri);
    $this
      ->assertSession()
      ->pageTextContains($shipment
      ->label());
    $this
      ->assertSession()
      ->pageTextContains('$10.00');
    $this
      ->assertSession()
      ->linkByHrefExists($this->shipmentUri . '/' . $shipment
      ->id() . '/delete');
    $this
      ->drupalGet($this->shipmentUri . '/' . $shipment
      ->id() . '/delete');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Delete');
    $this
      ->assertSession()
      ->addressEquals($this->shipmentUri);
    $this
      ->assertSession()
      ->pageTextNotContains('$10.00');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_shipment')
      ->resetCache([
      $shipment
        ->id(),
    ]);
    $shipment = Shipment::load($shipment
      ->id());
    $this
      ->assertNull($shipment);
  }

  /**
   * Tests the Shipments listing with and without the view.
   */
  public function testShipmentListing() {
    $this
      ->drupalGet($this->order
      ->toUrl());
    $this
      ->assertSession()
      ->linkExists('Shipments');
    $this
      ->assertSession()
      ->linkByHrefExists($this->shipmentUri);
    $this
      ->clickLink('Shipments');
    $this
      ->assertSession()
      ->pageTextContains('There are no shipments yet.');
    $shipment = $this
      ->createEntity('commerce_shipment', [
      'type' => 'default',
      'title' => $this
        ->randomString(16),
      'package_type_id' => 'package_type_a',
      'order_id' => $this->order
        ->id(),
      'amount' => new Price('10', 'USD'),
      'items' => [
        new ShipmentItem([
          'order_item_id' => 1,
          'title' => 'Test shipment item label',
          'quantity' => 1,
          'weight' => new Weight(0, 'g'),
          'declared_value' => new Price('1', 'USD'),
        ]),
      ],
      'tracking_code' => 'CODE',
    ]);
    $this
      ->getSession()
      ->reload();
    $this
      ->assertSession()
      ->pageTextNotContains('There are no shipments yet.');
    $this
      ->assertSession()
      ->pageTextContains($shipment
      ->label());
    $this
      ->assertSession()
      ->pageTextContains($shipment
      ->getTrackingCode());

    // Ensure the listing works without the view.
    View::load('order_shipments')
      ->delete();
    \Drupal::service('router.builder')
      ->rebuild();
    $this
      ->drupalGet($this->shipmentUri);
    $this
      ->assertSession()
      ->pageTextNotContains('There are no shipments yet.');
    $this
      ->assertSession()
      ->pageTextContains($shipment
      ->label());
    $shipment
      ->delete();
    $this
      ->getSession()
      ->reload();
    $this
      ->assertSession()
      ->pageTextContains('There are no shipments yet.');
  }

  /**
   * Tests using inline_entity_form to manage an order's shipments.
   *
   * @requires module inline_entity_form
   */
  public function testInlineEntityFormIntegration() {

    // Create a default billing profile to simplify testing.
    $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->adminUser
        ->id(),
      'address' => $this->defaultAddress,
      'field_phone' => '202-555-0108',
    ]);
    $address = [
      'country_code' => 'US',
      'administrative_area' => 'WI',
      'locality' => 'Milwaukee',
      'postal_code' => '53177',
      'address_line1' => 'Pabst Blue Ribbon Dr',
      'given_name' => 'Frederick',
      'family_name' => 'Pabst',
    ];
    $shipping_profile = $this
      ->createEntity('profile', [
      'type' => 'customer_shipping',
      'uid' => $this->adminUser
        ->id(),
      'address' => $address,
      'field_phone' => '202-555-0108',
    ]);
    $form_display = commerce_get_entity_display('commerce_order', 'default', 'form');
    $form_display
      ->setComponent('shipments', [
      'type' => 'inline_entity_form_complex',
    ]);
    $form_display
      ->save();
    $this
      ->drupalGet($this->order
      ->toUrl('edit-form'));
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Add new shipment');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $ief = $this
      ->getSession()
      ->getPage()
      ->find('css', '[data-drupal-selector="edit-shipments-wrapper"]');
    $this
      ->assertNotNull($ief);
    $ief
      ->fillField('shipments[form][0][title][0][value]', 'Shipment #1');
    $ief
      ->fillField('shipments[form][0][shipping_profile][0][profile][select_address]', $shipping_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $ief
      ->pressButton('Create shipment');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Save');

    // Verify the address when viewing the order.
    $rendered_shipping_information = $this
      ->getSession()
      ->getPage()
      ->find('xpath', '//details//summary[contains(text(), "Shipping information")]');
    $rendered_shipping_information
      ->getParent();
    $this
      ->assertRenderedAddressInRegion($address, $rendered_shipping_information
      ->getParent());
    $this
      ->drupalGet($this->order
      ->toUrl('edit-form'));
    $edit_shipment_button = $this
      ->xpath('//input[@id="edit-shipments-entities-0-actions-ief-entity-edit"]')[0];
    $edit_shipment_button
      ->press();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipments[form][inline_entity_form][entities][0][form][tracking_code][0][value]', 'CODE');
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipments[form][inline_entity_form][entities][0][form][shipping_profile][0][profile][select_address]', $this->defaultProfile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([], 'Save', 'commerce-order-default-edit-form');
    $this
      ->assertSession()
      ->pageTextContains("The order {$this->order->getOrderNumber()} has been successfully saved.");
    $rendered_shipping_information = $this
      ->getSession()
      ->getPage()
      ->find('xpath', '//details//summary[contains(text(), "Shipping information")]');
    $rendered_shipping_information
      ->getParent();
    $this
      ->assertRenderedAddressInRegion($this->defaultAddress, $rendered_shipping_information
      ->getParent());

    // Try updating the shipping profile again, this time by clicking on the
    // "Update shipment" button prior to saving the main form.
    // @note part of this is commented out due to incompatibilities.
    $this
      ->drupalGet($this->order
      ->toUrl('edit-form'));
    $edit_shipment_button = $this
      ->xpath('//input[@id="edit-shipments-entities-0-actions-ief-entity-edit"]')[0];
    $edit_shipment_button
      ->press();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $ief = $this
      ->getSession()
      ->getPage()
      ->find('css', '[data-drupal-selector="edit-shipments-form-inline-entity-form-entities-0-form"]');
    $this
      ->assertRenderedAddressInRegion($this->defaultAddress, $ief);
    $this
      ->assertSession()
      ->fieldValueEquals('shipments[form][inline_entity_form][entities][0][form][tracking_code][0][value]', 'CODE');
    $this
      ->getSession()
      ->getPage()
      ->fillField('shipments[form][inline_entity_form][entities][0][form][shipping_profile][0][profile][select_address]', $shipping_profile
      ->id());
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertRenderedAddressInRegion($address, $ief);

    // @todo test when IEF + InlineForms are compatible.
    // $ief->pressButton('Update shipment');
    // $this->assertSession()->assertWaitOnAjaxRequest();
    $this
      ->submitForm([], 'Save', 'commerce-order-default-edit-form');
    $this
      ->assertSession()
      ->pageTextContains("The order {$this->order->getOrderNumber()} has been successfully saved.");
    $rendered_shipping_information = $this
      ->getSession()
      ->getPage()
      ->find('xpath', '//details//summary[contains(text(), "Shipping information")]');
    $rendered_shipping_information
      ->getParent();
    $this
      ->assertRenderedAddressInRegion($address, $rendered_shipping_information
      ->getParent());
  }

  /**
   * Asserts that the given address is rendered on the page.
   *
   * @param array $address
   *   The address.
   * @param \Behat\Mink\Element\NodeElement $element
   *   The parent element holding the address.
   *
   * @todo use assertRenderedAddress after https://www.drupal.org/project/commerce/issues/3117251
   */
  protected function assertRenderedAddressInRegion(array $address, NodeElement $element) {
    $address_text = $element
      ->find('css', 'p.address')
      ->getText();
    foreach ($address as $property => $value) {
      if ($property === 'country_code') {
        $value = $this->countryList[$value];
      }
      $this
        ->assertContains($value, $address_text);
    }
  }

  /**
   * Tests shipment confirmation email.
   *
   * @group debug
   */
  public function testShipmentConfirmationEmail() {

    // Enable email confirmation and set bcc address.
    $this
      ->drupalGet('/admin/commerce/config/shipment-types/default/edit');
    $edit = [
      'sendConfirmation' => 1,
      'confirmationBcc' => 'testBcc@shipping.com',
    ];
    $this
      ->submitForm($edit, 'Save');

    // Add Shipment.
    $this
      ->drupalGet($this->shipmentUri);
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Add shipment');
    $page
      ->fillField('title[0][value]', 'Test shipment');
    $page
      ->hasField('shipment_items[1]');
    $page
      ->checkField('shipment_items[1]');
    $page
      ->hasCheckedField('shipment_items[1]');
    $this
      ->assertRenderedAddress($this->defaultAddress, 'shipping_profile[0][profile]');
    $page
      ->pressButton('Recalculate shipping');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $page
      ->fillField('tracking_code[0][value]', 'A1234567890');
    $page
      ->pressButton('Save');

    // Email is triggered at Send shipment step.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Finalize shipment');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to apply this transition?');
    $this
      ->assertSession()
      ->pageTextContains('This action cannot be undone.');
    $this
      ->assertSession()
      ->linkExists('Cancel');

    // Note, there is some odd behavior calling the `press()` method on the
    // button, so after asserting it exists, click via this method.
    $this
      ->click('button:contains("Confirm")');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Send shipment');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('This action cannot be undone.');
    $this
      ->click('button:contains("Confirm")');

    // Test email content.
    $email = current($this
      ->getMails());
    $this
      ->assertEquals('testBcc@shipping.com', $email['headers']['Bcc']);
    $this
      ->assertEquals("An item for order #{$this->order->getOrderNumber()} shipped!", $email['subject']);
    $this
      ->assertContains('Bryan Centarro', $email['body']);
    $this
      ->assertContains('9 Drupal Ave', $email['body']);
    $this
      ->assertContains('Greenville, SC', $email['body']);
    $this
      ->assertContains('29616', $email['body']);
    $this
      ->assertContains('Tracking information:', $email['body']);
    $this
      ->assertContains('A1234567890', $email['body']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommerceBrowserTestTrait::assertFieldValues protected function Asserts that the passed field values are correct.
CommerceBrowserTestTrait::createEntity protected function Creates a new entity.
CommerceBrowserTestTrait::reloadEntity protected function Reloads the entity after clearing the static cache.
CommerceBrowserTestTrait::saveHtmlOutput protected function Debugger method to save additional HTML output.
CommerceWebDriverTestBase::$adminUser protected property A test user with administrative privileges.
CommerceWebDriverTestBase::$countryList protected property The country list.
CommerceWebDriverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 3
CommerceWebDriverTestBase::$store protected property The store entity.
CommerceWebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE. Overrides WebDriverTestBase::assertJsCondition
CommerceWebDriverTestBase::assertRenderedAddress protected function Asserts that the given address is rendered on the page.
CommerceWebDriverTestBase::setRawFieldValue protected function Sets an input field's raw value.
CommerceWebDriverTestBase::tearDown protected function Overrides WebDriverTestBase::tearDown
CommerceWebDriverTestBase::waitForAjaxToFinish Deprecated protected function Waits for jQuery to become active and animations to complete.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
ShipmentAdminTest::$defaultAddress protected property The default profile's address.
ShipmentAdminTest::$defaultProfile protected property The default profile.
ShipmentAdminTest::$modules public static property Modules to enable. Overrides CommerceWebDriverTestBase::$modules
ShipmentAdminTest::$order protected property A sample order.
ShipmentAdminTest::$shipmentUri protected property The base admin shipment uri.
ShipmentAdminTest::assertRenderedAddressInRegion protected function Asserts that the given address is rendered on the page.
ShipmentAdminTest::getAdministratorPermissions protected function Gets the permissions for the admin user. Overrides CommerceWebDriverTestBase::getAdministratorPermissions
ShipmentAdminTest::setUp protected function Overrides CommerceWebDriverTestBase::setUp
ShipmentAdminTest::testInlineEntityFormIntegration public function Tests using inline_entity_form to manage an order's shipments.
ShipmentAdminTest::testShipmentAddPage public function Tests the Shipment add page.
ShipmentAdminTest::testShipmentConfirmationEmail public function Tests shipment confirmation email.
ShipmentAdminTest::testShipmentCreate public function Tests creating a shipment for an order.
ShipmentAdminTest::testShipmentDelete public function Tests deleting a shipment.
ShipmentAdminTest::testShipmentEdit public function Tests editing a shipment.
ShipmentAdminTest::testShipmentListing public function Tests the Shipments listing with and without the view.
ShipmentAdminTest::testShipmentTabAndOperation public function Tests that Shipments tab and operation visibility.
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.