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

Apply code review changes.

Author: oleksandrkravchuk

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

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestFramework\Utility;
+
+/**
+ * Helper class to add list of added new files.
+ */
+class AddedFiles
+{
+    /**
+     * Provide list of new files.
+     *
+     * @param $changedFilesBaseDir
+     *
+     * @return string[]
+     */
+    public static function getAddedFilesList(string $changedFilesBaseDir): array
+    {
+        return FilesSearch::getFilesFromListFile(
+            $changedFilesBaseDir,
+            'changed_files*.added.*',
+            function () {
+                // if no list files, probably, this is the dev environment
+                // phpcs:ignore Generic.PHP.NoSilencedErrors,Magento2.Security.InsecureFunction
+                @exec('git diff --cached --name-only --diff-filter=A', $addedFiles);
+                return $addedFiles;
+            }
+        );
+    }
+}

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

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestFramework\Utility;
+
+/**
+ * Helper class to search files by provided directory and file pattern.
+ */
+class FilesSearch
+{
+    /**
+     * Read files from generated lists.
+     *
+     * @param string $listsBaseDir
+     * @param string $listFilePattern
+     * @param callable $noListCallback
+     * @return string[]
+     */
+    public static function getFilesFromListFile(
+        string $listsBaseDir,
+        string $listFilePattern,
+        callable $noListCallback
+    ): array {
+        $filesDefinedInList = [];
+        $listFiles = glob($listsBaseDir . '/_files/' . $listFilePattern);
+        if (!empty($listFiles)) {
+            foreach ($listFiles as $listFile) {
+                $filesDefinedInList[] = file($listFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+            }
+            $filesDefinedInList = array_merge([], ...$filesDefinedInList);
+        } else {
+            $filesDefinedInList = call_user_func($noListCallback);
+        }
+        array_walk(
+            $filesDefinedInList,
+            function (&$file) {
+                $file = BP . '/' . $file;
+            }
+        );
+        $filesDefinedInList = array_values(array_unique($filesDefinedInList));
+
+        return $filesDefinedInList;
+    }
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+class A
+{
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+class B extends A
+{
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+class C implements Z
+{
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+class D
+{
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+class E extends B
+{
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+class F extends E implements Z
+{
+}

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

@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\TestFramework\Utility\ChildrenClassesSearch;
+
+interface Z
+{
+}

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

@@ -3,11 +3,17 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\TestFramework\Utility;
 
-use Magento\Framework\App\Action\AbstractAction;
+use Magento\TestFramework\Utility\ChildrenClassesSearch\A;
+use Magento\TestFramework\Utility\ChildrenClassesSearch\B;
+use Magento\TestFramework\Utility\ChildrenClassesSearch\E;
+use Magento\TestFramework\Utility\ChildrenClassesSearch\F;
+use PHPUnit\Framework\TestCase;
 
-class ChildrenClassesSearchTest extends \PHPUnit\Framework\TestCase
+class ChildrenClassesSearchTest extends TestCase
 {
     /**
      * @var ChildrenClassesSearch
@@ -22,18 +28,27 @@ protected function setUp(): void
     public function testChildrenSearch(): void
     {
         $files = [
-            __DIR__ . '/PartialNamespace/Foo.php',
-            __DIR__ . '/PartialNamespace/Bar.php',
-            __DIR__ . '/PartialNamespace/Baz.php',
+            __DIR__ . '/ChildrenClassesSearch/A.php',
+            __DIR__ . '/ChildrenClassesSearch/B.php',
+            __DIR__ . '/ChildrenClassesSearch/C.php',
+            __DIR__ . '/ChildrenClassesSearch/D.php',
+            __DIR__ . '/ChildrenClassesSearch/E.php',
+            __DIR__ . '/ChildrenClassesSearch/F.php',
+            __DIR__ . '/ChildrenClassesSearch/Z.php',
         ];
 
         $found = $this->childrenClassesSearch->getClassesWhichAreChildrenOf(
             $files,
-            AbstractAction::class,
+            A::class,
             false
         );
 
-        $this->assertCount(1, $found);
-        $this->assertEquals(current($found), \Magento\TestFramework\Utility\PartialNamespace\Foo::class);
+        $expected = [
+            B::class,
+            E::class,
+            F::class
+        ];
+
+        $this->assertSame($expected, $found);
     }
 }