MQE-1257: MFTF doctor command

jilu1 · jilu1 · commit f1299b1b03e2 · 2019-11-08T16:41:32.000-06:00
diff --git a/src/Magento/FunctionalTestingFramework/Config/MftfApplicationConfig.php b/src/Magento/FunctionalTestingFramework/Config/MftfApplicationConfig.php
@@ -15,8 +15,7 @@ class MftfApplicationConfig
     const GENERATION_PHASE = "generation";
     const EXECUTION_PHASE = "execution";
     const UNIT_TEST_PHASE = "testing";
-    const DIAGNOSTIC_PHASE = "diagnostic";
-    const MFTF_PHASES = [self::GENERATION_PHASE, self::EXECUTION_PHASE, self::UNIT_TEST_PHASE, self::DIAGNOSTIC_PHASE];
+    const MFTF_PHASES = [self::GENERATION_PHASE, self::EXECUTION_PHASE, self::UNIT_TEST_PHASE];
 
     /**
      * Mftf debug levels
diff --git a/src/Magento/FunctionalTestingFramework/Console/CommandList.php b/src/Magento/FunctionalTestingFramework/Console/CommandList.php
@@ -30,6 +30,7 @@ public function __construct(array $commands = [])
     {
         $this->commands = [
             'build:project' => new BuildProjectCommand(),
+            'doctor' => new DoctorCommand(),
             'generate:docs' => new GenerateDocsCommand(),
             'generate:suite' => new GenerateSuiteCommand(),
             'generate:tests' => new GenerateTestsCommand(),
@@ -41,7 +42,6 @@ public function __construct(array $commands = [])
             'run:test' => new RunTestCommand(),
             'setup:env' => new SetupEnvCommand(),
             'static-checks' => new StaticChecksCommand(),
-            'troubleshoot' => new TroubleShootCommand(),
             'upgrade:tests' => new UpgradeTestsCommand(),
         ] + $commands;
     }
diff --git a/src/Magento/FunctionalTestingFramework/Console/DoctorCommand.php b/src/Magento/FunctionalTestingFramework/Console/DoctorCommand.php
@@ -16,13 +16,14 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Magento\FunctionalTestingFramework\Util\ModuleResolver;
+use Magento\FunctionalTestingFramework\Module\MagentoWebDriver;
+use Magento\FunctionalTestingFramework\Module\MagentoWebDriverDoctor;
 
-class TroubleShootCommand extends Command
+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 REQUIRED_PHP_EXTS = ['CURL', 'mbstring', 'bcmath', 'zip', 'dom', 'gd', 'intl'];
 
     /**
      * Command Output
@@ -31,14 +32,21 @@ class TroubleShootCommand extends Command
      */
     private $output;
 
