From 0141968b9e725da2036c548cadb7631a56a376e6 Mon Sep 17 00:00:00 2001
From: David Monllao <davidm@moodle.com>
Date: Wed, 4 Sep 2013 13:40:56 +0800
Subject: [PATCH] MDL-41555 tool_behat: Improving behat & selenium exceptions
 messages

Also moving the 'selenium not running'
checking to a proper place as it was
not thrown since the homepage start
visit() was introduced.
---
 admin/tool/behat/lang/en/tool_behat.php |  1 +
 lib/tests/behat/behat_hooks.php         | 58 +++++++++++++++----------
 2 files changed, 35 insertions(+), 24 deletions(-)

diff --git a/admin/tool/behat/lang/en/tool_behat.php b/admin/tool/behat/lang/en/tool_behat.php
index 9f426cc6a01..a67581d7664 100644
--- a/admin/tool/behat/lang/en/tool_behat.php
+++ b/admin/tool/behat/lang/en/tool_behat.php
@@ -38,6 +38,7 @@ $string['stepsdefinitionscontains'] = 'Contains';
 $string['stepsdefinitionsfilters'] = 'Steps definitions';
 $string['stepsdefinitionstype'] = 'Type';
 $string['theninfo'] = 'Then. Checkings to ensure the outcomes are the expected ones';
+$string['unknownexceptioninfo'] = 'There was a problem with Selenium or the browser, try to upgrade Selenium to the latest version. Error: ';
 $string['viewsteps'] = 'Filter';
 $string['wheninfo'] = 'When. Actions that provokes an event';
 $string['wrongbehatsetup'] = 'Something is wrong with behat setup, ensure:<ul>
diff --git a/lib/tests/behat/behat_hooks.php b/lib/tests/behat/behat_hooks.php
index 645a647d90a..c7afed67060 100644
--- a/lib/tests/behat/behat_hooks.php
+++ b/lib/tests/behat/behat_hooks.php
@@ -34,6 +34,8 @@ use Behat\Behat\Event\SuiteEvent as SuiteEvent,
     Behat\Behat\Event\StepEvent as StepEvent,
     WebDriver\Exception\NoSuchWindow as NoSuchWindow,
     WebDriver\Exception\UnexpectedAlertOpen as UnexpectedAlertOpen,
+    WebDriver\Exception\UnknownError as UnknownError,
+    WebDriver\Exception\CurlExec as CurlExec,
     WebDriver\Exception\NoAlertOpenError as NoAlertOpenError;
 
 /**
@@ -102,7 +104,9 @@ class behat_hooks extends behat_base {
         }
 
         if (!behat_util::is_server_running()) {
-            throw new Exception($CFG->behat_wwwroot . ' is not available, ensure you started your PHP built-in server. More info in ' . behat_command::DOCS_URL . '#Running_tests');
+            throw new Exception($CFG->behat_wwwroot .
+                ' is not available, ensure you started your PHP built-in server or your web server is correctly started and set up.' .
+                ' More info in ' . behat_command::DOCS_URL . '#Running_tests');
         }
 
         // Prevents using outdated data, upgrade script would start and tests would fail.
@@ -164,12 +168,23 @@ class behat_hooks extends behat_base {
         }
 
         // Start always in the the homepage.
-        $this->getSession()->visit($this->locate_path('/'));
+        try {
+            $this->getSession()->visit($this->locate_path('/'));
+        } catch (CurlExec $e) {
+            // Exception thrown by WebDriver, so only @javascript tests will be caugth; in
+            // behat_util::is_server_running() we already checked that the server is running.
+            $moreinfo = 'More info in ' . behat_command::DOCS_URL . '#Running_tests';
+            $msg = 'Selenium server is not running, you need to start it to run tests that involve Javascript. ' . $moreinfo;
+            throw new Exception($msg);
+        } catch (UnknownError $e) {
+            // Generic 'I have no idea' Selenium error. Custom exception to provide more feedback about possible solutions.
+            $this->throw_unknown_exception($e);
+        }
 
         // Checking that the root path is a Moodle test site.
         if (self::is_first_scenario()) {
             $notestsiteexception = new Exception('The base URL (' . $CFG->wwwroot . ') is not a behat test site, ' .
-                'ensure you started the built-in web server in the correct directory');
+                'ensure you started the built-in web server in the correct directory or your web server is correctly started and set up');
             $this->find("xpath", "//head/child::title[normalize-space(.)='Acceptance test site']", $notestsiteexception);
 
             self::$initprocessesfinished = true;
@@ -186,27 +201,6 @@ class behat_hooks extends behat_base {
 
     }
 
-    /**
-     * Ensures selenium is running.
-     *
-     * Is only executed in scenarios which requires Javascript to run,
-     * it returns a direct error message about what's going on.
-     *
-     * @throws Exception
-     * @BeforeScenario @javascript
-     */
-    public function before_scenario_javascript($event) {
-
-        // Just trying if server responds.
-        try {
-            $this->getSession()->wait(0, false);
-        } catch (Exception $e) {
-            $moreinfo = 'More info in ' . behat_command::DOCS_URL . '#Running_tests';
-            $msg = 'Selenium server is not running, you need to start it to run tests that involves Javascript. ' . $moreinfo;
-            throw new Exception($msg);
-        }
-    }
-
     /**
      * Checks that all DOM is ready.
      *
@@ -240,6 +234,9 @@ class behat_hooks extends behat_base {
 
         } catch (NoSuchWindow $e) {
             // If we were interacting with a popup window it will not exists after closing it.
+        } catch (UnknownError $e) {
+            // Custom exception to provide more feedback about possible solutions.
+            $this->throw_unknown_exception($e);
         }
     }
 
@@ -357,4 +354,17 @@ class behat_hooks extends behat_base {
     protected static function is_first_scenario() {
         return !(self::$initprocessesfinished);
     }
+
+    /**
+     * Throws an exception after appending an extra info text.
+     *
+     * @throws Exception
+     * @param UnknownError $exception
+     * @return void
+     */
+    protected function throw_unknown_exception(UnknownError $exception) {
+        $text = get_string('unknownexceptioninfo', 'tool_behat');
+        throw new Exception($text . PHP_EOL . $exception->getMessage());
+    }
+
 }