MQE-1043: MFTF force flag should ignore the magento base url even when valid

- ModuleResolver now completely ignores trying to get enabledModules if --force is set
- Shuffled around exception throwing for faster failure
- Fix for MQE-1017 included, exceptions are now more verbose and precise as to when they are thrown.

Author: KevinBKozan

src/Magento/FunctionalTestingFramework/Exceptions/TestFrameworkException.php

@@ -6,6 +6,8 @@
 
 namespace Magento\FunctionalTestingFramework\Exceptions;
 
+use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
+
 /**
  * Class TestFrameworkException
  */
@@ -14,9 +16,17 @@ class TestFrameworkException extends \Exception
     /**
      * TestFrameworkException constructor.
      * @param string $message
+     * @param array $context
+     * @SuppressWarnings(PHPMD.UnusedLocalVariable)
      */
-    public function __construct($message)
+    public function __construct($message, $context = [])
     {
+        list($childClass, $callingClass) = debug_backtrace(false, 2);
+        LoggingUtil::getInstance()->getLogger($callingClass['class'])->error(
+            $message,
+            $context
+        );
+
         parent::__construct($message);
     }
 }

src/Magento/FunctionalTestingFramework/Util/ModuleResolver.php

@@ -7,6 +7,7 @@
 namespace Magento\FunctionalTestingFramework\Util;
 
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
 
 /**
@@ -138,10 +139,6 @@ public function getEnabledModules()
         }
 
         $token = $this->getAdminToken();
-        if (!$token || !is_string($token)) {
-            $this->enabledModules = [];
-            return $this->enabledModules;
-        }
 
         $url = ConfigSanitizerUtil::sanitizeUrl(getenv('MAGENTO_BASE_URL')) . $this->moduleUrl;
 
@@ -157,10 +154,17 @@ public function getEnabledModules()
         $response = curl_exec($ch);
 
         if (!$response) {
-            $this->enabledModules = [];
-        } else {
-            $this->enabledModules = json_decode($response);
+            $message = "Could not retrieve Modules from Magento Instance.";
+            $context = [
+                "Admin Module List Url" => $url,
+                "MAGENTO_ADMIN_USERNAME" => getenv("MAGENTO_ADMIN_USERNAME"),
+                "MAGENTO_ADMIN_PASSWORD" => getenv("MAGENTO_ADMIN_PASSWORD"),
+            ];
+            throw new TestFrameworkException($message, $context);
         }
+
+        $this->enabledModules = json_decode($response);
+
         return $this->enabledModules;
     }
 
@@ -190,25 +194,14 @@ public function getModulesPath()
             return $this->enabledModulePaths;
         }
 
-        $enabledModules = $this->getEnabledModules();
-        if (empty($enabledModules) && !MftfApplicationConfig::getConfig()->forceGenerateEnabled()) {
-            $errorMsg = 'Could not retrieve enabled modules from provided MAGENTO_BASE_URL ' .
-                'please make sure Magento is available at this url';
-            LoggingUtil::getInstance()->getLogger(ModuleResolver::class)->error(
-                $errorMsg,
-                ['MAGENTO_BASE_URL' => getenv('MAGENTO_BASE_URL')]
-            );
-            trigger_error($errorMsg, E_USER_ERROR);
-        }
-
         $allModulePaths = $this->aggregateTestModulePaths();
 
-        if (empty($enabledModules)) {
+        if (MftfApplicationConfig::getConfig()->forceGenerateEnabled()) {
             $this->enabledModulePaths = $this->applyCustomModuleMethods($allModulePaths);
             return $this->enabledModulePaths;
         }
 
-        $enabledModules = array_merge($enabledModules, $this->getModuleWhitelist());
+        $enabledModules = array_merge($this->getEnabledModules(), $this->getModuleWhitelist());
         $enabledDirectoryPaths = $this->getEnabledDirectoryPaths($enabledModules, $allModulePaths);
 
         $this->enabledModulePaths = $this->applyCustomModuleMethods($enabledDirectoryPaths);
@@ -325,9 +318,15 @@ private function getEnabledDirectoryPaths($enabledModules, $allModulePaths)
     {
         $enabledDirectoryPaths = [];
         foreach ($enabledModules as $magentoModuleName) {
-            $moduleShortName = explode('_', $magentoModuleName)[1];
+            // Magento_Backend -> Backend or DevDocs -> DevDocs (if whitelisted has no underscore)
+            $moduleShortName = explode('_', $magentoModuleName)[1] ?? $magentoModuleName;
             if (!isset($this->knownDirectories[$moduleShortName]) && !isset($allModulePaths[$moduleShortName])) {
                 continue;
+            } elseif (isset($this->knownDirectories[$moduleShortName]) && !isset($allModulePaths[$moduleShortName])) {
+                LoggingUtil::getInstance()->getLogger(ModuleResolver::class)->warn(
+                    "Known directory could not match to an existing path.",
+                    ['knownDirectory' => $moduleShortName]
+                );
             } else {
                 $enabledDirectoryPaths[$moduleShortName] = $allModulePaths[$moduleShortName];
             }
@@ -342,7 +341,6 @@ private function getEnabledDirectoryPaths($enabledModules, $allModulePaths)
      */
     private function printMagentoVersionInfo()
     {
-
         if (MftfApplicationConfig::getConfig()->forceGenerateEnabled()) {
             return;
         }
@@ -377,7 +375,13 @@ protected function getAdminToken()
         $login = $_ENV['MAGENTO_ADMIN_USERNAME'] ?? null;
         $password = $_ENV['MAGENTO_ADMIN_PASSWORD'] ?? null;
         if (!$login || !$password || !isset($_ENV['MAGENTO_BASE_URL'])) {
-            return false;
+            $message = "Cannot retrieve API token without credentials and base url, please fill out .env.";
+            $context = [
+                "MAGENTO_BASE_URL" => getenv("MAGENTO_BASE_URL"),
+                "MAGENTO_ADMIN_USERNAME" => getenv("MAGENTO_ADMIN_USERNAME"),
+                "MAGENTO_ADMIN_PASSWORD" => getenv("MAGENTO_ADMIN_PASSWORD"),
+            ];
+            throw new TestFrameworkException($message, $context);
         }
 
         $url = ConfigSanitizerUtil::sanitizeUrl($_ENV['MAGENTO_BASE_URL']) . $this->adminTokenUrl;
@@ -398,9 +402,17 @@ protected function getAdminToken()
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
 
         $response = curl_exec($ch);
+
         if (!$response) {
-            return $response;
+            $message = "Could not retrieve API token from Magento Instance.";
+            $context = [
+                "Admin Integration Token Url" => $url,
+                "MAGENTO_ADMIN_USERNAME" => getenv("MAGENTO_ADMIN_USERNAME"),
+                "MAGENTO_ADMIN_PASSWORD" => getenv("MAGENTO_ADMIN_PASSWORD"),
+            ];
+            throw new TestFrameworkException($message, $context);
         }
+
         return json_decode($response);
     }