ENGCOM-7279: Fix Magento Integrity Dependency test in case to be used not in scope of app/code isntallation. #27578

Author: slavvka

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

@@ -12,6 +12,7 @@
 use Magento\Framework\App\Utility\Files;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\UrlInterface;
+use Magento\TestFramework\Dependency\Reader\ClassScanner;
 use Magento\TestFramework\Dependency\Route\RouteMapper;
 use Magento\TestFramework\Exception\NoSuchActionException;
 
@@ -79,24 +80,33 @@ class PhpRule implements RuleInterface
      */
     private $whitelists;
 
+    /**
+     * @var ClassScanner
+     */
+    private $classScanner;
+
     /**
      * @param array $mapRouters
      * @param array $mapLayoutBlocks
      * @param array $pluginMap
      * @param array $whitelists
-     * @throws \Exception
+     * @param ClassScanner|null $classScanner
+     *
+     * @throws LocalizedException
      */
     public function __construct(
         array $mapRouters,
         array $mapLayoutBlocks,
         array $pluginMap = [],
-        array $whitelists = []
+        array $whitelists = [],
+        ClassScanner $classScanner = null
     ) {
         $this->_mapRouters = $mapRouters;
         $this->_mapLayoutBlocks = $mapLayoutBlocks;
         $this->pluginMap = $pluginMap ?: null;
         $this->routeMapper = new RouteMapper();
         $this->whitelists = $whitelists;
+        $this->classScanner = $classScanner ?? new ClassScanner();
     }
 
     /**
@@ -176,7 +186,7 @@ private function caseClassesAndIdentifiers($currentModule, $file, &$contents)
             if (empty($matches['class_inside_module'][$i]) && !empty($matches['module_scoped_key'][$i])) {
                 $dependencyType = RuleInterface::TYPE_SOFT;
             } else {
-                $currentClass = $this->getClassFromFilepath($file, $currentModule);
+                $currentClass = $this->getClassFromFilepath($file);
                 $dependencyType = $this->isPluginDependency($currentClass, $dependencyClass)
                     ? RuleInterface::TYPE_SOFT
                     : RuleInterface::TYPE_HARD;
@@ -196,14 +206,11 @@ private function caseClassesAndIdentifiers($currentModule, $file, &$contents)
      * Get class name from filename based on class/file naming conventions
      *
      * @param string $filepath
-     * @param string $module
      * @return string
      */
-    private function getClassFromFilepath($filepath, $module)
+    private function getClassFromFilepath(string $filepath): string
     {
-        $class = strstr($filepath, str_replace(['_', '\\', '/'], DIRECTORY_SEPARATOR, $module));
-        $class = str_replace(DIRECTORY_SEPARATOR, '\\', strstr($class, '.php', true));
-        return $class;
+        return $this->classScanner->getClassName($filepath);
     }
 
     /**
@@ -267,7 +274,8 @@ private function isPluginDependency($dependent, $dependency)
         if ($subject === $dependency) {
             return true;
         } elseif ($subject) {
-            $subjectModule = substr($subject, 0, strpos($subject, '\\', 9)); // (strlen('Magento\\') + 1) === 9
+            $moduleNameLength = strpos($subject, '\\', strpos($subject, '\\') + 1);
+            $subjectModule = substr($subject, 0, $moduleNameLength);
             return strpos($dependency, $subjectModule) === 0;
         } else {
             return false;

dev/tests/static/framework/Magento/TestFramework/Dependency/Reader/ClassScanner.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestFramework\Dependency\Reader;
+
+use Magento\Setup\Module\Di\Code\Reader\FileClassScanner;
+
+/**
+ * Search classes in file by path.
+ */
+class ClassScanner
+{
+    /**
+     * @var string[]
+     */
+    private $classNames = [];
+
+    /**
+     * Get class name by file name.
+     *
+     * @param string $filePath
+     *
+     * @return string
+     */
+    public function getClassName(string $filePath): string
+    {
+        if (!isset($this->classNames[$filePath])) {
+            $this->classNames[$filePath] = $this->loadClassName($filePath);
+        }
+
+        return $this->classNames[$filePath];
+    }
+
+    /**
+     * Load class name from file.
+     *
+     * @param string $filePath
+     *
+     * @return string
+     */
+    private function loadClassName(string $filePath): string
+    {
+        $scanner = new FileClassScanner($filePath);
+        return $scanner->getClassName();
+    }
+}

dev/tests/static/framework/autoload.php

@@ -34,3 +34,6 @@
 
 $generatedCode = DirectoryList::getDefaultConfig()[DirectoryList::GENERATED_CODE][DirectoryList::PATH];
 $autoloadWrapper->addPsr4('Magento\\', $baseDir . '/' . $generatedCode . '/Magento/');
+
+$setup = DirectoryList::getDefaultConfig()[DirectoryList::SETUP][DirectoryList::PATH];
+$autoloadWrapper->addPsr4('Magento\\Setup\\', $baseDir . '/' . $setup . '/Magento/Setup/');

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

@@ -7,6 +7,7 @@
 
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
+use Magento\TestFramework\Dependency\Reader\ClassScanner;
 use Magento\TestFramework\Exception\NoSuchActionException;
 
 /**
@@ -24,6 +25,11 @@ class PhpRuleTest extends \PHPUnit\Framework\TestCase
      */
     private $objectManagerHelper;
 
