Code Refactored with data provider

Author: srsathish92

app/code/Magento/Analytics/ReportXml/QueryFactory.php

@@ -1,14 +1,15 @@
 <?php
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Analytics\ReportXml;
 
 use Magento\Analytics\ReportXml\DB\SelectBuilderFactory;
 use Magento\Framework\App\CacheInterface;
 use Magento\Framework\ObjectManagerInterface;
-use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\DB\Select;
 
@@ -50,20 +51,20 @@ class QueryFactory
     private $selectHydrator;
 
     /**
-     * @var Json|null
+     * @var Json
      */
     private $jsonSerializer;
 
     /**
      * QueryFactory constructor.
      *
-     * @param CacheInterface         $queryCache
-     * @param SelectHydrator         $selectHydrator
+     * @param CacheInterface $queryCache
+     * @param SelectHydrator $selectHydrator
      * @param ObjectManagerInterface $objectManager
-     * @param SelectBuilderFactory   $selectBuilderFactory
-     * @param Config                 $config
-     * @param array                  $assemblers
-     * @param Json|null              $jsonSerializer
+     * @param SelectBuilderFactory $selectBuilderFactory
+     * @param Config $config
+     * @param array $assemblers
+     * @param Json $jsonSerializer
      */
     public function __construct(
         CacheInterface $queryCache,
@@ -72,15 +73,15 @@ public function __construct(
         SelectBuilderFactory $selectBuilderFactory,
         Config $config,
         array $assemblers,
-        Json $jsonSerializer = null
+        Json $jsonSerializer
     ) {
         $this->config = $config;
         $this->selectBuilderFactory = $selectBuilderFactory;
         $this->assemblers = $assemblers;
         $this->queryCache = $queryCache;
         $this->objectManager = $objectManager;
         $this->selectHydrator = $selectHydrator;
-        $this->jsonSerializer = $jsonSerializer ?: ObjectManager::getInstance()->get(Json::class);
+        $this->jsonSerializer = $jsonSerializer;
     }
 
     /**
@@ -120,31 +121,10 @@ private function constructQuery($queryName)
         );
     }
 
-    /**
-     * Create query class using objectmanger
-     *
-     * @param  Select $select
-     * @param  string $connection
-     * @param  array  $queryConfig
-     * @return Query
-     */
-    private function createQueryObject($select, $connection, $queryConfig)
-    {
-        return $this->objectManager->create(
-            Query::class,
-            [
-                'select' => $select,
-                'selectHydrator' => $this->selectHydrator,
-                'connectionName' => $connection,
-                'config' => $queryConfig
-            ]
-        );
-    }
-
     /**
      * Creates query by name
      *
-     * @param  string $queryName
+     * @param string $queryName
      * @return Query
      */
     public function create($queryName)
@@ -165,4 +145,29 @@ public function create($queryName)
         );
         return $query;
     }
+
+    /**
+     * Create query class using objectmanger
+     *
+     * @param Select $select
+     * @param string $connection
+     * @param array $queryConfig
+     * @return Query
+     */
+    private function createQueryObject(
+        Select $select,
+        string $connection,
+        array $queryConfig
+    ): Query
+    {
+        return $this->objectManager->create(
+            Query::class,
+            [
+                'select' => $select,
+                'selectHydrator' => $this->selectHydrator,
+                'connectionName' => $connection,
+                'config' => $queryConfig
+            ]
+        );
+    }
 }

app/code/Magento/Analytics/Test/Unit/ReportXml/QueryFactoryTest.php

@@ -142,59 +142,21 @@ protected function setUp(): void
         );
     }
 
