ACQE-5089

* Added warnings to test dependency check

Author: KevinBKozan

src/Magento/FunctionalTestingFramework/StaticCheck/TestDependencyCheck.php

@@ -24,8 +24,11 @@ class TestDependencyCheck implements StaticCheckInterface
  const EXTENDS_REGEX_PATTERN = '/extends=["\']([^\'"]*)/';
  const ACTIONGROUP_REGEX_PATTERN = '/ref=["\']([^\'"]*)/';
 
- const ERROR_LOG_FILENAME = 'mftf-dependency-checks';
+ const ERROR_LOG_FILENAME = 'mftf-dependency-checks-errors';
  const ERROR_LOG_MESSAGE = 'MFTF File Dependency Check';
+ const WARNING_LOG_FILENAME = 'mftf-dependency-checks-warnings';
+
+ const ALLOW_LIST_FILENAME = 'test-dependency-allowlist';
 
  /**
  * Array of FullModuleName => [dependencies], including flattened dependency tree
@@ -51,6 +54,17 @@ class TestDependencyCheck implements StaticCheckInterface
  */
  private $errors = [];
 
+ /**
+ * Array containing all warnings found after running the execute() function.
+ * @var array
+ */
+ private $warnings = [];
+ /**
+ * Array containing warnings found while iterating through files
+ * @var array
+ */
+ private $tempWarnings = [];
+
  /**
  * String representing the output summary found after running the execute() function.
  * @var string
@@ -75,6 +89,11 @@ class TestDependencyCheck implements StaticCheckInterface
  */
  private $testDependencyUtil;
 
+ /**
+ * @var array $allowFailureEntities
+ */
+ private $allowFailureEntities = [];
+
  /**
  * Checks test dependencies, determined by references in tests versus the dependencies listed in the Magento module
  *
@@ -93,6 +112,17 @@ public function execute(InputInterface $input)
  "TEST DEPENDENCY CHECK ABORTED: MFTF must be attached or pointing to Magento codebase."
  );
  }
+
+ foreach ($allModules as $modulePath)
+ {
+ if (file_exists($modulePath . DIRECTORY_SEPARATOR . self::ALLOW_LIST_FILENAME)) {
+ $contents = file_get_contents($modulePath . DIRECTORY_SEPARATOR . self::ALLOW_LIST_FILENAME);
+ foreach(explode("\n", $contents) as $entity) {
+ $this->allowFailureEntities[$entity] = true;
+ }
+ }
+ }
+
  $registrar = new \Magento\Framework\Component\ComponentRegistrar();
  $this->moduleNameToPath = $registrar->getPaths(\Magento\Framework\Component\ComponentRegistrar::MODULE);
  $this->moduleNameToComposerName = $this->testDependencyUtil->buildModuleNameToComposerName(
@@ -118,12 +148,20 @@ public function execute(InputInterface $input)
  $this->errors += $this->findErrorsInFileSet($actionGroupXmlFiles);
  $this->errors += $this->findErrorsInFileSet($dataXmlFiles);
 
+
  // hold on to the output and print any errors to a file
  $this->output = $this->scriptUtil->printErrorsToFile(
  $this->errors,
  StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
  self::ERROR_LOG_MESSAGE
  );
+ if (!empty($this->warnings)) {
+ $this->output .= "\n " . $this->scriptUtil->printWarningsToFile(
+ $this->warnings,
+ StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::WARNING_LOG_FILENAME . '.txt',
+ self::ERROR_LOG_MESSAGE
+ );
+ }
  }
 
  /**
@@ -199,6 +237,7 @@ private function findErrorsInFileSet(Finder $files): array
  // Find violating references and set error output
  $violatingReferences = $this->findViolatingReferences($moduleName);
  $testErrors = array_merge($testErrors, $this->setErrorOutput($violatingReferences, $filePath));
+ $this->warnings = array_merge($this->warnings, $this->setErrorOutput($this->tempWarnings, $filePath));
  }
  return $testErrors;
  }
@@ -221,6 +260,7 @@ private function findViolatingReferences(string $moduleName): array
  );
  $moduleDependencies = $this->flattenedDependencies[$moduleName];
  foreach ($modulesReferencedInTest as $entityName => $files) {
+ $isInAllowList = array_key_exists($entityName, $this->allowFailureEntities);
  $valid = false;
  foreach ($files as $module) {
  if (array_key_exists($module, $moduleDependencies) || $module === $currentModule) {
@@ -229,6 +269,10 @@ private function findViolatingReferences(string $moduleName): array
  }
  }
  if (!$valid) {
+ if ($isInAllowList) {
+ $this->tempWarnings[$entityName] = $files;
+ continue;
+ }
  $violatingReferences[$entityName] = $files;
  }
  }

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

@@ -67,22 +67,38 @@ public function printErrorsToFile(array $errors, string $filePath, string $messa
  return $message . ": No errors found.";
  }
 
+ $this->printTofile($errors, $filePath, $message);
+
+ $errorCount = count($errors);
+
+ return $message . ": Errors found across {$errorCount} file(s). Error details output to {$filePath}";
+ }
+
+ public function printWarningsToFile(array $warnings, string $filePath, string $message): string
+ {
+ if (empty($warnings)) {
+ return "" . ": No warnings found.";
+ }
+ $this->printTofile($warnings, $filePath, $message);
+ $errorCount = count($warnings);
+
+ return $message . ": Warnings found across {$errorCount} file(s). Warning details output to {$filePath}";
+ }
+
+ private function printTofile($contents, string $filePath, string $message)
+ {
  $dirname = dirname($filePath);
  if (!file_exists($dirname)) {
  mkdir($dirname, 0777, true);
  }
 
  $fileResource = fopen($filePath, 'w');
 
- foreach ($errors as $test => $error) {
+ foreach ($contents 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 {$filePath}";
-
- return $output;
  }
 
  /**