MAGETWO-69185: Unable to create shipping label if Region not specified for shipping origin

Author: slamking

app/code/Magento/Shipping/Test/Unit/Model/Shipping/LabelsTest.php

@@ -38,6 +38,16 @@ class LabelsTest extends \PHPUnit_Framework_TestCase
      */
     protected $region;
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $carrierFactory;
+
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $user;
+
     protected function setUp()
     {
         $this->request = $this->getMockBuilder(\Magento\Shipping\Model\Shipment\Request::class)
@@ -48,32 +58,32 @@ protected function setUp()
             ->setMethods(['create'])
             ->getMock();
         $requestFactory->expects(static::any())->method('create')->willReturn($this->request);
-
-        $carrier = $this->getMockBuilder(\Magento\Shipping\Model\Carrier\AbstractCarrier::class)
+        $this->carrierFactory = $this->getMockBuilder(\Magento\Shipping\Model\CarrierFactory::class)
             ->disableOriginalConstructor()
+            ->setMethods(['create'])
             ->getMock();
-
-        $carrierFactory = $this->getMockBuilder(\Magento\Shipping\Model\CarrierFactory::class)
+        $storeManager = $this->getStoreManager();
+        $this->user = $this->getMockBuilder(\Magento\User\Model\User::class)
             ->disableOriginalConstructor()
-            ->setMethods(['create'])
+            ->setMethods(['getFirstname', 'getLastname', 'getEmail', 'getName'])
             ->getMock();
-        $carrierFactory->expects(static::any())->method('create')->willReturn($carrier);
 
-        $storeManager = $this->getStoreManager();
-        $authSession = $this->getAuthSession();
+        $authSession = $this->getMockBuilder(\Magento\Backend\Model\Auth\Session::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getUser'])
+            ->getMock();
+        $authSession->expects(static::any())->method('getUser')->willReturn($this->user);
         $regionFactory = $this->getRegionFactory();
-
         $this->scopeConfig = $this->getMockBuilder(\Magento\Framework\App\Config::class)
             ->disableOriginalConstructor()
             ->setMethods(['getValue'])
             ->getMock();
-
-        $bjectManagerHelper = new ObjectManagerHelper($this);
-        $this->labels = $bjectManagerHelper->getObject(
+        $objectManagerHelper = new ObjectManagerHelper($this);
+        $this->labels = $objectManagerHelper->getObject(
             \Magento\Shipping\Model\Shipping\Labels::class,
             [
                 'shipmentRequestFactory' => $requestFactory,
-                'carrierFactory' => $carrierFactory,
+                'carrierFactory' => $this->carrierFactory,
                 'storeManager' => $storeManager,
                 'scopeConfig' => $this->scopeConfig,
                 'authSession' => $authSession,
@@ -83,14 +93,21 @@ protected function setUp()
     }
 
     /**
-     * @covers \Magento\Shipping\Model\Shipping\Labels
+     * @dataProvider requestToShipmentDataProvider
      */
-    public function testRequestToShipment()
+    public function testRequestToShipment($regionId)
     {
+        $carrier = $this->getMockBuilder(\Magento\Shipping\Model\Carrier\AbstractCarrier::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->carrierFactory->expects(static::any())->method('create')->willReturn($carrier);
         $order = $this->getMockBuilder(\Magento\Sales\Model\Order::class)
             ->disableOriginalConstructor()
             ->getMock();
-
+        $this->user->expects($this->exactly(2))->method('getFirstname')->willReturn('John');
+        $this->user->expects($this->exactly(2))->method('getLastname')->willReturn('Doe');
+        $this->user->expects($this->once())->method('getName')->willReturn('John Doe');
+        $this->user->expects($this->once())->method('getEmail')->willReturn('admin@admin.test.com');
         $shippingMethod = $this->getMockBuilder(\Magento\Framework\DataObject::class)
             ->disableOriginalConstructor()
             ->setMethods(['getCarrierCode'])
@@ -124,7 +141,7 @@ public function testRequestToShipment()
         $this->scopeConfig->expects(static::any())
             ->method('getValue')
             ->willReturnMap([
-                [Shipment::XML_PATH_STORE_REGION_ID, ScopeInterface::SCOPE_STORE, $storeId, 'CA'],
+                [Shipment::XML_PATH_STORE_REGION_ID, ScopeInterface::SCOPE_STORE, $storeId, $regionId],
                 [Shipment::XML_PATH_STORE_ADDRESS1, ScopeInterface::SCOPE_STORE, $storeId, 'Beverly Heals'],
                 ['general/store_information', ScopeInterface::SCOPE_STORE, $storeId, [
                     'name' => 'General Store', 'phone' => '(244)1500301'
@@ -134,38 +151,35 @@ public function testRequestToShipment()
                 [Shipment::XML_PATH_STORE_COUNTRY_ID, ScopeInterface::SCOPE_STORE, $storeId, 'US'],
                 [Shipment::XML_PATH_STORE_ADDRESS2, ScopeInterface::SCOPE_STORE, $storeId, '1st Park Avenue'],
             ]);
-
         $this->labels->requestToShipment($shipment);
     }
 
     /**
-     * @return \PHPUnit_Framework_MockObject_MockObject
+     * @expectedException \Magento\Framework\Exception\LocalizedException
+     * @dataProvider testRequestToShipmentLocalizedExceptionDataProvider
      */
-    protected function getAuthSession()
+    public function testRequestToShipmentLocalizedException($isShipmentCarrierNotNull)
     {
-        $user = $this->getMockBuilder(\Magento\User\Model\User::class)
+        $order = $this->getMockBuilder(\Magento\Sales\Model\Order::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getFirstname', 'getLastname', 'getEmail', 'getName'])
             ->getMock();
-        $user->expects(static::exactly(2))
-            ->method('getFirstname')
-            ->willReturn('John');
-        $user->expects(static::exactly(2))
-            ->method('getLastname')
-            ->willReturn('Doe');
-        $user->expects(static::once())
-            ->method('getName')
-            ->willReturn('John Doe');
-        $user->expects(static::once())
-            ->method('getEmail')
-            ->willReturn('admin@admin.test.com');
-
-        $authSession = $this->getMockBuilder(\Magento\Backend\Model\Auth\Session::class)
+        $shipment = $this->getMockBuilder(\Magento\Sales\Model\Order\Shipment::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getUser'])
             ->getMock();
-        $authSession->expects(static::any())->method('getUser')->willReturn($user);
-        return $authSession;
+        $shippingMethod = $this->getMockBuilder(\Magento\Framework\DataObject::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getCarrierCode'])
+            ->getMock();
+        $order->expects($this->exactly(2))
+            ->method('getShippingMethod')
+            ->with(true)
+            ->willReturn($shippingMethod);
+        $this->carrierFactory
+            ->expects(static::any())
+            ->method('create')
+            ->willReturn($isShipmentCarrierNotNull ? $shippingMethod : null);
+        $shipment->expects($this->once())->method('getOrder')->willReturn($order);
+        $this->labels->requestToShipment($shipment);
     }
 
     /**
@@ -245,4 +259,36 @@ protected function getRecipientAddress()
             ->willReturn(1);
         return $address;
     }
+
+    /**
+     * Data provider to testRequestToShipment
+     * @return array
+     */
+    public function requestToShipmentDataProvider()
+    {
+        return [
+            [
+                'CA'
+            ],
+            [
+                null
+            ]
+        ];
+    }
+
+    /**
+     * Data provider to testRequestToShipmentLocalizedException
+     * @return array
+     */
+    public function testRequestToShipmentLocalizedExceptionDataProvider()
+    {
+        return [
+            [
+                true
+            ],
+            [
+                false
+            ]
+        ];
+    }
 }