Merge branch '2.4-develop' into PR_L3_06_04_2022

Author: veloraven

dev/tests/integration/framework/Magento/TestFramework/Fixture/LegacyDataFixture.php

@@ -66,7 +66,9 @@ private function execute(string $filePath): void
             require $filePath;
         } catch (\Throwable $e) {
             throw new \Exception(
-                'Error in fixture ' . $filePath . PHP_EOL . $e->getTraceAsString(),
+                'Error in fixture: ' . $filePath
+                . PHP_EOL . $e->getMessage()
+                . PHP_EOL . $e->getTraceAsString(),
                 0,
                 $e
             );

dev/tests/static/testsuite/Magento/Test/Integrity/ParameterizedFixtureTest.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+
+namespace Magento\Test\Integrity;
+
+use Magento\Framework\Component\ComponentRegistrar;
+use Magento\TestFramework\Fixture\DataFixtureInterface;
+use Magento\TestFramework\Utility\AddedFiles;
+use Magento\TestFramework\Utility\ClassNameExtractor;
+use PHPUnit\Framework\TestCase;
+use ReflectionClass;
+use ReflectionException;
+
+/**
+ * Static test for legacy data fixtures
+ */
+class ParameterizedFixtureTest extends TestCase
+{
+    /**
+     * Validates parameterized data fixtures location
+     *
+     * @return void
+     */
+    public function testLocation(): void
+    {
+        $classNameExtractor = new ClassNameExtractor();
+        $files = AddedFiles::getAddedFilesList(__DIR__ . '/..');
+        $errors = [];
+        foreach ($files as $file) {
+            if (pathinfo($file, PATHINFO_EXTENSION) !== 'php' || !file_exists($file)) {
+                continue;
+            }
+            $path = str_replace(BP . '/', '', $file);
+            $errorMessage = "Parameterized data fixture $path MUST be placed in {{ModuleAppDir}}/Test/Fixture folder";
+            $class = $classNameExtractor->getNameWithNamespace(file_get_contents($file));
+            if ($class) {
+                try {
+                    $classReflection = new ReflectionClass($class);
+                    if (!$classReflection->isSubclassOf(DataFixtureInterface::class)) {
+                        continue;
+                    }
+                } catch (ReflectionException $exception) {
+                    $errors[]  = $errorMessage;
+                    continue;
+                }
+
+                if (!$this->isFileLocatedInModuleDirectory($file)) {
+                    $errors[]  = $errorMessage;
+                }
+            }
+        }
+        if (!empty($errors)) {
+            $this->fail(implode(PHP_EOL, $errors));
+        }
+    }
+
+    /**
+     * @param string $file
+     * @return bool
+     */
+    private function isFileLocatedInModuleDirectory(string $file): bool
+    {
+        $componentRegistrar = new ComponentRegistrar();
+        $found = false;
+        foreach ($componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleDir) {
+            if ($file === $moduleDir . '/Test/Fixture/' . basename($file)) {
+                $found = true;
+                break;
+            }
+        }
+        return $found;
+    }
+}

dev/tests/static/testsuite/Magento/Test/Legacy/LegacyFixtureTest.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Test\Legacy;
+
+use Magento\TestFramework\Utility\AddedFiles;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Static test for parameterized data fixtures
+ */
+class LegacyFixtureTest extends TestCase
+{
+    /**
+     * Prevent creating new fixture files
+     *
+     * @return void
+     */
+    public function testNew(): void
+    {
+        $docUrl = 'https://devdocs.magento.com/guides/v2.4/test/integration/parameterized_data_fixture.html';
+        $files = AddedFiles::getAddedFilesList(__DIR__ . '/..');
+        $legacyFixtureFiles = [];
+        foreach ($files as $file) {
+            if (pathinfo($file, PATHINFO_EXTENSION) === 'php'
+                && preg_match('/(Test|integration\/testsuite|api-functional\/testsuite).*\/(_files|Fixtures)/', $file)
+            ) {
+                $legacyFixtureFiles[] = str_replace(BP . '/', '', $file);
+            }
+        }
+
+        $this->assertCount(
+            0,
+            $legacyFixtureFiles,
+            "The format used for creating fixtures is deprecated. Please use parameterized fixture format.\n"
+            . "For details please look at $docUrl.\r\n"
+            . "The following fixture files were added:\r\n"
+            . implode(PHP_EOL, $legacyFixtureFiles)
+        );
+    }
+}