MQE-1257: MFTF doctor command

Author: jilu1

docs/commands/mftf.md

@@ -113,7 +113,11 @@ vendor/bin/mftf build:project --MAGENTO_BASE_URL=http://magento.local/ --MAGENTO
 
 #### Description
 
-Diagnose MFTF configuration and setup
+Diagnose MFTF configuration and setup. Currently this command will check the following:
+- Verify admin credentials are valid. Allowing MFTF authenticates and runs API requests to Magento through cURL
+- Verify that Selenium is up and running and available for MFTF
+- Verify that new session of browser can open Magento admin and store front urls
+- Verify that MFTF can run MagentoCLI commands
 
 #### Usage
 

src/Magento/FunctionalTestingFramework/Console/DoctorCommand.php

@@ -18,23 +18,20 @@
 use Magento\FunctionalTestingFramework\Util\ModuleResolver;
 use Magento\FunctionalTestingFramework\Module\MagentoWebDriver;
 use Magento\FunctionalTestingFramework\Module\MagentoWebDriverDoctor;
+use Symfony\Component\Console\Style\SymfonyStyle;
 
 class DoctorCommand extends Command
 {
     const CODECEPTION_AUTOLOAD_FILE = PROJECT_ROOT . '/vendor/codeception/codeception/autoload.php';
     const MFTF_CODECEPTION_CONFIG_FILE = ENV_FILE_PATH . 'codeception.yml';
     const SUITE = 'functional';
-    const COLOR_LIGHT_GREEN = "\e[1;32m";
-    const COLOR_LIGHT_RED = "\e[1;31m";
-    const COLOR_LIGHT_DEFAULT = "\e[1;39m";
-    const COLOR_RESTORE = "\e[0m";
 
     /**
-     * Command Output
+     * Console output style
      *
-     * @var OutputInterface
+     * @var SymfonyStyle
      */
-    private $output;
+    private $ioStyle;
 
     /**
      * Exception Context
@@ -63,17 +60,17 @@ protected function configure()
      * @param OutputInterface $output
      * @return integer
      * @throws TestFrameworkException
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        // For output style
+        $this->ioStyle = new SymfonyStyle($input, $output);
+
         $cmdStatus = true;
 
         // Config application
         $verbose = $output->isVerbose();
-        $this->input = $input;
-        $this->output = $output;
         MftfApplicationConfig::create(
             false,
             MftfApplicationConfig::GENERATION_PHASE,
@@ -126,14 +123,15 @@ private function checkAuthenticationToMagentoAdmin()
     {
         $result = false;
         try {
-            $this->output->writeln(
-                "\n" . self::COLOR_LIGHT_DEFAULT . "Authenticating admin account by API ..." . self::COLOR_RESTORE
-            );
+            $this->ioStyle->text("Requesting API token for admin user through cURL ...");
             ModuleResolver::getInstance()->getAdminToken();
-            $this->output->writeln(self::COLOR_LIGHT_GREEN . 'Successful' . self::COLOR_RESTORE);
+            $this->ioStyle->success('Successful');
             $result = true;
         } catch (TestFrameworkException $e) {
-            $this->output->writeln(self::COLOR_LIGHT_RED . $e->getMessage() . self::COLOR_RESTORE);
+            $this->ioStyle->error(
+                $e->getMessage()
+                . "\nPlease verify MAGENTO_ADMIN_USERNAME and MAGENTO_ADMIN_PASSWORD in .env."
+            );
         }
         return $result;
     }
@@ -148,14 +146,14 @@ private function checkAuthenticationToMagentoAdmin()
      */
     private function checkContextOnStep($exceptionType, $message)
     {
-        $this->output->writeln("\n" . self::COLOR_LIGHT_DEFAULT. $message . self::COLOR_RESTORE);
+        $this->ioStyle->text($message . ' ...');
         $this->runMagentoWebDriverDoctor();
 
         if (isset($this->context[$exceptionType])) {
-            $this->output->writeln(self::COLOR_LIGHT_RED . $this->context[$exceptionType] . self::COLOR_RESTORE);
+            $this->ioStyle->error($this->context[$exceptionType]);
             return false;
         } else {
-            $this->output->writeln(self::COLOR_LIGHT_GREEN . 'Successful' . self::COLOR_RESTORE);
+            $this->ioStyle->success('Successful');
             return true;
         }
     }

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriverDoctor.php

@@ -94,12 +94,16 @@ private function connectToSeleniumServer()
                 $this->httpProxy,
                 $this->httpProxyPort
             );
+            if (null !== $this->remoteWebDriver) {
+                return;
+            }
         } catch (\Exception $e) {
-            throw new TestFrameworkException(
-                "Failed to connect Selenium WebDriver at: {$this->wdHost}.\n"
-                . "Please make sure that Selenium Server is running."
-            );
         }
+
+        throw new TestFrameworkException(
+            "Failed to connect Selenium WebDriver at: {$this->wdHost}.\n"
+            . "Please make sure that Selenium Server is running."
+        );
     }
 
     /**
@@ -112,19 +116,21 @@ private function connectToSeleniumServer()
     private function loadPageAtUrl($url)
     {
         try {
-            // Open the web page at url first
-            $this->remoteWebDriver->get($url);
-
-            // Execute Javascript to retrieve HTTP response code
-            $script = ''
-                . 'var xhr = new XMLHttpRequest();'
-                . "xhr.open('GET', '" . $url . "', false);"
-                . 'xhr.send(null); '
-                . 'return xhr.status';
-            $status = $this->remoteWebDriver->executeScript($script);
-
-            if ($status === 200) {
-                return;
+            if (null !== $this->remoteWebDriver) {
+                // Open the web page at url first
+                $this->remoteWebDriver->get($url);
+
+                // Execute Javascript to retrieve HTTP response code
+                $script = ''
+                    . 'var xhr = new XMLHttpRequest();'
+                    . "xhr.open('GET', '" . $url . "', false);"
+                    . 'xhr.send(null); '
+                    . 'return xhr.status';
+                $status = $this->remoteWebDriver->executeScript($script);
+
+                if ($status === 200) {
+                    return;
+                }
             }
         } catch (\Exception $e) {
         }

src/Magento/FunctionalTestingFramework/_bootstrap.php

@@ -16,7 +16,7 @@
 }
 defined('PROJECT_ROOT') || define('PROJECT_ROOT', $projectRootPath);
 
-$envFilePath = realpath($projectRootPath . '/dev/tests/acceptance/');
+$envFilePath = realpath($projectRootPath . '/dev/tests/acceptance/') . DIRECTORY_SEPARATOR;
 defined('ENV_FILE_PATH') || define('ENV_FILE_PATH', $envFilePath);
 
 //Load constants from .env file