MQE-1257: MFTF doctor command

jilu1 · jilu1 · commit 25c5706cc2df · 2019-11-15T09:38:30.000-06:00
diff --git a/docs/commands/mftf.md b/docs/commands/mftf.md
@@ -109,6 +109,20 @@ You can include options to set configuration parameter values for your environme
 vendor/bin/mftf build:project --MAGENTO_BASE_URL=http://magento.local/ --MAGENTO_BACKEND_NAME=admin214365
 ```
 
+### `doctor`
+
+#### Description
+
+Diagnose MFTF configuration and setup
+
+#### Usage
+
+```bash
+vendor/bin/mftf doctor
+```
+
+#### Options
+
 ### `generate:tests`
 
 #### Description
diff --git a/src/Magento/FunctionalTestingFramework/Console/DoctorCommand.php b/src/Magento/FunctionalTestingFramework/Console/DoctorCommand.php
@@ -67,6 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         // Config application
         $verbose = $output->isVerbose();
+        $this->input = $input;
         $this->output = $output;
         MftfApplicationConfig::create(
             false,
@@ -81,11 +82,31 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         // Check connection to Selenium
-        $status = $this->checkConnectionToSeleniumServer();
+        $status = $this->checkContextOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_CONTEXT_SELENIUM,
+            'Connecting to Selenium Server'
+        );
+        $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
+
+        // Check opening Magento Admin in web browser
+        $status = $this->checkContextOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_CONTEXT_ADMIN,
+            'Loading Admin page'
+        );
+        $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
+
+        // Check opening Magento Storefront in web browser
+        $status = $this->checkContextOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_CONTEXT_STOREFRONT,
+            'Loading Storefront page'
+        );
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         // Check access to Magento CLI
-        $status = $this->checkAccessToMagentoCLI();
+        $status = $this->checkContextOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_CONTEXT_CLI,
+            'Running Magento CLI'
+        );
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         if ($cmdStatus) {
@@ -96,15 +117,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * Check authentication to Magento Admin
+     * Check admin account authentication
      *
      * @return boolean
      */
     private function checkAuthenticationToMagentoAdmin()
     {
         $result = false;
         try {
-            $this->output->writeln("\nChecking authentication to Magento Admin ...");
+            $this->output->writeln("\nAuthenticating admin account by API ...");
             ModuleResolver::getInstance()->getAdminToken();
             $this->output->writeln('Successful');
             $result = true;
@@ -115,38 +136,20 @@ private function checkAuthenticationToMagentoAdmin()
     }
 
     /**
-     * Check Connection to Selenium Server
-     *
-     * @return boolean
-     */
-    private function checkConnectionToSeleniumServer()
-    {
-        // 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');
-            return true;
-        }
-    }
-
-    /**
-     * Check access to Magento CLI setup
+     * Check exception context after runMagentoWebDriverDoctor
      *
+     * @param string $exceptionType
+     * @param string $message
      * @return boolean
+     * @throws TestFrameworkException
      */
-    private function checkAccessToMagentoCLI()
+    private function checkContextOnStep($exceptionType, $message)
     {
-        // Check Magento CLI setup
-        $this->output->writeln("\nChecking access to Magento CLI ...");
+        $this->output->writeln("\n$message ...");
         $this->runMagentoWebDriverDoctor();
 
-        if (isset($this->context[MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_CLI])) {
-            $this->output->write($this->context[MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_CLI] . "\n");
+        if (isset($this->context[$exceptionType])) {
+            $this->output->write($this->context[$exceptionType] . "\n");
             return false;
         } else {
             $this->output->writeln('Successful');
@@ -158,6 +161,7 @@ private function checkAccessToMagentoCLI()
      * Run diagnose through MagentoWebDriverDoctor
      *
      * @return void
+     * @throws TestFrameworkException
      */
     private function runMagentoWebDriverDoctor()
     {
diff --git a/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriverDoctor.php b/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriverDoctor.php
@@ -11,13 +11,22 @@
 
 /**
  * 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
+ * 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';
+    const EXCEPTION_CONTEXT_SELENIUM = 'selenium';
+    const EXCEPTION_CONTEXT_ADMIN = 'admin';
+    const EXCEPTION_CONTEXT_STOREFRONT = 'store';
+    const EXCEPTION_CONTEXT_CLI = 'cli';
+
+    /**
+     * Remote Web Driver
+     *
+     * @var RemoteWebDriver
+     */
+    private $remoteWebDriver = null;
 
     /**
      * Go through parent initialization routines and in addition diagnose potential environment issues
@@ -32,56 +41,121 @@ public function _initialize()
         $context = [];
 
         try {
-            $this->checkSeleniumServerReadiness();
+            $this->connectToSeleniumServer();
         } catch (TestFrameworkException $e) {
-            $context[self::EXCEPTION_TYPE_SELENIUM] = $e->getMessage();
+            $context[self::EXCEPTION_CONTEXT_SELENIUM] = $e->getMessage();
         }
 
         try {
-            $this->checkMagentoCLI();
-        } catch (TestFrameworkException $e) {
-            $context[self::EXCEPTION_TYPE_MAGENTO_CLI] = $e->getMessage();
+            $adminUrl = rtrim(getenv('MAGENTO_BACKEND_BASE_URL'), '/')
+                ?: rtrim(getenv('MAGENTO_BASE_URL'), '/')
+                . '/' . getenv('MAGENTO_BACKEND_NAME') . '/admin';
+            $this->loadPageAtUrl($adminUrl);
+        } catch (\Exception $e) {
+            $context[self::EXCEPTION_CONTEXT_ADMIN] = $e->getMessage();
+        }
+
+        try {
+            $storeUrl = getenv('MAGENTO_BASE_URL');
+            $this->loadPageAtUrl($storeUrl);
+        } catch (\Exception $e) {
+            $context[self::EXCEPTION_CONTEXT_STOREFRONT] = $e->getMessage();
+        }
+
+        try {
+            $this->runMagentoCLI();
+        } catch (\Exception $e) {
+            $context[self::EXCEPTION_CONTEXT_CLI] = $e->getMessage();
+        }
+
+        if (null !== $this->remoteWebDriver) {
+            $this->remoteWebDriver->close();
         }
 
         if (!empty($context)) {
-            throw new TestFrameworkException('MagentoWebDriverDoctor initialization failed', $context);
+            throw new TestFrameworkException('Exception occurred in MagentoWebDriverDoctor', $context);
         }
     }
 
     /**
-     * Check connectivity to running selenium server
+     * Check connecting to running selenium server
      *
      * @return void
      * @throws TestFrameworkException
      */
-    private function checkSeleniumServerReadiness()
+    private function connectToSeleniumServer()
     {
         try {
-            $driver = RemoteWebDriver::create(
+            $this->remoteWebDriver = 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"
+                "Failed to connect Selenium WebDriver at: {$this->wdHost}.\n"
                 . "Please make sure that Selenium Server is running."
             );
         }
     }
 
     /**
-     * Check Magento CLI setup
+     * Validate loading a web page at url in the browser controlled by selenium
+     *
+     * @param string $url
+     * @return void
+     * @throws TestFrameworkException
+     */
+    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;
+            }
+        } catch (\Exception $e) {
+        }
+
+        throw new TestFrameworkException(
+            "Failed to load page at url: $url\n"
+            . "Please check network connection for the browser running Selenium."
+        );
+    }
+
+    /**
+     * Check running Magento CLI command
      *
      * @return void
      * @throws TestFrameworkException
      */
-    private function checkMagentoCLI()
+    private function runMagentoCLI()
     {
-        parent::magentoCLI(self::MAGENTO_CLI_COMMAND);
+        try {
+            $regex = '~^.*(?<name>Magento CLI).*[\r\n]+(?<usage>Usage:).*~';
+            $output = parent::magentoCLI(self::MAGENTO_CLI_COMMAND);
+            preg_match($regex, $output, $matches);
+
+            if (isset($matches['name']) && isset($matches['usage'])) {
+                return;
+            }
+        } catch (\Exception $e) {
+            throw new TestFrameworkException(
+                "Failed to run Magento CLI command\n"
+                . "Please reference Magento DevDoc to setup command.php and .htaccess files."
+            );
+        }
     }
 }
