ObserversTest::testProcessDom() - Code Metrics - Inspection of "DE7600 Order Level Gift Messages" - eBayEnterprise/magento-retail-order-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Scott van

created 2015-12-03 20:29 UTC

ObserversTest::testProcessDom() A

↳ Parent: ObserversTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	60
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	60
rs	9.5556
cc	1
eloc	38
nc	1
nop	0

How to fix Long Method

<?php
/**
 * Copyright (c) 2013-2014 eBay Enterprise, Inc.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * @copyright   Copyright (c) 2013-2014 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

class EbayEnterprise_Eb2cGiftwrap_Test_Model_ObserversTest extends EbayEnterprise_Eb2cCore_Test_Base
{
    /**
     * Test that the method EbayEnterprise_Eb2cGiftwrap_Model_Observers::processDom will invoked
     * and will will run EbayEnterprise_Catalog_Model_Feed_File::process with the required
     * parameters
     */
    public function testProcessDom()
    {
        $doc = Mage::helper('eb2ccore')->getNewDomDocument();
        $doc->loadXML(
            '<ItemMaster>
                <Item operation_type="Add" gsi_client_id="MAGTNA" catalog_id="14">
                    <ItemId>
                        <ClientItemId>14-77554</ClientItemId>
                    </ItemId>
                    <BaseAttributes>
                        <ItemDescription>Gift Wrap 1</ItemDescription>
                        <ItemType>GiftWrap</ItemType>
                        <TaxCode>78</TaxCode>
                    </BaseAttributes>
                </Item>
            </ItemMaster>'
        );

        $feedData = array('event_type' => 'ItemMaster');
        $coreFeed = $this->getModelMockBuilder('ebayenterprise_catalog/feed_core')
            ->disableOriginalConstructor()
            ->setMethods(array('getFeedConfig'))
            ->getMock();
        $coreFeed->expects($this->any())
            ->method('getFeedConfig')
            ->will($this->returnValue($feedData));

        $observer = new Varien_Event_Observer(array('event' => new Varien_Event(array('doc' => $doc, 'file_detail' => array(
            'local_file' => 'EbayEnterprise/Product/ItemMaster/Inbound/ItemMaster_TestSubset.xml',
            'core_feed' => 'core feed mock',
            'timestamp' => '2012-07-06 10:09:05',
            'error_file' => '/EbayEnterprise/Eb2c/Feed/Product/ItemMaster/outbound/ItemMaster_20140107224605_12345_ABCD.xml',
            'core_feed' => $coreFeed
        )))));
        $cfgData = array(
            'allowable_event_type' => 'ItemMaster',
        );
        $config = $this->getModelMock('eb2cgiftwrap/feed_import_config', array('getImportConfigData'));
        $config->expects($this->any())
            ->method('getImportConfigData')
            ->will($this->returnValue($cfgData));
        $this->replaceByMock('model', 'eb2cgiftwrap/feed_import_config', $config);

        $items = $this->getModelMock('eb2cgiftwrap/feed_import_items', array());
        $this->replaceByMock('model', 'eb2cgiftwrap/feed_import_items', $items);

        $fileModelMock = $this->getModelMockBuilder('ebayenterprise_catalog/feed_file')
            ->disableOriginalConstructor()
            ->setMethods(array('process'))
            ->getMock();
        $fileModelMock->expects($this->once())
            ->method('process')
            ->with($this->identicalTo($config), $this->identicalTo($items))
            ->will($this->returnSelf());
        $this->replaceByMock('model', 'ebayenterprise_catalog/feed_file', $fileModelMock);

        $observers = Mage::getModel('eb2cgiftwrap/observers');

        $this->assertSame($observers, $observers->processDom($observer));
    }

    /**
     * Validate expected event configuration.
     *
     * @dataProvider dataProvider
     */
    public function testEventSetup($area, $eventName, $observerClassAlias, $observerMethod)
    {
        $this->_testEventConfig($area, $eventName, $observerClassAlias, $observerMethod);
    }

    /**
     * Provide address data, order data, if the address is the primary shipping
     * address, and the gift message id the address should have after the test.
     *
     * @return array

     */
    public function provideShipGroupGiftingData()
    {
        $giftMessageId = 11;
        return [
            // address data, order data, primary shipping, message id
            [['gift_message_id' => $giftMessageId], [], false, $giftMessageId], // non-primary shipping address, address has message, use address message
            [['gift_message_id' => $giftMessageId], [], true, $giftMessageId], // primary shipping address, order has no message, use address message
            [['gift_message_id' => $giftMessageId], ['gift_message_id' => $giftMessageId + 1], false, $giftMessageId], // non-primary shipping address, order has message, use address message
            [[], ['gift_message_id' => $giftMessageId], true, $giftMessageId], // primary shipping address, order has message, use order message
        ];
    }

    /**
     * @param array
     * @param array
     * @param bool
     * @param int
     * @dataProvider provideShipGroupGiftingData
     */
    public function testHandleEbayEnterpriseOrderCreateShipGroup($addressData, $orderData, $isPrimaryShippingAddress, $giftMessageId)
    {
        $address = $this->getModelMockBuilder('sales/order_address')
            ->setMethods(['isPrimaryShippingAddress'])
            ->setConstructorArgs([$addressData])
            ->getMock();
        $address->method('isPrimaryShippingAddress')->willReturn($isPrimaryShippingAddress);

        $order = Mage::getModel('sales/order', $orderData);

        $payload = $this->getMock('eBayEnterprise\RetailOrderManagement\Payload\Order\IShipGroup');

        $event = new Varien_Event(['address' => $address, 'order' => $order, 'ship_group_payload' => $payload]);
        $eventObserver = new Varien_Event_Observer(['event' => $event]);

        $orderGifting = $this->getModelMock('eb2cgiftwrap/order_create_gifting', ['injectGifting']);
        $orderGifting->expects($this->once())
            ->method('injectGifting')
            ->with($this->identicalTo($address))
            ->willReturnSelf();

        $observer = Mage::getModel('eb2cgiftwrap/observers', ['order_gifting' => $orderGifting]);
        $observer->handleEbayEnterpriseOrderCreateShipGroup($eventObserver);

        $this->assertSame($giftMessageId, $address->getGiftMessageId());
    }
}


