Merge remote-tracking branch 'arcticfoxes/MC-6296' into MC-4245

Author: Joan He

app/code/Magento/Dhl/Model/Carrier.php

@@ -1000,18 +1000,29 @@ protected function _getQuotesFromServer($request)
     protected function _buildQuotesRequestXml()
     {
         $rawRequest = $this->_rawRequest;
-        $xmlStr = '<?xml version = "1.0" encoding = "UTF-8"?>' .
-            '<p:DCTRequest xmlns:p="http://www.dhl.com" xmlns:p1="http://www.dhl.com/datatypes" ' .
-            'xmlns:p2="http://www.dhl.com/DCTRequestdatatypes" ' .
+
+        $xmlStr = '<?xml version="1.0" encoding = "UTF-8"?>' .
+            '<req:DCTRequest schemaVersion="2.0" ' .
+            'xmlns:req="http://www.dhl.com" ' .
             'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' .
-            'xsi:schemaLocation="http://www.dhl.com DCT-req.xsd "/>';
+            'xsi:schemaLocation="http://www.dhl.com DCT-req_global-2.0.xsd"/>';
+
         $xml = $this->_xmlElFactory->create(['data' => $xmlStr]);
         $nodeGetQuote = $xml->addChild('GetQuote', '', '');
         $nodeRequest = $nodeGetQuote->addChild('Request');
 
         $nodeServiceHeader = $nodeRequest->addChild('ServiceHeader');
-        $nodeServiceHeader->addChild('SiteID', (string)$this->getConfigData('id'));
-        $nodeServiceHeader->addChild('Password', (string)$this->getConfigData('password'));
+        $nodeServiceHeader->addChild('MessageTime', $this->buildMessageTimestamp());
+        $nodeServiceHeader->addChild(
+            'MessageReference',
+            $this->buildMessageReference(self::SERVICE_PREFIX_QUOTE)
+        );
+        $nodeServiceHeader->addChild('SiteID', (string) $this->getConfigData('id'));
+        $nodeServiceHeader->addChild('Password', (string) $this->getConfigData('password'));
+
+        $nodeMetaData = $nodeRequest->addChild('MetaData');
+        $nodeMetaData->addChild('SoftwareName', $this->buildSoftwareName());
+        $nodeMetaData->addChild('SoftwareVersion', $this->buildSoftwareVersion());
 
         $nodeFrom = $nodeGetQuote->addChild('From');
         $nodeFrom->addChild('CountryCode', $rawRequest->getOrigCountryId());
@@ -1995,4 +2006,24 @@ private function buildMessageReference(string $servicePrefix): string
 
         return str_replace('.', '', uniqid("MAGE_{$servicePrefix}_", true));
     }
+
+    /**
+     * Builds a string to be used as the request SoftwareName.
+     *
+     * @return string
+     */
+    private function buildSoftwareName(): string
+    {
+        return substr($this->productMetadata->getName(), 0, 30);
+    }
+
+    /**
+     * Builds a string to be used as the request SoftwareVersion.
+     *
+     * @return string
+     */
+    private function buildSoftwareVersion(): string
+    {
+        return substr($this->productMetadata->getVersion(), 0, 10);
+    }
 }

app/code/Magento/Dhl/Test/Unit/Model/CarrierTest.php

@@ -130,14 +130,6 @@ protected function setUp()
 
         $this->scope = $this->getMockForAbstractClass(ScopeConfigInterface::class);
 
-        $xmlElFactory = $this->getXmlFactory();
-        $rateFactory = $this->getRateFactory();
-        $rateMethodFactory = $this->getRateMethodFactory();
-        $httpClientFactory = $this->getHttpClientFactory();
-        $configReader = $this->getConfigReader();
-        $readFactory = $this->getReadFactory();
-        $storeManager = $this->getStoreManager();
-
         $this->error = $this->getMockBuilder(Error::class)
             ->setMethods(['setCarrier', 'setCarrierTitle', 'setErrorMessage'])
             ->getMock();
@@ -148,8 +140,6 @@ protected function setUp()
         $this->errorFactory->method('create')
             ->willReturn($this->error);
 