+    /**
+     * Exception Context
+     *
+     * @var array
+     */
+    private $context = [];
+
     /**
      * Configures the current command.
      *
      * @return void
      */
     protected function configure()
     {
-        $this->setName('troubleshoot')
+        $this->setName('doctor')
             ->setDescription(
                 'This command checks environment readiness for generating and running MFTF tests.'
             );
@@ -62,24 +70,22 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->output = $output;
         MftfApplicationConfig::create(
             false,
-            MftfApplicationConfig::DIAGNOSTIC_PHASE,
+            MftfApplicationConfig::GENERATION_PHASE,
             $verbose,
             MftfApplicationConfig::LEVEL_DEVELOPER,
             false
         );
 
-        // Check required PHP extensions
-        foreach (self::REQUIRED_PHP_EXTS as $ext) {
-            $status = $this->checkPhpExtIsAvailable($ext);
-            $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
-        }
-
         // Check authentication to Magento Admin
         $status = $this->checkAuthenticationToMagentoAdmin();
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
-        // Check connectivity and authentication to Magento Admin
-        $status = $this->checkConnectivityToSeleniumServer();
+        // Check connection to Selenium
+        $status = $this->checkConnectionToSeleniumServer();
+        $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
+
+        // Check access to Magento CLI
+        $status = $this->checkAccessToMagentoCLI();
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         if ($cmdStatus) {
@@ -90,70 +96,104 @@ protected function execute(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * Check php extention is installed and available
+     * Check authentication to Magento Admin
      *
-     * @param string $ext
      * @return boolean
      */
-    private function checkPhpExtIsAvailable($ext)
+    private function checkAuthenticationToMagentoAdmin()
     {
         $result = false;
-        $this->output->writeln("\nChecking PHP extenstion \"{$ext}\" ...");
-        if (extension_loaded(strtolower($ext))) {
+        try {
+            $this->output->writeln("\nChecking authentication to Magento Admin ...");
+            ModuleResolver::getInstance()->getAdminToken();
             $this->output->writeln('Successful');
             $result = true;
-        } else {
-            $this->output->writeln(
-                "MFTF requires \"{$ext}\" extension installed to make tests run\n"
-                . "Please make sure that the PHP you run has \"{$ext}\" installed and enabled."
-            );
+        } catch (TestFrameworkException $e) {
+            $this->output->writeln($e->getMessage());
         }
         return $result;
     }
 
     /**
-     * Check authentication to Magento Admin
+     * Check Connection to Selenium Server
      *
      * @return boolean
      */
-    private function checkAuthenticationToMagentoAdmin()
+    private function checkConnectionToSeleniumServer()
     {
-        $result = false;
-        try {
-            $this->output->writeln("\nChecking authentication to Magento Admin ...");
-            ModuleResolver::getInstance()->getAdminToken();
+        // Check connection to Selenium through Codeception
+        $this->output->writeln("\nChecking connection to Selenium Server ...");
+        $this->runMagentoWebDriverDoctor();
+
+        if (isset($this->context[MagentoWebDriverDoctor::EXCEPTION_TYPE_SELENIUM])) {
+            $this->output->write($this->context[MagentoWebDriverDoctor::EXCEPTION_TYPE_SELENIUM] . "\n");
+            return false;
+        } else {
             $this->output->writeln('Successful');
-            $result = true;
-        } catch (TestFrameworkException $e) {
-            $this->output->writeln($e->getMessage());
+            return true;
         }
-        return $result;
     }
 
     /**
-     * Check Connectivity to Selenium Server
+     * Check access to Magento CLI setup
      *
      * @return boolean
      */
-    private function checkConnectivityToSeleniumServer()
+    private function checkAccessToMagentoCLI()
     {
-        $result = false;
+        // Check Magento CLI setup
+        $this->output->writeln("\nChecking access to Magento CLI ...");
+        $this->runMagentoWebDriverDoctor();
+
+        if (isset($this->context[MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_CLI])) {
+            $this->output->write($this->context[MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_CLI] . "\n");
+            return false;
+        } else {
+            $this->output->writeln('Successful');
+            return true;
+        }
+    }
+
+    /**
+     * Run diagnose through MagentoWebDriverDoctor
+     *
+     * @return void
+     */
+    private function runMagentoWebDriverDoctor()
+    {
+        if (!empty($this->context)) {
+            return;
+        }
+
+        $magentoWebDriver = '\\' . MagentoWebDriver::class;
+        $magentoWebDriverDoctor = '\\' . MagentoWebDriverDoctor::class;
 
-        // Check connectivity to Selenium through Codeception
-        $this->output->writeln("\nChecking connectivity to Selenium Server ...");
         require_once realpath(self::CODECEPTION_AUTOLOAD_FILE);
 
         $config = Configuration::config(realpath(self::MFTF_CODECEPTION_CONFIG_FILE));
         $settings = Configuration::suiteSettings(self::SUITE, $config);
+
+        // Enable MagentoWebDriverDoctor
+        $settings['modules']['enabled'][] = $magentoWebDriverDoctor;
+        $settings['modules']['config'][$magentoWebDriverDoctor] =
+            $settings['modules']['config'][$magentoWebDriver];
+
+        // Disable MagentoWebDriver to avoid conflicts
+        foreach ($settings['modules']['enabled'] as $index => $module) {
+            if ($module == $magentoWebDriver) {
+                unset($settings['modules']['enabled'][$index]);
+                break;
+            }
+        }
+        unset($settings['modules']['config'][$magentoWebDriver]);
+
         $dispatcher = new EventDispatcher();
         $suiteManager = new SuiteManager($dispatcher, self::SUITE, $settings);
         try {
             $suiteManager->initialize();
-            $this->output->writeln('Successful');
-            $result = true;
+            $this->context = ['Successful'];
         } catch (TestFrameworkException $e) {
-            $this->output->writeln($e->getMessage());
+            $this->context = $e->getContext();
         }
-        return $result;
     }
 }
diff --git a/src/Magento/FunctionalTestingFramework/Exceptions/TestFrameworkException.php b/src/Magento/FunctionalTestingFramework/Exceptions/TestFrameworkException.php
@@ -13,6 +13,13 @@
  */
 class TestFrameworkException extends \Exception
 {
+    /**
+     * Exception context
+     *
+     * @var array
+     */
+    protected $context;
+
     /**
      * TestFrameworkException constructor.
      * @param string $message
@@ -27,6 +34,17 @@ public function __construct($message, $context = [])
             $context
         );
 
+        $this->context = $context;
         parent::__construct($message);
     }
+
+    /**
+     * Return exception context
+     *
+     * @return array
+     */
+    public function getContext()
+    {
+        return $this->context;
+    }
 }
diff --git a/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php b/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php
@@ -129,11 +129,6 @@ public function _initialize()
         $this->config = ConfigSanitizerUtil::sanitizeWebDriverConfig($this->config);
         parent::_initialize();
         $this->cleanJsError();
-
-        // Check Selenium Server readiness if it's in diagnostic phase
-        if (MftfApplicationConfig::getConfig()->getPhase() === MftfApplicationConfig::DIAGNOSTIC_PHASE) {
-            $this->checkSeleniumServerReadiness();
-        }
     }
 
     /**
@@ -834,32 +829,6 @@ public function makeScreenshot($name = null)
         AllureHelper::addAttachmentToCurrentStep($screenName, 'Screenshot');
     }
 
-    /**
-     * Check connectivity to running selenium server
-     *
-     * @return void
-     * @throws TestFrameworkException
-     */
-    public function checkSeleniumServerReadiness()
-    {
-        try {
-            $driver = RemoteWebDriver::create(
-                $this->wdHost,
-                $this->capabilities,
-                $this->connectionTimeoutInMs,
-                $this->requestTimeoutInMs,
-                $this->httpProxy,
-                $this->httpProxyPort
-            );
-            $driver->close();
-        } catch (WebDriverCurlException $e) {
-            throw new TestFrameworkException(
-                "Can't connect to Webdriver at {$this->wdHost}.\n"
-                . "Please make sure that Selenium Server is running."
-            );
-        }
-    }
-
     /**
      * Takes given $command and executes it against bin/magento executable. Returns stdout output from the command.
      *
diff --git a/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriverDoctor.php b/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriverDoctor.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Module;
+
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
+use Facebook\WebDriver\Remote\RemoteWebDriver;
+
+/**
+ * MagentoWebDriverDoctor module extends MagentoWebDriver module and is a light weighted module to diagnose webdriver
+ * initialization and other setup issues. It uses in memory version of MagentoWebDriver's configuration file
+ */
+class MagentoWebDriverDoctor extends MagentoWebDriver
+{
+    const MAGENTO_CLI_COMMAND = 'list';
+    const EXCEPTION_TYPE_SELENIUM = 'selenium';
+    const EXCEPTION_TYPE_MAGENTO_CLI = 'cli';
+
+    /**
+     * Go through parent initialization routines and in addition diagnose potential environment issues
+     *
+     * @return void
+     * @throws TestFrameworkException
+     */
+    public function _initialize()
+    {
+        parent::_initialize();
+
+        $context = [];
+
+        try {
+            $this->checkSeleniumServerReadiness();
+        } catch (TestFrameworkException $e) {
+            $context[self::EXCEPTION_TYPE_SELENIUM] = $e->getMessage();
+        }
+
+        try {
+            $this->checkMagentoCLI();
+        } catch (TestFrameworkException $e) {
+            $context[self::EXCEPTION_TYPE_MAGENTO_CLI] = $e->getMessage();
+        }
+
+        if (!empty($context)) {
+            throw new TestFrameworkException('MagentoWebDriverDoctor initialization failed', $context);
+        }
+    }
+
+    /**
+     * Check connectivity to running selenium server
+     *
+     * @return void
+     * @throws TestFrameworkException
+     */
+    private function checkSeleniumServerReadiness()
+    {
+        try {
+            $driver = RemoteWebDriver::create(
+                $this->wdHost,
+                $this->capabilities,
+                $this->connectionTimeoutInMs,
+                $this->requestTimeoutInMs,
+                $this->httpProxy,
+                $this->httpProxyPort
+            );
+            $driver->close();
+        } catch (\Exception $e) {
+            throw new TestFrameworkException(
+                "Can't connect to Webdriver at {$this->wdHost}.\n"
+                . "Please make sure that Selenium Server is running."
+            );
+        }
+    }
+
+    /**
+     * Check Magento CLI setup
+     *
+     * @return void
+     * @throws TestFrameworkException
+     */
+    private function checkMagentoCLI()
+    {
+        parent::magentoCLI(self::MAGENTO_CLI_COMMAND);
+    }
+}
