CustomTest.php in Commerce Core 8.2

Namespace

Drupal\Tests\commerce_tax\Kernel\Plugin\Commerce\TaxType

File

modules/tax/tests/src/Kernel/Plugin/Commerce/TaxType/CustomTest.php

<?php

namespace Drupal\Tests\commerce_tax\Kernel\Plugin\Commerce\TaxType;

use Drupal\commerce_order\Adjustment;
use Drupal\commerce_order\Entity\Order;
use Drupal\commerce_order\Entity\OrderItem;
use Drupal\commerce_price\Price;
use Drupal\commerce_store\Entity\Store;
use Drupal\commerce_tax\Entity\TaxType;
use Drupal\commerce_tax\Plugin\Commerce\TaxType\Custom;
use Drupal\profile\Entity\Profile;
use Drupal\Tests\commerce_order\Kernel\OrderKernelTestBase;

/**
 * @coversDefaultClass \Drupal\commerce_tax\Plugin\Commerce\TaxType\Custom
 * @group commerce
 */
class CustomTest extends OrderKernelTestBase {

  /**
   * The tax type.
   *
   * @var \Drupal\commerce_tax\Entity\TaxTypeInterface
   */
  protected $taxType;

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

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installConfig([
      'commerce_tax',
    ]);
    $user = $this
      ->createUser();
    $this->user = $this
      ->reloadEntity($user);
    $this->taxType = TaxType::create([
      'id' => 'serbian_vat',
      'label' => 'Serbian VAT',
      'plugin' => 'custom',
      'configuration' => [
        'display_inclusive' => TRUE,
        'display_label' => 'vat',
        'round' => TRUE,
        'rates' => [
          [
            'id' => 'standard',
            'label' => 'Standard',
            'percentage' => '0.2',
          ],
          [
            'id' => 'reduced',
            'label' => 'Reduced',
            'percentage' => '0.1',
          ],
        ],
        'territories' => [
          [
            'country_code' => 'RS',
          ],
        ],
      ],
      // Don't allow the tax type to apply automatically.
      'status' => FALSE,
    ]);
    $this->taxType
      ->save();
  }

  /**
   * @covers ::getWeight
   * @covers ::isDisplayInclusive
   * @covers ::shouldRound
   * @covers ::getZones
   */
  public function testGetters() {
    $plugin = $this->taxType
      ->getPlugin();
    assert($plugin instanceof Custom);
    $this
      ->assertEquals(0, $plugin
      ->getWeight());
    $this
      ->assertTrue($plugin
      ->isDisplayInclusive());
    $this
      ->assertTrue($plugin
      ->shouldRound());
    $zones = $plugin
      ->getZones();

    /** @var \Drupal\commerce_tax\TaxZone $zone */
    $zone = reset($zones);
    $rates = $zone
      ->getRates();
    $this
      ->assertCount(1, $zones);
    $this
      ->assertCount(2, $rates);
    $this
      ->assertArrayHasKey('standard', $rates);
    $this
      ->assertArrayHasKey('reduced', $rates);
    $this
      ->assertEquals('standard', $rates['standard']
      ->getId());
    $this
      ->assertEquals('Standard', $rates['standard']
      ->getLabel());
    $this
      ->assertEquals('0.2', $rates['standard']
      ->getPercentage()
      ->getNumber());
    $this
      ->assertTrue($rates['standard']
      ->isDefault());
    $this
      ->assertEquals('reduced', $rates['reduced']
      ->getId());
    $this
      ->assertEquals('Reduced', $rates['reduced']
      ->getLabel());
    $this
      ->assertEquals('0.1', $rates['reduced']
      ->getPercentage()
      ->getNumber());
    $this
      ->assertFalse($rates['reduced']
      ->isDefault());
  }

  /**
   * @covers ::applies
   * @covers ::apply
   */
  public function testApplication() {
    $plugin = $this->taxType
      ->getPlugin();

    // US store, US customer.
    $order = $this
      ->buildOrder('US', 'US');
    $this
      ->assertFalse($plugin
      ->applies($order));

    // US store registered to collect tax in Serbia, US customer.
    $order = $this
      ->buildOrder('US', 'US', [
      'RS',
    ]);
    $this
      ->assertTrue($plugin
      ->applies($order));
    $plugin
      ->apply($order);
    $this
      ->assertCount(0, $order
      ->collectAdjustments());

    // US store registered to collect tax in Serbia, Serbian customer.
    $order = $this
      ->buildOrder('RS', 'US', [
      'RS',
    ]);
    $this
      ->assertTrue($plugin
      ->applies($order));
    $plugin
      ->apply($order);
    $this
      ->assertCount(1, $order
      ->collectAdjustments());

    // Serbian store and US customer.
    $order = $this
      ->buildOrder('US', 'RS');
    $this
      ->assertTrue($plugin
      ->applies($order));
    $plugin
      ->apply($order);
    $this
      ->assertCount(0, $order
      ->collectAdjustments());

    // Serbian store and customer.
    $order = $this
      ->buildOrder('RS', 'RS');
    $this
      ->assertTrue($plugin
      ->applies($order));
    $plugin
      ->apply($order);
    $this
      ->assertCount(1, $order
      ->collectAdjustments());

    // Test non-tax-inclusive prices + display-inclusive taxes.
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $adjustment = reset($adjustments);
    $this
      ->assertEquals(new Price('12.40', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals('tax', $adjustment
      ->getType());
    $this
      ->assertEquals(t('VAT'), $adjustment
      ->getLabel());
    $this
      ->assertEquals(new Price('2.07', 'USD'), $adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $adjustment
      ->getPercentage());
    $this
      ->assertEquals('serbian_vat|default|standard', $adjustment
      ->getSourceId());
    $this
      ->assertTrue($adjustment
      ->isIncluded());

    // Test tax-inclusive prices + display-inclusive taxes.
    $order = $this
      ->buildOrder('RS', 'RS', [], TRUE);
    $plugin
      ->apply($order);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $adjustment = reset($adjustments);
    $this
      ->assertEquals(new Price('10.33', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals(new Price('1.72', 'USD'), $adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $adjustment
      ->getPercentage());
    $this
      ->assertTrue($adjustment
      ->isIncluded());

    // Test tax-inclusive prices + non-display-inclusive taxes.
    $configuration = $plugin
      ->getConfiguration();
    $configuration['display_inclusive'] = FALSE;
    $plugin
      ->setConfiguration($configuration);
    $order = $this
      ->buildOrder('RS', 'RS', [], TRUE);
    $plugin
      ->apply($order);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $adjustment = reset($adjustments);
    $this
      ->assertEquals(new Price('8.61', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals(new Price('1.72', 'USD'), $adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $adjustment
      ->getPercentage());
    $this
      ->assertFalse($adjustment
      ->isIncluded());
  }

  /**
   * @covers ::apply
   */
  public function testDiscountedPrices() {
    $plugin = $this->taxType
      ->getPlugin();

    // Tax-inclusive prices + display-inclusive taxes.
    // A 10.33 USD price with a 1.00 USD discount should have a 9.33 USD total.
    $order = $this
      ->buildOrder('RS', 'RS', [], TRUE);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $order_item
      ->addAdjustment(new Adjustment([
      'type' => 'promotion',
      'label' => t('Discount'),
      'amount' => new Price('-1', 'USD'),
    ]));
    $plugin
      ->apply($order);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $tax_adjustment = end($adjustments);
    $this
      ->assertEquals(new Price('10.33', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals(new Price('9.33', 'USD'), $order_item
      ->getAdjustedUnitPrice());
    $this
      ->assertCount(2, $adjustments);
    $this
      ->assertEquals('tax', $tax_adjustment
      ->getType());
    $this
      ->assertEquals(t('VAT'), $tax_adjustment
      ->getLabel());
    $this
      ->assertEquals(new Price('1.56', 'USD'), $tax_adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $tax_adjustment
      ->getPercentage());

    // Non-tax-inclusive prices + display-inclusive taxes.
    // A 10.33 USD price is 12.40 USD with 20% tax included.
    // A 1.00 USD discount should result in a 11.40 USD total.
    $order = $this
      ->buildOrder('RS', 'RS', []);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $order_item
      ->addAdjustment(new Adjustment([
      'type' => 'promotion',
      'label' => t('Discount'),
      'amount' => new Price('-1', 'USD'),
    ]));
    $plugin
      ->apply($order);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $tax_adjustment = end($adjustments);
    $this
      ->assertEquals(new Price('12.40', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals(new Price('11.40', 'USD'), $order_item
      ->getAdjustedUnitPrice());
    $this
      ->assertCount(2, $adjustments);
    $this
      ->assertEquals('tax', $tax_adjustment
      ->getType());
    $this
      ->assertEquals(t('VAT'), $tax_adjustment
      ->getLabel());
    $this
      ->assertEquals(new Price('1.90', 'USD'), $tax_adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $tax_adjustment
      ->getPercentage());

    // Non-tax-inclusive prices + non-display-inclusive taxes.
    // A 10.33 USD price with a 1.00 USD discount is 9.33 USD.
    // And 9.33 USD plus 20% tax is 11.20 USD.
    $configuration = $plugin
      ->getConfiguration();
    $configuration['display_inclusive'] = FALSE;
    $plugin
      ->setConfiguration($configuration);
    $order = $this
      ->buildOrder('RS', 'RS', []);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $order_item
      ->addAdjustment(new Adjustment([
      'type' => 'promotion',
      'label' => t('Discount'),
      'amount' => new Price('-1', 'USD'),
    ]));
    $plugin
      ->apply($order);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $tax_adjustment = end($adjustments);
    $this
      ->assertEquals(new Price('10.33', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals(new Price('11.20', 'USD'), $order_item
      ->getAdjustedUnitPrice());
    $this
      ->assertCount(2, $adjustments);
    $this
      ->assertEquals('tax', $tax_adjustment
      ->getType());
    $this
      ->assertEquals(t('VAT'), $tax_adjustment
      ->getLabel());
    $this
      ->assertEquals(new Price('1.87', 'USD'), $tax_adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $tax_adjustment
      ->getPercentage());

    // Tax-inclusive prices + non-display-inclusive taxes.
    // A 10.33 USD price is 8.61 USD once the 20% tax is removed.
    // A 1.00 USD discount gives 7.61 USD + 20% VAT -> 8.88 USD.
    $configuration = $plugin
      ->getConfiguration();
    $configuration['display_inclusive'] = FALSE;
    $plugin
      ->setConfiguration($configuration);
    $order = $this
      ->buildOrder('RS', 'RS', [], TRUE);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $order_item
      ->addAdjustment(new Adjustment([
      'type' => 'promotion',
      'label' => t('Discount'),
      'amount' => new Price('-1', 'USD'),
    ]));
    $plugin
      ->apply($order);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $adjustments = $order
      ->collectAdjustments();
    $tax_adjustment = end($adjustments);
    $this
      ->assertEquals(new Price('8.61', 'USD'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals(new Price('9.13', 'USD'), $order_item
      ->getAdjustedUnitPrice());
    $this
      ->assertCount(2, $adjustments);
    $this
      ->assertEquals('tax', $tax_adjustment
      ->getType());
    $this
      ->assertEquals(t('VAT'), $tax_adjustment
      ->getLabel());
    $this
      ->assertEquals(new Price('1.52', 'USD'), $tax_adjustment
      ->getAmount());
    $this
      ->assertEquals('0.2', $tax_adjustment
      ->getPercentage());
  }

  /**
   * Builds an order for testing purposes.
   *
   * @param string $customer_country
   *   The customer's country code.
   * @param string $store_country
   *   The store's country code.
   * @param array $store_registrations
   *   The store's tax registrations.
   * @param bool $prices_include_tax
   *   Whether prices include tax.
   *
   * @return \Drupal\commerce_order\Entity\OrderInterface
   *   The order.
   */
  protected function buildOrder($customer_country, $store_country, array $store_registrations = [], $prices_include_tax = FALSE) {
    $store = Store::create([
      'type' => 'default',
      'label' => 'My store',
      'address' => [
        'country_code' => $store_country,
      ],
      'prices_include_tax' => $prices_include_tax,
      'tax_registrations' => $store_registrations,
    ]);
    $store
      ->save();
    $customer_profile = Profile::create([
      'type' => 'customer',
      'uid' => $this->user
        ->id(),
      'address' => [
        'country_code' => $customer_country,
      ],
    ]);
    $customer_profile
      ->save();
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => 1,
      // Intentionally uneven number, to test rounding.
      'unit_price' => new Price('10.33', 'USD'),
    ]);
    $order_item
      ->save();
    $order = Order::create([
      'type' => 'default',
      'uid' => $this->user
        ->id(),
      'store_id' => $store,
      'billing_profile' => $customer_profile,
      'order_items' => [
        $order_item,
      ],
    ]);
    $order
      ->setRefreshState(Order::REFRESH_SKIP);
    $order
      ->save();
    return $order;
  }

}

Classes

Name	Description
CustomTest	@coversDefaultClass \Drupal\commerce_tax\Plugin\Commerce\TaxType\Custom @group commerce