007ce54435f5c7accfc593de754bd326eb64bd0d
[moodle.git] / lib / tests / behat / behat_data_generators.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  * Data generators for acceptance testing.
19  *
20  * @package   core
21  * @category  test
22  * @copyright 2012 David MonllaĆ³
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
28 require_once(__DIR__ . '/../../behat/behat_base.php');
30 use Behat\Gherkin\Node\TableNode as TableNode;
31 use Behat\Behat\Exception\PendingException as PendingException;
33 /**
34  * Class to set up quickly a Given environment.
35  *
36  * Acceptance tests are block-boxed, so this steps definitions should only
37  * be used to set up the test environment as we are not replicating user steps.
38  *
39  * All data generators should be in lib/testing/generator/*, shared between phpunit
40  * and behat and they should be called from here, if possible using the standard
41  * 'create_$elementname($options)' and if it's not possible (data generators arguments will not be
42  * always the same) or the element is not suitable to be a data generator, create a
43  * 'process_$elementname($options)' method and use the data generator from there if possible.
44  *
45  * @todo      If the available elements list grows too much this class must be split into smaller pieces
46  * @package   core
47  * @category  test
48  * @copyright 2012 David MonllaĆ³
49  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
50  */
51 class behat_data_generators extends behat_base {
53     const cap_allow = 'Allow';
54     const cap_prevent = 'Prevent';
55     const cap_prohibit = 'Prohibit';
57     /**
58      * @var testing_data_generator
59      */
60     protected $datagenerator;
62     /**
63      * Each element specifies:
64      * - The data generator sufix used.
65      * - The required fields.
66      * - The mapping between other elements references and database field names.
67      * @var array
68      */
69     protected static $elements = array(
70         'users' => array(
71             'datagenerator' => 'user',
72             'required' => array('username')
73         ),
74         'categories' => array(
75             'datagenerator' => 'category',
76             'required' => array('idnumber'),
77             'switchids' => array('category' => 'parent')
78         ),
79         'courses' => array(
80             'datagenerator' => 'course',
81             'required' => array('shortname'),
82             'switchids' => array('category' => 'category')
83         ),
84         'groups' => array(
85             'datagenerator' => 'group',
86             'required' => array('idnumber', 'course'),
87             'switchids' => array('course' => 'courseid')
88         ),
89         'groupings' => array(
90             'datagenerator' => 'grouping',
91             'required' => array('idnumber', 'course'),
92             'switchids' => array('course' => 'courseid')
93         ),
94         'course enrolments' => array(
95             'datagenerator' => 'enrol_user',
96             'required' => array('user', 'course', 'role'),
97             'switchids' => array('user' => 'userid', 'course' => 'courseid', 'role' => 'roleid')
99         ),
100         'permission overrides' => array(
101             'datagenerator' => 'permission_override',
102             'required' => array('capability', 'permission', 'role', 'contextlevel', 'reference'),
103             'switchids' => array('role' => 'roleid')
104         ),
105         'system role assigns' => array(
106             'datagenerator' => 'system_role_assign',
107             'required' => array('user', 'role'),
108             'switchids' => array('user' => 'userid', 'role' => 'roleid')
109         ),
110         'role assigns' => array(
111             'datagenerator' => 'role_assign',
112             'required' => array('user', 'role', 'contextlevel', 'reference'),
113             'switchids' => array('user' => 'userid', 'role' => 'roleid')
114         ),
115         'activities' => array(
116             'datagenerator' => 'activity',
117             'required' => array('activity', 'idnumber', 'course'),
118             'switchids' => array('course' => 'course')
119         ),
120         'group members' => array(
121             'datagenerator' => 'group_member',
122             'required' => array('user', 'group'),
123             'switchids' => array('user' => 'userid', 'group' => 'groupid')
124         ),
125         'grouping groups' => array(
126             'datagenerator' => 'grouping_group',
127             'required' => array('grouping', 'group'),
128             'switchids' => array('grouping' => 'groupingid', 'group' => 'groupid')
129         ),
130         'cohorts' => array(
131             'datagenerator' => 'cohort',
132             'required' => array('idnumber')
133         )
134     );
136     /**
137      * Creates the specified element. More info about available elements in http://docs.moodle.org/dev/Acceptance_testing#Fixtures.
138      *
139      * @Given /^the following "(?P<element_string>(?:[^"]|\\")*)" exists:$/
140      *
141      * @throws Exception
142      * @throws PendingException
143      * @param string    $elementname The name of the entity to add
144      * @param TableNode $data
145      */
146     public function the_following_exists($elementname, TableNode $data) {
148         // Now that we need them require the data generators.
149         require_once(__DIR__ . '/../../testing/generator/lib.php');
151         if (empty(self::$elements[$elementname])) {
152             throw new PendingException($elementname . ' data generator is not implemented');
153         }
155         $this->datagenerator = testing_util::get_data_generator();
157         $elementdatagenerator = self::$elements[$elementname]['datagenerator'];
158         $requiredfields = self::$elements[$elementname]['required'];
159         if (!empty(self::$elements[$elementname]['switchids'])) {
160             $switchids = self::$elements[$elementname]['switchids'];
161         }
163         foreach ($data->getHash() as $elementdata) {
165             // Check if all the required fields are there.
166             foreach ($requiredfields as $requiredfield) {
167                 if (!isset($elementdata[$requiredfield])) {
168                     throw new Exception($elementname . ' requires the field ' . $requiredfield . ' to be specified');
169                 }
170             }
172             // Switch from human-friendly references to ids.
173             if (isset($switchids)) {
174                 foreach ($switchids as $element => $field) {
175                     $methodname = 'get_' . $element . '_id';
177                     // Not all the switch fields are required, default vars will be assigned by data generators.
178                     if (isset($elementdata[$element])) {
179                         // Temp $id var to avoid problems when $element == $field.
180                         $id = $this->{$methodname}($elementdata[$element]);
181                         unset($elementdata[$element]);
182                         $elementdata[$field] = $id;
183                     }
184                 }
185             }
187             // Preprocess the entities that requires a special treatment.
188             if (method_exists($this, 'preprocess_' . $elementdatagenerator)) {
189                 $elementdata = $this->{'preprocess_' . $elementdatagenerator}($elementdata);
190             }
192             // Creates element.
193             $methodname = 'create_' . $elementdatagenerator;
194             if (method_exists($this->datagenerator, $methodname)) {
195                 // Using data generators directly.
196                 $this->datagenerator->{$methodname}($elementdata);
198             } else if (method_exists($this, 'process_' . $elementdatagenerator)) {
199                 // Using an alternative to the direct data generator call.
200                 $this->{'process_' . $elementdatagenerator}($elementdata);
201             } else {
202                 throw new PendingException($elementname . ' data generator is not implemented');
203             }
204         }
206     }
208     /**
209      * If password is not set it uses the username.
210      * @param array $data
211      * @return array
212      */
213     protected function preprocess_user($data) {
214         if (!isset($data['password'])) {
215             $data['password'] = $data['username'];
216         }
217         return $data;
218     }
220     /**
221      * Adapter to modules generator
222      * @throws Exception Custom exception for test writers
223      * @param array $data
224      * @return void
225      */
226     protected function process_activity($data) {
228         // The the_following_exists() method checks that the field exists.
229         $activityname = $data['activity'];
230         unset($data['activity']);
232         // Custom exception.
233         try {
234             $this->datagenerator->create_module($activityname, $data);
235         } catch (coding_exception $e) {
236             throw new Exception('\'' . $activityname . '\' activity can not be added using this step,' .
237                 ' use the step \'I add a "ACTIVITY_OR_RESOURCE_NAME_STRING" to section "SECTION_NUMBER"\' instead');
238         }
239     }
241     /**
242      * Adapter to enrol_user() data generator.
243      * @throws Exception
244      * @param array $data
245      * @return void
246      */
247     protected function process_enrol_user($data) {
248         global $SITE;
250         if (empty($data['roleid'])) {
251             throw new Exception('\'course enrolments\' requires the field \'role\' to be specified');
252         }
254         if (!isset($data['userid'])) {
255             throw new Exception('\'course enrolments\' requires the field \'user\' to be specified');
256         }
258         if (!isset($data['courseid'])) {
259             throw new Exception('\'course enrolments\' requires the field \'course\' to be specified');
260         }
262         if (!isset($data['enrol'])) {
263             $data['enrol'] = 'manual';
264         }
266         // If the provided course shortname is the site shortname we consider it a system role assign.
267         if ($data['courseid'] == $SITE->id) {
268             // Frontpage course assign.
269             $context = context_course::instance($data['courseid']);
270             role_assign($data['roleid'], $data['userid'], $context->id);
272         } else {
273             // Course assign.
274             $this->datagenerator->enrol_user($data['userid'], $data['courseid'], $data['roleid'], $data['enrol']);
275         }
277     }
279     /**
280      * Allows/denies a capability at the specified context
281      *
282      * @throws Exception
283      * @param array $data
284      * @return void
285      */
286     protected function process_permission_override($data) {
288         // Will throw an exception if it does not exist.
289         $context = $this->get_context($data['contextlevel'], $data['reference']);
291         switch ($data['permission']) {
292             case self::cap_allow:
293                 $permission = CAP_ALLOW;
294                 break;
295             case self::cap_prevent:
296                 $permission = CAP_PREVENT;
297                 break;
298             case self::cap_prohibit:
299                 $permission = CAP_PROHIBIT;
300                 break;
301             default:
302                 throw new Exception('The \'' . $data['permission'] . '\' permission does not exist');
303                 break;
304         }
306         if (is_null(get_capability_info($data['capability']))) {
307             throw new Exception('The \'' . $data['capability'] . '\' capability does not exist');
308         }
310         role_change_permission($data['roleid'], $context, $data['capability'], $permission);
311     }
313     /**
314      * Assigns a role to a user at system context
315      *
316      * Used by "system role assigns" can be deleted when
317      * system role assign will be deprecated in favour of
318      * "role assigns"
319      *
320      * @throws Exception
321      * @param array $data
322      * @return void
323      */
324     protected function process_system_role_assign($data) {
326         if (empty($data['roleid'])) {
327             throw new Exception('\'system role assigns\' requires the field \'role\' to be specified');
328         }
330         if (!isset($data['userid'])) {
331             throw new Exception('\'system role assigns\' requires the field \'user\' to be specified');
332         }
334         $context = context_system::instance();
336         $this->datagenerator->role_assign($data['roleid'], $data['userid'], $context->id);
337     }
339     /**
340      * Assigns a role to a user at the specified context
341      *
342      * @throws Exception
343      * @param array $data
344      * @return void
345      */
346     protected function process_role_assign($data) {
348         if (empty($data['roleid'])) {
349             throw new Exception('\'role assigns\' requires the field \'role\' to be specified');
350         }
352         if (!isset($data['userid'])) {
353             throw new Exception('\'role assigns\' requires the field \'user\' to be specified');
354         }
356         if (empty($data['contextlevel'])) {
357             throw new Exception('\'role assigns\' requires the field \'contextlevel\' to be specified');
358         }
360         if (!isset($data['reference'])) {
361             throw new Exception('\'role assigns\' requires the field \'reference\' to be specified');
362         }
364         // Getting the context id.
365         $context = $this->get_context($data['contextlevel'], $data['reference']);
367         $this->datagenerator->role_assign($data['roleid'], $data['userid'], $context->id);
368     }
370     /**
371      * Gets the user id from it's username.
372      * @throws Exception
373      * @param string $username
374      * @return int
375      */
376     protected function get_user_id($username) {
377         global $DB;
379         if (!$id = $DB->get_field('user', 'id', array('username' => $username))) {
380             throw new Exception('The specified user with username "' . $username . '" does not exist');
381         }
382         return $id;
383     }
385     /**
386      * Gets the role id from it's shortname.
387      * @throws Exception
388      * @param string $roleshortname
389      * @return int
390      */
391     protected function get_role_id($roleshortname) {
392         global $DB;
394         if (!$id = $DB->get_field('role', 'id', array('shortname' => $roleshortname))) {
395             throw new Exception('The specified role with shortname"' . $roleshortname . '" does not exist');
396         }
398         return $id;
399     }
401     /**
402      * Gets the category id from it's idnumber.
403      * @throws Exception
404      * @param string $idnumber
405      * @return int
406      */
407     protected function get_category_id($idnumber) {
408         global $DB;
410         // If no category was specified use the data generator one.
411         if ($idnumber == false) {
412             return null;
413         }
415         if (!$id = $DB->get_field('course_categories', 'id', array('idnumber' => $idnumber))) {
416             throw new Exception('The specified category with idnumber "' . $idnumber . '" does not exist');
417         }
419         return $id;
420     }
422     /**
423      * Gets the course id from it's shortname.
424      * @throws Exception
425      * @param string $shortname
426      * @return int
427      */
428     protected function get_course_id($shortname) {
429         global $DB;
431         if (!$id = $DB->get_field('course', 'id', array('shortname' => $shortname))) {
432             throw new Exception('The specified course with shortname"' . $shortname . '" does not exist');
433         }
434         return $id;
435     }
437     /**
438      * Gets the group id from it's idnumber.
439      * @throws Exception
440      * @param string $idnumber
441      * @return int
442      */
443     protected function get_group_id($idnumber) {
444         global $DB;
446         if (!$id = $DB->get_field('groups', 'id', array('idnumber' => $idnumber))) {
447             throw new Exception('The specified group with idnumber "' . $idnumber . '" does not exist');
448         }
449         return $id;
450     }
452     /**
453      * Gets the grouping id from it's idnumber.
454      * @throws Exception
455      * @param string $idnumber
456      * @return int
457      */
458     protected function get_grouping_id($idnumber) {
459         global $DB;
461         if (!$id = $DB->get_field('groupings', 'id', array('idnumber' => $idnumber))) {
462             throw new Exception('The specified grouping with idnumber "' . $idnumber . '" does not exist');
463         }
464         return $id;
465     }
467     /**
468      * Gets the internal context id from the context reference.
469      *
470      * The context reference changes depending on the context
471      * level, it can be the system, a user, a category, a course or
472      * a module.
473      *
474      * @throws Exception
475      * @param string $levelname The context level string introduced by the test writer
476      * @param string $contextref The context reference introduced by the test writer
477      * @return context
478      */
479     protected function get_context($levelname, $contextref) {
480         global $DB;
482         // Getting context levels and names (we will be using the English ones as it is the test site language).
483         $contextlevels = context_helper::get_all_levels();
484         $contextnames = array();
485         foreach ($contextlevels as $level => $classname) {
486             $contextnames[context_helper::get_level_name($level)] = $level;
487         }
489         if (empty($contextnames[$levelname])) {
490             throw new Exception('The specified "' . $levelname . '" context level does not exist');
491         }
492         $contextlevel = $contextnames[$levelname];
494         // Return it, we don't need to look for other internal ids.
495         if ($contextlevel == CONTEXT_SYSTEM) {
496             return context_system::instance();
497         }
499         switch ($contextlevel) {
501             case CONTEXT_USER:
502                 $instanceid = $DB->get_field('user', 'id', array('username' => $contextref));
503                 break;
505             case CONTEXT_COURSECAT:
506                 $instanceid = $DB->get_field('course_categories', 'id', array('idnumber' => $contextref));
507                 break;
509             case CONTEXT_COURSE:
510                 $instanceid = $DB->get_field('course', 'id', array('shortname' => $contextref));
511                 break;
513             case CONTEXT_MODULE:
514                 $instanceid = $DB->get_field('course_modules', 'id', array('idnumber' => $contextref));
515                 break;
517             default:
518                 break;
519         }
521         $contextclass = $contextlevels[$contextlevel];
522         if (!$context = $contextclass::instance($instanceid, IGNORE_MISSING)) {
523             throw new Exception('The specified "' . $contextref . '" context reference does not exist');
524         }
526         return $context;
527     }