AC-15461:Migration New Relic from REST v2 to NerdGraph (GraphQL)

Author: sandesh-as

app/code/Magento/NewRelicReporting/Model/Config.php

@@ -265,7 +265,7 @@ public function isNerdGraphMode()
      *
      * @return string
      */
-    public function getNerdGraphUrl()
+    public function getNerdGraphUrl(): string
     {
         return (string)$this->scopeConfig->getValue(self::XML_PATH_NERD_GRAPH_API_URL);
     }

app/code/Magento/NewRelicReporting/Test/Unit/Model/Config/Source/ApiModeTest.php

@@ -46,16 +46,16 @@ public function testToOptionArrayReturnsCorrectStructure(): void
 
         // Assert it's an array
         $this->assertIsArray($result);
-        
+
         // Assert it has exactly 2 options
         $this->assertCount(2, $result);
-        
+
         // Assert structure of first option (v2 REST)
         $this->assertArrayHasKey('value', $result[0]);
         $this->assertArrayHasKey('label', $result[0]);
         $this->assertEquals(ApiMode::MODE_V2_REST, $result[0]['value']);
         $this->assertEquals('v2 REST (Legacy)', $result[0]['label']->render());
-        
+
         // Assert structure of second option (NerdGraph)
         $this->assertArrayHasKey('value', $result[1]);
         $this->assertArrayHasKey('label', $result[1]);
@@ -69,9 +69,9 @@ public function testToOptionArrayReturnsCorrectStructure(): void
     public function testToOptionArrayUsesConstants(): void
     {
         $result = $this->apiMode->toOptionArray();
-        
+
         $values = array_column($result, 'value');
-        
+
         $this->assertContains(ApiMode::MODE_V2_REST, $values);
         $this->assertContains(ApiMode::MODE_NERDGRAPH, $values);
     }
@@ -85,14 +85,14 @@ public function testToArrayReturnsCorrectStructure(): void
 
         // Assert it's an array
         $this->assertIsArray($result);
-        
+
         // Assert it has exactly 2 options
         $this->assertCount(2, $result);
-        
+
         // Assert keys match constants
         $this->assertArrayHasKey(ApiMode::MODE_V2_REST, $result);
         $this->assertArrayHasKey(ApiMode::MODE_NERDGRAPH, $result);
-        
+
         // Assert values are correct
         $this->assertEquals('v2 REST (Legacy)', $result[ApiMode::MODE_V2_REST]->render());
         $this->assertEquals('NerdGraph (GraphQL) - Recommended', $result[ApiMode::MODE_NERDGRAPH]->render());
@@ -114,7 +114,7 @@ public function testBothMethodsReturnSameOptionCount(): void
     {
         $optionArray = $this->apiMode->toOptionArray();
         $array = $this->apiMode->toArray();
-        
+
         $this->assertCount(count($optionArray), $array);
     }
 
