CouponAvailableConstraintValidatorTest.php in Commerce Cart API 8

Namespace

Drupal\Tests\commerce_cart_api\Kernel

File

tests/src/Kernel/CouponAvailableConstraintValidatorTest.php

<?php

namespace Drupal\Tests\commerce_cart_api\Kernel;

use Drupal\commerce_order\Entity\Order;
use Drupal\commerce_order\Entity\OrderItem;
use Drupal\commerce_price\Price;
use Drupal\commerce_promotion\Entity\Coupon;
use Drupal\commerce_promotion\Entity\Promotion;
use Drupal\Core\Entity\Entity\EntityFormMode;
use Drupal\Tests\commerce_order\Kernel\OrderKernelTestBase;

/**
 * Tests the coupon available constraint on coupons fields.
 *
 * @group commerce
 */
class CouponAvailableConstraintValidatorTest extends OrderKernelTestBase {

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('commerce_promotion');
    $this
      ->installEntitySchema('commerce_promotion_coupon');
    EntityFormMode::create([
      'id' => 'commerce_order_item.add_to_cart',
      'label' => 'Add to cart',
      'targetEntityType' => 'commerce_order_item',
    ])
      ->save();
    $this
      ->installSchema('commerce_promotion', [
      'commerce_promotion_usage',
    ]);
    $this
      ->installConfig([
      'commerce_promotion',
    ]);
  }

  /**
   * Tests the validator.
   */
  public function testValidator() {
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => 1,
      'unit_price' => new Price('12.00', 'USD'),
    ]);
    $order_item
      ->save();

    /** @var \Drupal\commerce_order\Entity\Order $order */
    $order = Order::create([
      'type' => 'default',
      'state' => 'draft',
      'mail' => '[e-mail]',
      'ip_address' => '127.0.0.1',
      'order_number' => '6',
      'store_id' => $this->store,
      'uid' => $this
        ->createUser(),
      'order_items' => [
        $order_item,
      ],
    ]);
    $order
      ->setRefreshState(Order::REFRESH_SKIP);
    $order
      ->save();
    $promotion = Promotion::create([
      'order_types' => [
        'default',
      ],
      'stores' => [
        $this->store
          ->id(),
      ],
      'usage_limit' => 1,
      'start_date' => '2017-01-01',
      'status' => TRUE,
    ]);
    $promotion
      ->save();
    $coupon = Coupon::create([
      'promotion_id' => $promotion
        ->id(),
      'code' => 'coupon_code',
      'usage_limit' => 1,
      'status' => TRUE,
    ]);
    $coupon
      ->save();
    $order
      ->get('coupons')
      ->setValue([
      $coupon,
    ]);
    $constraints = $order
      ->validate();
    $this
      ->assertCount(0, $constraints);
    $coupon
      ->setEnabled(FALSE);

    // We must save, since ::referencedEntities reloads entities.
    $coupon
      ->save();
    $constraints = $order
      ->validate();
    $this
      ->assertCount(1, $constraints);
    $this
      ->assertEquals(sprintf('The coupon <em class="placeholder">%s</em> is not available for this order.', $coupon
      ->getCode()), $constraints
      ->get(0)
      ->getMessage());
    $coupon
      ->setEnabled(TRUE);
    $coupon
      ->save();
    $constraints = $order
      ->validate();
    $this
      ->assertCount(0, $constraints);
    $this->container
      ->get('commerce_promotion.usage')
      ->register($order, $promotion, $coupon);
    $constraints = $order
      ->validate();
    $this
      ->assertCount(1, $constraints);
    $this
      ->assertEquals('coupons.0', $constraints
      ->get(0)
      ->getPropertyPath());
    $this
      ->assertEquals(sprintf('The coupon <em class="placeholder">%s</em> is not available for this order.', $coupon
      ->getCode()), $constraints
      ->get(0)
      ->getMessage());
    $promotion
      ->setUsageLimit(2);
    $promotion
      ->save();
    $coupon
      ->setUsageLimit(2);
    $coupon
      ->save();
    $constraints = $order
      ->validate();
    $this
      ->assertCount(0, $constraints);
    $order
      ->getState()
      ->applyTransitionById('place');
    $order
      ->save();
    $coupon
      ->setEnabled(FALSE);
    $coupon
      ->save();

    // Placed orders should not validate coupons, as price calculation is done.
    $constraints = $order
      ->validate();
    $this
      ->assertCount(0, $constraints);
  }

}

Classes

Name	Description
CouponAvailableConstraintValidatorTest	Tests the coupon available constraint on coupons fields.