MQE-1257: MFTF doctor command

Author: jilu1

src/Magento/FunctionalTestingFramework/Console/DoctorCommand.php

@@ -59,14 +59,14 @@ protected function configure()
      * @param OutputInterface $output
      * @return integer
      * @throws TestFrameworkException
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $cmdStatus = true;
 
         // Config application
         $verbose = $output->isVerbose();
+        $this->input = $input;
         $this->output = $output;
         MftfApplicationConfig::create(
             false,
@@ -81,11 +81,31 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         // Check connection to Selenium
-        $status = $this->checkConnectionToSeleniumServer();
+        $status = $this->checkOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_TYPE_SELENIUM,
+            'Checking connection to Selenium Server'
+        );
+        $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
+
+        // Check opening Magento Admin in web browser
+        $status = $this->checkOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_ADMIN,
+            'Checking opening Magento Admin in web browser controlled by Selenium'
+        );
+        $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
+
+        // Check opening Magento Storefront in web browser
+        $status = $this->checkOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_STOREFRONT,
+            'Checking opening Magento Storefront in web browser controlled by Selenium'
+        );
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         // Check access to Magento CLI
-        $status = $this->checkAccessToMagentoCLI();
+        $status = $this->checkOnStep(
+            MagentoWebDriverDoctor::EXCEPTION_TYPE_MAGENTO_CLI,
+            'Checking access to Magento CLI'
+        );
         $cmdStatus = $cmdStatus && !$status ? false : $cmdStatus;
 
         if ($cmdStatus) {
@@ -115,38 +135,18 @@ 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 on a step context after runMagentoWebDriverDoctor
      *
      * @return boolean
+     * @throws TestFrameworkException
      */
-    private function checkAccessToMagentoCLI()
+    private function checkOnStep($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 +158,7 @@ private function checkAccessToMagentoCLI()
      * Run diagnose through MagentoWebDriverDoctor
      *
      * @return void
+     * @throws TestFrameworkException
      */
     private function runMagentoWebDriverDoctor()
     {

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriverDoctor.php

@@ -15,10 +15,20 @@
  */
 class MagentoWebDriverDoctor extends MagentoWebDriver
 {
+    const POLL_INTERVAL_MS = 1000;
     const MAGENTO_CLI_COMMAND = 'list';
     const EXCEPTION_TYPE_SELENIUM = 'selenium';
+    const EXCEPTION_TYPE_MAGENTO_ADMIN = 'admin';
+    const EXCEPTION_TYPE_MAGENTO_STOREFRONT = 'storefront';
     const EXCEPTION_TYPE_MAGENTO_CLI = 'cli';
 
+    /**
+     * Remote Web Driver
+     *
+     * @var RemoteWebDriver
+     */
+    private $remoteWebDriver = null;
+
     /**
      * Go through parent initialization routines and in addition diagnose potential environment issues
      *
@@ -37,12 +47,32 @@ public function _initialize()
             $context[self::EXCEPTION_TYPE_SELENIUM] = $e->getMessage();
         }
 
+        try {
+            $adminUrl = getenv('MAGENTO_BACKEND_BASE_URL')
+                ?: rtrim(getenv('MAGENTO_BASE_URL'), '/')
+                . '/' . getenv('MAGENTO_BACKEND_NAME') . '/admin';
+            $this->validateGoToUrl($adminUrl);
+        } catch (\Exception $e) {
+            $context[self::EXCEPTION_TYPE_MAGENTO_ADMIN] = $e->getMessage();
+        }
+
+        try {
+            $storeUrl = getenv('MAGENTO_BASE_URL');
+            $this->validateGoToUrl($storeUrl);
+        } catch (\Exception $e) {
+            $context[self::EXCEPTION_TYPE_MAGENTO_STOREFRONT] = $e->getMessage();
+        }
+
         try {
             $this->checkMagentoCLI();
         } catch (TestFrameworkException $e) {
             $context[self::EXCEPTION_TYPE_MAGENTO_CLI] = $e->getMessage();
         }
 
+        if (null !== $this->remoteWebDriver) {
+            $this->remoteWebDriver->close();
+        }
+
         if (!empty($context)) {
             throw new TestFrameworkException('MagentoWebDriverDoctor initialization failed', $context);
         }
@@ -56,16 +86,17 @@ public function _initialize()
      */
     private function checkSeleniumServerReadiness()
     {
+        $this->connectionTimeoutInMs = 5000;
+        $this->requestTimeoutInMs = 5000;
         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"
@@ -74,6 +105,38 @@ private function checkSeleniumServerReadiness()
         }
     }
 
+    /**
+     * Validate if an url is accessible to browser controlled by selenium
+     *
+     * @param string $url
+     * @return void
+     * @throws TestFrameworkException
+     */
+    private function validateGoToUrl($url)
+    {
+        $this->remoteWebDriver->get($url);
+
+        $end = microtime(true) + $this->config['pageload_timeout'];
+        while ($end > microtime(true)) {
+            try {
+                $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) {
+            }
+            usleep(self::POLL_INTERVAL_MS);
+        }
+        throw new TestFrameworkException(
+            "Timed out opening page at url: $url"
+        );
+    }
+
     /**
      * Check Magento CLI setup
      *