Merge pull request magento#2498 from magento-borg/DEVOPS-2174-2.2

Fixed issues:
- DEVOPS-232 Static Testing in Jenkins
- MAGETWO-89342 Backport fixes for broken L3 builds on B2B

Author: slavvka

dev/tests/integration/framework/Magento/TestFramework/Annotation/DataFixture.php

@@ -9,6 +9,8 @@
  */
 namespace Magento\TestFramework\Annotation;
 
+use PHPUnit\Framework\Exception;
+
 class DataFixture
 {
     /**
@@ -171,8 +173,13 @@ protected function _applyOneFixture($fixture)
                 require $fixture;
             }
         } catch (\Exception $e) {
-            throw new \Exception(
-                sprintf("Error in fixture: %s.\n %s", json_encode($fixture), $e->getMessage()),
+            throw new Exception(
+                sprintf(
+                    "Error in fixture: %s.\n %s\n %s",
+                    json_encode($fixture),
+                    $e->getMessage(),
+                    $e->getTraceAsString()
+                ),
                 500,
                 $e
             );

dev/tests/integration/framework/Magento/TestFramework/Annotation/DataFixtureBeforeTransaction.php

@@ -9,6 +9,8 @@
  */
 namespace Magento\TestFramework\Annotation;
 
+use PHPUnit\Framework\Exception;
+
 class DataFixtureBeforeTransaction
 {
     /**
@@ -138,8 +140,15 @@ protected function _applyOneFixture($fixture)
                 require $fixture;
             }
         } catch (\Exception $e) {
-            throw new \Exception(
-                sprintf("Error in fixture: %s.\n %s", json_encode($fixture), (string)$e)
+            throw new Exception(
+                sprintf(
+                    "Error in fixture: %s.\n %s\n %s",
+                    json_encode($fixture),
+                    $e->getMessage(),
+                    $e->getTraceAsString()
+                ),
+                500,
+                $e
             );
         }
     }

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

@@ -41,6 +41,16 @@ class ComposerTest extends \PHPUnit\Framework\TestCase
      */
     private static $objectManager;
 
+    /**
+     * @var string[]
+     */
+    private static $rootComposerModuleBlacklist = [];
+
+    /**
+     * @var string[]
+     */
+    private static $moduleNameBlacklist;
+
     public static function setUpBeforeClass()
     {
         self::$root = BP;
@@ -52,6 +62,26 @@ public static function setUpBeforeClass()
         }
         self::$dependencies = [];
         self::$objectManager = Bootstrap::create(BP, $_SERVER)->getObjectManager();
+        // A block can be whitelisted and thus not be required to be public
+        self::$rootComposerModuleBlacklist = self::getBlacklist(
+            __DIR__ . '/_files/blacklist/composer_root_modules*.txt'
+        );
+        self::$moduleNameBlacklist = self::getBlacklist(__DIR__ . '/_files/blacklist/composer_module_names*.txt');
+    }
+
+    /**
+     * Return aggregated blacklist
+     *
+     * @param string $pattern
+     * @return string[]
+     */
+    public static function getBlacklist(string $pattern)
+    {
+        $blacklist = [];
+        foreach (glob($pattern) as $list) {
+            $blacklist = array_merge($blacklist, file($list, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES));
+        }
+        return $blacklist;
     }
 
     public function testValidComposerJson()
@@ -248,12 +278,15 @@ private function assertNoMap(\StdClass $json)
      */
     private function assertConsistentModuleName(\SimpleXMLElement $xml, $packageName)
     {
-        $moduleName = (string)$xml->module->attributes()->name;
-        $this->assertEquals(
-            $packageName,
-            $this->convertModuleToPackageName($moduleName),
-            "For the module '{$moduleName}', the expected package name is '{$packageName}'"
-        );
+        if (!in_array($packageName, self::$moduleNameBlacklist)) {
+            $moduleName = (string)$xml->module->attributes()->name;
+            $expectedPackageName = $this->convertModuleToPackageName($moduleName);
+            $this->assertEquals(
+                $expectedPackageName,
+                $packageName,
+                "For the module '{$moduleName}', the expected package name is '{$expectedPackageName}'"
+            );
+        }
     }
 
     /**
@@ -314,36 +347,49 @@ private function assertPhpVersionInSync($name, $phpVersion)
      * Make sure requirements of components are reflected in root composer.json
      *
      * @param \StdClass $json
+     * @return void
      */
     private function assertRequireInSync(\StdClass $json)
     {
-        $name = $json->name;
         if (preg_match('/magento\/project-*/', self::$rootJson['name']) == 1) {
             return;
         }
-        if (isset($json->require)) {
-            $errors = [];
-            foreach (array_keys((array)$json->require) as $depName) {
-                if ($depName == 'magento/magento-composer-installer') {
-                    // Magento Composer Installer is not needed for already existing components
-                    continue;
-                }
-                if (!isset(self::$mainComposerModules[$depName])) {
-                    $errors[] = "'$name' depends on '$depName'";
-                }
+        if (!in_array($json->name, self::$rootComposerModuleBlacklist) && isset($json->require)) {
+            $this->checkPackageInRootComposer($json);
+        }
+    }
+
+    /**
+     * Check if package is reflected in root composer.json
+     *
+     * @param \StdClass $json
+     * @return void
+     */
+    private function checkPackageInRootComposer(\StdClass $json)
+    {
+        $name = $json->name;
+        $errors = [];
+        foreach (array_keys((array)$json->require) as $depName) {
+            if ($depName == 'magento/magento-composer-installer') {
+                // Magento Composer Installer is not needed for already existing components
+                continue;
             }
 
-            if (!empty($errors)) {
-                $this->fail(
-                    "The following dependencies are missing in root 'composer.json',"
-                    . " while declared in child components.\n"
-                    . "Consider adding them to 'require-dev' section (if needed for child components only),"
-                    . " to 'replace' section (if they are present in the project),"
-                    . " to 'require' section (if needed for the skeleton).\n"
-                    . join("\n", $errors)
-                );
+            if (!isset(self::$rootJson['require-dev'][$depName]) && !isset(self::$rootJson['require'][$depName])
+                && !isset(self::$rootJson['replace'][$depName])) {
+                $errors[] = "'$name' depends on '$depName'";
             }
         }
+        if (!empty($errors)) {
+            $this->fail(
+                "The following dependencies are missing in root 'composer.json',"
+                . " while declared in child components.\n"
+                . "Consider adding them to 'require-dev' section (if needed for child components only),"
+                . " to 'replace' section (if they are present in the project),"
+                . " to 'require' section (if needed for the skeleton).\n"
+                . join("\n", $errors)
+            );
+        }
     }
 
     /**
@@ -386,6 +432,10 @@ private function assertPackageVersions(\StdClass $json)
      */
     private function checkDiscrepancy($componentConfig, $packageName)
     {
+        if (in_array($packageName, self::$rootComposerModuleBlacklist)) {
+            return false;
+        }
+
         $rootConstraint = (new VersionParser())->parseConstraints(self::$mainComposerModules[$packageName]);
         $componentConstraint = (new VersionParser())->parseConstraints($componentConfig->require->$packageName);
 
@@ -484,7 +534,11 @@ private function checkProject()
                 }
             }
             sort($dependenciesListed);
-            $nonDeclaredDependencies = array_diff(self::$dependencies, $dependenciesListed);
+            $nonDeclaredDependencies = array_diff(
+                self::$dependencies,
+                $dependenciesListed,
+                self::$rootComposerModuleBlacklist
+            );
             $nonexistentDependencies = array_diff($dependenciesListed, self::$dependencies);
             $this->assertEmpty(
                 $nonDeclaredDependencies,

dev/tests/static/testsuite/Magento/Test/Integrity/Di/CompilerTest.php

@@ -62,6 +62,11 @@ class CompilerTest extends \PHPUnit\Framework\TestCase
      */
     protected $pluginValidator;
 
+    /**
+     * @var string[]|null
+     */
+    private $pluginBlacklist;
+
     protected function setUp()
     {
         $this->_shell = new \Magento\Framework\Shell(new \Magento\Framework\Shell\CommandRenderer());
@@ -107,6 +112,31 @@ protected function setUp()
         $this->pluginValidator = new PluginValidator(new InterfaceValidator());
     }
 
+    /**
+     * Return plugin blacklist class names
+     *
+     * @return string[]
+     */
+    private function getPluginBlacklist(): array
+    {
+        if ($this->pluginBlacklist === null) {
+            $blacklistFiles = str_replace(
+                '\\',
+                '/',
+                realpath(__DIR__) . '/../_files/blacklist/compiler_plugins*.txt'
+            );
+            $blacklistItems = [];
+            foreach (glob($blacklistFiles) as $fileName) {
+                $blacklistItems = array_merge(
+                    $blacklistItems,
+                    file($fileName, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES)
+                );
+            }
+            $this->pluginBlacklist = $blacklistItems;
+        }
+        return $this->pluginBlacklist;
+    }
+
     /**
      * Validate DI config file
      *
@@ -360,6 +390,7 @@ protected function validatePlugins($plugin, $type)
      * Get application plugins
      *
      * @return array
+     * @throws \Exception
      */
     protected function pluginDataProvider()
     {
@@ -376,8 +407,10 @@ protected function pluginDataProvider()
                 $type = \Magento\Framework\App\Utility\Classes::resolveVirtualType($type);
                 if ($node->attributes->getNamedItem('type')) {
                     $plugin = $node->attributes->getNamedItem('type')->nodeValue;
-                    $plugin = \Magento\Framework\App\Utility\Classes::resolveVirtualType($plugin);
-                    $plugins[] = ['plugin' => $plugin, 'intercepted type' => $type];
+                    if (!in_array($plugin, $this->getPluginBlacklist())) {
+                        $plugin = \Magento\Framework\App\Utility\Classes::resolveVirtualType($plugin);
+                        $plugins[] = ['plugin' => $plugin, 'intercepted type' => $type];
+                    }
                 }
             }
         }

dev/tests/static/testsuite/Magento/Test/Integrity/Magento/Backend/ControllerAclTest.php

@@ -148,10 +148,10 @@ private function getAclResources()
         if ($this->aclResources !== null) {
             return $this->aclResources;
         }
-        $aclFiles = array_keys(Files::init()->getConfigFiles('acl.xml', []));
+        $aclFiles = Files::init()->getConfigFiles('acl.xml', []);
         $xmlResources = [];
         array_map(function ($file) use (&$xmlResources) {
-            $config = simplexml_load_file($file);
+            $config = simplexml_load_file($file[0]);
             $nodes = $config->xpath('.//resource/@id') ?: [];
             foreach ($nodes as $node) {
                 $xmlResources[(string)$node] = $node;

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

@@ -22,11 +22,42 @@ class PublicCodeTest extends \PHPUnit\Framework\TestCase
         '$this', 'void', 'string', 'int', 'bool', 'boolean', 'integer', 'null'
     ];
 
+    /**
+     * @var string[]|null
+     */
+    private $blockWhitelist;
+
+    /**
+     * Return whitelist class names
+     *
+     * @return string[]
+     */
+    private function getWhitelist(): array
+    {
+        if ($this->blockWhitelist === null) {
+            $whiteListFiles = str_replace(
+                '\\',
+                '/',
+                realpath(__DIR__) . '/_files/whitelist/public_code*.txt'
+            );
+            $whiteListItems = [];
+            foreach (glob($whiteListFiles) as $fileName) {
+                $whiteListItems = array_merge(
+                    $whiteListItems,
+                    file($fileName, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES)
+                );
+            }
+            $this->blockWhitelist = $whiteListItems;
+        }
+        return $this->blockWhitelist;
+    }
+
     /**
      * Since blocks can be referenced from templates, they should be stable not to break theme customizations.
      * So all blocks should be @api annotated. This test checks that all blocks declared in layout files are public
      *
      * @param $layoutFile
+     * @throws \ReflectionException
      * @dataProvider layoutFilesDataProvider
      */
     public function testAllBlocksReferencedInLayoutArePublic($layoutFile)
@@ -37,7 +68,7 @@ public function testAllBlocksReferencedInLayoutArePublic($layoutFile)
         /** @var $node \SimpleXMLElement */
         foreach ($elements as $node) {
             $class = (string) $node['class'];
-            if ($class && \class_exists($class)) {
+            if ($class && \class_exists($class) && !in_array($class, $this->getWhitelist())) {
                 $reflection = (new \ReflectionClass($class));
                 if (strpos($reflection->getDocComment(), '@api') === false) {
                     $nonPublishedBlocks[] = $class;
@@ -47,7 +78,7 @@ public function testAllBlocksReferencedInLayoutArePublic($layoutFile)
         if (count($nonPublishedBlocks)) {
             $this->fail(
                 "Layout file '$layoutFile' uses following blocks that are not marked with @api annotation:\n"
-                . implode(",\n", $nonPublishedBlocks)
+                . implode(",\n", array_unique($nonPublishedBlocks))
             );
         }
     }
@@ -56,6 +87,7 @@ public function testAllBlocksReferencedInLayoutArePublic($layoutFile)
      * Find all layout update files in magento modules and themes.
      *
      * @return array
+     * @throws \Exception
      */
     public function layoutFilesDataProvider()
     {
@@ -68,8 +100,8 @@ public function layoutFilesDataProvider()
      * This test walks through all public PHP types and makes sure that all their method arguments
      * and return values are public types.
      *
-     *
      * @param string $class
+     * @throws \ReflectionException
      * @dataProvider publicPHPTypesDataProvider
      */
     public function testAllPHPClassesReferencedFromPublicClassesArePublic($class)
@@ -102,14 +134,15 @@ public function testAllPHPClassesReferencedFromPublicClassesArePublic($class)
         if (count($nonPublishedClasses)) {
             $this->fail(
                 "Public type '" . $class . "' references following non-public types:\n"
-                . implode("\n", $nonPublishedClasses)
+                . implode("\n", array_unique($nonPublishedClasses))
             );
         }
     }
 
     /**
      * Retrieve list of all interfaces and classes in Magento codebase that are marked with @api annotation.
      * @return array
+     * @throws \Exception
      */
     public function publicPHPTypesDataProvider()
     {
@@ -119,7 +152,9 @@ public function publicPHPTypesDataProvider()
             $fileContents = \file_get_contents($file);
             if (strpos($fileContents, '@api') !== false) {
                 foreach ($this->getDeclaredClassesAndInterfaces($file) as $class) {
-                    if (class_exists($class->getName()) || interface_exists($class->getName())) {
+                    if (!in_array($class->getName(), $this->getWhitelist())
+                        && (class_exists($class->getName()) || interface_exists($class->getName()))
+                    ) {
                         $result[$class->getName()] = [$class->getName()];
                     }
                 }