-        $carrierHelper = $this->getCarrierHelper();
-
         $this->xmlValidator = $this->getMockBuilder(XmlValidator::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -174,17 +164,17 @@ protected function setUp()
             Carrier::class,
             [
                 'scopeConfig' => $this->scope,
-                'xmlSecurity' => new Security(),
-                'logger' => $this->logger,
-                'xmlElFactory' => $xmlElFactory,
-                'rateFactory' => $rateFactory,
                 'rateErrorFactory' => $this->errorFactory,
-                'rateMethodFactory' => $rateMethodFactory,
-                'httpClientFactory' => $httpClientFactory,
-                'readFactory' => $readFactory,
-                'storeManager' => $storeManager,
-                'configReader' => $configReader,
-                'carrierHelper' => $carrierHelper,
+                'logger' => $this->logger,
+                'xmlSecurity' => new Security(),
+                'xmlElFactory' => $this->getXmlFactory(),
+                'rateFactory' => $this->getRateFactory(),
+                'rateMethodFactory' => $this->getRateMethodFactory(),
+                'carrierHelper' => $this->getCarrierHelper(),
+                'configReader' => $this->getConfigReader(),
+                'storeManager' => $this->getStoreManager(),
+                'readFactory' => $this->getReadFactory(),
+                'httpClientFactory' => $this->getHttpClientFactory(),
                 'data' => ['id' => 'dhl', 'store' => '1'],
                 'xmlValidator' => $this->xmlValidator,
                 'coreDate' => $this->coreDateMock,
@@ -212,15 +202,15 @@ public function scopeConfigGetValue($path)
             'carriers/dhl/content_type' => 'N',
             'carriers/dhl/nondoc_methods' => '1,3,4,8,P,Q,E,F,H,J,M,V,Y',
             'carriers/dhl/showmethod' => 1,
-            'carriers/dhl/title' => 'dhl Title',
+            'carriers/dhl/title' => 'DHL Title',
             'carriers/dhl/specificerrmsg' => 'dhl error message',
             'carriers/dhl/unit_of_measure' => 'K',
             'carriers/dhl/size' => '1',
             'carriers/dhl/height' => '1.6',
             'carriers/dhl/width' => '1.6',
             'carriers/dhl/depth' => '1.6',
             'carriers/dhl/debug' => 1,
-            'shipping/origin/country_id' => 'GB',
+            'shipping/origin/country_id' => 'GB'
         ];
         return isset($pathMap[$path]) ? $pathMap[$path] : null;
     }
@@ -276,22 +266,29 @@ protected function _invokePrepareShippingLabelContent(\SimpleXMLElement $xml)
         return $method->invoke($model, $xml);
     }
 
+    /**
+     * Tests that valid rates are returned when sending a quotes request.
+     */
     public function testCollectRates()
     {
+        $requestData = require __DIR__ . '/_files/dhl_quote_request_data.php';
+        $responseXml = file_get_contents(__DIR__ . '/_files/dhl_quote_response.xml');
+
         $this->scope->method('getValue')
             ->willReturnCallback([$this, 'scopeConfigGetValue']);
 
         $this->scope->method('isSetFlag')
             ->willReturn(true);
 
         $this->httpResponse->method('getBody')
-            ->willReturn(file_get_contents(__DIR__ . '/_files/success_dhl_response_rates.xml'));
+            ->willReturn($responseXml);
 
-        /** @var RateRequest $request */
-        $request = $this->objectManager->getObject(
-            RateRequest::class,
-            require __DIR__ . '/_files/rates_request_data_dhl.php'
-        );
+        $this->coreDateMock->method('date')
+           ->willReturnCallback(function () {
+               return date(\DATE_RFC3339);
+           });
+
+        $request = $this->objectManager->getObject(RateRequest::class, $requestData);
 
         $reflectionClass = new \ReflectionObject($this->httpClient);
         $rawPostData = $reflectionClass->getProperty('raw_post_data');
@@ -301,13 +298,27 @@ public function testCollectRates()
             ->method('debug')
             ->with($this->stringContains('<SiteID>****</SiteID><Password>****</Password>'));
 
-        self::assertNotEmpty($this->model->collectRates($request)->getAllRates());
-        self::assertContains('<Weight>18.223</Weight>', $rawPostData->getValue($this->httpClient));
-        self::assertContains('<Height>0.630</Height>', $rawPostData->getValue($this->httpClient));
-        self::assertContains('<Width>0.630</Width>', $rawPostData->getValue($this->httpClient));
-        self::assertContains('<Depth>0.630</Depth>', $rawPostData->getValue($this->httpClient));
+        $expectedRates = require __DIR__ . '/_files/dhl_quote_response_rates.php';
+        $actualRates = $this->model->collectRates($request)->getAllRates();
+
+        self::assertEquals(count($expectedRates), count($actualRates));
+
+        foreach ($actualRates as $i => $actualRate) {
+            $actualRate = $actualRate->getData();
+            unset($actualRate['method_title']);
+            self::assertEquals($expectedRates[$i], $actualRate);
+        }
+
+        $requestXml = $rawPostData->getValue($this->httpClient);
+        self::assertContains('<Weight>18.223</Weight>', $requestXml);
+        self::assertContains('<Height>0.630</Height>', $requestXml);
+        self::assertContains('<Width>0.630</Width>', $requestXml);
+        self::assertContains('<Depth>0.630</Depth>', $requestXml);
     }
 
