MDL-37858 testing: Adding nasty strings generator
[moodle.git] / lib / tests / behat / behat_hooks.php
CommitLineData
f5ceb6c2
DM
1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * Behat hooks steps definitions.
20 *
21 * This methods are used by Behat CLI command.
22 *
23 * @package core
24 * @category test
25 * @copyright 2012 David MonllaĆ³
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 */
28
29// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
30
31require_once(__DIR__ . '/../../behat/behat_base.php');
32
33use Behat\Behat\Event\SuiteEvent as SuiteEvent;
34use Behat\Behat\Event\ScenarioEvent as ScenarioEvent;
35use Behat\Behat\Event\StepEvent as StepEvent;
36
37/**
38 * Hooks to the behat process.
39 *
40 * Behat accepts hooks after and before each
41 * suite, feature, scenario and step.
42 *
43 * They can not call other steps as part of their process
44 * like regular steps definitions does.
45 *
46 * Throws generic Exception because they are captured by Behat.
47 *
48 * @package core
49 * @category test
50 * @copyright 2012 David MonllaĆ³
51 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52 */
53class behat_hooks extends behat_base {
54
f5ceb6c2
DM
55 /**
56 * Gives access to moodle codebase, ensures all is ready and sets up the test lock.
57 *
58 * Includes config.php to use moodle codebase with $CFG->behat_*
59 * instead of $CFG->prefix and $CFG->dataroot, called once per suite.
60 *
61 * @static
62 * @throws Exception
63 * @BeforeSuite
64 */
65 public static function before_suite($event) {
66 global $CFG;
67
68 // To work with behat_dataroot and behat_prefix instead of the regular environment.
69 define('BEHAT_RUNNING', 1);
70 define('CLI_SCRIPT', 1);
71
b831d479 72 // With BEHAT_RUNNING we will be using $CFG->behat_* instead of $CFG->dataroot, $CFG->prefix and $CFG->wwwroot.
f5ceb6c2
DM
73 require_once(__DIR__ . '/../../../config.php');
74
75 // Now that we are MOODLE_INTERNAL.
76 require_once(__DIR__ . '/../../behat/classes/behat_command.php');
77 require_once(__DIR__ . '/../../behat/classes/util.php');
78 require_once(__DIR__ . '/../../testing/classes/test_lock.php');
79
80 // Avoids vendor/bin/behat to be executed directly without test environment enabled
81 // to prevent undesired db & dataroot modifications, this is also checked
82 // before each scenario (accidental user deletes) in the BeforeScenario hook.
83
84 if (!behat_util::is_test_mode_enabled()) {
85 throw new Exception('Behat only can run if test mode is enabled. More info in ' . behat_command::DOCS_URL . '#Running_tests');
86 }
87
88 if (!behat_util::is_server_running()) {
89 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');
90 }
91
b831d479
DM
92 // Prevents using outdated data, upgrade script would start and tests would fail.
93 if (!behat_util::is_test_data_updated()) {
94 $commandpath = 'php admin/tool/behat/cli/util.php';
95 throw new Exception('Your behat test site is outdated, please run ' . $commandpath . ' from your moodle dirroot to drop and install the behat test site again.');
96 }
f5ceb6c2
DM
97 // Avoid parallel tests execution, it continues when the previous lock is released.
98 test_lock::acquire('behat');
99 }
100
101 /**
102 * Resets the test environment.
103 *
104 * @throws coding_exception If here we are not using the test database it should be because of a coding error
105 * @BeforeScenario
106 */
107 public function before_scenario($event) {
108 global $DB, $SESSION, $CFG;
109
110 // As many checks as we can.
111 if (!defined('BEHAT_RUNNING') ||
112 php_sapi_name() != 'cli' ||
113 !behat_util::is_test_mode_enabled() ||
114 !behat_util::is_test_site() ||
115 !isset($CFG->originaldataroot)) {
116 throw new coding_exception('Behat only can modify the test database and the test dataroot!');
117 }
118
119 behat_util::reset_database();
120 behat_util::reset_dataroot();
121
10dd80c2
DM
122 purge_all_caches();
123 accesslib_clear_all_caches(true);
124
f5ceb6c2
DM
125 // Assing valid data to admin user (some generator-related code needs a valid user).
126 $user = $DB->get_record('user', array('username' => 'admin'));
127 session_set_user($user);
128
129 // Avoid some notices / warnings.
130 $SESSION = new stdClass();
131 }
132
133 /**
134 * Ensures selenium is running.
135 *
136 * Is only executed in scenarios which requires Javascript to run,
137 * it returns a direct error message about what's going on.
138 *
139 * @throws Exception
140 * @BeforeScenario @javascript
141 */
142 public function before_scenario_javascript($event) {
143
144 // Just trying if server responds.
145 try {
146 $this->getSession()->executeScript('// empty comment');
147 } catch (Exception $e) {
148 $moreinfo = 'More info in ' . behat_command::DOCS_URL . '#Running_tests';
149 $msg = 'Selenium server is not running, you need to start it to run tests that involves Javascript. ' . $moreinfo;
150 throw new Exception($msg);
151 }
152 }
153
154 /**
155 * Checks that all DOM is ready.
156 *
157 * Executed only when running against a real browser.
158 *
159 * @AfterStep @javascript
160 */
161 public function after_step_javascript($event) {
162
163 // If it doesn't have definition or it fails there is no need to check it.
164 if ($event->getResult() != StepEvent::PASSED ||
165 !$event->hasDefinition()) {
166 return;
167 }
168
d56ae59b
DM
169 // Wait until the page is ready.
170 $this->getSession()->wait(self::TIMEOUT, '(document.readyState === "complete")');
f5ceb6c2
DM
171 }
172
173}