community-features#252 Create static test for action controllers.

Incapsulate logic in new class.
Add test coverage.

Author: oleksandrkravchuk

dev/tests/integration/etc/config-global.php.dist

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestFramework\Utility;
+
+/**
+ * Search for children classes in list of files.
+ */
+class ChildrenClassesSearch
+{
+    /**
+     * @var ClassNameExtractor
+     */
+    private $classNameExtractor;
+
+    public function __construct()
+    {
+        $this->classNameExtractor = new ClassNameExtractor();
+    }
+
+    /**
+     * Get list of classes name which are subclasses of mentioned class.
+     *
+     * @param array $fileList
+     * @param string $parent
+     * @param bool $asDataSet
+     *
+     * @return array
+     * @throws \ReflectionException
+     */
+    public function getClassesWhichAreChildrenOf(array $fileList, string $parent, bool $asDataSet = true): array
+    {
+        $found = [];
+
+        foreach ($fileList as $file) {
+            $name = $asDataSet ? $file[0] : $file;
+            $class = $this->classNameExtractor->getNameWithNamespace(file_get_contents($name));
+
+            if ($class) {
+                $classReflection = new \ReflectionClass($class);
+                if ($classReflection->isSubclassOf($parent)) {
+                    $found[] = $class;
+                }
+            }
+        }
+
+        return $found;
+    }
+}

dev/tests/static/framework/Magento/TestFramework/Utility/ChildrenClassesSearch.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility;
+
+use Magento\Framework\App\Action\AbstractAction;
+
+class ChildrenClassesSearchTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var ChildrenClassesSearch
+     */
+    private $childrenClassesSearch;
+
+    protected function setUp(): void
+    {
+        $this->childrenClassesSearch = new ChildrenClassesSearch();
+    }
+
+    public function testChildrenSearch(): void
+    {
+        $files = [
+            __DIR__ . '/PartialNamespace/Foo.php',
+            __DIR__ . '/PartialNamespace/Bar.php',
+            __DIR__ . '/PartialNamespace/Baz.php',
+        ];
+
+        $found = $this->childrenClassesSearch->getClassesWhichAreChildrenOf(
+            $files,
+            AbstractAction::class,
+            false
+        );
+
+        $this->assertCount(1, $found);
+        $this->assertEquals(current($found), \Magento\TestFramework\Utility\PartialNamespace\Foo::class);
+    }
+}

dev/tests/static/framework/tests/unit/testsuite/Magento/TestFramework/Utility/ChildrenClassesSearchTest.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\PartialNamespace;
+
+use Magento\Framework\App\ActionInterface;
+use Magento\Framework\App\ResponseInterface;
+
+class Baz implements ActionInterface
+{
+    /**
+     * Execute action based on request and return result
+     *
+     * @return \Magento\Framework\Controller\ResultInterface|ResponseInterface
+     * @throws \Magento\Framework\Exception\NotFoundException
+     */
+    public function execute()
+    {
+
+    }
+}

dev/tests/static/framework/tests/unit/testsuite/Magento/TestFramework/Utility/PartialNamespace/Baz.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\PartialNamespace;
+
+use Magento\Framework\App\Action\AbstractAction;
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\App\ResponseInterface;
+
+class Foo extends AbstractAction
+{
+    /**
+     * Dispatch request
+     *
+     * @param RequestInterface $request
+     *
+     * @return ResponseInterface
+     */
+    public function dispatch(RequestInterface $request)
+    {
+    }
+
+    /**
+     * Execute action based on request and return result
+     *
+     * @return \Magento\Framework\Controller\ResultInterface|ResponseInterface
+     * @throws \Magento\Framework\Exception\NotFoundException
+     */
+    public function execute()
+    {
+    }
+}

dev/tests/static/framework/tests/unit/testsuite/Magento/TestFramework/Utility/PartialNamespace/Foo.php

@@ -7,24 +7,22 @@
 
 namespace Magento\Test\Legacy\Magento\Framework\App\Action;
 
-use Exception;
 use Magento\Framework\App\Action\AbstractAction;
 use Magento\Framework\App\ActionInterface;
 use Magento\Framework\App\Utility\Files;
 use Magento\Framework\Exception\LocalizedException;
-use Magento\TestFramework\Utility\ClassNameExtractor;
+use Magento\TestFramework\Utility\ChildrenClassesSearch;
 use PHPUnit\Framework\TestCase;
-use ReflectionClass;
 
 /**
  * Test newly created controllers must do not extend AbstractAction.
  */
 class AbstractActionTest extends TestCase
 {
     /**
-     * @var ClassNameExtractor
+     * @var ChildrenClassesSearch
      */
-    private $classNameExtractor;
+    private $childrenClassesSearch;
 
     /**
      * @var Files
@@ -36,32 +34,20 @@ class AbstractActionTest extends TestCase
      */
     protected function setUp(): void
     {
-        $this->classNameExtractor = new ClassNameExtractor();
+        $this->childrenClassesSearch = new ChildrenClassesSearch();
         $this->fileUtilities = Files::init();
     }
 
     /**
      * Test newly created controllers do not extend deprecated AbstractAction.
+     *
+     * @throws \ReflectionException
      */
     public function testNewControllersDoNotExtendAbstractAction(): void
     {
         $files = $this->getTestFiles();
-        $found = [];
-
-        foreach ($files as $file) {
-            $class = $this->classNameExtractor->getNameWithNamespace(file_get_contents($file[0]));
 
-            if ($class) {
-                try {
-                    $classReflection = new  ReflectionClass($class);
-                    if ($classReflection->isSubclassOf(AbstractAction::class)) {
-                        $found[] = $class;
-                    }
-                } catch (Exception $exception) {
-                    $this->addWarning('Skipped due to exception: ' . $class);
-                }
-            }
-        }
+        $found = $this->childrenClassesSearch->getClassesWhichAreChildrenOf($files, AbstractAction::class);
 
         $this->assertEmpty(
             $found,