+    /**
+     * Tests that an error is returned when attempting to collect rates for an inactive shipping method.
+     */
     public function testCollectRatesErrorMessage()
     {
         $this->scope->method('getValue')
@@ -325,16 +336,6 @@ public function testCollectRatesErrorMessage()
         $this->assertSame($this->error, $this->model->collectRates($request));
     }
 
-    public function testCollectRatesFail()
-    {
-        $this->scope->expects($this->once())->method('isSetFlag')->willReturn(true);
-
-        $request = new RateRequest();
-        $request->setPackageWeight(1);
-
-        $this->assertFalse(false, $this->model->collectRates($request));
-    }
-
     /**
      * Test request to shipment sends valid xml values.
      *
@@ -520,34 +521,104 @@ public function dhlProductsDataProvider() : array
     }
 
     /**
-     * Tests that the built message reference string is of the appropriate format.
+     * Tests that the built MessageReference string is of the appropriate format.
+     *
+     * @dataProvider buildMessageReferenceDataProvider
+     * @param $servicePrefix
+     * @throws \ReflectionException
+     */
+    public function testBuildMessageReference($servicePrefix)
+    {
+        $method = new \ReflectionMethod($this->model, 'buildMessageReference');
+        $method->setAccessible(true);
+
+        $messageReference = $method->invoke($this->model, $servicePrefix);
+        $this->assertGreaterThanOrEqual(28, strlen($messageReference));
+        $this->assertLessThanOrEqual(32, strlen($messageReference));
+    }
+
+    /**
+     * @return array
+     */
+    public function buildMessageReferenceDataProvider()
+    {
+        return [
+            'quote_prefix' => ['QUOT'],
+            'shipval_prefix' => ['SHIP'],
+            'tracking_prefix' => ['TRCK']
+        ];
+    }
+
+    /**
+     * Tests that an exception is thrown when an invalid service prefix is provided.
      *
      * @expectedException \Magento\Framework\Exception\LocalizedException
      * @expectedExceptionMessage Invalid service prefix
-     * @throws \ReflectionException
      */
-    public function testBuildMessageReference()
+    public function testBuildMessageReferenceInvalidPrefix()
     {
         $method = new \ReflectionMethod($this->model, 'buildMessageReference');
         $method->setAccessible(true);
 
-        $constPrefixQuote = new \ReflectionClassConstant($this->model, 'SERVICE_PREFIX_QUOTE');
-        $constPrefixShipval = new \ReflectionClassConstant($this->model, 'SERVICE_PREFIX_SHIPVAL');
-        $constPrefixTracking = new \ReflectionClassConstant($this->model, 'SERVICE_PREFIX_TRACKING');
+        $method->invoke($this->model, 'INVALID');
+    }
 
