1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\Order;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Framework\ObjectManagerInterface;
use Magento\Sales\Api\InvoiceRepositoryInterface;
use Magento\Sales\Model\Order;
use Magento\TestFramework\Helper\Bootstrap;
/**
* Test for CreditmemoFactory class.
* @magentoDbIsolation enabled
*/
class CreditmemoFactoryTest extends \PHPUnit\Framework\TestCase
{
/**
* Placeholder for order item id field.
*/
const ORDER_ITEM_ID_PLACEHOLDER = 'id_item_';
/**
* @var ObjectManagerInterface
*/
private $objectManager;
/**
* @var CreditmemoFactory
*/
private $creditmemoFactory;
/**
* {@inheritdoc}
*/
protected function setUp()
{
$this->objectManager = Bootstrap::getObjectManager();
$this->creditmemoFactory = $this->objectManager->create(CreditmemoFactory::class);
}
/**
* Checks a case when creditmemo created from the order.
*
* @magentoDataFixture Magento/Sales/_files/order_with_bundle_and_invoiced.php
* @dataProvider createByOrderDataProvider
* @param array $creditmemoData
* @param int $expectedQty
*/
public function testCreateByOrder(array $creditmemoData, $expectedQty)
{
$order = $this->getOrder('100000001');
$creditmemoData = $this->prepareCreditMemoData($order, $creditmemoData);
$creditmemo = $this->creditmemoFactory->createByOrder($order, $creditmemoData);
self::assertEquals($expectedQty, $creditmemo->getTotalQty(), 'Creditmemo has wrong total qty.');
}
/**
* @return array
*/
public function createByOrderDataProvider(): array
{
return [
[
'creditmemoData' => [
'qtys' => [
self::ORDER_ITEM_ID_PLACEHOLDER . '2' => 2,
self::ORDER_ITEM_ID_PLACEHOLDER . '3' => 10,
],
],
'expectedQty' => 12,
],
[
'creditmemoData' => [
'qtys' => [
self::ORDER_ITEM_ID_PLACEHOLDER . '1' => 2,
self::ORDER_ITEM_ID_PLACEHOLDER . '2' => 2,
self::ORDER_ITEM_ID_PLACEHOLDER . '3' => 10,
],
],
'expectedQty' => 14,
],
];
}
/**
* Checks a case when creditmemo created from the invoice.
*
* @magentoDataFixture Magento/Sales/_files/invoice_with_bundle.php
*
* @return void
*/
public function testCreateByInvoice()
{
$invoice = $this->getInvoice('100000001');
$creditmemo = $this->creditmemoFactory->createByInvoice($invoice);
self::assertEquals(14, $creditmemo->getTotalQty(), 'Creditmemo has wrong total qty.');
}
/**
* Prepare Creditmemo data.
*
* @param Order $order
* @param array $creditmemoData
* @return array
*/
private function prepareCreditMemoData(Order $order, array $creditmemoData): array
{
$result = [];
$orderItems = $order->getAllItems();
foreach ($creditmemoData['qtys'] as $key => $item) {
$result[$orderItems[$this->prepareOrderItemKey($key)]->getId()] = $item;
}
$creditmemoData['qtys'] = $result;
return $creditmemoData;
}
/**
* Prepare order item key.
*
* @param string $key
* @return int
*/
private function prepareOrderItemKey($key)
{
return str_replace(self::ORDER_ITEM_ID_PLACEHOLDER, '', $key) - 1;
}
/**
* Retrieves order by increment ID.
*
* @param string $incrementId
* @return Order
*/
private function getOrder(string $incrementId): Order
{
/** @var Order $order */
$order = $this->objectManager->create(Order::class);
$order->loadByIncrementId($incrementId);
return $order;
}
/**
* Retrieves invoice by increment ID.
*
* @param string $incrementId
* @return Invoice
*/
private function getInvoice(string $incrementId): Invoice
{
/** @var SearchCriteriaBuilder $searchCriteriaBuilder */
$searchCriteriaBuilder = $this->objectManager->get(SearchCriteriaBuilder::class);
$searchCriteria = $searchCriteriaBuilder
->addFilter('increment_id', $incrementId)
->create();
/** @var InvoiceRepositoryInterface $repository */
$repository = $this->objectManager->get(InvoiceRepositoryInterface::class);
$items = $repository->getList($searchCriteria)->getItems();
return array_pop($items);
}
}