4c160dd79998a7108ec1abb0d96efafa3691fea4
[moodle.git] / lib / tests / behat / behat_hooks.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Behat hooks steps definitions.
19  *
20  * This methods are used by Behat CLI command.
21  *
22  * @package    core
23  * @category   test
24  * @copyright  2012 David MonllaĆ³
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
30 require_once(__DIR__ . '/../../behat/behat_base.php');
32 use Behat\Behat\Event\SuiteEvent as SuiteEvent,
33     Behat\Behat\Event\ScenarioEvent as ScenarioEvent,
34     Behat\Behat\Event\StepEvent as StepEvent,
35     Behat\Mink\Exception\DriverException as DriverException,
36     WebDriver\Exception\NoSuchWindow as NoSuchWindow,
37     WebDriver\Exception\UnexpectedAlertOpen as UnexpectedAlertOpen,
38     WebDriver\Exception\UnknownError as UnknownError,
39     WebDriver\Exception\CurlExec as CurlExec,
40     WebDriver\Exception\NoAlertOpenError as NoAlertOpenError;
42 /**
43  * Hooks to the behat process.
44  *
45  * Behat accepts hooks after and before each
46  * suite, feature, scenario and step.
47  *
48  * They can not call other steps as part of their process
49  * like regular steps definitions does.
50  *
51  * Throws generic Exception because they are captured by Behat.
52  *
53  * @package   core
54  * @category  test
55  * @copyright 2012 David MonllaĆ³
56  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57  */
58 class behat_hooks extends behat_base {
60     /**
61      * @var Last browser session start time.
62      */
63     protected static $lastbrowsersessionstart = 0;
65     /**
66      * @var For actions that should only run once.
67      */
68     protected static $initprocessesfinished = false;
70     /**
71      * Some exceptions can only be caught in a before or after step hook,
72      * they can not be thrown there as they will provoke a framework level
73      * failure, but we can store them here to fail the step in i_look_for_exceptions()
74      * which result will be parsed by the framework as the last step result.
75      *
76      * @var Null or the exception last step throw in the before or after hook.
77      */
78     protected static $currentstepexception = null;
80     /**
81      * If we are saving any kind of dump on failure we should use the same parent dir during a run.
82      *
83      * @var The parent dir name
84      */
85     protected static $faildumpdirname = false;
87     /**
88      * Gives access to moodle codebase, ensures all is ready and sets up the test lock.
89      *
90      * Includes config.php to use moodle codebase with $CFG->behat_*
91      * instead of $CFG->prefix and $CFG->dataroot, called once per suite.
92      *
93      * @static
94      * @throws Exception
95      * @BeforeSuite
96      */
97     public static function before_suite($event) {
98         global $CFG;
100         // Defined only when the behat CLI command is running, the moodle init setup process will
101         // read this value and switch to $CFG->behat_dataroot and $CFG->behat_prefix instead of
102         // the normal site.
103         define('BEHAT_TEST', 1);
105         define('CLI_SCRIPT', 1);
107         // With BEHAT_TEST we will be using $CFG->behat_* instead of $CFG->dataroot, $CFG->prefix and $CFG->wwwroot.
108         require_once(__DIR__ . '/../../../config.php');
110         // Now that we are MOODLE_INTERNAL.
111         require_once(__DIR__ . '/../../behat/classes/behat_command.php');
112         require_once(__DIR__ . '/../../behat/classes/behat_selectors.php');
113         require_once(__DIR__ . '/../../behat/classes/behat_context_helper.php');
114         require_once(__DIR__ . '/../../behat/classes/util.php');
115         require_once(__DIR__ . '/../../testing/classes/test_lock.php');
116         require_once(__DIR__ . '/../../testing/classes/nasty_strings.php');
118         // Avoids vendor/bin/behat to be executed directly without test environment enabled
119         // to prevent undesired db & dataroot modifications, this is also checked
120         // before each scenario (accidental user deletes) in the BeforeScenario hook.
122         if (!behat_util::is_test_mode_enabled()) {
123             throw new Exception('Behat only can run if test mode is enabled. More info in ' . behat_command::DOCS_URL . '#Running_tests');
124         }
126         if (!behat_util::is_server_running()) {
127             throw new Exception($CFG->behat_wwwroot .
128                 ' is not available, ensure you specified correct url and that the server is set up and started.' .
129                 ' More info in ' . behat_command::DOCS_URL . '#Running_tests');
130         }
132         // Prevents using outdated data, upgrade script would start and tests would fail.
133         if (!behat_util::is_test_data_updated()) {
134             $commandpath = 'php admin/tool/behat/cli/init.php';
135             throw new Exception("Your behat test site is outdated, please run\n\n    " .
136                     $commandpath . "\n\nfrom your moodle dirroot to drop and install the behat test site again.");
137         }
138         // Avoid parallel tests execution, it continues when the previous lock is released.
139         test_lock::acquire('behat');
141         // Store the browser reset time if reset after N seconds is specified in config.php.
142         if (!empty($CFG->behat_restart_browser_after)) {
143             // Store the initial browser session opening.
144             self::$lastbrowsersessionstart = time();
145         }
147         if (!empty($CFG->behat_faildump_path) && !is_writable($CFG->behat_faildump_path)) {
148             throw new Exception('You set $CFG->behat_faildump_path to a non-writable directory');
149         }
150     }
152     /**
153      * Resets the test environment.
154      *
155      * @throws coding_exception If here we are not using the test database it should be because of a coding error
156      * @BeforeScenario
157      */
158     public function before_scenario($event) {
159         global $DB, $SESSION, $CFG;
161         // As many checks as we can.
162         if (!defined('BEHAT_TEST') ||
163                !defined('BEHAT_SITE_RUNNING') ||
164                php_sapi_name() != 'cli' ||
165                !behat_util::is_test_mode_enabled() ||
166                !behat_util::is_test_site()) {
167             throw new coding_exception('Behat only can modify the test database and the test dataroot!');
168         }
170         $moreinfo = 'More info in ' . behat_command::DOCS_URL . '#Running_tests';
171         $driverexceptionmsg = 'Selenium server is not running, you need to start it to run tests that involve Javascript. ' . $moreinfo;
172         try {
173             $session = $this->getSession();
174         } catch (CurlExec $e) {
175             // Exception thrown by WebDriver, so only @javascript tests will be caugth; in
176             // behat_util::is_server_running() we already checked that the server is running.
177             throw new Exception($driverexceptionmsg);
178         } catch (DriverException $e) {
179             throw new Exception($driverexceptionmsg);
180         } catch (UnknownError $e) {
181             // Generic 'I have no idea' Selenium error. Custom exception to provide more feedback about possible solutions.
182             $this->throw_unknown_exception($e);
183         }
186         // We need the Mink session to do it and we do it only before the first scenario.
187         if (self::is_first_scenario()) {
188             behat_selectors::register_moodle_selectors($session);
189             behat_context_helper::set_session($session);
190         }
192         // Reset $SESSION.
193         \core\session\manager::init_empty_session();
195         behat_util::reset_all_data();
197         // Assign valid data to admin user (some generator-related code needs a valid user).
198         $user = $DB->get_record('user', array('username' => 'admin'));
199         \core\session\manager::set_user($user);
201         // Reset the browser if specified in config.php.
202         if (!empty($CFG->behat_restart_browser_after) && $this->running_javascript()) {
203             $now = time();
204             if (self::$lastbrowsersessionstart + $CFG->behat_restart_browser_after < $now) {
205                 $session->restart();
206                 self::$lastbrowsersessionstart = $now;
207             }
208         }
210         // Start always in the the homepage.
211         try {
212             // Let's be conservative as we never know when new upstream issues will affect us.
213             $session->visit($this->locate_path('/'));
214         } catch (UnknownError $e) {
215             $this->throw_unknown_exception($e);
216         }
219         // Checking that the root path is a Moodle test site.
220         if (self::is_first_scenario()) {
221             $notestsiteexception = new Exception('The base URL (' . $CFG->wwwroot . ') is not a behat test site, ' .
222                 'ensure you started the built-in web server in the correct directory or your web server is correctly started and set up');
223             $this->find("xpath", "//head/child::title[normalize-space(.)='" . behat_util::BEHATSITENAME . "']", $notestsiteexception);
225             self::$initprocessesfinished = true;
226         }
227         // Run all test with medium (1024x768) screen size, to avoid responsive problems.
228         $this->resize_window('medium');
229     }
231     /**
232      * Wait for JS to complete before beginning interacting with the DOM.
233      *
234      * Executed only when running against a real browser. We wrap it
235      * all in a try & catch to forward the exception to i_look_for_exceptions
236      * so the exception will be at scenario level, which causes a failure, by
237      * default would be at framework level, which will stop the execution of
238      * the run.
239      *
240      * @BeforeStep @javascript
241      */
242     public function before_step_javascript($event) {
244         try {
245             $this->wait_for_pending_js();
246             self::$currentstepexception = null;
247         } catch (Exception $e) {
248             self::$currentstepexception = $e;
249         }
250     }
252     /**
253      * Wait for JS to complete after finishing the step.
254      *
255      * With this we ensure that there are not AJAX calls
256      * still in progress.
257      *
258      * Executed only when running against a real browser. We wrap it
259      * all in a try & catch to forward the exception to i_look_for_exceptions
260      * so the exception will be at scenario level, which causes a failure, by
261      * default would be at framework level, which will stop the execution of
262      * the run.
263      *
264      * @AfterStep @javascript
265      */
266     public function after_step_javascript($event) {
267         global $CFG;
269         // Save a screenshot if the step failed.
270         if (!empty($CFG->behat_faildump_path) &&
271                 $event->getResult() === StepEvent::FAILED) {
272             $this->take_screenshot($event);
273         }
275         try {
276             $this->wait_for_pending_js();
277             self::$currentstepexception = null;
278         } catch (UnexpectedAlertOpen $e) {
279             self::$currentstepexception = $e;
281             // Accepting the alert so the framework can continue properly running
282             // the following scenarios. Some browsers already closes the alert, so
283             // wrapping in a try & catch.
284             try {
285                 $this->getSession()->getDriver()->getWebDriverSession()->accept_alert();
286             } catch (Exception $e) {
287                 // Catching the generic one as we never know how drivers reacts here.
288             }
289         } catch (Exception $e) {
290             self::$currentstepexception = $e;
291         }
292     }
294     /**
295      * Execute any steps required after the step has finished.
296      *
297      * This includes creating an HTML dump of the content if there was a failure.
298      *
299      * @AfterStep
300      */
301     public function after_step($event) {
302         global $CFG;
304         // Save the page content if the step failed.
305         if (!empty($CFG->behat_faildump_path) &&
306                 $event->getResult() === StepEvent::FAILED) {
307             $this->take_contentdump($event);
308         }
309     }
311     /**
312      * Getter for self::$faildumpdirname
313      *
314      * @return string
315      */
316     protected function get_run_faildump_dir() {
317         return self::$faildumpdirname;
318     }
320     /**
321      * Take screenshot when a step fails.
322      *
323      * @throws Exception
324      * @param StepEvent $event
325      */
326     protected function take_screenshot(StepEvent $event) {
327         // Goutte can't save screenshots.
328         if (!$this->running_javascript()) {
329             return false;
330         }
332         list ($dir, $filename) = $this->get_faildump_filename($event, 'png');
333         $this->saveScreenshot($filename, $dir);
334     }
336     /**
337      * Take a dump of the page content when a step fails.
338      *
339      * @throws Exception
340      * @param StepEvent $event
341      */
342     protected function take_contentdump(StepEvent $event) {
343         list ($dir, $filename) = $this->get_faildump_filename($event, 'html');
345         $fh = fopen($dir . DIRECTORY_SEPARATOR . $filename, 'w');
346         fwrite($fh, $this->getSession()->getPage()->getContent());
347         fclose($fh);
348     }
350     /**
351      * Determine the full pathname to store a failure-related dump.
352      *
353      * This is used for content such as the DOM, and screenshots.
354      *
355      * @param StepEvent $event
356      * @param String $filetype The file suffix to use. Limited to 4 chars.
357      */
358     protected function get_faildump_filename(StepEvent $event, $filetype) {
359         global $CFG;
361         // All the contentdumps should be in the same parent dir.
362         if (!$faildumpdir = self::get_run_faildump_dir()) {
363             $faildumpdir = self::$faildumpdirname = date('Ymd_His');
365             $dir = $CFG->behat_faildump_path . DIRECTORY_SEPARATOR . $faildumpdir;
367             if (!is_dir($dir) && !mkdir($dir, $CFG->directorypermissions, true)) {
368                 // It shouldn't, we already checked that the directory is writable.
369                 throw new Exception('No directories can be created inside $CFG->behat_faildump_path, check the directory permissions.');
370             }
371         } else {
372             // We will always need to know the full path.
373             $dir = $CFG->behat_faildump_path . DIRECTORY_SEPARATOR . $faildumpdir;
374         }
376         // The scenario title + the failed step text.
377         // We want a i-am-the-scenario-title_i-am-the-failed-step.$filetype format.
378         $filename = $event->getStep()->getParent()->getTitle() . '_' . $event->getStep()->getText();
379         $filename = preg_replace('/([^a-zA-Z0-9\_]+)/', '-', $filename);
381         // File name limited to 255 characters. Leaving 4 chars for the file
382         // extension as we allow .png for images and .html for DOM contents.
383         $filename = substr($filename, 0, 250) . '.' . $filetype;
385         return array($dir, $filename);
386     }
388     /**
389      * Waits for all the JS to be loaded.
390      *
391      * @throws \Exception
392      * @throws NoSuchWindow
393      * @throws UnknownError
394      * @return bool True or false depending whether all the JS is loaded or not.
395      */
396     protected function wait_for_pending_js() {
398         // We don't use behat_base::spin() here as we don't want to end up with an exception
399         // if the page & JSs don't finish loading properly.
400         for ($i = 0; $i < self::EXTENDED_TIMEOUT * 10; $i++) {
401             $pending = '';
402             try {
403                 $jscode = 'return ' . self::PAGE_READY_JS . ' ? "" : M.util.pending_js.join(":");';
404                 $pending = $this->getSession()->evaluateScript($jscode);
405             } catch (NoSuchWindow $nsw) {
406                 // We catch an exception here, in case we just closed the window we were interacting with.
407                 // No javascript is running if there is no window right?
408                 $pending = '';
409             } catch (UnknownError $e) {
410                 // M is not defined when the window or the frame don't exist anymore.
411                 if (strstr($e->getMessage(), 'M is not defined') != false) {
412                     $pending = '';
413                 }
414             }
416             // If there are no pending JS we stop waiting.
417             if ($pending === '') {
418                 return true;
419             }
421             // 0.1 seconds.
422             usleep(100000);
423         }
425         // Timeout waiting for JS to complete. It will be catched and forwarded to behat_hooks::i_look_for_exceptions().
426         // It is unlikely that Javascript code of a page or an AJAX request needs more than self::EXTENDED_TIMEOUT seconds
427         // to be loaded, although when pages contains Javascript errors M.util.js_complete() can not be executed, so the
428         // number of JS pending code and JS completed code will not match and we will reach this point.
429         throw new \Exception('Javascript code and/or AJAX requests are not ready after ' . self::EXTENDED_TIMEOUT .
430             ' seconds. There is a Javascript error or the code is extremely slow.');
431     }
433     /**
434      * Internal step definition to find exceptions, debugging() messages and PHP debug messages.
435      *
436      * Part of behat_hooks class as is part of the testing framework, is auto-executed
437      * after each step so no features will splicitly use it.
438      *
439      * @Given /^I look for exceptions$/
440      * @throw Exception Unknown type, depending on what we caught in the hook or basic \Exception.
441      * @see Moodle\BehatExtension\Tester\MoodleStepTester
442      */
443     public function i_look_for_exceptions() {
445         // If the step already failed in a hook throw the exception.
446         if (!is_null(self::$currentstepexception)) {
447             throw self::$currentstepexception;
448         }
450         // Wrap in try in case we were interacting with a closed window.
451         try {
453             // Exceptions.
454             $exceptionsxpath = "//div[@data-rel='fatalerror']";
455             // Debugging messages.
456             $debuggingxpath = "//div[@data-rel='debugging']";
457             // PHP debug messages.
458             $phperrorxpath = "//div[@data-rel='phpdebugmessage']";
459             // Any other backtrace.
460             $othersxpath = "(//*[contains(., ': call to ')])[1]";
462             $xpaths = array($exceptionsxpath, $debuggingxpath, $phperrorxpath, $othersxpath);
463             $joinedxpath = implode(' | ', $xpaths);
465             // Joined xpath expression. Most of the time there will be no exceptions, so this pre-check
466             // is faster than to send the 4 xpath queries for each step.
467             if (!$this->getSession()->getDriver()->find($joinedxpath)) {
468                 return;
469             }
471             // Exceptions.
472             if ($errormsg = $this->getSession()->getPage()->find('xpath', $exceptionsxpath)) {
474                 // Getting the debugging info and the backtrace.
475                 $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.alert-error');
476                 // If errorinfoboxes is empty, try find notifytiny (original) class.
477                 if (empty($errorinfoboxes)) {
478                     $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.notifytiny');
479                 }
480                 $errorinfo = $this->get_debug_text($errorinfoboxes[0]->getHtml()) . "\n" .
481                     $this->get_debug_text($errorinfoboxes[1]->getHtml());
483                 $msg = "Moodle exception: " . $errormsg->getText() . "\n" . $errorinfo;
484                 throw new \Exception(html_entity_decode($msg));
485             }
487             // Debugging messages.
488             if ($debuggingmessages = $this->getSession()->getPage()->findAll('xpath', $debuggingxpath)) {
489                 $msgs = array();
490                 foreach ($debuggingmessages as $debuggingmessage) {
491                     $msgs[] = $this->get_debug_text($debuggingmessage->getHtml());
492                 }
493                 $msg = "debugging() message/s found:\n" . implode("\n", $msgs);
494                 throw new \Exception(html_entity_decode($msg));
495             }
497             // PHP debug messages.
498             if ($phpmessages = $this->getSession()->getPage()->findAll('xpath', $phperrorxpath)) {
500                 $msgs = array();
501                 foreach ($phpmessages as $phpmessage) {
502                     $msgs[] = $this->get_debug_text($phpmessage->getHtml());
503                 }
504                 $msg = "PHP debug message/s found:\n" . implode("\n", $msgs);
505                 throw new \Exception(html_entity_decode($msg));
506             }
508             // Any other backtrace.
509             // First looking through xpath as it is faster than get and parse the whole page contents,
510             // we get the contents and look for matches once we found something to suspect that there is a backtrace.
511             if ($this->getSession()->getDriver()->find($othersxpath)) {
512                 $backtracespattern = '/(line [0-9]* of [^:]*: call to [\->&;:a-zA-Z_\x7f-\xff][\->&;:a-zA-Z0-9_\x7f-\xff]*)/';
513                 if (preg_match_all($backtracespattern, $this->getSession()->getPage()->getContent(), $backtraces)) {
514                     $msgs = array();
515                     foreach ($backtraces[0] as $backtrace) {
516                         $msgs[] = $backtrace . '()';
517                     }
518                     $msg = "Other backtraces found:\n" . implode("\n", $msgs);
519                     throw new \Exception(htmlentities($msg));
520                 }
521             }
523         } catch (NoSuchWindow $e) {
524             // If we were interacting with a popup window it will not exists after closing it.
525         }
526     }
528     /**
529      * Converts HTML tags to line breaks to display the info in CLI
530      *
531      * @param string $html
532      * @return string
533      */
534     protected function get_debug_text($html) {
536         // Replacing HTML tags for new lines and keeping only the text.
537         $notags = preg_replace('/<+\s*\/*\s*([A-Z][A-Z0-9]*)\b[^>]*\/*\s*>*/i', "\n", $html);
538         return preg_replace("/(\n)+/s", "\n", $notags);
539     }
541     /**
542      * Returns whether the first scenario of the suite is running
543      *
544      * @return bool
545      */
546     protected static function is_first_scenario() {
547         return !(self::$initprocessesfinished);
548     }
550     /**
551      * Throws an exception after appending an extra info text.
552      *
553      * @throws Exception
554      * @param UnknownError $exception
555      * @return void
556      */
557     protected function throw_unknown_exception(UnknownError $exception) {
558         $text = get_string('unknownexceptioninfo', 'tool_behat');
559         throw new Exception($text . PHP_EOL . $exception->getMessage());
560     }