+    /**
+     * @var ClassScanner
+     */
+    private $classScanner;
+
     /**
      * @inheritDoc
      * @throws \Exception
@@ -39,13 +45,16 @@ protected function setUp()
         $whitelist = [];
 
         $this->objectManagerHelper = new ObjectManagerHelper($this);
+        $this->classScanner = $this->createMock(ClassScanner::class);
+
         $this->model = $this->objectManagerHelper->getObject(
             PhpRule::class,
             [
                 'mapRouters' => $mapRoutes,
                 'mapLayoutBlocks' => $mapLayoutBlocks,
                 'pluginMap' => $pluginMap,
                 'whitelists' => $whitelist,
+                'classScanner' => $this->classScanner
             ]
         );
     }
@@ -62,14 +71,20 @@ public function testNonPhpGetDependencyInfo()
     /**
      * @param string $class
      * @param string $content
+     * @param int $expectedScans
      * @param array $expected
-     * @dataProvider getDependencyInfoDataProvider
+     *
      * @throws \Exception
+     * @dataProvider getDependencyInfoDataProvider
      */
-    public function testGetDependencyInfo($class, $content, array $expected)
+    public function testGetDependencyInfo(string $class, string $content, int $expectedScans, array $expected): void
     {
         $file = $this->makeMockFilepath($class);
         $module = $this->getModuleFromClass($class);
+        $this->classScanner->expects($this->exactly($expectedScans))
+            ->method('getClassName')
+            ->with($file)
+            ->willReturn($class);
         $this->assertEquals($expected, $this->model->getDependencyInfo($module, 'php', $file, $content));
     }
 
@@ -82,11 +97,13 @@ public function getDependencyInfoDataProvider()
             'Extend class in same module' => [
                 'Magento\SomeModule\SomeClass',
                 'something extends \Magento\SomeModule\Any\ClassName {',
+                0,
                 []
             ],
             'Extend class in different module' => [
                 'Magento\AnotherModule\SomeClass',
                 'something extends \Magento\SomeModule\Any\ClassName {',
+                1,
                 [
                     [
                         'modules' => ['Magento\SomeModule'],
@@ -98,11 +115,13 @@ public function getDependencyInfoDataProvider()
             'getViewFileUrl in same module' => [
                 'Magento\SomeModule\SomeClass',
                 '$this->getViewFileUrl("Magento_SomeModule::js/order-by-sku-failure.js")',
+                0,
                 []
             ],
             'getViewFileUrl in different module' => [
                 'Magento\AnotherModule\SomeClass',
                 '$this->getViewFileUrl("Magento_SomeModule::js/order-by-sku-failure.js")',
+                1,
                 [
                     [
                         'modules' => ['Magento\SomeModule'],
@@ -114,11 +133,13 @@ public function getDependencyInfoDataProvider()
             'Helper class from same module' => [
                 'Magento\SomeModule\SomeClass',
                 '$this->helper("Magento\SomeModule\Any\ClassName")',
+                0,
                 []
             ],
             'Helper class from another module' => [
                 'Magento\AnotherModule\SomeClass',
                 '$this->helper("Magento\SomeModule\Any\ClassName")',
+                1,
                 [
                     [
                         'modules' => ['Magento\SomeModule'],
@@ -129,11 +150,14 @@ public function getDependencyInfoDataProvider()
             ],
             'getBlock from same module' => [
                 'Magento\SomeModule\SomeClass',
-                '$this->getLayout()->getBlock(\'block.name\');', []
+                '$this->getLayout()->getBlock(\'block.name\');',
+                0,
+                []
             ],
             'getBlock from another module' => [
                 'Magento\AnotherModule\SomeClass',
                 '$this->getLayout()->getBlock(\'block.name\');',
+                0,
                 [
                     [
                         'modules' => ['Magento\SomeModule'],
@@ -145,16 +169,19 @@ public function getDependencyInfoDataProvider()
             'Plugin on class in same module' => [
                 'Magento\Module1\Plugin1',
                 ', \Magento\Module1\Subject $variable',
+                0,
                 []
             ],
             'Plugin depends on arbitrary class in same module' => [
                 'Magento\Module1\Plugin1',
                 ', \Magento\Module1\NotSubject $variable',
+                0,
                 []
             ],
             'Plugin on class in different module' => [
                 'Magento\Module1\Plugin2',
                 'Magento\Module2\Subject',
+                1,
                 [
                     [
                         'modules' => ['Magento\Module2'],
@@ -166,6 +193,7 @@ public function getDependencyInfoDataProvider()
             'Plugin depends on arbitrary class in same module as subject' => [
                 'Magento\Module1\Plugin2',
                 'Magento\Module2\NotSubject',
+                1,
                 [
                     [
                         'modules' => ['Magento\Module2'],
@@ -177,6 +205,7 @@ public function getDependencyInfoDataProvider()
             'Plugin depends on arbitrary class in arbitrary module' => [
                 'Magento\Module1\Plugin2',
                 'Magento\OtherModule\NotSubject',
+                1,
                 [
                     [
                         'modules' => ['Magento\OtherModule'],
@@ -322,8 +351,9 @@ private function makeMockFilepath($class)
      * @param string $class
      * @return string
      */
-    private function getModuleFromClass($class)
+    private function getModuleFromClass(string $class): string
     {
-        return substr($class, 0, strpos($class, '\\', 9)); // (strlen('Magento\\') + 1) === 9
+        $moduleNameLength = strpos($class, '\\', strpos($class, '\\') + 1);
+        return substr($class, 0, $moduleNameLength);
     }
 }