|
|
| (51 intermediate revisions by 11 users not shown) |
| Line 1: |
Line 1: |
| {{Moodle 2.3}} | | {{Template:Migrated|newDocId=/docs/guides/testing/}} |
| | |
| Moodle PHPUnit integration is designed to allow easy adding of new tests. At the start of each test the state is automatically reset to fresh new installation (unless explicitly told not to reset).
| |
| | |
| =Testcase classes=
| |
| | |
| There are two basic test class that are supposed to used in all Moodle unit tests - basic_testcase and advanced_testcase. '''Please note it is strongly recommended to put only one testcase into each class file.'''
| |
| ;basic_testcase : Very simple tests that do not modify database, dataroot or any PHP globals. It can be used for example when trying examples from the official PHPUnit tutorial.
| |
| ;advanced_testcase : Enhanced testcase class enhanced for easy testing of Moodle code.
| |
| | |
| There is a third testcase class that is specially designed for testing of our Moodle database layer, it should not be used for other purposes.
| |
| | |
| == Assertions ==
| |
| | |
| The complete list of assertions can be found in the [http://www.phpunit.de/manual/3.7/en/appendixes.assertions.html phpunit manual].
| |
| ==Sample plugin testcase==
| |
| | |
| PHPUnit tests are located in <code>tests/*_test.php</code> files in your plugin, for example mod/myplugin/tests/sample_test.php, the file should contain only one class that extends <code>advanced_testcase</code>:
| |
| | |
| <code php>
| |
| class mod_myplugin_sample_testcase extends advanced_testcase {
| |
| public function test_adding() {
| |
| $this->assertEquals(2, 1+2);
| |
| }
| |
| }
| |
| </code>
| |
| | |
| See [[PHPUnit integration#Class and file naming rules]] for more information.
| |
| | |
| ==Inclusion of Moodle library files==
| |
| | |
| If you want to include some Moodle library files you should always declare '''global $CFG'''. The reason is that testcase files may be included from non-moodle code which does not make the global $CFG available automatically.
| |
| | |
| ==Automatic state reset==
| |
| By default after each test Moodle database and dataroot is automatically reset to the original state which was present right after installation. make sure to use $this->resetAfterTest() to indicate that the database or changes of standard global variables are expected.
| |
| | |
| If you received the error "Warning: unexpected database modification, resetting DB state" it is because the test is not using $this->resetAfterTest().
| |
| | |
| <code php>
| |
| class mod_myplugin_testcase extends advanced_testcase {
| |
| public function test_deleting() {
| |
| global $DB;
| |
| $this->resetAfterTest(true);
| |
| $DB->delete_records('user');
| |
| $this->assertEmpty($DB->get_records('user'));
| |
| }
| |
| public function test_user_table_was_reset() {
| |
| global $DB;
| |
| $this->assertEquals(2, $DB->count_records('user', array()));
| |
| }
| |
| }
| |
| </code>
| |
| | |
| =Generators=
| |
| | |
| Tests that need to modify default installation may use generators to create new courses, users, etc. All examples on this page should be used from test methods of a test class derived from advanced_testcase.
| |
| | |
| Note if you are using PHPUnit [https://phpunit.de/manual/current/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.data-providers @dataProvider] functions to provide parameters to unit tests, you can not use the data generator or change the user etc in the data provider function.
| |
| | |
| ==Creating users==
| |
| At the start of each test there are only two users present - guest and administrator. If you need to add more test accounts use:
| |
| <code php>
| |
| $user = $this->getDataGenerator()->create_user();
| |
| </code>
| |
| | |
| You may also specify properties of the user account, for example:
| |
| <code php>
| |
| $user1 = $this->getDataGenerator()->create_user(array('email'=>'user1@example.com', 'username'=>'user1'));
| |
| </code>
| |
| | |
| By default no user is logged-in, use setUser() method to change current $USER value:
| |
| <code php>
| |
| $this->setUser($user1);
| |
| </code>
| |
| | |
| Guest and admin accounts have a shortcut methods:
| |
| <code php>
| |
| $this->setGuestUser();
| |
| $this->setAdminUser();
| |
| </code>
| |
| | |
| Null can be used to set current user back to not-logged-in:
| |
| <code php>
| |
| $this->setUser(null);
| |
| </code>
| |
| | |
| ==Creating course categories==
| |
| | |
| <code php>
| |
| $category1 = $this->getDataGenerator()->create_category();
| |
| $category2 = $this->getDataGenerator()->create_category(array('name'=>'Some subcategory', 'parent'=>$category1->id));
| |
| </code>
| |
| | |
| ==Creating courses==
| |
| | |
| <code php>
| |
| $course1 = $this->getDataGenerator()->create_course();
| |
|
| |
| $category = $this->getDataGenerator()->create_category();
| |
| $course2 = $this->getDataGenerator()->create_course(array('name'=>'Some course', 'category'=>$category->id));
| |
| </code>
| |
| | |
| ==Creating activities==
| |
| | |
| Some activity plugins include instance generators. The generator class are defined in plugindirectory/tests/generator/lib.php.
| |
| | |
| Example of creation of new course with one page resource:
| |
| | |
| <code php>
| |
| $course = $this->getDataGenerator()->create_course();
| |
| $generator = $this->getDataGenerator()->get_plugin_generator('mod_page');
| |
| $generator->create_instance(array('course'=>$course->id));
| |
| </code>
| |
| | |
| The following is functionally the same, but a bit shorter:
| |
| <code php>
| |
| $course = $this->getDataGenerator()->create_course();
| |
| $page = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
| |
| </code>
| |
| | |
| ==Creating cohorts==
| |
| {{Moodle 2.4}}
| |
| Since 2.4 there the data generator supports creation of new cohorts.
| |
| | |
| <code php>
| |
| $cohort = $this->getDataGenerator()->create_cohort();
| |
| </code>
| |
| | |
| ==Simplified user enrolments==
| |
| {{Moodle 2.4}}
| |
| Instead of standard enrolment API it is possible to use simplified method in data generator. It is intended to be used with self and manual enrolment plugins.
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->enrol_user($userid, $courseid);
| |
| $this->getDataGenerator()->enrol_user($userid, $courseid, $teacherroleid);
| |
| $this->getDataGenerator()->enrol_user($userid, $courseid, $teacherroleid, 'manual');
| |
| </code>
| |
| | |
| ==Creating scales==
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_scale();
| |
| $this->getDataGenerator()->create_scale(array('name' => $name, 'scale' => $scale, 'courseid' => $courseid, 'userid' => $userid, 'description' => description, 'descriptionformat' => $descriptionformat));
| |
| </code>
| |
| | |
| ==Creating roles==
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_role();
| |
| $this->getDataGenerator()->create_role(array('shortname' => $shortname, 'name' => $name, 'description' => description, 'archetype' => $archetype));
| |
| </code>
| |
| | |
| ==Creating tags==
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_tag();
| |
| $this->getDataGenerator()->create_tag(array(
| |
| 'userid' => $userid,
| |
| 'rawname' => $rawname,
| |
| 'name' => $name,
| |
| 'description' => $description,
| |
| 'descriptionformat' => $descriptionformat,
| |
| 'flag' => $flag
| |
| ));
| |
| </code>
| |
| | |
| ==Groups==
| |
| | |
| ===Creating groups===
| |
| <code php>
| |
| $this->getDataGenerator()->create_group(array('courseid' => $courseid));
| |
| $this->getDataGenerator()->create_group(array('courseid' => $courseid, 'name' => $name, 'description' => $description, 'descriptionformat' => $descriptionformat));
| |
| </code>
| |
| | |
| ===Adding users to groups===
| |
| <code php>
| |
| $this->getDataGenerator()->create_group_member(array('userid' => $userid, 'groupid' => $groupid));
| |
| $this->getDataGenerator()->create_group_member(array('userid' => $userid, 'groupid' => $groupid, 'component' => $component, 'itemid' => $itemid));
| |
| </code>
| |
| | |
| ===Creating groupings===
| |
| <code php>
| |
| $this->getDataGenerator()->create_grouping(array('courseid' => $courseid));
| |
| $this->getDataGenerator()->create_grouping(array('courseid' => $courseid, 'name' => $name, 'description' => $description, 'descriptionformat' => $descriptionformat));
| |
| </code>
| |
| | |
| ===Adding groups to groupings===
| |
| <code php>
| |
| $this->getDataGenerator()->create_grouping_group(array('groupingid' => $groupingid, 'groupid' => $groupid));
| |
| </code>
| |
| | |
| ==Repositories==
| |
| | |
| ===Creating repository instances===
| |
| {{Moodle 2.5}}
| |
| Some respository plugins include instance generators. The generator class are defined in plugindirectory/tests/generator/lib.php..
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_repository($type, $record, $options);
| |
| </code>
| |
| | |
| ===Creating repository types===
| |
| {{Moodle 2.5}}
| |
| Some respository plugins include type generators. The generator class are defined in plugindirectory/tests/generator/lib.php..
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_repository_type($type, $record, $options);
| |
| </code>
| |
| | |
| ==Creating grades==
| |
| | |
| ===Grade categories===
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_grade_category(array('courseid' => $courseid));
| |
| $this->getDataGenerator()->create_grade_category(array('courseid' => $courseid, 'fullname' => $fullname));
| |
| </code>
| |
| | |
| ===Grade items===
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_grade_item();
| |
| $this->getDataGenerator()->create_grade_item(array('itemtype' => $itemtype, 'itemname' => $itemname, 'outcomeid' => $outcomeid, 'scaleid' => $scaleid, 'gradetype' => $gradetype));
| |
| </code>
| |
| | |
| ===Outcomes===
| |
| | |
| <code php>
| |
| $this->getDataGenerator()->create_grade_outcome();
| |
| $this->getDataGenerator()->create_grade_item(array('fullname' => $fullname));
| |
| </code>
| |
| | |
| ==Other types of plugin==
| |
| {{Moodle 2.5}}
| |
| Any other type of plugin can have a generator. The generator class should extend component_generator_base, and then you can get an instance using $mygenerator = $this->getDataGenerator()->get_plugin_generator($frankenstylecomponentname);
| |
| | |
| For some types of plugin, like mod documented above, there may be a more specific class than component_generator_base to extend, like testing_module_generator. That will give a consistent set of method names to use. Otherwise, you can create whatever methods you like on your generator, to create the different things you need to work whith.
| |
| | |
| =Long tests=
| |
| | |
| All standard test should execute as fast as possible. Tests that take a loner time to execute (>10s) or are otherwise expensive (such as querying external servers that might be flooded by all dev machines) should be execute only when PHPUNIT_LONGTEST is true. This constant can be set in phpunit.xml or directly in config.php.
| |
| | |
| =Large test data=
| |
| See advanced_testcase::createXMLDataSet() and advanced_testcase::createCsvDataSet() and related functions there for easier ways to manage large test data sets within files rather than arrays in code. See [[PHPUnit_integration#Extra_methods]]
| |
| | |
| =Testing sending of messages=
| |
| {{Moodle 2.4}}
| |
| You can temporarily redirect all messages sent via message_send() to a message sink object. This allows developers to verify that the tested code is sending expected messages.
| |
| | |
| To test code using messaging first disable the use of transactions and then redirect the messaging into a new message sink, you can inspect the results later.
| |
| <code php>
| |
| $this->preventResetByRollback();
| |
| $sink = $this->redirectMessages();
| |
| //... code that is sending messages
| |
| $messages = $sink->get_messages();
| |
| $this->assertEquals(3, count($messages));
| |
| //.. test messages were generated in correct order with appropriate content
| |
| </code>
| |
| | |
| =Testing sending of emails=
| |
| {{Moodle 2.6}}
| |
| You can temporarily redirect emails sent via email_to_user() to a email message sink object. This allows developers to verify that the tested code is sending expected emails.
| |
| | |
| To test code using messaging first unset 'noemailever' setting and then redirect the emails into a new message sink where you can inspect the results later.
| |
| <code php>
| |
| unset_config('noemailever');
| |
| $sink = $this->redirectEmails();
| |
| //... code that is sending email
| |
| $messages = $sink->get_messages();
| |
| $this->assertEquals(1, count($messages));
| |
| </code>
| |
| | |
| =Logstores=
| |
| You can test events which were written to a logstore, but you must disable transactions, enable at least one valid logstore, and disable logstore buffering to ensure that the events are written to the database before the tests execute.
| |
| <code php>
| |
| $this->preventResetByRollback();
| |
| set_config('enabled_stores', 'logstore_standard', 'tool_log');
| |
| set_config('buffersize', 0, 'logstore_standard');
| |
| </code>
| |
| | |
| =Extra test settings=
| |
| | |
| Usually the test should not interact with any external systems and it should work the same on all systems. But sometimes you need to specify some option for connection to external systems or system configuration. It is intentionally not possible to use $CFG settings from config.php.
| |
| | |
| There are several ways how to inject your custom settings:
| |
| * define test setting constants in your phpunit.xml file
| |
| * define test setting constants in your config.php
| |
| | |
| These constants may be then used in your test or plugin code.
| |
| | |
| =See also=
| |
| * [[PHPUnit integration]]
| |
| * [[PHPUnit]]
| |
| | |
| [[Category:Unit testing]]
| |