@@ -125,19 +125,19 @@ public function testAllConstantsAreUsedInBothMethods(): void
     {
         $optionArray = $this->apiMode->toOptionArray();
         $array = $this->apiMode->toArray();
-        
+
         // Get values from toOptionArray
         $optionValues = array_column($optionArray, 'value');
-        
-        // Get keys from toArray  
+
+        // Get keys from toArray
         $arrayKeys = array_keys($array);
-        
+
         // Both should contain the same constants
         $this->assertEqualsCanonicalizing($optionValues, $arrayKeys);
-        
+
         // Verify specific constants are present
         $expectedConstants = [ApiMode::MODE_V2_REST, ApiMode::MODE_NERDGRAPH];
-        
+
         foreach ($expectedConstants as $constant) {
             $this->assertContains($constant, $optionValues);
             $this->assertArrayHasKey($constant, $array);
@@ -151,19 +151,19 @@ public function testLabelsConsistencyBetweenMethods(): void
     {
         $optionArray = $this->apiMode->toOptionArray();
         $array = $this->apiMode->toArray();
-        
+
         // Create mapping from toOptionArray
         $optionLabels = [];
         foreach ($optionArray as $option) {
             $optionLabels[$option['value']] = $option['label']->render();
         }
-        
+
         // Create mapping from toArray
         $arrayLabels = [];
         foreach ($array as $key => $label) {
             $arrayLabels[$key] = $label->render();
         }
-        
+
         // Labels should be identical for same keys
         $this->assertEquals($optionLabels, $arrayLabels);
     }
@@ -175,16 +175,16 @@ public function testMethodReturnTypes(): void
     {
         $optionArray = $this->apiMode->toOptionArray();
         $array = $this->apiMode->toArray();
-        
+
         // Both should return arrays
         $this->assertIsArray($optionArray);
         $this->assertIsArray($array);
-        
+
         // toOptionArray should return array of arrays
         foreach ($optionArray as $option) {
             $this->assertIsArray($option);
         }
-        
+
         // toArray should have string keys
         foreach (array_keys($array) as $key) {
             $this->assertIsString($key);
@@ -198,12 +198,12 @@ public function testMethodsAreImmutable(): void
     {
         $firstCall = $this->apiMode->toOptionArray();
         $secondCall = $this->apiMode->toOptionArray();
-        
+
         $this->assertEquals($firstCall, $secondCall);
-        
+
         $firstArrayCall = $this->apiMode->toArray();
         $secondArrayCall = $this->apiMode->toArray();
-        
+
         $this->assertEquals($firstArrayCall, $secondArrayCall);
     }
 
@@ -213,26 +213,26 @@ public function testMethodsAreImmutable(): void
     public function testSpecificLabelContent(): void
     {
         $optionArray = $this->apiMode->toOptionArray();
-        
+
         // Find v2 REST option
         $v2RestOption = null;
         $nerdGraphOption = null;
-        
+
         foreach ($optionArray as $option) {
             if ($option['value'] === ApiMode::MODE_V2_REST) {
                 $v2RestOption = $option;
             } elseif ($option['value'] === ApiMode::MODE_NERDGRAPH) {
                 $nerdGraphOption = $option;
             }
         }
-        
+
         $this->assertNotNull($v2RestOption);
         $this->assertNotNull($nerdGraphOption);
-        
+
         // Test specific label content
         $this->assertStringContainsString('Legacy', $v2RestOption['label']->render());
         $this->assertStringContainsString('v2 REST', $v2RestOption['label']->render());
-        
+
         $this->assertStringContainsString('Recommended', $nerdGraphOption['label']->render());
         $this->assertStringContainsString('NerdGraph', $nerdGraphOption['label']->render());
         $this->assertStringContainsString('GraphQL', $nerdGraphOption['label']->render());

app/code/Magento/NewRelicReporting/Test/Unit/Model/ConfigTest.php

@@ -12,9 +12,12 @@
 use Magento\NewRelicReporting\Model\Config;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use ReflectionException;
 
 /**
  * Test for Config model
+ *
+ * @SuppressWarnings(PHPMD.ExcessivePublicCount)
  */
 class ConfigTest extends TestCase
 {
@@ -695,13 +698,13 @@ public function testDisableModule()
 
     /**
      * Test disableModule with custom scope and scope ID
+     * @throws ReflectionException
      */
     public function testDisableModuleCustomScope()
     {
         // We need to use reflection to test the protected setConfigValue method with custom parameters
         $reflection = new \ReflectionClass($this->config);
         $setConfigValueMethod = $reflection->getMethod('setConfigValue');
-        $setConfigValueMethod->setAccessible(true);
 
         $this->resourceConfigMock->expects($this->once())
             ->method('saveConfig')
@@ -782,7 +785,7 @@ public function testGetNewRelicAppIdNull()
 
     /**
      * Test all string casting methods with various input types
-     * 
+     *
      * @dataProvider stringCastingProvider
      */
     public function testStringCastingMethods($method, $configPath, $inputValue, $expectedOutput)
@@ -798,7 +801,7 @@ public function testStringCastingMethods($method, $configPath, $inputValue, $exp
     /**
      * Data provider for string casting methods
      */
-    public function stringCastingProvider(): array
+    public static function stringCastingProvider(): array
     {
         return [
             // getNewRelicApiUrl tests
@@ -843,7 +846,7 @@ public function stringCastingProvider(): array
 
     /**
      * Test integer casting for getNewRelicAppId with various input types
-     * 
+     *
      * @dataProvider integerCastingProvider
      */
     public function testGetNewRelicAppIdCasting($inputValue, $expectedOutput)
@@ -859,7 +862,7 @@ public function testGetNewRelicAppIdCasting($inputValue, $expectedOutput)
     /**
      * Data provider for integer casting
      */
-    public function integerCastingProvider(): array
+    public static function integerCastingProvider(): array
     {
         return [
             [null, 0],
@@ -876,7 +879,7 @@ public function integerCastingProvider(): array
 
     /**
      * Test boolean casting for isSeparateApps with various input types
-     * 
+     *
      * @dataProvider booleanCastingProvider
      */
     public function testIsSeparateAppsCasting($inputValue, $expectedOutput)
@@ -892,7 +895,7 @@ public function testIsSeparateAppsCasting($inputValue, $expectedOutput)
     /**
      * Data provider for boolean casting
      */
-    public function booleanCastingProvider(): array
+    public static function booleanCastingProvider(): array
     {
         return [
             [null, false],
@@ -917,17 +920,14 @@ public function testConstructorAssignment()
     {
         // Use reflection to verify private properties are set correctly
         $reflection = new \ReflectionClass($this->config);
-        
+
         $scopeConfigProperty = $reflection->getProperty('scopeConfig');
-        $scopeConfigProperty->setAccessible(true);
         $this->assertSame($this->scopeConfigMock, $scopeConfigProperty->getValue($this->config));
-        
+
         $encryptorProperty = $reflection->getProperty('encryptor');
-        $encryptorProperty->setAccessible(true);
         $this->assertSame($this->encryptorMock, $encryptorProperty->getValue($this->config));
-        
+
         $resourceConfigProperty = $reflection->getProperty('resourceConfig');
-        $resourceConfigProperty->setAccessible(true);
         $this->assertSame($this->resourceConfigMock, $resourceConfigProperty->getValue($this->config));
     }
 
@@ -981,8 +981,14 @@ public function testComprehensiveConfigurationScenario()
 
         // Test all methods return expected values
         $this->assertTrue($this->config->isNewRelicEnabled());
-        $this->assertEquals('https://api.newrelic.com/v2/applications/%s/deployments.json', $this->config->getNewRelicApiUrl());
-        $this->assertEquals('https://insights-collector.newrelic.com/v1/accounts/%s/events', $this->config->getInsightsApiUrl());
+        $this->assertEquals(
+            'https://api.newrelic.com/v2/applications/%s/deployments.json',
+            $this->config->getNewRelicApiUrl()
+        );
+        $this->assertEquals(
+            'https://insights-collector.newrelic.com/v1/accounts/%s/events',
+            $this->config->getInsightsApiUrl()
+        );
         $this->assertEquals('123456', $this->config->getNewRelicAccountId());
         $this->assertEquals(789012, $this->config->getNewRelicAppId());
         $this->assertEquals('NRAK-DECRYPTED-API-KEY', $this->config->getNewRelicApiKey());