public function ShipmentTest::testShipmentsUi in Ubercart 8.4

Tests the UI for creating new shipments.

File

shipping/uc_fulfillment/tests/src/Functional/ShipmentTest.php, line 18

Class

ShipmentTest

Tests creating new shipments of packaged products.

Namespace

Drupal\Tests\uc_fulfillment\Functional

Code

public function testShipmentsUi() {

  // Log on as administrator to fulfill order.
  $this
    ->drupalLogin($this->adminUser);

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

  // A payment method for the order.
  $method = $this
    ->createPaymentMethod('other');

  // Process an anonymous, shippable order.
  $order = Order::create([
    'uid' => 0,
    'primary_email' => $this
      ->randomMachineName() . '@example.org',
    'payment_method' => $method['id'],
  ]);

  // Add three more products to use for our tests.
  $products = [];
  for ($i = 1; $i <= 4; $i++) {
    $product = $this
      ->createProduct([
      'uid' => $this->adminUser
        ->id(),
      'promote' => 0,
    ]);
    $order->products[$i] = OrderProduct::create([
      'nid' => $product->nid->target_id,
      'title' => $product->title->value,
      'model' => $product->model,
      'qty' => 1,
      'cost' => $product->cost->value,
      'price' => $product->price->value,
      'weight' => $product->weight,
      'data' => [],
    ]);
    $order->products[$i]->data->shippable = 1;
  }
  $order
    ->save();
  $order = Order::load($order
    ->id());
  uc_payment_enter($order
    ->id(), 'other', $order
    ->getTotal());

  // Now quickly package all the products in this order.
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/packages');
  $this
    ->submitForm([
    'shipping_types[small_package][table][1][checked]' => 1,
    'shipping_types[small_package][table][2][checked]' => 1,
    'shipping_types[small_package][table][3][checked]' => 1,
    'shipping_types[small_package][table][4][checked]' => 1,
  ], 'Create one package');

  // Test "Ship" operations for this package.
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/packages');
  $assert
    ->linkExists('Ship');
  $this
    ->clickLink('Ship');
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments/new?pkgs=1');
  foreach ($order->products as $sequence => $item) {
    $assert
      ->pageTextContains($item->qty->value . ' x ' . $item->model->value, 'Product quantity x SKU found.');

    // @todo Test for weight here too? How do we compute this?
  }

  // We're shipping a specific package, so it should already be checked.
  foreach ($order->products as $sequence => $item) {

    // Check that package is available for shipping.
    $assert
      ->fieldValueEquals('shipping_types[small_package][table][1][checked]', 1);
  }

  // Check that manual shipping method is selected.
  $assert
    ->fieldValueEquals('method', 'manual');

  //
  // Test presence and operation of ship operation on order admin View.
  //
  $this
    ->drupalGet('admin/store/orders/view');
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments');

  // Test action.
  $this
    ->clickLink('Ship');
  $assert
    ->statusCodeEquals(200);
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments/new');
  $assert
    ->pageTextContains('No shipments have been made for this order.', 'Ship action found.');
  $assert
    ->pageTextContains($order->products[1]->qty->value . ' x ' . $order->products[1]->model->value, 'Product quantity x SKU found.');

  // Check that manual shipping method is selected.
  $assert
    ->fieldValueEquals('method', 'manual');

  // Test reaching this through the shipments tab too ...
  // Select all packages and create shipment using
  // the default "Manual" method.
  $this
    ->submitForm([
    'shipping_types[small_package][table][' . $order
      ->id() . '][checked]' => 1,
  ], 'Ship packages');

  // Check that we're now on the shipment details page.
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/ship?method_id=manual&0=1');
  $assert
    ->pageTextContains('Origin address', 'Origin address pane found.');
  $assert
    ->pageTextContains('Destination address', 'Destination address pane found.');
  $assert
    ->pageTextContains('Package 1', 'Packages data pane found.');
  $assert
    ->pageTextContains('Shipment data', 'Shipment data pane found.');

  // Make the shipment.
  $edit = $this
    ->populateShipmentForm();
  $this
    ->submitForm($edit, 'Save shipment');

  // Check that we're now on the shipments overview page.
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments');
  $assert
    ->pageTextContains('Shipment ID', 'Shipment summary found.');
  $assert
    ->pageTextContains('1234567890ABCD', 'Shipment data present.');

  //
  // Test "View", "Edit", "Print", "Packing slip" and "Delete"
  // operations for this shipment.
  //
  // First, "View".
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments');

  // (Use Href to distinguish View operation from View tab.)
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments/1');
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments/1');

  // Should find four tabs here:
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments/1');
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments/1/edit');
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments/1/packing_slip');
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments/1/print');

  // We're editing the shipment we already made, so all the
  // packages should be checked.
  //    foreach ($order->products as $sequence => $item) {
  //      // Check that product is available for packaging.
  //      $assert->fieldValueEquals('products[' . $sequence . '][checked]', 1);
  //    }
  // Second, "Edit".
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments');

  // (Use Href to distinguish Edit operation from Edit tab.)
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments/1/edit');
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments/1/edit');

  // We're editing the shipment we already made, so all the
  // packages should be checked.
  //    foreach ($order->products as $sequence => $item) {
  //      // Check that product is available for packaging.
  //      $assert->fieldValueEquals('products[' . $sequence . '][checked]', 1);
  //    }
  // Third "Print".
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments');
  $assert
    ->linkExists('Print');
  $this
    ->clickLink('Print');
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments/1/print');

  //    foreach ($order->products as $sequence => $item) {
  //      $assert->pageTextContains(
  //        $item->qty->value . ' x ' . $item->model->value,
  //        'Product quantity x SKU found.'
  //      );
  //    }
  // Fourth "Packing slip".
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments');
  $assert
    ->linkExists('Packing slip');
  $this
    ->clickLink('Packing slip');
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments/1/packing_slip');

  // Check for "Print packing slip" and "Back" buttons.
  //    foreach ($order->products as $sequence => $item) {
  //      $assert->pageTextContains(
  //        $item->qty->value . ' x ' . $item->model->value,
  //        'Product quantity x SKU found.'
  //      );
  //    }
  // Fifth, "Delete".
  $this
    ->drupalGet('admin/store/orders/' . $order
    ->id() . '/shipments');
  $assert
    ->linkExists('Delete');
  $this
    ->clickLink('Delete');

  // Delete takes us to confirm page.
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments/1/delete');
  $assert
    ->pageTextContains('The shipment will be canceled and the packages it contains will be available for reshipment.', 'Deletion confirm question found.');

  // "Cancel" returns to the shipment list page.
  $this
    ->clickLink('Cancel');
  $assert
    ->linkByHrefExists('admin/store/orders/' . $order
    ->id() . '/shipments');

  // Again with the "Delete".
  $this
    ->clickLink('Delete');
  $this
    ->submitForm([], 'Delete');

  // Delete returns to new packages page with all packages unchecked.
  $assert
    ->addressEquals('admin/store/orders/' . $order
    ->id() . '/shipments/new');
  $assert
    ->pageTextContains('Shipment 1 has been deleted.', 'Shipment deleted message found.');

  //    foreach ($order->products as $sequence => $item) {
  //      // Check that package is available for shipping.
  //      $assert->fieldValueEquals('shipping_types[small_package][table][' . $sequence . '][checked]', 0);
  //    }
}