MC-6296: Update DCTRequest

Updated unit tests to use data providers

Author: amolina-adobe

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

@@ -283,6 +283,11 @@ public function testCollectRates()
         $this->httpResponse->method('getBody')
             ->willReturn($responseXml);
 
+        $this->coreDateMock->method('date')
+           ->willReturnCallback(function () {
+               return date(\DATE_RFC3339);
+           });
+
         $request = $this->objectManager->getObject(RateRequest::class, $requestData);
 
         $reflectionClass = new \ReflectionObject($this->httpClient);
@@ -516,68 +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.
      *
-     * @expectedException \Magento\Framework\Exception\LocalizedException
-     * @expectedExceptionMessage Invalid service prefix
+     * @dataProvider buildMessageReferenceDataProvider
+     * @param $servicePrefix
      * @throws \ReflectionException
      */
-    public function testBuildMessageReference()
+    public function testBuildMessageReference($servicePrefix)
     {
         $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');
-
-        $msgRefQuote = $method->invoke($this->model, $constPrefixQuote->getValue());
-        self::assertGreaterThanOrEqual(28, strlen($msgRefQuote));
-        self::assertLessThanOrEqual(32, strlen($msgRefQuote));
+        $messageReference = $method->invoke($this->model, $servicePrefix);
+        $this->assertGreaterThanOrEqual(28, strlen($messageReference));
+        $this->assertLessThanOrEqual(32, strlen($messageReference));
+    }
 
-        $msgRefShip = $method->invoke($this->model, $constPrefixShipval->getValue());
-        self::assertGreaterThanOrEqual(28, strlen($msgRefShip));
-        self::assertLessThanOrEqual(32, strlen($msgRefShip));
+    /**
+     * @return array
+     */
+    public function buildMessageReferenceDataProvider()
+    {
+        return [
+            'quote_prefix' => ['QUOT'],
+            'shipval_prefix' => ['SHIP'],
+            'tracking_prefix' => ['TRCK']
+        ];
+    }
 
-        $msgRefTrack = $method->invoke($this->model, $constPrefixTracking->getValue());
-        self::assertGreaterThanOrEqual(28, strlen($msgRefTrack));
-        self::assertLessThanOrEqual(32, strlen($msgRefTrack));
+    /**
+     * Tests that an exception is thrown when an invalid service prefix is provided.
+     *
+     * @expectedException \Magento\Framework\Exception\LocalizedException
+     * @expectedExceptionMessage Invalid service prefix
+     */
+    public function testBuildMessageReferenceInvalidPrefix()
+    {
+        $method = new \ReflectionMethod($this->model, 'buildMessageReference');
+        $method->setAccessible(true);
 
-        $method->invoke($this->model, 'TEST');
+        $method->invoke($this->model, 'INVALID');
     }
 
     /**
      * Tests that the built software name string is of the appropriate format.
      *
+     * @dataProvider buildSoftwareNameDataProvider
+     * @param $productName
      * @throws \ReflectionException
      */
-    public function testBuildSoftwareName()
+    public function testBuildSoftwareName($productName)
     {
         $method = new \ReflectionMethod($this->model, 'buildSoftwareName');
         $method->setAccessible(true);
 
-        $name = $method->invoke($this->model);
-        self::assertLessThanOrEqual(30, $name);
+        $this->productMetadataMock->method('getName')->willReturn($productName);
 
-        $nameExceedsLength = $method->invoke($this->model);
-        self::assertLessThanOrEqual(30, $nameExceedsLength);
+        $softwareName = $method->invoke($this->model);
+        $this->assertLessThanOrEqual(30, strlen($softwareName));
+    }
+
+    /**
+     * @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()
+    public function testBuildSoftwareVersion($productVersion)
     {
         $method = new \ReflectionMethod($this->model, 'buildSoftwareVersion');
         $method->setAccessible(true);
 
-        $version = $method->invoke($this->model);
-        self::assertLessThanOrEqual(10, strlen($version));
+        $this->productMetadataMock->method('getVersion')->willReturn($productVersion);
 
-        $versionExceedsLength = $method->invoke($this->model);
-        self::assertLessThanOrEqual(10, strlen($versionExceedsLength));
+        $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']
+        ];
     }
 
     /**
@@ -725,21 +766,6 @@ private function getCarrierHelper(): CarrierHelper
         return $carrierHelper;
     }
 
-    /**
-     * @return MockObject
-     */
-    private function getCoreDate(): MockObject
-    {
-        $coreDate = $this->getMockBuilder(\Magento\Framework\Stdlib\DateTime\DateTime::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $coreDate->method('date')->willReturnCallback(function () {
-            return date(\DATE_RFC3339);
-        });
-
-        return $coreDate;
-    }
-
     /**
      * @return MockObject
      */
@@ -762,24 +788,4 @@ private function getHttpClientFactory(): MockObject
 
         return $httpClientFactory;
     }
-
-    /**
-     * @return MockObject
-     */
-    private function getProductMetadata(): MockObject
-    {
-        $productMetadata = $this->createMock(\Magento\Framework\App\ProductMetadata::class);
-
-        $productMetadata->method('getName')->willReturnOnConsecutiveCalls(
-            'Magento',
-            str_pad('Magento', 24, '_')
-        );
-
-        $productMetadata->method('getVersion')->willReturnOnConsecutiveCalls(
-            '2.3.1',
-            'dev-MC-1000'
-        );
-
-        return $productMetadata;
-    }
 }