-        $msgRefQuote = $method->invoke($this->model, $constPrefixQuote->getValue());
-        self::assertGreaterThanOrEqual(28, strlen($msgRefQuote));
-        self::assertLessThanOrEqual(32, strlen($msgRefQuote));
+    /**
+     * Tests that the built software name string is of the appropriate format.
+     *
+     * @dataProvider buildSoftwareNameDataProvider
+     * @param $productName
+     * @throws \ReflectionException
+     */
+    public function testBuildSoftwareName($productName)
+    {
+        $method = new \ReflectionMethod($this->model, 'buildSoftwareName');
+        $method->setAccessible(true);
 
-        $msgRefShip = $method->invoke($this->model, $constPrefixShipval->getValue());
-        self::assertGreaterThanOrEqual(28, strlen($msgRefShip));
-        self::assertLessThanOrEqual(32, strlen($msgRefShip));
+        $this->productMetadataMock->method('getName')->willReturn($productName);
 
-        $msgRefTrack = $method->invoke($this->model, $constPrefixTracking->getValue());
-        self::assertGreaterThanOrEqual(28, strlen($msgRefTrack));
-        self::assertLessThanOrEqual(32, strlen($msgRefTrack));
+        $softwareName = $method->invoke($this->model);
+        $this->assertLessThanOrEqual(30, strlen($softwareName));
+    }
 
-        $method->invoke($this->model, 'TEST');
+    /**
+     * @return array
+     */
+    public function buildSoftwareNameDataProvider()
+    {
+        return [
+            'valid_length' => ['Magento'],
+            'exceeds_length' => ['Product_Name_Longer_Than_30_Char']
+        ];
+    }
+
+    /**
+     * Tests that the built software version string is of the appropriate format.
+     *
+     * @dataProvider buildSoftwareVersionProvider
+     * @param $productVersion
+     * @throws \ReflectionException
+     */
+    public function testBuildSoftwareVersion($productVersion)
+    {
+        $method = new \ReflectionMethod($this->model, 'buildSoftwareVersion');
+        $method->setAccessible(true);
+
+        $this->productMetadataMock->method('getVersion')->willReturn($productVersion);
+
+        $softwareVersion = $method->invoke($this->model);
+        $this->assertLessThanOrEqual(10, strlen($softwareVersion));
+    }
+
+    /**
+     * @return array
+     */
+    public function buildSoftwareVersionProvider()
+    {
+        return [
+            'valid_length' => ['2.3.1'],
+            'exceeds_length' => ['dev-MC-1000']
+        ];
     }
 
     /**
@@ -608,14 +679,18 @@ private function getRateMethodFactory(): MockObject
             ->disableOriginalConstructor()
             ->setMethods(['create'])
             ->getMock();
-        $rateMethod = $this->getMockBuilder(Method::class)
-            ->disableOriginalConstructor()
-            ->setMethods(['setPrice'])
-            ->getMock();
-        $rateMethod->method('setPrice')
-            ->willReturnSelf();
+
         $rateMethodFactory->method('create')
-            ->willReturn($rateMethod);
+            ->willReturnCallback(function () {
+                $rateMethod = $this->getMockBuilder(Method::class)
+                    ->disableOriginalConstructor()
+                    ->setMethods(['setPrice'])
+                    ->getMock();
+                $rateMethod->method('setPrice')
+                    ->willReturnSelf();
+
+                return $rateMethod;
+            });
 
         return $rateMethodFactory;
     }

app/code/Magento/Dhl/Test/Unit/Model/_files/rates_request_data_dhl.php renamed to app/code/Magento/Dhl/Test/Unit/Model/_files/dhl_quote_request_data.php

@@ -24,10 +24,9 @@
         'limit_carrier' => null,
         'base_subtotal_incl_tax' => '5',
         'orig_country_id' => 'US',
-        'country_id' => 'US',
-        'region_id' => '12',
-        'city' => 'Fremont',
-        'postcode' => '94538',
+        'orig_region_id' => '12',
+        'orig_city' => 'Fremont',
+        'orig_postcode' => '94538',
         'dhl_id' => 'MAGEN_8501',
         'dhl_password' => 'QR2GO1U74X',
         'dhl_account' => '799909537',