1			<?php
2			/**
3			* Copyright (c) 2013-2014 eBay Enterprise, Inc.
4			*
5			* NOTICE OF LICENSE
6			*
7			* This source file is subject to the Open Software License (OSL 3.0)
8			* that is bundled with this package in the file LICENSE.md.
9			* It is also available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* @copyright Copyright (c) 2013-2014 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
13			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
14			*/
15
16			class EbayEnterprise_Eb2cGiftwrap_Test_Model_ObserversTest extends EbayEnterprise_Eb2cCore_Test_Base
17			{
18			/**
19			* Test that the method EbayEnterprise_Eb2cGiftwrap_Model_Observers::processDom will invoked
20			* and will will run EbayEnterprise_Catalog_Model_Feed_File::process with the required
21			* parameters
22			*/
23			public function testProcessDom()
24			{
25			$doc = Mage::helper('eb2ccore')->getNewDomDocument();
26			$doc->loadXML(
27			'<ItemMaster>
28			<Item operation_type="Add" gsi_client_id="MAGTNA" catalog_id="14">
29			<ItemId>
30			<ClientItemId>14-77554</ClientItemId>
31			</ItemId>
32			<BaseAttributes>
33			<ItemDescription>Gift Wrap 1</ItemDescription>
34			<ItemType>GiftWrap</ItemType>
35			<TaxCode>78</TaxCode>
36			</BaseAttributes>
37			</Item>
38			</ItemMaster>'
39			);
40
41			$feedData = array('event_type' => 'ItemMaster');
42			$coreFeed = $this->getModelMockBuilder('ebayenterprise_catalog/feed_core')
43			->disableOriginalConstructor()
44			->setMethods(array('getFeedConfig'))
45			->getMock();
46			$coreFeed->expects($this->any())
47			->method('getFeedConfig')
48			->will($this->returnValue($feedData));
49
50			$observer = new Varien_Event_Observer(array('event' => new Varien_Event(array('doc' => $doc, 'file_detail' => array(
51			'local_file' => 'EbayEnterprise/Product/ItemMaster/Inbound/ItemMaster_TestSubset.xml',
52			'core_feed' => 'core feed mock',
53			'timestamp' => '2012-07-06 10:09:05',
54			'error_file' => '/EbayEnterprise/Eb2c/Feed/Product/ItemMaster/outbound/ItemMaster_20140107224605_12345_ABCD.xml',
55			'core_feed' => $coreFeed
56			)))));
57			$cfgData = array(
58			'allowable_event_type' => 'ItemMaster',
59			);
60			$config = $this->getModelMock('eb2cgiftwrap/feed_import_config', array('getImportConfigData'));
61			$config->expects($this->any())
62			->method('getImportConfigData')
63			->will($this->returnValue($cfgData));
64			$this->replaceByMock('model', 'eb2cgiftwrap/feed_import_config', $config);
65
66			$items = $this->getModelMock('eb2cgiftwrap/feed_import_items', array());
67			$this->replaceByMock('model', 'eb2cgiftwrap/feed_import_items', $items);
68
69			$fileModelMock = $this->getModelMockBuilder('ebayenterprise_catalog/feed_file')
70			->disableOriginalConstructor()
71			->setMethods(array('process'))
72			->getMock();
73			$fileModelMock->expects($this->once())
74			->method('process')
75			->with($this->identicalTo($config), $this->identicalTo($items))
76			->will($this->returnSelf());
77			$this->replaceByMock('model', 'ebayenterprise_catalog/feed_file', $fileModelMock);
78
79			$observers = Mage::getModel('eb2cgiftwrap/observers');
80
81			$this->assertSame($observers, $observers->processDom($observer));
82			}
83
84			/**
85			* Validate expected event configuration.
86			*
87			* @dataProvider dataProvider
88			*/
89			public function testEventSetup($area, $eventName, $observerClassAlias, $observerMethod)
90			{
91			$this->_testEventConfig($area, $eventName, $observerClassAlias, $observerMethod);
92			}
93
94			/**
95			* Provide address data, order data, if the address is the primary shipping
96			* address, and the gift message id the address should have after the test.
97			*
98			* @return array
			0 ignored issues – show Documentation introduced 2015-12-03 20:48 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<array\|boolean\|integer>[]`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
99			*/
100			public function provideShipGroupGiftingData()
101			{
102			$giftMessageId = 11;
103			return [
104			// address data, order data, primary shipping, message id
105			[['gift_message_id' => $giftMessageId], [], false, $giftMessageId], // non-primary shipping address, address has message, use address message
106			[['gift_message_id' => $giftMessageId], [], true, $giftMessageId], // primary shipping address, order has no message, use address message
107			[['gift_message_id' => $giftMessageId], ['gift_message_id' => $giftMessageId + 1], false, $giftMessageId], // non-primary shipping address, order has message, use address message
108			[[], ['gift_message_id' => $giftMessageId], true, $giftMessageId], // primary shipping address, order has message, use order message
109			];
110			}
111
112			/**
113			* @param array
114			* @param array
115			* @param bool
116			* @param int
117			* @dataProvider provideShipGroupGiftingData
118			*/
119			public function testHandleEbayEnterpriseOrderCreateShipGroup($addressData, $orderData, $isPrimaryShippingAddress, $giftMessageId)
120			{
121			$address = $this->getModelMockBuilder('sales/order_address')
122			->setMethods(['isPrimaryShippingAddress'])
123			->setConstructorArgs([$addressData])
124			->getMock();
125			$address->method('isPrimaryShippingAddress')->willReturn($isPrimaryShippingAddress);
126
127			$order = Mage::getModel('sales/order', $orderData);
128
129			$payload = $this->getMock('eBayEnterprise\RetailOrderManagement\Payload\Order\IShipGroup');
130
131			$event = new Varien_Event(['address' => $address, 'order' => $order, 'ship_group_payload' => $payload]);
132			$eventObserver = new Varien_Event_Observer(['event' => $event]);
133
134			$orderGifting = $this->getModelMock('eb2cgiftwrap/order_create_gifting', ['injectGifting']);
135			$orderGifting->expects($this->once())
136			->method('injectGifting')
137			->with($this->identicalTo($address))
138			->willReturnSelf();
139
140			$observer = Mage::getModel('eb2cgiftwrap/observers', ['order_gifting' => $orderGifting]);
141			$observer->handleEbayEnterpriseOrderCreateShipGroup($eventObserver);
142
143			$this->assertSame($giftMessageId, $address->getGiftMessageId());
144			}
145			}
146

eBayEnterprise / magento-retail-order-management

GitHub Access Token became invalid

Pull Request — master (#15)

ObserversTest::testProcessDom() A

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like