Merge pull request #721 from magento/MQE-2135

MQE-2135: MFTF static check output directory should not depend on current working directory

Author: jilu1

.gitignore

@@ -19,4 +19,4 @@ dev/tests/mftf.log
 dev/tests/docs/*
 dev/tests/_output
 dev/tests/functional.suite.yml
-mftf-annotations-static-check.txt
+

docs/commands/mftf.md

@@ -430,13 +430,15 @@ The example parameters are taken from the `etc/config/.env.example` file.
 
 ### `static-checks`
 
-Runs all or specific MFTF static-checks on the test codebase that MFTF is currently attached to.
+Runs all or specific MFTF static-checks on the test codebase that MFTF is currently attached to. 
 Behavior for determining what tests to run is as follows:
 
 *  If test names are specified, only those tests are run.
 *  If no test names are specified, tests are run according to `staticRuleset.json`.
 *  If no `staticRuleset.json` is found, all tests are run.
 
+Static checks errors are written to *.txt files under TEST_BP/tests/_output/static-results/
+
 #### Usage
 
 ```bash

src/Magento/FunctionalTestingFramework/StaticCheck/ActionGroupArgumentsCheck.php

@@ -65,7 +65,7 @@ public function execute(InputInterface $input)
 
         $this->output = $this->scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/StaticCheck/AnnotationsCheck.php

@@ -85,7 +85,7 @@ public function execute(InputInterface $input)
         $scriptUtil = new ScriptUtil();
         $this->output = $scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/StaticCheck/DeprecatedEntityUsageCheck.php

@@ -128,7 +128,7 @@ public function execute(InputInterface $input)
         // Hold on to the output and print any errors to a file
         $this->output = $this->scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/StaticCheck/StaticChecksList.php

@@ -7,13 +7,17 @@
 
 namespace Magento\FunctionalTestingFramework\StaticCheck;
 
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
+use Magento\FunctionalTestingFramework\Util\Path\FilePathFormatter;
+
 /**
  * Class StaticChecksList has a list of static checks to run on test xml
  * @codingStandardsIgnoreFile
  */
 class StaticChecksList implements StaticCheckListInterface
 {
     const DEPRECATED_ENTITY_USAGE_CHECK_NAME = 'deprecatedEntityUsage';
+    const STATIC_RESULTS = 'tests' . DIRECTORY_SEPARATOR .'_output' . DIRECTORY_SEPARATOR . 'static-results';
 
     /**
      * Property contains all static check scripts.
@@ -22,10 +26,18 @@ class StaticChecksList implements StaticCheckListInterface
      */
     private $checks;
 
+    /**
+     * Directory path for static checks error files
+     *
+     * @var string
+     */
+    private static $errorFilesPath = null;
+
     /**
      * Constructor
      *
      * @param array $checks
+     * @throws TestFrameworkException
      */
     public function __construct(array $checks = [])
     {
@@ -35,6 +47,11 @@ public function __construct(array $checks = [])
             self::DEPRECATED_ENTITY_USAGE_CHECK_NAME => new DeprecatedEntityUsageCheck(),
             'annotations' => new AnnotationsCheck()
         ] + $checks;
+
+        // Static checks error files directory
+        if (null === self::$errorFilesPath) {
+            self::$errorFilesPath = FilePathFormatter::format(TESTS_BP) . self::STATIC_RESULTS;
+        }
     }
 
     /**
@@ -44,4 +61,12 @@ public function getStaticChecks()
     {
         return $this->checks;
     }
+
+    /**
+     * Return the directory path for the static check error files
+     */
+    public static function getErrorFilesPath()
+    {
+        return self::$errorFilesPath;
+    }
 }

src/Magento/FunctionalTestingFramework/StaticCheck/TestDependencyCheck.php

@@ -121,7 +121,7 @@ public function execute(InputInterface $input)
         // hold on to the output and print any errors to a file
         $this->output = $this->scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/Util/Script/ScriptUtil.php

@@ -56,26 +56,30 @@ public function getAllModulePaths()
     /**
      * Prints out given errors to file, and returns summary result string
      * @param array  $errors
-     * @param string $filename
+     * @param string $filePath
      * @param string $message
      * @return string
      */
-    public function printErrorsToFile($errors, $filename, $message)
+    public function printErrorsToFile($errors, $filePath, $message)
     {
         if (empty($errors)) {
             return $message . ": No errors found.";
         }
 
-        $outputPath = getcwd() . DIRECTORY_SEPARATOR . $filename . ".txt";
-        $fileResource = fopen($outputPath, 'w');
+        $dirname = dirname($filePath);
+        if (!file_exists($dirname)) {
+            mkdir($dirname, 0777, true);
+        }
+
+        $fileResource = fopen($filePath, 'w');
 
         foreach ($errors as $test => $error) {
             fwrite($fileResource, $error[0] . PHP_EOL);
         }
 
         fclose($fileResource);
         $errorCount = count($errors);
-        $output = $message . ": Errors found across {$errorCount} file(s). Error details output to {$outputPath}";
+        $output = $message . ": Errors found across {$errorCount} file(s). Error details output to {$filePath}";
 
         return $output;
     }