MC-24057: Implement static dependency analysis for wildcard and API urls

- Added further test cases

Author: Rrego6

dev/tests/static/framework/Magento/TestFramework/Dependency/PhpRule.php

@@ -106,22 +106,24 @@ class PhpRule implements RuleInterface
      * @param array $pluginMap
      * @param array $whitelists
      * @param ClassScanner|null $classScanner
+     * @param RouteMapper|null $routeMapper
      */
     public function __construct(
         array $mapRouters,
         array $mapLayoutBlocks,
         ConfigReader $configReader,
         array $pluginMap = [],
         array $whitelists = [],
-        ClassScanner $classScanner = null
+        ClassScanner $classScanner = null,
+        RouteMapper $routeMapper = null
     ) {
         $this->_mapRouters = $mapRouters;
         $this->_mapLayoutBlocks = $mapLayoutBlocks;
         $this->configReader = $configReader;
         $this->pluginMap = $pluginMap ?: null;
-        $this->routeMapper = new RouteMapper();
         $this->whitelists = $whitelists;
         $this->classScanner = $classScanner ?? new ClassScanner();
+        $this->routeMapper = $routeMapper ?? new RouteMapper();
     }
 
     /**
@@ -388,9 +390,9 @@ private function processWildcardUrl(string $urlPath, string $filePath)
         }
 
         return $this->routeMapper->getDependencyByRoutePath(
-            $routeId,
-            $controllerName,
-            $actionName
+            strtolower($routeId),
+            strtolower($controllerName),
+            strtolower($actionName)
         );
     }
 

dev/tests/static/framework/tests/unit/testsuite/Magento/TestFramework/Dependency/PhpRuleTest.php

@@ -10,6 +10,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use Magento\TestFramework\Dependency\Reader\ClassScanner;
+use Magento\TestFramework\Dependency\Route\RouteMapper;
 
 /**
  * Test for PhpRule dependency check
@@ -36,34 +37,36 @@ class PhpRuleTest extends \PHPUnit\Framework\TestCase
      */
     private $webApiConfigReader;
 
+    private $pluginMap;
+    private $mapRoutes;
+    private $mapLayoutBlocks;
+    private $whitelist;
+
     /**
      * @inheritDoc
      * @throws \Exception
      */
     protected function setUp(): void
     {
-        $mapRoutes = ['someModule' => ['Magento\SomeModule'], 'anotherModule' => ['Magento\OneModule']];
-        $mapLayoutBlocks = ['area' => ['block.name' => ['Magento\SomeModule' => 'Magento\SomeModule']]];
-        $pluginMap = [
+        $this->mapRoutes = ['someModule' => ['Magento\SomeModule'], 'anotherModule' => ['Magento\OneModule']];
+        $this->mapLayoutBlocks = ['area' => ['block.name' => ['Magento\SomeModule' => 'Magento\SomeModule']]];
+        $this->pluginMap = [
             'Magento\Module1\Plugin1' => 'Magento\Module1\Subject',
             'Magento\Module1\Plugin2' => 'Magento\Module2\Subject',
         ];
-        $whitelist = [];
+        $this->whitelist = [];
 
         $this->objectManagerHelper = new ObjectManagerHelper($this);
         $this->classScanner = $this->createMock(ClassScanner::class);
         $this->webApiConfigReader = $this->makeWebApiConfigReaderMock();
 
-        $this->model = $this->objectManagerHelper->getObject(
-            PhpRule::class,
-            [
-                'mapRouters' => $mapRoutes,
-                'mapLayoutBlocks' => $mapLayoutBlocks,
-                'pluginMap' => $pluginMap,
-                'configReader' => $this->webApiConfigReader,
-                'whitelists' => $whitelist,
-                'classScanner' => $this->classScanner
-            ]
+        $this->model = new PhpRule(
+            $this->mapRoutes,
+            $this->mapLayoutBlocks,
+            $this->webApiConfigReader,
+            $this->pluginMap,
+            $this->whitelist,
+            $this->classScanner
         );
     }
 
@@ -225,6 +228,7 @@ public function getDependencyInfoDataProvider()
         ];
     }
 
+
     /**
      * @param string $class
      * @param string $content
@@ -265,12 +269,17 @@ public function getDependencyInfoDataCaseGetUrlDataProvider()
                     ]
                 ]
             ],
-            'getUrl from API of same module' => [
+            'getUrl from API of same module with parameter' => [
                 'Magento\Catalog\SomeClass',
                 '$this->getUrl("rest/V1/products/3")',
                 []
             ],
-            'getUrl from API of different module' => [
+            'getUrl from API of same module without parameter' => [
+                'Magento\Catalog\SomeClass',
+                '$this->getUrl("rest/V1/products")',
+                []
+            ],
+            'getUrl from API of different module with parameter' => [
                 'Magento\Backend\SomeClass',
                 '$this->getUrl("rest/V1/products/43/options")',
                 [
@@ -281,7 +290,7 @@ public function getDependencyInfoDataCaseGetUrlDataProvider()
                     ]
                 ],
             ],
-            'getUrl from routeid wildcard in controller' => [
+            'getUrl from routeid wildcard' => [
                 'Magento\Catalog\Controller\ControllerName\SomeClass',
                 '$this->getUrl("*/Invalid/*")',
                 []
@@ -291,19 +300,112 @@ public function getDependencyInfoDataCaseGetUrlDataProvider()
                 '$this->getUrl("Catalog/*/View")',
                 []
             ],