-    /**
-     * Get Query Data Mock
-     *
-     * @return array
-     */
-    private function getQueryDataMock(): array
-    {
-        return [
-            'connectionName' => self::STUB_CONNECTION,
-            'config' => [
-                'name' => self::STUB_QUERY_NAME,
-                'connection' => self::STUB_CONNECTION
-            ],
-            'select_parts' => []
-        ];
-    }
-
-    /**
-     * ObjectManager Mock with Query class
-     *
-     * @param  array $queryDataMock
-     * @return void
-     */
-    private function createQueryObjectMock($queryDataMock): void
-    {
-        $this->objectManagerMock->expects($this->once())
-            ->method('create')
-            ->with(
-                Query::class,
-                [
-                    'select' => $this->selectMock,
-                    'selectHydrator' => $this->selectHydratorMock,
-                    'connectionName' => $queryDataMock['connectionName'],
-                    'config' => $queryDataMock['config']
-                ]
-            )
-            ->willReturn($this->queryMock);
-    }
-
     /**
      * Test create() if query cached
      *
      * @return void
+     * @dataProvider queryDataProvider
      */
-    public function testCreateIfQueryCached(): void
+    public function testCreateIfQueryCached(array $queryDataMock, string $jsonEncodeData): void
     {
-        $queryName = self::STUB_QUERY_NAME;
-        $queryDataMock = $this->getQueryDataMock();
+        $queryConfigMock = $queryDataMock['config'];
+        $queryName = $queryConfigMock['name'];
 
         $this->queryCacheMock->expects($this->any())
             ->method('load')
             ->with($queryName)
-            ->willReturn(json_encode($queryDataMock));
+            ->willReturn($jsonEncodeData);
 
         $this->jsonSerializerMock->expects($this->once())
             ->method('unserialize')
@@ -220,12 +182,12 @@ public function testCreateIfQueryCached(): void
      * Test create() if query not cached
      *
      * @return void
+     * @dataProvider queryDataProvider
      */
-    public function testCreateIfQueryNotCached(): void
+    public function testCreateIfQueryNotCached(array $queryDataMock, string $jsonEncodeData): void
     {
-        $queryName = self::STUB_QUERY_NAME;
-        $queryDataMock = $this->getQueryDataMock();
         $queryConfigMock = $queryDataMock['config'];
+        $queryName = $queryConfigMock['name'];
 
         $selectBuilderMock = $this->getMockBuilder(SelectBuilder::class)
             ->disableOriginalConstructor()
@@ -263,15 +225,61 @@ public function testCreateIfQueryNotCached(): void
 
         $this->jsonSerializerMock->expects($this->once())
             ->method('serialize')
-            ->willReturn($this->queryMock);
+            ->willReturn($jsonEncodeData);
 
         $this->queryCacheMock->expects($this->once())
             ->method('save')
-            ->with($this->queryMock, $queryName);
+            ->with($jsonEncodeData, $queryName);
 
         $this->assertEquals(
             $this->queryMock,
             $this->subject->create($queryName)
         );
     }
+
+    /**
+     * Get Query Data Provider
+     *
+     * @return array
+     */
+    public function queryDataProvider(): array
+    {
+        return [
+            [
+                'getQueryDataMock' => [
+                    'connectionName' => self::STUB_CONNECTION,
+                    'config' => [
+                        'name' => self::STUB_QUERY_NAME,
+                        'connection' => self::STUB_CONNECTION
+                    ],
+                    'select_parts' => []
+                ],
+                'getQueryDataJsonEncodeMock' => '{"connectionName":"default",'.
+                    '"config":{"name":"test_query",'.
+                    '"connection":"default"},"select_parts":[]}'
+            ]
+        ];
+    }
+
+    /**
+     * ObjectManager Mock with Query class
+     *
+     * @param array $queryDataMock
+     * @return void
+     */
+    private function createQueryObjectMock($queryDataMock): void
+    {
+        $this->objectManagerMock->expects($this->once())
+            ->method('create')
+            ->with(
+                Query::class,
+                [
+                    'select' => $this->selectMock,
+                    'selectHydrator' => $this->selectHydratorMock,
+                    'connectionName' => $queryDataMock['connectionName'],
+                    'config' => $queryDataMock['config']
+                ]
+            )
+            ->willReturn($this->queryMock);
+    }
 }