class OrderTest in Commerce Core 8.2

Same name in this branch

8.2 modules/order/tests/src/Functional/OrderTest.php \Drupal\Tests\commerce_order\Functional\OrderTest
8.2 modules/order/tests/src/Kernel/Entity/OrderTest.php \Drupal\Tests\commerce_order\Kernel\Entity\OrderTest

Tests the Order entity.

@coversDefaultClass \Drupal\commerce_order\Entity\Order

@group commerce

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses DeprecatedServicePropertyTrait, UserCreationTrait
  - class \Drupal\Tests\commerce\Kernel\CommerceKernelTestBase uses StoreCreationTrait, DeprecationSuppressionTrait
    class \Drupal\Tests\commerce_order\Kernel\OrderKernelTestBase
    class \Drupal\Tests\commerce_order\Kernel\Entity\OrderTest

Expanded class hierarchy of OrderTest

File

modules/order/tests/src/Kernel/Entity/OrderTest.php, line 21

Namespace

Drupal\Tests\commerce_order\Kernel\Entity

View source

class OrderTest extends OrderKernelTestBase {

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

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'commerce_order_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $user = $this
      ->createUser();
    $this->user = $this
      ->reloadEntity($user);
  }

  /**
   * Tests the order entity and its methods.
   *
   * @covers ::getOrderNumber
   * @covers ::setOrderNumber
   * @covers ::getStore
   * @covers ::setStore
   * @covers ::getStoreId
   * @covers ::setStoreId
   * @covers ::getCustomer
   * @covers ::setCustomer
   * @covers ::getCustomerId
   * @covers ::setCustomerId
   * @covers ::getEmail
   * @covers ::setEmail
   * @covers ::getIpAddress
   * @covers ::setIpAddress
   * @covers ::getBillingProfile
   * @covers ::setBillingProfile
   * @covers ::collectProfiles
   * @covers ::getItems
   * @covers ::setItems
   * @covers ::hasItems
   * @covers ::addItem
   * @covers ::removeItem
   * @covers ::hasItem
   * @covers ::getAdjustments
   * @covers ::setAdjustments
   * @covers ::addAdjustment
   * @covers ::removeAdjustment
   * @covers ::clearAdjustments
   * @covers ::collectAdjustments
   * @covers ::getSubtotalPrice
   * @covers ::recalculateTotalPrice
   * @covers ::getTotalPrice
   * @covers ::getTotalPaid
   * @covers ::setTotalPaid
   * @covers ::getBalance
   * @covers ::isPaid
   * @covers ::getState
   * @covers ::getRefreshState
   * @covers ::setRefreshState
   * @covers ::getData
   * @covers ::setData
   * @covers ::unsetData
   * @covers ::isLocked
   * @covers ::lock
   * @covers ::unlock
   * @covers ::getCreatedTime
   * @covers ::setCreatedTime
   * @covers ::getPlacedTime
   * @covers ::setPlacedTime
   * @covers ::getCompletedTime
   * @covers ::setCompletedTime
   * @covers ::getCalculationDate
   */
  public function testOrder() {

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = Profile::create([
      'type' => 'customer',
      'address' => [
        'country_code' => 'US',
        'postal_code' => '53177',
        'locality' => 'Milwaukee',
        'address_line1' => 'Pabst Blue Ribbon Dr',
        'administrative_area' => 'WI',
        'given_name' => 'Frederick',
        'family_name' => 'Pabst',
      ],
    ]);
    $profile
      ->save();
    $profile = $this
      ->reloadEntity($profile);

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '1',
      'unit_price' => new Price('2.00', 'USD'),
    ]);
    $order_item
      ->save();
    $order_item = $this
      ->reloadEntity($order_item);

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $another_order_item */
    $another_order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '2',
      'unit_price' => new Price('3.00', 'USD'),
    ]);
    $another_order_item
      ->save();
    $another_order_item = $this
      ->reloadEntity($another_order_item);

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = Order::create([
      'type' => 'default',
      'state' => 'completed',
      'store_id' => $this->store
        ->id(),
    ]);
    $order
      ->save();
    $order
      ->setOrderNumber(7);
    $this
      ->assertEquals(7, $order
      ->getOrderNumber());
    $this
      ->assertFalse($order
      ->isPaid());
    $order
      ->setStore($this->store);
    $this
      ->assertEquals($this->store, $order
      ->getStore());
    $this
      ->assertEquals($this->store
      ->id(), $order
      ->getStoreId());
    $order
      ->setStoreId(0);
    $this
      ->assertEquals(NULL, $order
      ->getStore());
    $order
      ->setStoreId($this->store
      ->id());
    $this
      ->assertEquals($this->store, $order
      ->getStore());
    $this
      ->assertEquals($this->store
      ->id(), $order
      ->getStoreId());
    $this
      ->assertInstanceOf(UserInterface::class, $order
      ->getCustomer());
    $this
      ->assertTrue($order
      ->getCustomer()
      ->isAnonymous());
    $this
      ->assertEquals(0, $order
      ->getCustomerId());
    $order
      ->setCustomer($this->user);
    $this
      ->assertEquals($this->user, $order
      ->getCustomer());
    $this
      ->assertEquals($this->user
      ->id(), $order
      ->getCustomerId());
    $this
      ->assertTrue($order
      ->getCustomer()
      ->isAuthenticated());

    // Non-existent/deleted user ID.
    $order
      ->setCustomerId(888);
    $this
      ->assertInstanceOf(UserInterface::class, $order
      ->getCustomer());
    $this
      ->assertTrue($order
      ->getCustomer()
      ->isAnonymous());
    $this
      ->assertEquals(888, $order
      ->getCustomerId());
    $order
      ->setCustomerId($this->user
      ->id());
    $this
      ->assertEquals($this->user, $order
      ->getCustomer());
    $this
      ->assertEquals($this->user
      ->id(), $order
      ->getCustomerId());
    $order
      ->setEmail('commerce@example.com');
    $this
      ->assertEquals('commerce@example.com', $order
      ->getEmail());
    $order
      ->setIpAddress('127.0.0.2');
    $this
      ->assertEquals('127.0.0.2', $order
      ->getIpAddress());
    $order
      ->setBillingProfile($profile);
    $this
      ->assertEquals($profile, $order
      ->getBillingProfile());
    $profiles = $order
      ->collectProfiles();
    $this
      ->assertCount(1, $profiles);
    $this
      ->assertArrayHasKey('billing', $profiles);
    $this
      ->assertEquals($profile, $profiles['billing']);
    $order
      ->setItems([
      $order_item,
      $another_order_item,
    ]);
    $this
      ->assertEquals([
      $order_item,
      $another_order_item,
    ], $order
      ->getItems());
    $this
      ->assertNotEmpty($order
      ->hasItems());
    $order
      ->removeItem($another_order_item);
    $this
      ->assertEquals([
      $order_item,
    ], $order
      ->getItems());
    $this
      ->assertNotEmpty($order
      ->hasItem($order_item));
    $this
      ->assertEmpty($order
      ->hasItem($another_order_item));
    $order
      ->addItem($another_order_item);
    $this
      ->assertEquals([
      $order_item,
      $another_order_item,
    ], $order
      ->getItems());
    $this
      ->assertNotEmpty($order
      ->hasItem($another_order_item));
    $this
      ->assertEquals(new Price('8.00', 'USD'), $order
      ->getTotalPrice());
    $adjustments = [];
    $adjustments[] = new Adjustment([
      'type' => 'custom',
      'label' => '10% off',
      'amount' => new Price('-1.00', 'USD'),
    ]);
    $adjustments[] = new Adjustment([
      'type' => 'fee',
      'label' => 'Handling fee',
      'amount' => new Price('10.00', 'USD'),
      'locked' => TRUE,
    ]);
    $order
      ->addAdjustment($adjustments[0]);
    $order
      ->addAdjustment($adjustments[1]);
    $this
      ->assertEquals($adjustments, $order
      ->getAdjustments());
    $this
      ->assertEquals($adjustments, $order
      ->getAdjustments([
      'custom',
      'fee',
    ]));
    $this
      ->assertEquals([
      $adjustments[0],
    ], $order
      ->getAdjustments([
      'custom',
    ]));
    $this
      ->assertEquals([
      $adjustments[1],
    ], $order
      ->getAdjustments([
      'fee',
    ]));
    $order
      ->removeAdjustment($adjustments[0]);
    $this
      ->assertEquals(new Price('8.00', 'USD'), $order
      ->getSubtotalPrice());
    $this
      ->assertEquals(new Price('18.00', 'USD'), $order
      ->getTotalPrice());
    $this
      ->assertEquals([
      $adjustments[1],
    ], $order
      ->getAdjustments());
    $order
      ->setAdjustments($adjustments);
    $this
      ->assertEquals($adjustments, $order
      ->getAdjustments());
    $this
      ->assertEquals(new Price('17.00', 'USD'), $order
      ->getTotalPrice());

    // Confirm that locked adjustments persist after clear.
    // Custom adjustments are locked by default.
    $order
      ->addAdjustment(new Adjustment([
      'type' => 'fee',
      'label' => 'Random fee',
      'amount' => new Price('10.00', 'USD'),
    ]));
    $order
      ->clearAdjustments();
    $this
      ->assertEquals($adjustments, $order
      ->getAdjustments());
    $this
      ->assertEquals($adjustments, $order
      ->collectAdjustments());
    $this
      ->assertEquals($adjustments, $order
      ->collectAdjustments([
      'custom',
      'fee',
    ]));
    $this
      ->assertEquals([
      $adjustments[0],
    ], $order
      ->collectAdjustments([
      'custom',
    ]));
    $this
      ->assertEquals([
      $adjustments[1],
    ], $order
      ->collectAdjustments([
      'fee',
    ]));
    $this
      ->assertEquals(new Price('0', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('17.00', 'USD'), $order
      ->getBalance());
    $this
      ->assertFalse($order
      ->isPaid());
    $order
      ->setTotalPaid(new Price('7.00', 'USD'));
    $this
      ->assertEquals(new Price('7.00', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('10.00', 'USD'), $order
      ->getBalance());
    $this
      ->assertFalse($order
      ->isPaid());
    $order
      ->setTotalPaid(new Price('17.00', 'USD'));
    $this
      ->assertEquals(new Price('17.00', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('0', 'USD'), $order
      ->getBalance());
    $this
      ->assertTrue($order
      ->isPaid());
    $order
      ->setTotalPaid(new Price('27.00', 'USD'));
    $this
      ->assertEquals(new Price('27.00', 'USD'), $order
      ->getTotalPaid());
    $this
      ->assertEquals(new Price('-10.00', 'USD'), $order
      ->getBalance());
    $this
      ->assertTrue($order
      ->isPaid());
    $this
      ->assertEquals('completed', $order
      ->getState()
      ->getId());

    // Confirm that free orders are considered paid after placement.
    $order
      ->addAdjustment(new Adjustment([
      'type' => 'custom',
      'label' => '100% off',
      'amount' => new Price('-17.00', 'USD'),
    ]));
    $order
      ->setTotalPaid(new Price('0', 'USD'));
    $this
      ->assertTrue($order
      ->getTotalPrice()
      ->isZero());
    $this
      ->assertTrue($order
      ->isPaid());
    $order
      ->set('state', 'draft');
    $this
      ->assertFalse($order
      ->isPaid());
    $order
      ->setRefreshState(Order::REFRESH_ON_SAVE);
    $this
      ->assertEquals(Order::REFRESH_ON_SAVE, $order
      ->getRefreshState());
    $this
      ->assertEquals('default', $order
      ->getData('test', 'default'));
    $order
      ->setData('test', 'value');
    $this
      ->assertEquals('value', $order
      ->getData('test', 'default'));
    $order
      ->unsetData('test');
    $this
      ->assertNull($order
      ->getData('test'));
    $this
      ->assertEquals('default', $order
      ->getData('test', 'default'));
    $this
      ->assertFalse($order
      ->isLocked());
    $order
      ->lock();
    $this
      ->assertTrue($order
      ->isLocked());
    $order
      ->unlock();
    $this
      ->assertFalse($order
      ->isLocked());
    $order
      ->setCreatedTime(635879700);
    $this
      ->assertEquals(635879700, $order
      ->getCreatedTime());
    $order
      ->setPlacedTime(635879800);
    $this
      ->assertEquals(635879800, $order
      ->getPlacedTime());
    $order
      ->setCompletedTime(635879900);
    $this
      ->assertEquals(635879900, $order
      ->getCompletedTime());
    $date = $order
      ->getCalculationDate();
    $this
      ->assertEquals($order
      ->getPlacedTime(), $date
      ->format('U'));
    $order
      ->set('placed', NULL);
    $date = $order
      ->getCalculationDate();
    $this
      ->assertEquals(\Drupal::time()
      ->getRequestTime(), $date
      ->format('U'));
  }

  /**
   * @covers ::preSave
   */
  public function testPreSave() {

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->user
        ->id(),
      'address' => [
        'country_code' => 'US',
        'postal_code' => '53177',
        'locality' => 'Milwaukee',
        'address_line1' => 'Pabst Blue Ribbon Dr',
        'administrative_area' => 'WI',
        'given_name' => 'Frederick',
        'family_name' => 'Pabst',
      ],
    ]);
    $profile
      ->save();
    $profile = $this
      ->reloadEntity($profile);

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = Order::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'uid' => '888',
      'billing_profile' => $profile,
      'state' => 'completed',
    ]);
    $order
      ->save();

    // Confirm that saving the order clears an invalid customer ID.
    $this
      ->assertEquals(0, $order
      ->getCustomerId());

    // Confirm that saving the order reassigns the billing profile.
    $order
      ->save();
    $this
      ->assertEquals(0, $order
      ->getBillingProfile()
      ->getOwnerId());
    $this
      ->assertEquals($profile
      ->id(), $order
      ->getBillingProfile()
      ->id());

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '1',
      'unit_price' => new Price('2.00', 'USD'),
    ]);
    $order_item
      ->save();
    $order_item = $this
      ->reloadEntity($order_item);

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $another_order_item */
    $another_order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '2',
      'unit_price' => new Price('3.00', 'USD'),
    ]);
    $another_order_item
      ->save();
    $another_order_item = $this
      ->reloadEntity($another_order_item);
    $order
      ->setItems([
      $order_item,
      $another_order_item,
    ]);
    $this
      ->assertCount(2, $order
      ->get('order_items'));
    $another_order_item
      ->delete();

    // Assert that saving the order fixes the reference to a deleted order item.
    $order
      ->save();
    $this
      ->reloadEntity($order);
    $this
      ->assertCount(1, $order
      ->get('order_items'));
  }

  /**
   * Tests that an order's email updates with the customer.
   */
  public function testOrderEmail() {
    $customer = $this
      ->createUser([
      'mail' => 'test@example.com',
    ]);
    $order_with_customer = Order::create([
      'type' => 'default',
      'state' => 'completed',
      'uid' => $customer,
    ]);
    $order_with_customer
      ->save();
    $this
      ->assertEquals($customer
      ->getEmail(), $order_with_customer
      ->getEmail());
    $order_without_customer = Order::create([
      'type' => 'default',
      'state' => 'completed',
    ]);
    $order_without_customer
      ->save();
    $this
      ->assertEquals('', $order_without_customer
      ->getEmail());
    $order_without_customer
      ->setCustomer($customer);
    $order_without_customer
      ->save();
    $this
      ->assertEquals($customer
      ->getEmail(), $order_without_customer
      ->getEmail());
  }

  /**
   * Tests the handling of legacy order item adjustments on adjustment clear.
   *
   * @covers ::clearAdjustments
   * @covers ::collectAdjustments
   */
  public function testHandlingLegacyOrderItemAdjustments() {

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '2',
      'unit_price' => new Price('10.00', 'USD'),
      'adjustments' => [
        new Adjustment([
          'type' => 'custom',
          'label' => '10% off',
          'amount' => new Price('-1.00', 'USD'),
          'percentage' => '0.1',
        ]),
        new Adjustment([
          'type' => 'fee',
          'label' => 'Random fee',
          'amount' => new Price('2.00', 'USD'),
        ]),
      ],
      'uses_legacy_adjustments' => TRUE,
    ]);
    $order_item
      ->save();
    $order = Order::create([
      'type' => 'default',
      'order_items' => [
        $order_item,
      ],
      'state' => 'draft',
    ]);

    // Confirm that legacy adjustments are multiplied by quantity.
    $adjustments = $order
      ->collectAdjustments();
    $this
      ->assertCount(2, $adjustments);
    $this
      ->assertEquals('-2.00', $adjustments[0]
      ->getAmount()
      ->getNumber());
    $this
      ->assertEquals('4.00', $adjustments[1]
      ->getAmount()
      ->getNumber());

    // Confirm that the legacy order item adjustments are converted on clear.
    $order
      ->clearAdjustments();
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order_item
      ->getAdjustments();
    $this
      ->assertFalse($order_item
      ->usesLegacyAdjustments());
    $this
      ->assertCount(1, $adjustments);
    $this
      ->assertEquals('-2.00', $adjustments[0]
      ->getAmount()
      ->getNumber());

    // The order item adjustments are no longer multiplied by quantity.
    $this
      ->assertEquals($adjustments, $order
      ->collectAdjustments());
  }

  /**
   * Tests the order total recalculation logic.
   *
   * @covers ::recalculateTotalPrice
   */
  public function testTotalCalculation() {
    $order = Order::create([
      'type' => 'default',
      'state' => 'completed',
    ]);
    $order
      ->save();

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '2',
      'unit_price' => new Price('2.00', 'USD'),
    ]);
    $order_item
      ->save();
    $order_item = $this
      ->reloadEntity($order_item);

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $another_order_item */
    $another_order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '1',
      'unit_price' => new Price('3.00', 'USD'),
    ]);
    $another_order_item
      ->save();
    $another_order_item = $this
      ->reloadEntity($another_order_item);
    $adjustments = [];
    $adjustments[0] = new Adjustment([
      'type' => 'tax',
      'label' => 'Tax',
      'amount' => new Price('100.00', 'USD'),
      'included' => TRUE,
    ]);
    $adjustments[1] = new Adjustment([
      'type' => 'tax',
      'label' => 'Tax',
      'amount' => new Price('2.121', 'USD'),
      'source_id' => 'us_sales_tax',
    ]);
    $adjustments[2] = new Adjustment([
      'type' => 'tax',
      'label' => 'Tax',
      'amount' => new Price('5.344', 'USD'),
      'source_id' => 'us_sales_tax',
    ]);

    // Included adjustments do not affect the order total.
    $order
      ->addAdjustment($adjustments[0]);
    $order_item
      ->addAdjustment($adjustments[1]);
    $another_order_item
      ->addAdjustment($adjustments[2]);
    $order
      ->setItems([
      $order_item,
      $another_order_item,
    ]);
    $order
      ->save();

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $this
      ->reloadEntity($order);
    $collected_adjustments = $order
      ->collectAdjustments();
    $this
      ->assertCount(3, $collected_adjustments);
    $this
      ->assertEquals($adjustments[1], $collected_adjustments[0]);
    $this
      ->assertEquals($adjustments[2], $collected_adjustments[1]);
    $this
      ->assertEquals($adjustments[0], $collected_adjustments[2]);

    // The total will be correct only if the adjustments were correctly
    // combined, and rounded.
    $this
      ->assertEquals(new Price('14.47', 'USD'), $order
      ->getTotalPrice());

    // Test handling deleted order items + non-inclusive adjustments.
    $order
      ->addAdjustment($adjustments[1]);
    $order_item
      ->delete();
    $another_order_item
      ->delete();
    $order
      ->recalculateTotalPrice();
    $this
      ->assertNull($order
      ->getTotalPrice());
  }

  /**
   * Tests the generation of the 'placed' and 'completed' timestamps.
   */
  public function testTimestamps() {

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '2',
      'unit_price' => new Price('2.00', 'USD'),
    ]);
    $order_item
      ->save();

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = Order::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'order_items' => [
        $order_item,
      ],
      'state' => 'draft',
    ]);
    $order
      ->save();
    $order = $this
      ->reloadEntity($order);
    $this
      ->assertNull($order
      ->getPlacedTime());
    $this
      ->assertNull($order
      ->getCompletedTime());

    // Transitioning the order out of the draft state should set the timestamps.
    $order
      ->getState()
      ->applyTransitionById('place');
    $order
      ->save();
    $this
      ->assertEquals($order
      ->getPlacedTime(), \Drupal::time()
      ->getRequestTime());
    $this
      ->assertEquals($order
      ->getCompletedTime(), \Drupal::time()
      ->getRequestTime());
  }

  /**
   * Tests the order with order items using different currencies.
   *
   * @covers ::getSubtotalPrice
   * @covers ::recalculateTotalPrice
   * @covers ::getTotalPrice
   */
  public function testMultipleCurrencies() {
    $currency_importer = $this->container
      ->get('commerce_price.currency_importer');
    $currency_importer
      ->import('EUR');
    $usd_order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '1',
      'unit_price' => new Price('2.00', 'USD'),
    ]);
    $usd_order_item
      ->save();
    $eur_order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '1',
      'unit_price' => new Price('3.00', 'EUR'),
    ]);
    $eur_order_item
      ->save();
    $order = Order::create([
      'type' => 'default',
      'state' => 'completed',
    ]);
    $order
      ->save();

    // The order currency should match the currency of the first order item.
    $this
      ->assertNull($order
      ->getTotalPrice());
    $order
      ->addItem($usd_order_item);
    $this
      ->assertEquals($usd_order_item
      ->getTotalPrice(), $order
      ->getTotalPrice());

    // Replacing the order item should replace the order total and its currency.
    $order
      ->removeItem($usd_order_item);
    $order
      ->addItem($eur_order_item);
    $this
      ->assertEquals($eur_order_item
      ->getTotalPrice(), $order
      ->getTotalPrice());

    // Adding a second order item with a different currency should fail.
    $currency_mismatch = FALSE;
    try {
      $order
        ->addItem($usd_order_item);
    } catch (CurrencyMismatchException $e) {
      $currency_mismatch = TRUE;
    }
    $this
      ->assertTrue($currency_mismatch);
  }

  /**
   * Tests that the paid event is dispatched when the balance reaches zero.
   */
  public function testPaidEvent() {

    /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => '2',
      'unit_price' => new Price('10.00', 'USD'),
    ]);
    $order_item
      ->save();
    $order = Order::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'order_items' => [
        $order_item,
      ],
      'state' => 'draft',
    ]);
    $order
      ->save();
    $this
      ->assertNull($order
      ->getData('order_test_called'));
    $order
      ->setTotalPaid(new Price('20.00', 'USD'));
    $order
      ->save();
    $this
      ->assertEquals(1, $order
      ->getData('order_test_called'));

    // Confirm that the event is not dispatched the second time the balance
    // reaches zero.
    $order
      ->setTotalPaid(new Price('10.00', 'USD'));
    $order
      ->save();
    $order
      ->setTotalPaid(new Price('20.00', 'USD'));
    $order
      ->save();
    $this
      ->assertEquals(1, $order
      ->getData('order_test_called'));

    // Confirm that the event is dispatched for orders created as paid.
    $another_order = Order::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'order_items' => [
        $order_item,
      ],
      'total_paid' => new Price('20.00', 'USD'),
      'state' => 'draft',
    ]);
    $another_order
      ->save();
    $this
      ->assertEquals(1, $another_order
      ->getData('order_test_called'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
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::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
CommerceKernelTestBase::$store	protected	property	The default store.	1
CommerceKernelTestBase::tearDown	protected	function	Overrides KernelTestBase::tearDown
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.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
DeprecationSuppressionTrait::restoreErrorHandler	protected	function	Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler	protected	function	Sets an error handler to suppress specified deprecation messages.
EntityKernelTestBase::$deprecatedProperties	protected	property	The list of deprecated services.
EntityKernelTestBase::$entityTypeManager	protected	property	The entity type manager service.	1
EntityKernelTestBase::$generatedIds	protected	property	A list of generated identifiers.
EntityKernelTestBase::$state	protected	property	The state service.
EntityKernelTestBase::createUser	protected	function	Creates a user.
EntityKernelTestBase::generateRandomEntityId	protected	function	Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo	protected	function	Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule	protected	function	Installs a module and refreshes services.
EntityKernelTestBase::refreshServices	protected	function	Refresh services.	1
EntityKernelTestBase::reloadEntity	protected	function	Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule	protected	function	Uninstalls a module and refreshes services.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
OrderTest::$modules	public static	property	Modules to enable. Overrides OrderKernelTestBase::$modules
OrderTest::$user	protected	property	A sample user.
OrderTest::setUp	protected	function	Overrides OrderKernelTestBase::setUp
OrderTest::testHandlingLegacyOrderItemAdjustments	public	function	Tests the handling of legacy order item adjustments on adjustment clear.
OrderTest::testMultipleCurrencies	public	function	Tests the order with order items using different currencies.
OrderTest::testOrder	public	function	Tests the order entity and its methods.
OrderTest::testOrderEmail	public	function	Tests that an order's email updates with the customer.
OrderTest::testPaidEvent	public	function	Tests that the paid event is dispatched when the balance reaches zero.
OrderTest::testPreSave	public	function	@covers ::preSave
OrderTest::testTimestamps	public	function	Tests the generation of the 'placed' and 'completed' timestamps.
OrderTest::testTotalCalculation	public	function	Tests the order total recalculation logic.
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.
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.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

You are here

class OrderTest in Commerce Core 8.2

Hierarchy

File

Namespace

Members

API Navigation