Merge branch 'MDL-48373' of git://github.com/timhunt/moodle
[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     /**
54      * @var testing_data_generator
55      */
56     protected $datagenerator;
58     /**
59      * Each element specifies:
60      * - The data generator sufix used.
61      * - The required fields.
62      * - The mapping between other elements references and database field names.
63      * @var array
64      */
65     protected static $elements = array(
66         'users' => array(
67             'datagenerator' => 'user',
68             'required' => array('username')
69         ),
70         'categories' => array(
71             'datagenerator' => 'category',
72             'required' => array('idnumber'),
73             'switchids' => array('category' => 'parent')
74         ),
75         'courses' => array(
76             'datagenerator' => 'course',
77             'required' => array('shortname'),
78             'switchids' => array('category' => 'category')
79         ),
80         'groups' => array(
81             'datagenerator' => 'group',
82             'required' => array('idnumber', 'course'),
83             'switchids' => array('course' => 'courseid')
84         ),
85         'groupings' => array(
86             'datagenerator' => 'grouping',
87             'required' => array('idnumber', 'course'),
88             'switchids' => array('course' => 'courseid')
89         ),
90         'course enrolments' => array(
91             'datagenerator' => 'enrol_user',
92             'required' => array('user', 'course', 'role'),
93             'switchids' => array('user' => 'userid', 'course' => 'courseid', 'role' => 'roleid')
94         ),
95         'permission overrides' => array(
96             'datagenerator' => 'permission_override',
97             'required' => array('capability', 'permission', 'role', 'contextlevel', 'reference'),
98             'switchids' => array('role' => 'roleid')
99         ),
100         'system role assigns' => array(
101             'datagenerator' => 'system_role_assign',
102             'required' => array('user', 'role'),
103             'switchids' => array('user' => 'userid', 'role' => 'roleid')
104         ),
105         'role assigns' => array(
106             'datagenerator' => 'role_assign',
107             'required' => array('user', 'role', 'contextlevel', 'reference'),
108             'switchids' => array('user' => 'userid', 'role' => 'roleid')
109         ),
110         'activities' => array(
111             'datagenerator' => 'activity',
112             'required' => array('activity', 'idnumber', 'course'),
113             'switchids' => array('course' => 'course', 'gradecategory' => 'gradecat')
114         ),
115         'group members' => array(
116             'datagenerator' => 'group_member',
117             'required' => array('user', 'group'),
118             'switchids' => array('user' => 'userid', 'group' => 'groupid')
119         ),
120         'grouping groups' => array(
121             'datagenerator' => 'grouping_group',
122             'required' => array('grouping', 'group'),
123             'switchids' => array('grouping' => 'groupingid', 'group' => 'groupid')
124         ),
125         'cohorts' => array(
126             'datagenerator' => 'cohort',
127             'required' => array('idnumber')
128         ),
129         'cohort members' => array(
130             'datagenerator' => 'cohort_member',
131             'required' => array('user', 'cohort'),
132             'switchids' => array('user' => 'userid', 'cohort' => 'cohortid')
133         ),
134         'roles' => array(
135             'datagenerator' => 'role',
136             'required' => array('shortname')
137         ),
138         'grade categories' => array(
139             'datagenerator' => 'grade_category',
140             'required' => array('fullname', 'course'),
141             'switchids' => array('course' => 'courseid', 'gradecategory' => 'parent')
142         ),
143         'grade items' => array(
144             'datagenerator' => 'grade_item',
145             'required' => array('course'),
146             'switchids' => array('scale' => 'scaleid', 'outcome' => 'outcomeid', 'course' => 'courseid',
147                                  'gradecategory' => 'categoryid')
148         ),
149         'grade outcomes' => array(
150             'datagenerator' => 'grade_outcome',
151             'required' => array('shortname', 'scale'),
152             'switchids' => array('course' => 'courseid', 'gradecategory' => 'categoryid', 'scale' => 'scaleid')
153         ),
154         'scales' => array(
155             'datagenerator' => 'scale',
156             'required' => array('name', 'scale'),
157             'switchids' => array('course' => 'courseid')
158         ),
159         'question categories' => array(
160             'datagenerator' => 'question_category',
161             'required' => array('name', 'contextlevel', 'reference'),
162             'switchids' => array('questioncategory' => 'category')
163         ),
164         'questions' => array(
165             'datagenerator' => 'question',
166             'required' => array('qtype', 'questioncategory', 'name'),
167             'switchids' => array('questioncategory' => 'category', 'user' => 'createdby')
168         ),
169     );
171     /**
172      * Creates the specified element. More info about available elements in http://docs.moodle.org/dev/Acceptance_testing#Fixtures.
173      *
174      * @Given /^the following "(?P<element_string>(?:[^"]|\\")*)" exist:$/
175      *
176      * @throws Exception
177      * @throws PendingException
178      * @param string    $elementname The name of the entity to add
179      * @param TableNode $data
180      */
181     public function the_following_exist($elementname, TableNode $data) {
183         // Now that we need them require the data generators.
184         require_once(__DIR__ . '/../../testing/generator/lib.php');
186         if (empty(self::$elements[$elementname])) {
187             throw new PendingException($elementname . ' data generator is not implemented');
188         }
190         $this->datagenerator = testing_util::get_data_generator();
192         $elementdatagenerator = self::$elements[$elementname]['datagenerator'];
193         $requiredfields = self::$elements[$elementname]['required'];
194         if (!empty(self::$elements[$elementname]['switchids'])) {
195             $switchids = self::$elements[$elementname]['switchids'];
196         }
198         foreach ($data->getHash() as $elementdata) {
200             // Check if all the required fields are there.
201             foreach ($requiredfields as $requiredfield) {
202                 if (!isset($elementdata[$requiredfield])) {
203                     throw new Exception($elementname . ' requires the field ' . $requiredfield . ' to be specified');
204                 }
205             }
207             // Switch from human-friendly references to ids.
208             if (isset($switchids)) {
209                 foreach ($switchids as $element => $field) {
210                     $methodname = 'get_' . $element . '_id';
212                     // Not all the switch fields are required, default vars will be assigned by data generators.
213                     if (isset($elementdata[$element])) {
214                         // Temp $id var to avoid problems when $element == $field.
215                         $id = $this->{$methodname}($elementdata[$element]);
216                         unset($elementdata[$element]);
217                         $elementdata[$field] = $id;
218                     }
219                 }
220             }
222             // Preprocess the entities that requires a special treatment.
223             if (method_exists($this, 'preprocess_' . $elementdatagenerator)) {
224                 $elementdata = $this->{'preprocess_' . $elementdatagenerator}($elementdata);
225             }
227             // Creates element.
228             $methodname = 'create_' . $elementdatagenerator;
229             if (method_exists($this->datagenerator, $methodname)) {
230                 // Using data generators directly.
231                 $this->datagenerator->{$methodname}($elementdata);
233             } else if (method_exists($this, 'process_' . $elementdatagenerator)) {
234                 // Using an alternative to the direct data generator call.
235                 $this->{'process_' . $elementdatagenerator}($elementdata);
236             } else {
237                 throw new PendingException($elementname . ' data generator is not implemented');
238             }
239         }
241     }
243     /**
244      * If password is not set it uses the username.
245      * @param array $data
246      * @return array
247      */
248     protected function preprocess_user($data) {
249         if (!isset($data['password'])) {
250             $data['password'] = $data['username'];
251         }
252         return $data;
253     }
255     /**
256      * If contextlevel and reference are specified for cohort, transform them to the contextid.
257      *
258      * @param array $data
259      * @return array
260      */
261     protected function preprocess_cohort($data) {
262         if (isset($data['contextlevel'])) {
263             if (!isset($data['reference'])) {
264                 throw new Exception('If field contextlevel is specified, field reference must also be present');
265             }
266             $context = $this->get_context($data['contextlevel'], $data['reference']);
267             unset($data['contextlevel']);
268             unset($data['reference']);
269             $data['contextid'] = $context->id;
270         }
271         return $data;
272     }
274     /**
275      * Preprocesses the creation of a grade item. Converts gradetype text to a number.
276      * @param array $data
277      * @return array
278      */
279     protected function preprocess_grade_item($data) {
280         global $CFG;
281         require_once("$CFG->libdir/grade/constants.php");
283         if (isset($data['gradetype'])) {
284             $data['gradetype'] = constant("GRADE_TYPE_" . strtoupper($data['gradetype']));
285         }
286         return $data;
287     }
289     /**
290      * Adapter to modules generator
291      * @throws Exception Custom exception for test writers
292      * @param array $data
293      * @return void
294      */
295     protected function process_activity($data) {
296         global $DB, $CFG;
298         // The the_following_exists() method checks that the field exists.
299         $activityname = $data['activity'];
300         unset($data['activity']);
302         // Convert scale name into scale id (negative number indicates using scale).
303         if (isset($data['grade']) && strlen($data['grade']) && !is_number($data['grade'])) {
304             $data['grade'] = - $this->get_scale_id($data['grade']);
305             require_once("$CFG->libdir/grade/constants.php");
307             if (!isset($data['gradetype'])) {
308                 $data['gradetype'] = GRADE_TYPE_SCALE;
309             }
310         }
312         // We split $data in the activity $record and the course module $options.
313         $cmoptions = array();
314         $cmcolumns = $DB->get_columns('course_modules');
315         foreach ($cmcolumns as $key => $value) {
316             if (isset($data[$key])) {
317                 $cmoptions[$key] = $data[$key];
318             }
319         }
321         // Custom exception.
322         try {
323             $this->datagenerator->create_module($activityname, $data, $cmoptions);
324         } catch (coding_exception $e) {
325             throw new Exception('\'' . $activityname . '\' activity can not be added using this step,' .
326                 ' use the step \'I add a "ACTIVITY_OR_RESOURCE_NAME_STRING" to section "SECTION_NUMBER"\' instead');
327         }
328     }
330     /**
331      * Adapter to enrol_user() data generator.
332      * @throws Exception
333      * @param array $data
334      * @return void
335      */
336     protected function process_enrol_user($data) {
337         global $SITE;
339         if (empty($data['roleid'])) {
340             throw new Exception('\'course enrolments\' requires the field \'role\' to be specified');
341         }
343         if (!isset($data['userid'])) {
344             throw new Exception('\'course enrolments\' requires the field \'user\' to be specified');
345         }
347         if (!isset($data['courseid'])) {
348             throw new Exception('\'course enrolments\' requires the field \'course\' to be specified');
349         }
351         if (!isset($data['enrol'])) {
352             $data['enrol'] = 'manual';
353         }
355         // If the provided course shortname is the site shortname we consider it a system role assign.
356         if ($data['courseid'] == $SITE->id) {
357             // Frontpage course assign.
358             $context = context_course::instance($data['courseid']);
359             role_assign($data['roleid'], $data['userid'], $context->id);
361         } else {
362             // Course assign.
363             $this->datagenerator->enrol_user($data['userid'], $data['courseid'], $data['roleid'], $data['enrol']);
364         }
366     }
368     /**
369      * Allows/denies a capability at the specified context
370      *
371      * @throws Exception
372      * @param array $data
373      * @return void
374      */
375     protected function process_permission_override($data) {
377         // Will throw an exception if it does not exist.
378         $context = $this->get_context($data['contextlevel'], $data['reference']);
380         switch ($data['permission']) {
381             case get_string('allow', 'role'):
382                 $permission = CAP_ALLOW;
383                 break;
384             case get_string('prevent', 'role'):
385                 $permission = CAP_PREVENT;
386                 break;
387             case get_string('prohibit', 'role'):
388                 $permission = CAP_PROHIBIT;
389                 break;
390             default:
391                 throw new Exception('The \'' . $data['permission'] . '\' permission does not exist');
392                 break;
393         }
395         if (is_null(get_capability_info($data['capability']))) {
396             throw new Exception('The \'' . $data['capability'] . '\' capability does not exist');
397         }
399         role_change_permission($data['roleid'], $context, $data['capability'], $permission);
400     }
402     /**
403      * Assigns a role to a user at system context
404      *
405      * Used by "system role assigns" can be deleted when
406      * system role assign will be deprecated in favour of
407      * "role assigns"
408      *
409      * @throws Exception
410      * @param array $data
411      * @return void
412      */
413     protected function process_system_role_assign($data) {
415         if (empty($data['roleid'])) {
416             throw new Exception('\'system role assigns\' requires the field \'role\' to be specified');
417         }
419         if (!isset($data['userid'])) {
420             throw new Exception('\'system role assigns\' requires the field \'user\' to be specified');
421         }
423         $context = context_system::instance();
425         $this->datagenerator->role_assign($data['roleid'], $data['userid'], $context->id);
426     }
428     /**
429      * Assigns a role to a user at the specified context
430      *
431      * @throws Exception
432      * @param array $data
433      * @return void
434      */
435     protected function process_role_assign($data) {
437         if (empty($data['roleid'])) {
438             throw new Exception('\'role assigns\' requires the field \'role\' to be specified');
439         }
441         if (!isset($data['userid'])) {
442             throw new Exception('\'role assigns\' requires the field \'user\' to be specified');
443         }
445         if (empty($data['contextlevel'])) {
446             throw new Exception('\'role assigns\' requires the field \'contextlevel\' to be specified');
447         }
449         if (!isset($data['reference'])) {
450             throw new Exception('\'role assigns\' requires the field \'reference\' to be specified');
451         }
453         // Getting the context id.
454         $context = $this->get_context($data['contextlevel'], $data['reference']);
456         $this->datagenerator->role_assign($data['roleid'], $data['userid'], $context->id);
457     }
459     /**
460      * Creates a role.
461      *
462      * @param array $data
463      * @return void
464      */
465     protected function process_role($data) {
467         // We require the user to fill the role shortname.
468         if (empty($data['shortname'])) {
469             throw new Exception('\'role\' requires the field \'shortname\' to be specified');
470         }
472         $this->datagenerator->create_role($data);
473     }
475     /**
476      * Adds members to cohorts
477      *
478      * @param array $data
479      * @return void
480      */
481     protected function process_cohort_member($data) {
482         cohort_add_member($data['cohortid'], $data['userid']);
483     }
485     /**
486      * Create a question category.
487      *
488      * @param array $data the row of data from the behat script.
489      */
490     protected function process_question_category($data) {
491         $context = $this->get_context($data['contextlevel'], $data['reference']);
492         $data['contextid'] = $context->id;
493         $this->datagenerator->get_plugin_generator('core_question')->create_question_category($data);
494     }
496     /**
497      * Create a question.
498      *
499      * Creating questions relies on the question/type/.../tests/helper.php mechanism.
500      * We start with test_question_maker::get_question_form_data($data['qtype'], $data['template'])
501      * and then overlay the values from any other fields of $data that are set.
502      *
503      * @param array $data the row of data from the behat script.
504      */
505     protected function process_question($data) {
506         if (array_key_exists('questiontext', $data)) {
507             $data['questiontext'] = array(
508                     'text'   => $data['questiontext'],
509                     'format' => FORMAT_HTML,
510                 );
511         }
513         if (array_key_exists('generalfeedback', $data)) {
514             $data['generalfeedback'] = array(
515                     'text'   => $data['generalfeedback'],
516                     'format' => FORMAT_HTML,
517                 );
518         }
520         $which = null;
521         if (!empty($data['template'])) {
522             $which = $data['template'];
523         }
525         $this->datagenerator->get_plugin_generator('core_question')->create_question($data['qtype'], $which, $data);
526     }
528     /**
529      * Gets the grade category id from the grade category fullname
530      * @throws Exception
531      * @param string $username
532      * @return int
533      */
534     protected function get_gradecategory_id($fullname) {
535         global $DB;
537         if (!$id = $DB->get_field('grade_categories', 'id', array('fullname' => $fullname))) {
538             throw new Exception('The specified grade category with fullname "' . $fullname . '" does not exist');
539         }
540         return $id;
541     }
543     /**
544      * Gets the user id from it's username.
545      * @throws Exception
546      * @param string $username
547      * @return int
548      */
549     protected function get_user_id($username) {
550         global $DB;
552         if (!$id = $DB->get_field('user', 'id', array('username' => $username))) {
553             throw new Exception('The specified user with username "' . $username . '" does not exist');
554         }
555         return $id;
556     }
558     /**
559      * Gets the role id from it's shortname.
560      * @throws Exception
561      * @param string $roleshortname
562      * @return int
563      */
564     protected function get_role_id($roleshortname) {
565         global $DB;
567         if (!$id = $DB->get_field('role', 'id', array('shortname' => $roleshortname))) {
568             throw new Exception('The specified role with shortname "' . $roleshortname . '" does not exist');
569         }
571         return $id;
572     }
574     /**
575      * Gets the category id from it's idnumber.
576      * @throws Exception
577      * @param string $idnumber
578      * @return int
579      */
580     protected function get_category_id($idnumber) {
581         global $DB;
583         // If no category was specified use the data generator one.
584         if ($idnumber == false) {
585             return null;
586         }
588         if (!$id = $DB->get_field('course_categories', 'id', array('idnumber' => $idnumber))) {
589             throw new Exception('The specified category with idnumber "' . $idnumber . '" does not exist');
590         }
592         return $id;
593     }
595     /**
596      * Gets the course id from it's shortname.
597      * @throws Exception
598      * @param string $shortname
599      * @return int
600      */
601     protected function get_course_id($shortname) {
602         global $DB;
604         if (!$id = $DB->get_field('course', 'id', array('shortname' => $shortname))) {
605             throw new Exception('The specified course with shortname "' . $shortname . '" does not exist');
606         }
607         return $id;
608     }
610     /**
611      * Gets the group id from it's idnumber.
612      * @throws Exception
613      * @param string $idnumber
614      * @return int
615      */
616     protected function get_group_id($idnumber) {
617         global $DB;
619         if (!$id = $DB->get_field('groups', 'id', array('idnumber' => $idnumber))) {
620             throw new Exception('The specified group with idnumber "' . $idnumber . '" does not exist');
621         }
622         return $id;
623     }
625     /**
626      * Gets the grouping id from it's idnumber.
627      * @throws Exception
628      * @param string $idnumber
629      * @return int
630      */
631     protected function get_grouping_id($idnumber) {
632         global $DB;
634         if (!$id = $DB->get_field('groupings', 'id', array('idnumber' => $idnumber))) {
635             throw new Exception('The specified grouping with idnumber "' . $idnumber . '" does not exist');
636         }
637         return $id;
638     }
640     /**
641      * Gets the cohort id from it's idnumber.
642      * @throws Exception
643      * @param string $idnumber
644      * @return int
645      */
646     protected function get_cohort_id($idnumber) {
647         global $DB;
649         if (!$id = $DB->get_field('cohort', 'id', array('idnumber' => $idnumber))) {
650             throw new Exception('The specified cohort with idnumber "' . $idnumber . '" does not exist');
651         }
652         return $id;
653     }
655     /**
656      * Gets the outcome item id from its shortname.
657      * @throws Exception
658      * @param string $shortname
659      * @return int
660      */
661     protected function get_outcome_id($shortname) {
662         global $DB;
664         if (!$id = $DB->get_field('grade_outcomes', 'id', array('shortname' => $shortname))) {
665             throw new Exception('The specified outcome with shortname "' . $shortname . '" does not exist');
666         }
667         return $id;
668     }
670     /**
671      * Get the id of a named scale.
672      * @param string $name the name of the scale.
673      * @return int the scale id.
674      */
675     protected function get_scale_id($name) {
676         global $DB;
678         if (!$id = $DB->get_field('scale', 'id', array('name' => $name))) {
679             throw new Exception('The specified scale with name "' . $name . '" does not exist');
680         }
681         return $id;
682     }
684     /**
685      * Get the id of a named question category (must be globally unique).
686      * Note that 'Top' is a special value, used when setting the parent of another
687      * category, meaning top-level.
688      *
689      * @param string $name the question category name.
690      * @return int the question category id.
691      */
692     protected function get_questioncategory_id($name) {
693         global $DB;
695         if ($name == 'Top') {
696             return 0;
697         }
699         if (!$id = $DB->get_field('question_categories', 'id', array('name' => $name))) {
700             throw new Exception('The specified question category with name "' . $name . '" does not exist');
701         }
702         return $id;
703     }
705     /**
706      * Gets the internal context id from the context reference.
707      *
708      * The context reference changes depending on the context
709      * level, it can be the system, a user, a category, a course or
710      * a module.
711      *
712      * @throws Exception
713      * @param string $levelname The context level string introduced by the test writer
714      * @param string $contextref The context reference introduced by the test writer
715      * @return context
716      */
717     protected function get_context($levelname, $contextref) {
718         global $DB;
720         // Getting context levels and names (we will be using the English ones as it is the test site language).
721         $contextlevels = context_helper::get_all_levels();
722         $contextnames = array();
723         foreach ($contextlevels as $level => $classname) {
724             $contextnames[context_helper::get_level_name($level)] = $level;
725         }
727         if (empty($contextnames[$levelname])) {
728             throw new Exception('The specified "' . $levelname . '" context level does not exist');
729         }
730         $contextlevel = $contextnames[$levelname];
732         // Return it, we don't need to look for other internal ids.
733         if ($contextlevel == CONTEXT_SYSTEM) {
734             return context_system::instance();
735         }
737         switch ($contextlevel) {
739             case CONTEXT_USER:
740                 $instanceid = $DB->get_field('user', 'id', array('username' => $contextref));
741                 break;
743             case CONTEXT_COURSECAT:
744                 $instanceid = $DB->get_field('course_categories', 'id', array('idnumber' => $contextref));
745                 break;
747             case CONTEXT_COURSE:
748                 $instanceid = $DB->get_field('course', 'id', array('shortname' => $contextref));
749                 break;
751             case CONTEXT_MODULE:
752                 $instanceid = $DB->get_field('course_modules', 'id', array('idnumber' => $contextref));
753                 break;
755             default:
756                 break;
757         }
759         $contextclass = $contextlevels[$contextlevel];
760         if (!$context = $contextclass::instance($instanceid, IGNORE_MISSING)) {
761             throw new Exception('The specified "' . $contextref . '" context reference does not exist');
762         }
764         return $context;
765     }