Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Weee\Test\Unit\Model\Total\Quote;
use Magento\Catalog\Model\Product;
use Magento\Framework\Serialize\Serializer\Json;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use Magento\Quote\Api\Data\ShippingAssignmentInterface;
use Magento\Quote\Api\Data\ShippingInterface;
use Magento\Quote\Model\Quote;
use Magento\Quote\Model\Quote\Address;
use Magento\Quote\Model\Quote\Address\Total;
use Magento\Quote\Model\Quote\Item;
use Magento\Tax\Helper\Data;
use Magento\Tax\Model\Calculation;
use Magento\Tax\Model\Sales\Total\Quote\CommonTaxCollector as CTC;
use Magento\Weee\Model\Total\Quote\WeeeTax;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class WeeeTaxTest extends TestCase
{
/**#@+
* Constants for array keys
*/
const KEY_WEEE_TOTALS = 'weee_total_excl_tax';
const KEY_WEEE_BASE_TOTALS = 'weee_base_total_excl_tax';
/**#@-*/
/**
* @var WeeeTax
*/
protected $weeeCollector;
/**
* @var MockObject|Quote
*/
protected $quoteMock;
/**
* \Magento\Framework\TestFramework\Unit\Helper\ObjectManager
*/
protected $objectManagerHelper;
protected function setUp(): void
{
$this->objectManagerHelper = new ObjectManager($this);
$this->quoteMock = $this->createMock(Quote::class);
}
/**
* Setup tax helper with an array of methodName, returnValue
*
* @param array $taxConfig
* @return MockObject|\Magento\Tax\Helper\Data
*/
protected function setupTaxHelper($taxConfig)
{
$taxHelper = $this->createMock(Data::class);
foreach ($taxConfig as $method => $value) {
$taxHelper->expects($this->any())->method($method)->willReturn($value);
}
return $taxHelper;
}
/**
* Setup weee helper with an array of methodName, returnValue
*
* @param array $weeeConfig
* @return MockObject|\Magento\Weee\Helper\Data
*/
protected function setupWeeeHelper($weeeConfig)
{
$weeeHelper = $this->createMock(\Magento\Weee\Helper\Data::class);
foreach ($weeeConfig as $method => $value) {
$weeeHelper->expects($this->any())->method($method)->willReturn($value);
}
return $weeeHelper;
}
/**
* Setup an item mock
*
* @param float $itemQty
* @return MockObject|Item
*/
protected function setupItemMock($itemQty)
{
$itemMock = $this->createPartialMock(
Item::class,
[
'getProduct',
'getQuote',
'getAddress',
'getTotalQty'
]
);
$productMock = $this->createMock(Product::class);
$itemMock->expects($this->any())->method('getProduct')->willReturn($productMock);
$itemMock->expects($this->any())->method('getTotalQty')->willReturn($itemQty);
return $itemMock;
}
/**
* Setup address mock
*
* @param MockObject|Item $itemMock
* @param boolean $isWeeeTaxable
* @param array $itemWeeeTaxDetails
* @param array $addressData
* @return MockObject
*/
protected function setupTotalMock($itemMock, $isWeeeTaxable, $itemWeeeTaxDetails, $addressData)
{
$totalMock = $this->getMockBuilder(Total::class)
->addMethods(
['getWeeeCodeToItemMap', 'getExtraTaxableDetails', 'getWeeeTotalExclTax', 'getWeeeBaseTotalExclTax']
)
->disableOriginalConstructor()
->getMock();
$map = [];
$extraDetails = [];
$weeeTotals = 0;
$weeeBaseTotals = 0;
if ($isWeeeTaxable) {
$i = 1;
$weeeTaxDetails = [];
foreach ($itemWeeeTaxDetails as $data) {
$code = 'weee' . ($i++) . '-myWeeeCode';
$map[$code] = $itemMock;
$weeeTaxDetails[] = [
CTC::KEY_TAX_DETAILS_TYPE => 'weee',
CTC::KEY_TAX_DETAILS_CODE => $code,
CTC::KEY_TAX_DETAILS_PRICE_EXCL_TAX => $data['weee_tax_applied_amount'],
CTC::KEY_TAX_DETAILS_BASE_PRICE_EXCL_TAX => $data['base_weee_tax_applied_amount'],
CTC::KEY_TAX_DETAILS_PRICE_INCL_TAX => $data['weee_tax_applied_amount_incl_tax'],
CTC::KEY_TAX_DETAILS_BASE_PRICE_INCL_TAX => $data['base_weee_tax_applied_amount_incl_tax'],
CTC::KEY_TAX_DETAILS_ROW_TOTAL => $data['weee_tax_applied_row_amount'],
CTC::KEY_TAX_DETAILS_BASE_ROW_TOTAL => $data['base_weee_tax_applied_row_amnt'],
CTC::KEY_TAX_DETAILS_ROW_TOTAL_INCL_TAX => $data['weee_tax_applied_row_amount_incl_tax'],
CTC::KEY_TAX_DETAILS_BASE_ROW_TOTAL_INCL_TAX => $data['base_weee_tax_applied_row_amnt_incl_tax'],
];
}
$extraDetails = [
'weee' => [
'sequence-1' => $weeeTaxDetails
],
];
} else {
if (isset($addressData[self::KEY_WEEE_TOTALS])) {
$weeeTotals = $addressData[self::KEY_WEEE_TOTALS];
}
if (isset($addressData[self::KEY_WEEE_BASE_TOTALS])) {
$weeeBaseTotals = $addressData[self::KEY_WEEE_BASE_TOTALS];
}
}
$totalMock->expects($this->any())->method('getWeeeCodeToItemMap')->willReturn($map);
$totalMock->expects($this->any())->method('getExtraTaxableDetails')->willReturn($extraDetails);
$totalMock
->expects($this->any())
->method('getWeeeTotalExclTax')
->willReturn($weeeTotals);
$totalMock
->expects($this->any())
->method('getWeeeBaseTotalExclTax')
->willReturn($weeeBaseTotals);
return $totalMock;
}
/**
* Setup shipping assignment mock.
* @param MockObject $addressMock
* @param MockObject $itemMock
* @return MockObject
*/
protected function setupShippingAssignmentMock($addressMock, $itemMock)
{
$shippingMock = $this->getMockForAbstractClass(ShippingInterface::class);
$shippingMock->expects($this->any())->method('getAddress')->willReturn($addressMock);
$shippingAssignmentMock = $this->getMockForAbstractClass(ShippingAssignmentInterface::class);
$itemMock = $itemMock ? [$itemMock] : [];
$shippingAssignmentMock->expects($this->any())->method('getItems')->willReturn($itemMock);
$shippingAssignmentMock->expects($this->any())->method('getShipping')->willReturn($shippingMock);
return $shippingAssignmentMock;
}
/**
* Verify that correct fields of item has been set
*
* @param MockObject|null $item
* @param array $itemData
*/
public function verifyItem($item, $itemData)
{
if (!$item) {
return;
}
foreach ($itemData as $key => $value) {
$this->assertEquals($value, $item->getData($key), 'item ' . $key . ' is incorrect');
}
}
/**
* Verify that correct fields of address has been set
*
* @param MockObject|Address $address
* @param array $addressData
*/
public function verifyTotals($address, $addressData)
{
foreach ($addressData as $key => $value) {
if ($key != self::KEY_WEEE_TOTALS && $key != self::KEY_WEEE_BASE_TOTALS) {
// just check the output values
$this->assertEquals($value, $address->getData($key), 'address ' . $key . ' is incorrect');
}
}
}
public function testFetch()
{
$serializerMock = $this->getMockBuilder(Json::class)
->getMock();
$weeeTotal = 17;
$totalMock = new Total(
[],
$serializerMock
);
$taxHelper = $this->setupTaxHelper([]);
$weeeHelper = $this->setupWeeeHelper(['getTotalAmounts' => $weeeTotal]);
$this->weeeCollector = $this->objectManagerHelper->getObject(
WeeeTax::class,
['taxData' => $taxHelper, 'weeeData' => $weeeHelper]
);
$expectedResult = [
'code' => 'weee',
'title' => __('FPT'),
'value' => $weeeTotal,
'area' => null,
];
$this->assertEquals($expectedResult, $this->weeeCollector->fetch($this->quoteMock, $totalMock));
}
public function testFetchWithZeroAmounts()
{
$serializerMock = $this->getMockBuilder(Json::class)
->getMock();
$totalMock = new Total(
[],
$serializerMock
);
$taxHelper = $this->setupTaxHelper([]);
$weeeHelper = $this->setupWeeeHelper(['getTotalAmounts' => null]);
$this->weeeCollector = $this->objectManagerHelper->getObject(
WeeeTax::class,
['taxData' => $taxHelper, 'weeeData' => $weeeHelper]
);
$this->assertNull($this->weeeCollector->fetch($this->quoteMock, $totalMock));
}
/**
* Test the collect function of the weee collector
*
* @param array $taxConfig
* @param array $weeeConfig
* @param array $itemWeeeTaxDetails
* @param float $itemQty
* @param array $addressData
* @dataProvider collectDataProvider
*/
public function testCollect($taxConfig, $weeeConfig, $itemWeeeTaxDetails, $itemQty, $addressData = [])
{
//Setup
if ($itemQty > 0) {
$itemMock = $this->setupItemMock($itemQty);
} else {
$itemMock = null;
}
$totalMock = $this->setupTotalMock($itemMock, $weeeConfig['isTaxable'], $itemWeeeTaxDetails, $addressData);
$addressMock = $this->createMock(Address::class);
$shippingAssignmentMock = $this->setupShippingAssignmentMock($addressMock, $itemMock);
$taxHelper = $this->setupTaxHelper($taxConfig);
$weeeHelper = $this->setupWeeeHelper($weeeConfig);
$arguments = [
'taxData' => $taxHelper,
'weeeData' => $weeeHelper,
];
$this->weeeCollector = $this->objectManagerHelper->getObject(
WeeeTax::class,
$arguments
);
//Execute
$this->weeeCollector->collect($this->quoteMock, $shippingAssignmentMock, $totalMock);
//Verify
$summed = [];
foreach ($itemWeeeTaxDetails as $itemWeeeTaxDetail) {
foreach ($itemWeeeTaxDetail as $key => $value) {
$summed[$key] = (array_key_exists($key, $summed) ? $value + $summed[$key] : $value);
}
}
$this->verifyItem($itemMock, $summed);
$this->verifyTotals($totalMock, $addressData);
}
/**
* Data provider for testCollect
*
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* Multiple datasets
*
* @return array
*/
public function collectDataProvider()
{
// 1. When the Weee is not taxable, this collector does not change the item, but it will update the address
// data based on the weee totals accumulated in the previous 'weee' collector
// 2. If the Weee amount is included in the subtotal, then it is not included in the 'weee_amount' field
$data = [];
$data['price_incl_tax_weee_taxable_unit_included_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => true,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => 9.24,
'base_weee_tax_applied_amount' => 9.24,
'weee_tax_applied_row_amount' => 18.48,
'base_weee_tax_applied_row_amnt' => 18.48,
'weee_tax_applied_amount_incl_tax' => 10,
'base_weee_tax_applied_amount_incl_tax' => 10,
'weee_tax_applied_row_amount_incl_tax' => 20,
'base_weee_tax_applied_row_amnt_incl_tax' => 20,
],
],
'item_qty' => 2,
'address_data' => [
'subtotal' => 18.48,
'base_subtotal' => 18.48,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_incl_tax_weee_taxable_unit_not_included_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => true,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => false,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => 9.24,
'base_weee_tax_applied_amount' => 9.24,
'weee_tax_applied_row_amount' => 18.48,
'base_weee_tax_applied_row_amnt' => 18.48,
'weee_tax_applied_amount_incl_tax' => 10,
'base_weee_tax_applied_amount_incl_tax' => 10,
'weee_tax_applied_row_amount_incl_tax' => 20,
'base_weee_tax_applied_row_amnt_incl_tax' => 20,
],
],
'item_qty' => 2,
'address_data' => [
'subtotal' => 0,
'base_subtotal' => 0,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 18.48,
'base_weee_amount' => 18.48,
],
];
$data['price_excl_tax_weee_taxable_unit_included_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => 10,
'base_weee_tax_applied_amount' => 10,
'weee_tax_applied_row_amount' => 20,
'base_weee_tax_applied_row_amnt' => 20,
'weee_tax_applied_amount_incl_tax' => 10.83,
'base_weee_tax_applied_amount_incl_tax' => 10.83,
'weee_tax_applied_row_amount_incl_tax' => 21.66,
'base_weee_tax_applied_row_amnt_incl_tax' => 21.66,
],
],
'item_qty' => 2,
'address_data' => [
'subtotal' => 20,
'base_subtotal' => 20,
'subtotal_incl_tax' => 21.66,
'base_subtotal_incl_tax' => 21.66,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_incl_tax_weee_non_taxable_unit_included_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => true,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => false,
'getApplied' => [],
],
'item_weee_tax_details' => [
],
'item_qty' => 2,
'address_data' => [
self::KEY_WEEE_TOTALS => 20,
self::KEY_WEEE_BASE_TOTALS => 20,
'subtotal' => 20,
'base_subtotal' => 20,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_excl_tax_weee_non_taxable_unit_include_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => false,
'getApplied' => [],
],
'item_weee_tax_details' => [
],
'item_qty' => 2,
'address_data' => [
self::KEY_WEEE_TOTALS => 20,
self::KEY_WEEE_BASE_TOTALS => 20,
'subtotal' => 20,
'base_subtotal' => 20,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_incl_tax_weee_taxable_row_include_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => true,
'getCalculationAlgorithm' => Calculation::CALC_ROW_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => 9.24,
'base_weee_tax_applied_amount' => 9.24,
'weee_tax_applied_row_amount' => 18.48,
'base_weee_tax_applied_row_amnt' => 18.48,
'weee_tax_applied_amount_incl_tax' => 10,
'base_weee_tax_applied_amount_incl_tax' => 10,
'weee_tax_applied_row_amount_incl_tax' => 20,
'base_weee_tax_applied_row_amnt_incl_tax' => 20,
],
],
'item_qty' => 2,
'address_data' => [
'subtotal' => 18.48,
'base_subtotal' => 18.48,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_excl_tax_weee_taxable_row_include_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_ROW_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => 10,
'base_weee_tax_applied_amount' => 10,
'weee_tax_applied_row_amount' => 20,
'base_weee_tax_applied_row_amnt' => 20,
'weee_tax_applied_amount_incl_tax' => 10.83,
'base_weee_tax_applied_amount_incl_tax' => 10.83,
'weee_tax_applied_row_amount_incl_tax' => 21.65,
'base_weee_tax_applied_row_amnt_incl_tax' => 21.65,
],
],
'item_qty' => 2,
'address_data' => [
'subtotal' => 20,
'base_subtotal' => 20,
'subtotal_incl_tax' => 21.65,
'base_subtotal_incl_tax' => 21.65,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_incl_tax_weee_non_taxable_row_include_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => true,
'getCalculationAlgorithm' => Calculation::CALC_ROW_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => true,
'isTaxable' => false,
'getApplied' => [],
],
'item_weee_tax_details' => [
],
'item_qty' => 2,
'address_data' => [
self::KEY_WEEE_TOTALS => 20,
self::KEY_WEEE_BASE_TOTALS => 20,
'subtotal' => 20,
'base_subtotal' => 20,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 0,
'base_weee_amount' => 0,
],
];
$data['price_excl_tax_weee_non_taxable_row_not_included_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_ROW_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => false,
'isTaxable' => false,
'getApplied' => [],
],
'item_weee_tax_details' => [
],
'item_qty' => 2,
'address_data' => [
self::KEY_WEEE_TOTALS => 20,
self::KEY_WEEE_BASE_TOTALS => 20,
'subtotal' => 0,
'base_subtotal' => 0,
'subtotal_incl_tax' => 20,
'base_subtotal_incl_tax' => 20,
'weee_amount' => 20,
'base_weee_amount' => 20,
],
];
$data['price_excl_tax_weee_taxable_unit_not_included_in_subtotal'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => false,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => 10,
'base_weee_tax_applied_amount' => 10,
'weee_tax_applied_row_amount' => 20,
'base_weee_tax_applied_row_amnt' => 20,
'weee_tax_applied_amount_incl_tax' => 11.00,
'base_weee_tax_applied_amount_incl_tax' => 11.00,
'weee_tax_applied_row_amount_incl_tax' => 22.00,
'base_weee_tax_applied_row_amnt_incl_tax' => 22.00,
],
[
'weee_tax_applied_amount' => 2,
'base_weee_tax_applied_amount' => 2,
'weee_tax_applied_row_amount' => 4,
'base_weee_tax_applied_row_amnt' => 4,
'weee_tax_applied_amount_incl_tax' => 2.20,
'base_weee_tax_applied_amount_incl_tax' => 2.20,
'weee_tax_applied_row_amount_incl_tax' => 4.40,
'base_weee_tax_applied_row_amnt_incl_tax' => 4.40,
],
],
'item_qty' => 2,
'address_data' => [
'subtotal' => 0,
'base_subtotal' => 0,
'subtotal_incl_tax' => 26.40,
'base_subtotal_incl_tax' => 26.40,
'weee_amount' => 24,
'base_weee_amount' => 24,
],
];
$data['weee_disabled'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => false,
'includeInSubtotal' => false,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => null,
'base_weee_tax_applied_amount' => null,
'weee_tax_applied_row_amount' => null,
'base_weee_tax_applied_row_amnt' => null,
'weee_tax_applied_amount_incl_tax' => null,
'base_weee_tax_applied_amount_incl_tax' => null,
'weee_tax_applied_row_amount_incl_tax' => null,
'base_weee_tax_applied_row_amnt_incl_tax' => null,
],
[
'weee_tax_applied_amount' => null,
'base_weee_tax_applied_amount' => null,
'weee_tax_applied_row_amount' => null,
'base_weee_tax_applied_row_amnt' => null,
'weee_tax_applied_amount_incl_tax' => null,
'base_weee_tax_applied_amount_incl_tax' => null,
'weee_tax_applied_row_amount_incl_tax' => null,
'base_weee_tax_applied_row_amnt_incl_tax' => null,
],
],
'item_qty' => 1,
'address_data' => [
'subtotal' => null,
'base_subtotal' => null,
'subtotal_incl_tax' => null,
'base_subtotal_incl_tax' => null,
'weee_amount' => null,
'base_weee_amount' => null,
],
];
$data['zero_items'] = [
'tax_config' => [
'priceIncludesTax' => false,
'getCalculationAlgorithm' => Calculation::CALC_UNIT_BASE,
],
'weee_config' => [
'isEnabled' => true,
'includeInSubtotal' => false,
'isTaxable' => true,
'getApplied' => [],
],
'item_weee_tax_details' => [
[
'weee_tax_applied_amount' => null,
'base_weee_tax_applied_amount' => null,
'weee_tax_applied_row_amount' => null,
'base_weee_tax_applied_row_amnt' => null,
'weee_tax_applied_amount_incl_tax' => null,
'base_weee_tax_applied_amount_incl_tax' => null,
'weee_tax_applied_row_amount_incl_tax' => null,
'base_weee_tax_applied_row_amnt_incl_tax' => null,
],
[
'weee_tax_applied_amount' => null,
'base_weee_tax_applied_amount' => null,
'weee_tax_applied_row_amount' => null,
'base_weee_tax_applied_row_amnt' => null,
'weee_tax_applied_amount_incl_tax' => null,
'base_weee_tax_applied_amount_incl_tax' => null,
'weee_tax_applied_row_amount_incl_tax' => null,
'base_weee_tax_applied_row_amnt_incl_tax' => null,
],
],
'item_qty' => 0,
'address_data' => [
'subtotal' => null,
'base_subtotal' => null,
'subtotal_incl_tax' => null,
'base_subtotal_incl_tax' => null,
'weee_amount' => null,
'base_weee_amount' => null,
],
];
return $data;
}
}