Skip to content

Commit ca2ade1

Browse files
magicbunnehmagicbunneh
authored
Merge pull request #780 from magento-tango/MAGETWO-62783
Bug fixes: * MAGETWO-62783: Wrong address template used for order e-mails
2 parents c1478c9 + 5ce0592 commit ca2ade1

File tree

6 files changed

+300
-37
lines changed

6 files changed

+300
-37
lines changed

‎app/code/Magento/Sales/Model/Order/Address/Renderer.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ public function __construct(
4848
*/
4949
public function format(Address $address, $type)
5050
{
51+
$this->addressConfig->setStore($address->getOrder()->getStoreId());
5152
$formatType = $this->addressConfig->getFormatByCode($type);
5253
if (!$formatType || !$formatType->getRenderer()) {
5354
return null;

‎app/code/Magento/Sales/Test/Unit/Model/Order/Address/RendererTest.php

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<?php
2+
/**
3+
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
namespace Magento\Sales\Test\Unit\Model\Order\Address;
7+
8+
use Magento\Sales\Model\Order\Address\Renderer as OrderAddressRenderer;
9+
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
10+
use Magento\Customer\Model\Address\Config as CustomerAddressConfig;
11+
use Magento\Framework\Event\ManagerInterface as EventManager;
12+
use Magento\Sales\Model\Order\Address as OrderAddress;
13+
use Magento\Sales\Model\Order;
14+
use Magento\Customer\Block\Address\Renderer\RendererInterface as CustomerAddressBlockRenderer;
15+
use Magento\Framework\DataObject;
16+
17+
class RendererTest extends \PHPUnit_Framework_TestCase
18+
{
19+
/**
20+
* @var OrderAddressRenderer
21+
*/
22+
private $orderAddressRenderer;
23+
24+
/**
25+
* @var ObjectManagerHelper
26+
*/
27+
private $objectManagerHelper;
28+
29+
/**
30+
* @var CustomerAddressConfig|\PHPUnit_Framework_MockObject_MockObject
31+
*/
32+
private $customerAddressConfigMock;
33+
34+
/**
35+
* @var EventManager|\PHPUnit_Framework_MockObject_MockObject
36+
*/
37+
private $eventManagerMock;
38+
39+
/**
40+
* @var OrderAddress|\PHPUnit_Framework_MockObject_MockObject
41+
*/
42+
private $orderAddressMock;
43+
44+
/**
45+
* @var Order|\PHPUnit_Framework_MockObject_MockObject
46+
*/
47+
private $orderMock;
48+
49+
/**
50+
* @var CustomerAddressBlockRenderer|\PHPUnit_Framework_MockObject_MockObject
51+
*/
52+
private $customerAddressBlockRendererMock;
53+
54+
protected function setUp()
55+
{
56+
$this->customerAddressConfigMock = $this->getMockBuilder(CustomerAddressConfig::class)
57+
->disableOriginalConstructor()
58+
->getMock();
59+
$this->eventManagerMock = $this->getMockBuilder(EventManager::class)
60+
->getMockForAbstractClass();
61+
$this->orderAddressMock = $this->getMockBuilder(OrderAddress::class)
62+
->disableOriginalConstructor()
63+
->getMock();
64+
$this->orderMock = $this->getMockBuilder(Order::class)
65+
->disableOriginalConstructor()
66+
->getMock();
67+
$this->customerAddressBlockRendererMock = $this->getMockBuilder(CustomerAddressBlockRenderer::class)
68+
->getMockForAbstractClass();
69+
70+
$this->orderAddressMock->expects(static::any())
71+
->method('getOrder')
72+
->willReturn($this->orderMock);
73+
74+
$this->objectManagerHelper = new ObjectManagerHelper($this);
75+
$this->orderAddressRenderer = $this->objectManagerHelper->getObject(
76+
OrderAddressRenderer::class,
77+
[
78+
'addressConfig' => $this->customerAddressConfigMock,
79+
'eventManager' => $this->eventManagerMock
80+
]
81+
);
82+
}
83+
84+
public function testFormat()
85+
{
86+
$type = 'html';
87+
$formatType = new DataObject(['renderer' => $this->customerAddressBlockRendererMock]);
88+
$addressData = ['address', 'data'];
89+
$result = 'result string';
90+
91+
$this->setStoreExpectations(1);
92+
$this->customerAddressConfigMock->expects(static::atLeastOnce())
93+
->method('getFormatByCode')
94+
->with($type)
95+
->willReturn($formatType);
96+
$this->eventManagerMock->expects(static::once())
97+
->method('dispatch')
98+
->with('customer_address_format', ['type' => $formatType, 'address' => $this->orderAddressMock]);
99+
$this->orderAddressMock->expects(static::atLeastOnce())
100+
->method('getData')
101+
->willReturn($addressData);
102+
$this->customerAddressBlockRendererMock->expects(static::once())
103+
->method('renderArray')
104+
->with($addressData, null)
105+
->willReturn($result);
106+
107+
$this->assertEquals($result, $this->orderAddressRenderer->format($this->orderAddressMock, $type));
108+
}
109+
110+
public function testFormatNoRenderer()
111+
{
112+
$type = 'html';
113+
114+
$this->setStoreExpectations(1);
115+
$this->customerAddressConfigMock->expects(static::atLeastOnce())
116+
->method('getFormatByCode')
117+
->with($type)
118+
->willReturn(null);
119+
$this->eventManagerMock->expects(static::never())
120+
->method('dispatch');
121+
122+
$this->assertEquals(null, $this->orderAddressRenderer->format($this->orderAddressMock, $type));
123+
}
124+
125+
/**
126+
* Set expectations for store
127+
*
128+
* @param string|int $storeId
129+
* @return void
130+
*/
131+
private function setStoreExpectations($storeId)
132+
{
133+
$this->orderMock->expects(static::atLeastOnce())
134+
->method('getStoreId')
135+
->willReturn($storeId);
136+
$this->customerAddressConfigMock->expects(static::atLeastOnce())
137+
->method('setStore')
138+
->with($storeId)
139+
->willReturnSelf();
140+
}
141+
}

‎dev/tests/integration/testsuite/Magento/Sales/Model/Order/Address/RendererTest.php

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<?php
2+
/**
3+
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
namespace Magento\Sales\Model\Order\Address;
7+
8+
use Magento\TestFramework\Helper\Bootstrap;
9+
use Magento\Framework\ObjectManagerInterface;
10+
use Magento\Sales\Model\Order\Address\Renderer as OrderAddressRenderer;
11+
use Magento\Config\Model\ResourceModel\Config as ConfigResourceModel;
12+
use Magento\Framework\App\Config;
13+
use Magento\Store\Model\Store;
14+
use Magento\Sales\Model\Order\Address as OrderAddress;
15+
use Magento\Sales\Model\Order;
16+
17+
class RendererTest extends \PHPUnit_Framework_TestCase
18+
{
19+
/**
20+
* @var ObjectManagerInterface
21+
*/
22+
private $objectManager;
23+
24+
/**
25+
* @var OrderAddressRenderer
26+
*/
27+
private $orderAddressRenderer;
28+
29+
/**
30+
* @var ConfigResourceModel
31+
*/
32+
private $configResourceModel;
33+
34+
/**
35+
* @var Config
36+
*/
37+
private $config;
38+
39+
protected function setUp()
40+
{
41+
$this->objectManager = Bootstrap::getObjectManager();
42+
$this->orderAddressRenderer = $this->objectManager->get(OrderAddressRenderer::class);
43+
$this->configResourceModel = $this->objectManager->get(ConfigResourceModel::class);
44+
$this->config = $this->objectManager->get(Config::class);
45+
}
46+
47+
/**
48+
* @magentoDataFixture Magento/Sales/_files/order_fixture_store.php
49+
* @magentoDbIsolation enabled
50+
* @magentoAppIsolation enabled
51+
*/
52+
public function testFormat()
53+
{
54+
$addressTemplates = [
55+
'text' => 'text_customized',
56+
'oneline' => 'oneline_customized',
57+
'html' => 'html_customized',
58+
'pdf' => 'pdf_customized'
59+
];
60+
61+
/** @var Store $store */
62+
$store = $this->objectManager->create(Store::class);
63+
$storeId = $store->load('fixturestore')->getStoreId();
64+
65+
$this->configResourceModel->saveConfig(
66+
'customer/address_templates/text',
67+
$addressTemplates['text'],
68+
'stores',
69+
$storeId
70+
);
71+
$this->configResourceModel->saveConfig(
72+
'customer/address_templates/oneline',
73+
$addressTemplates['oneline'],
74+
'stores',
75+
$storeId
76+
);
77+
$this->configResourceModel->saveConfig(
78+
'customer/address_templates/html',
79+
$addressTemplates['html'],
80+
'stores',
81+
$storeId
82+
);
83+
$this->configResourceModel->saveConfig(
84+
'customer/address_templates/pdf',
85+
$addressTemplates['pdf'],
86+
'stores',
87+
$storeId
88+
);
89+
$this->config->clean();
90+
91+
/** @var Order $order */
92+
$order = $this->objectManager->create(Order::class)
93+
->loadByIncrementId('100000004');
94+
95+
/** @var OrderAddress $address */
96+
$address = $order->getBillingAddress();
97+
98+
$this->assertEquals($addressTemplates['text'], $this->orderAddressRenderer->format($address, 'text'));
99+
$this->assertEquals($addressTemplates['oneline'], $this->orderAddressRenderer->format($address, 'oneline'));
100+
$this->assertEquals($addressTemplates['html'], $this->orderAddressRenderer->format($address, 'html'));
101+
$this->assertEquals($addressTemplates['pdf'], $this->orderAddressRenderer->format($address, 'pdf'));
102+
}
103+
}

‎dev/tests/integration/testsuite/Magento/Sales/_files/order_fixture_store.php

Lines changed: 36 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,54 @@
44
* See COPYING.txt for license details.
55
*/
66

7-
// @codingStandardsIgnoreFile
7+
use Magento\TestFramework\Helper\Bootstrap as BootstrapHelper;
8+
use Magento\Framework\Indexer\IndexerRegistry;
9+
use Magento\CatalogSearch\Model\Indexer\Fulltext as FulltextIndexer;
10+
use Magento\Catalog\Model\Product;
11+
use Magento\Sales\Model\Order\Address as OrderAddress;
12+
use Magento\Sales\Model\Order\Payment as OrderPayment;
13+
use Magento\Sales\Model\Order\Item as OrderItem;
14+
use Magento\Sales\Model\Order;
15+
use Magento\Store\Model\StoreManagerInterface;
816

9-
require __DIR__ . '/../../../Magento/Store/_files/core_fixturestore.php';
17+
require __DIR__ . '/../../Store/_files/core_fixturestore.php';
1018

11-
require __DIR__ . '/../../../Magento/Catalog/_files/product_simple_duplicated.php';
12-
/** @var \Magento\Catalog\Model\Product $product */
19+
$objectManager = BootstrapHelper::getObjectManager();
1320

14-
$addressData = include __DIR__ . '/address_data.php';
21+
$objectManager->get(IndexerRegistry::class)
22+
->get(FulltextIndexer::INDEXER_ID)
23+
->reindexAll();
24+
25+
require __DIR__ . '/../../Catalog/_files/product_simple_duplicated.php';
26+
/** @var Product $product */
1527

16-
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
28+
$addressData = include __DIR__ . '/address_data.php';
1729

18-
$billingAddress = $objectManager->create(\Magento\Sales\Model\Order\Address::class, ['data' => $addressData]);
30+
$billingAddress = $objectManager->create(OrderAddress::class, ['data' => $addressData]);
1931
$billingAddress->setAddressType('billing');
2032

2133
$shippingAddress = clone $billingAddress;
2234
$shippingAddress->setId(null)->setAddressType('shipping');
2335

24-
$payment = $objectManager->create(\Magento\Sales\Model\Order\Payment::class);
36+
$payment = $objectManager->create(OrderPayment::class);
2537
$payment->setMethod('checkmo');
2638

27-
/** @var \Magento\Sales\Model\Order\Item $orderItem */
28-
$orderItem = $objectManager->create(\Magento\Sales\Model\Order\Item::class);
39+
/** @var OrderItem $orderItem */
40+
$orderItem = $objectManager->create(OrderItem::class);
2941
$orderItem->setProductId($product->getId())->setQtyOrdered(2);
3042

31-
/** @var \Magento\Sales\Model\Order $order */
32-
$order = $objectManager->create(\Magento\Sales\Model\Order::class);
33-
$order->setIncrementId(
34-
'100000004'
35-
)->setState(
36-
\Magento\Sales\Model\Order::STATE_PROCESSING
37-
)->setStatus(
38-
$order->getConfig()->getStateDefaultStatus(\Magento\Sales\Model\Order::STATE_PROCESSING)
39-
)->setSubtotal(
40-
100
41-
)->setBaseSubtotal(
42-
100
43-
)->setCustomerIsGuest(
44-
true
45-
)->setCustomerEmail(
46-
'[email protected]'
47-
)->setBillingAddress(
48-
$billingAddress
49-
)->setShippingAddress(
50-
$shippingAddress
51-
)->setStoreId(
52-
$objectManager->get(\Magento\Store\Model\StoreManagerInterface::class)->getStore('fixturestore')->getId()
53-
)->addItem(
54-
$orderItem
55-
)->setPayment(
56-
$payment
57-
);
43+
/** @var Order $order */
44+
$order = $objectManager->create(Order::class);
45+
$order->setIncrementId('100000004')
46+
->setState(Order::STATE_PROCESSING)
47+
->setStatus($order->getConfig()->getStateDefaultStatus(Order::STATE_PROCESSING))
48+
->setSubtotal(100)
49+
->setBaseSubtotal(100)
50+
->setCustomerIsGuest(true)
51+
->setCustomerEmail('[email protected]')
52+
->setBillingAddress($billingAddress)
53+
->setShippingAddress($shippingAddress)
54+
->setStoreId($objectManager->get(StoreManagerInterface::class)->getStore('fixturestore')->getId())
55+
->addItem($orderItem)
56+
->setPayment($payment);
5857
$order->save();

‎dev/tests/integration/testsuite/Magento/Sales/_files/order_fixture_store_rollback.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
/**
3+
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
use Magento\TestFramework\Helper\Bootstrap;
8+
use Magento\Framework\Indexer\IndexerRegistry;
9+
use Magento\CatalogSearch\Model\Indexer\Fulltext as FulltextIndexer;
10+
11+
require __DIR__ . '/default_rollback.php';
12+
require __DIR__ . '/../../Catalog/_files/product_simple_duplicated_rollback.php';
13+
require __DIR__ . '/../../Store/_files/core_fixturestore_rollback.php';
14+
15+
Bootstrap::getObjectManager()->get(IndexerRegistry::class)
16+
->get(FulltextIndexer::INDEXER_ID)
17+
->reindexAll();

‎dev/tests/integration/testsuite/Magento/Store/_files/core_fixturestore.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@
2525
/* Refresh stores memory cache */
2626
Bootstrap::getObjectManager()->get(\Magento\Store\Model\StoreManagerInterface::class)->reinitStores();
2727
}
28+
29+
//if test using this fixture relies on full text functionality it is required to explicitly perform re-indexation

0 commit comments

Comments
 (0)