MQE-526: Do not depend on xml merging by filename-order

- change merging to use Module path order
- add print statements around included/excluded modules

Author: imeron2433

dev/tests/_bootstrap.php

@@ -15,6 +15,9 @@
     'includePaths' => [PROJECT_ROOT . '/src']
 ]);
 
+// force php to generate
+$GLOBALS['FORCE_PHP_GENERATE'] = true;
+
 // Load needed framework env params
 $TEST_ENVS = [
     'MAGENTO_BASE_URL' => 'http://baseurl:8080',

src/Magento/FunctionalTestingFramework/Util/ConfigSanitizerUtil.php

@@ -84,7 +84,7 @@ private static function validateConfigBasedVars($config)
      * @param string $url
      * @return string
      */
-    private static function sanitizeUrl($url)
+    public static function sanitizeUrl($url)
     {
         if ($url === "") {
             trigger_error("MAGENTO_BASE_URL must be defined in .env", E_USER_ERROR);

src/Magento/FunctionalTestingFramework/Util/ModuleResolver.php

@@ -58,6 +58,13 @@ class ModuleResolver
      */
     protected $moduleUrl = "rest/V1/modules";
 
+    /**
+     * Url for magento version information.
+     *
+     * @var string
+     */
+    protected $versionUrl = "magento_version ";
+
     /**
      * List of known directory that does not map to a Magento module.
      *
@@ -123,13 +130,15 @@ public function getEnabledModules()
             return $this->enabledModules;
         }
 
+        $this->printMagentoVersionInfo();
+
         $token = $this->getAdminToken();
         if (!$token || !is_string($token)) {
             $this->enabledModules = [];
             return $this->enabledModules;
         }
 
-        $url = $_ENV['MAGENTO_BASE_URL'] . $this->moduleUrl;
+        $url = ConfigSanitizerUtil::sanitizeUrl($_ENV['MAGENTO_BASE_URL']) . $this->moduleUrl;
 
         $headers = [
             'Authorization: Bearer ' . $token,
@@ -175,31 +184,60 @@ public function getModulesPath()
         }
 
         $enabledModules = $this->getEnabledModules();
+        $forceGeneration = $GLOBALS['FORCE_PHP_GENERATE'] ?? false;
+
+        if (empty($enabledModules) && !$forceGeneration) {
+            trigger_error(
+                "Could not retrieve enabled modules from provided 'MAGENTO_BASE_URL'," .
+                "please make sure Magento is available at this url",
+                E_USER_ERROR
+            );
+        }
+
         $modulePath = defined('TESTS_MODULE_PATH') ? TESTS_MODULE_PATH : TESTS_BP;
-        $allModulePaths = glob($modulePath . '*/*');
+
+        // Build an associative array of module name to existing module filepaths based on defined TEST MODULE PATH
+        $allModulePaths = [];
+        foreach (glob($modulePath . '*/*') as $modPath) {
+            $modName = basename($modPath);
+            $allModulePaths[$modName] = $modPath;
+        }
+
         if (empty($enabledModules)) {
             $this->enabledModulePaths = $this->applyCustomModuleMethods($allModulePaths);
             return $this->enabledModulePaths;
         }
 
         $enabledModules = array_merge($enabledModules, $this->getModuleWhitelist());
-        $enabledDirectories = [];
-        foreach ($enabledModules as $module) {
-            $directoryName = explode('_', $module)[1];
-            $enabledDirectories[$directoryName] = $directoryName;
-        }
-
-        foreach ($allModulePaths as $index => $modulePath) {
-            $moduleShortName = basename($modulePath);
-            if (!isset($enabledDirectories[$moduleShortName]) && !isset($this->knownDirectories[$moduleShortName])) {
-                unset($allModulePaths[$index]);
+        $enabledDirectoryPaths = [];
+        foreach ($enabledModules as $magentoModuleName) {
+            $moduleShortName = explode('_', $magentoModuleName)[1];
+            if (!isset($this->knownDirectories[$moduleShortName]) && !isset($allModulePaths[$moduleShortName])) {
+                continue;
+            } else {
+                $enabledDirectoryPaths[$moduleShortName] = $allModulePaths[$moduleShortName];
             }
         }
 
-        $this->enabledModulePaths = $this->applyCustomModuleMethods($allModulePaths);
+        $this->enabledModulePaths = $this->applyCustomModuleMethods($enabledDirectoryPaths);
         return $this->enabledModulePaths;
     }
 
+    /**
+     * Executes a REST call to the supplied Magento Base Url for version information to display during generation
+     *
+     * @return void
+     */
+    private function printMagentoVersionInfo()
+    {
+        $url = ConfigSanitizerUtil::sanitizeUrl($_ENV['MAGENTO_BASE_URL']) . $this->versionUrl;
+        $ch = curl_init($url);
+        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        $response = curl_exec($ch);
+        print "Version Information: {$response}\n";
+    }
+
     /**
      * Get the API token for admin.
      *
@@ -213,7 +251,7 @@ protected function getAdminToken()
             return false;
         }
 
-        $url = $_ENV['MAGENTO_BASE_URL'] . $this->adminTokenUrl;
+        $url = ConfigSanitizerUtil::sanitizeUrl($_ENV['MAGENTO_BASE_URL']) . $this->adminTokenUrl;
         $data = [
             'username' => $login,
             'password' => $password
@@ -255,7 +293,13 @@ public function sortFilesByModuleSequence(array $files)
     protected function applyCustomModuleMethods($modulesPath)
     {
         $modulePathsResult = $this->removeBlacklistModules($modulesPath);
-        return array_merge($modulePathsResult, $this->getCustomModulePaths());
+        $customModulePaths = $this->getCustomModulePaths();
+
+        array_map(function ($value) {
+            print "Including module path: {$value}\n";
+        }, $customModulePaths);
+
+        return array_merge($modulePathsResult, $customModulePaths);
     }
 
     /**
@@ -267,9 +311,10 @@ protected function applyCustomModuleMethods($modulesPath)
     private function removeBlacklistModules($modulePaths)
     {
         $modulePathsResult = $modulePaths;
-        foreach ($modulePathsResult as $index => $modulePath) {
-            if (in_array(basename($modulePath), $this->getModuleBlacklist())) {
-                unset($modulePathsResult[$index]);
+        foreach ($modulePathsResult as $moduleName => $modulePath) {
+            if (in_array($moduleName, $this->getModuleBlacklist())) {
+                unset($modulePathsResult[$moduleName]);
+                print "Excluding module: {$moduleName}\n";
             }
         }