-            'getUrl from wildcard url within ignored Block class' => [
-                'Magento\Cms\Block\SomeClass',
+            'getUrl from wildcard url within ignored Model file' => [
+                'Magento\Cms\Model\SomeClass',
                 '$this->getUrl("Catalog/*/View")',
                 []
             ],
-            'getUrl from wildcard url for ControllerName' => [
-                'Magento\Catalog\Controller\Category\IGNORE',
-                '$this->getUrl("Catalog/*/View")',
+            'getUrl with in admin controller for controllerName wildcard' => [
+                'Magento\Backend\Controller\Adminhtml\System\Store\DeleteStore',
+                '$this->getUrl("adminhtml/*/deleteStorePost")',
                 []
             ],
         ];
     }
 
+
+    /**
+     * @param string $template
+     * @param string $content
+     * @param array $expected
+     * @throws \Exception
+     * @dataProvider getDependencyInfoDataCaseGetTemplateUrlDataProvider
+     */
+    public function testGetDependencyInfoCaseTemplateGetUrl(
+        string $template,
+        string $content,
+        array $expected
+    ) {
+        $module = $this->getModuleFromClass($template);
+
+        $this->assertEquals($expected, $this->model->getDependencyInfo($module, 'php', $template, $content));
+    }
+
+    public function getDependencyInfoDataCaseGetTemplateUrlDataProvider()
+    {
+        return [ 'getUrl from ignore template' => [
+            'app/code/Magento/Backend/view/adminhtml/templates/dashboard/totalbar/script.phtml',
+            '$getUrl("adminhtml/*/ajaxBlock"',
+            []]];
+    }
+
+    /**
+     * @param string $class
+     * @param string $content
+     * @param array $expected
+     * @dataProvider processWildcardUrlDataProvider
+     */
+    public function testProcessWildcardUrl(
+        string $class,
+        string $content,
+        array $expected
+    ) {
+        $routeMapper = $this->createMock(RouteMapper::class);
+        $routeMapper->expects($this->once())
+            ->method('getDependencyByRoutePath')
+            ->with(
+                $this->equalTo($expected['route_id']),
+                $this->equalTo($expected['controller_name']),
+                $this->equalTo($expected['action_name'])
+            );
+        $phpRule = new PhpRule(
+            $this->mapRoutes,
+            $this->mapLayoutBlocks,
+            $this->webApiConfigReader,
+            $this->pluginMap,
+            $this->whitelist,
+            $this->classScanner,
+            $routeMapper
+        );
+        $file = $this->makeMockFilepath($class);
+        $module = $this->getModuleFromClass($class);
+
+        $phpRule->getDependencyInfo($module, 'php', $file, $content);
+    }
+
+    public function processWildcardUrlDataProvider()
+    {
+        return [
+            'wildcard controller route' => [
+                'Magento\SomeModule\Controller\ControllerName\SomeClass',
+                '$this->getUrl("cms/*/index")',
+                [
+                    'route_id' => 'cms',
+                    'controller_name' => 'controllername',
+                    'action_name' => 'index'
+                ]
+            ],
+            'adminhtml wildcard controller route' => [
+                'Magento\Backend\Controller\Adminhtml\System\Store\DeleteStore',
+                '$this->getUrl("adminhtml/*/deleteStorePost")',
+                    [
+                        'route_id' => 'adminhtml',
+                        'controller_name' => 'system_store',
+                        'action_name' => 'deletestorepost'
+                    ]
+            ],
+            'index wildcard' => [
+                'Magento\Backend\Controller\System\Store\DeleteStore',
+                '$this->getUrl("routeid/controllername/*")',
+                [
+                    'route_id' => 'routeid',
+                    'controller_name' => 'controllername',
+                    'action_name' => 'deletestore'
+                ]
+            ]
+        ];
+    }
+
     /**
      * @param string $class
      * @param string $content
@@ -427,6 +529,10 @@ private function makeWebApiConfigReaderMock()
             '/V1/products/:sku/options' => ['GET' => ['service' => [
                 'class' => 'Magento\Catalog\Api\ProductCustomOptionRepositoryInterface',
                 'method' => 'getList'
+            ] ] ],
+            '/V1/products' => ['GET' => ['service' => [
+                'class' => 'Magento\Catalog\Api\ProductCustomOptionRepositoryInterface',
+                'method' => 'getList'
             ] ] ]
         ] ];