MDL-70815 mod_choice: Unit tests for the custom completion class
This commit is contained in:
Jun Pataleta
@@ -0,0 +1,209 @@
|
||||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace mod_choice;
|
||||
|
||||
use advanced_testcase;
|
||||
use cm_info;
|
||||
use coding_exception;
|
||||
use mod_choice\completion\custom_completion;
|
||||
use moodle_exception;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
global $CFG;
|
||||
require_once($CFG->libdir . '/completionlib.php');
|
||||
|
||||
/**
|
||||
* Class for unit testing mod_choice/custom_completion.
|
||||
*
|
||||
* @package mod_choice
|
||||
* @copyright 2021 Jun Pataleta <[email protected]>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class custom_completion_test extends advanced_testcase {
|
||||
|
||||
/**
|
||||
* Data provider for get_state().
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function get_state_provider(): array {
|
||||
return [
|
||||
'Undefined rule' => [
|
||||
'somenonexistentrule', COMPLETION_DISABLED, false, null, coding_exception::class
|
||||
],
|
||||
'Rule not available' => [
|
||||
'completionsubmit', COMPLETION_DISABLED, false, null, moodle_exception::class
|
||||
],
|
||||
'Rule available, user has not submitted' => [
|
||||
'completionsubmit', COMPLETION_ENABLED, false, COMPLETION_INCOMPLETE, null
|
||||
],
|
||||
'Rule available, user has submitted' => [
|
||||
'completionsubmit', COMPLETION_ENABLED, true, COMPLETION_COMPLETE, null
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for get_state().
|
||||
*
|
||||
* @dataProvider get_state_provider
|
||||
* @param string $rule The custom completion rule.
|
||||
* @param int $available Whether this rule is available.
|
||||
* @param bool $submitted Whether the user has made a choice.
|
||||
* @param int|null $status Expected status.
|
||||
* @param string|null $exception Expected exception.
|
||||
*/
|
||||
public function test_get_state(string $rule, int $available, ?bool $submitted, ?int $status, ?string $exception) {
|
||||
global $DB;
|
||||
|
||||
if (!is_null($exception)) {
|
||||
$this->expectException($exception);
|
||||
}
|
||||
|
||||
// Custom completion rule data for cm_info::customdata.
|
||||
$customdataval = [
|
||||
'customcompletionrules' => [
|
||||
$rule => $available
|
||||
]
|
||||
];
|
||||
|
||||
// Build a mock cm_info instance.
|
||||
$mockcminfo = $this->getMockBuilder(cm_info::class)
|
||||
->disableOriginalConstructor()
|
||||
->onlyMethods(['__get'])
|
||||
->getMock();
|
||||
|
||||
// Mock the return of the magic getter method when fetching the cm_info object's customdata and instance values.
|
||||
$mockcminfo->expects($this->any())
|
||||
->method('__get')
|
||||
->will($this->returnValueMap([
|
||||
['customdata', $customdataval],
|
||||
['instance', 1],
|
||||
]));
|
||||
|
||||
// Mock the DB calls.
|
||||
$DB = $this->createMock(get_class($DB));
|
||||
$DB->expects($this->atMost(1))
|
||||
->method('record_exists')
|
||||
->willReturn($submitted);
|
||||
|
||||
$customcompletion = new custom_completion($mockcminfo, 2);
|
||||
$this->assertEquals($status, $customcompletion->get_state($rule));
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for get_defined_custom_rules().
|
||||
*/
|
||||
public function test_get_defined_custom_rules() {
|
||||
$rules = custom_completion::get_defined_custom_rules();
|
||||
$this->assertCount(1, $rules);
|
||||
$this->assertEquals('completionsubmit', reset($rules));
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for get_defined_custom_rule_descriptions().
|
||||
*/
|
||||
public function test_get_custom_rule_descriptions() {
|
||||
// Get defined custom rules.
|
||||
$rules = custom_completion::get_defined_custom_rules();
|
||||
|
||||
// Build a mock cm_info instance.
|
||||
$mockcminfo = $this->getMockBuilder(cm_info::class)
|
||||
->disableOriginalConstructor()
|
||||
->onlyMethods(['__get'])
|
||||
->getMock();
|
||||
|
||||
// Instantiate a custom_completion object using the mocked cm_info.
|
||||
$customcompletion = new custom_completion($mockcminfo, 1);
|
||||
|
||||
// Get custom rule descriptions.
|
||||
$ruledescriptions = $customcompletion->get_custom_rule_descriptions();
|
||||
|
||||
// Confirm that defined rules and rule descriptions are consistent with each other.
|
||||
$this->assertEquals(count($rules), count($ruledescriptions));
|
||||
foreach ($rules as $rule) {
|
||||
$this->assertArrayHasKey($rule, $ruledescriptions);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for is_defined().
|
||||
*/
|
||||
public function test_is_defined() {
|
||||
// Build a mock cm_info instance.
|
||||
$mockcminfo = $this->getMockBuilder(cm_info::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
|
||||
$customcompletion = new custom_completion($mockcminfo, 1);
|
||||
|
||||
// Rule is defined.
|
||||
$this->assertTrue($customcompletion->is_defined('completionsubmit'));
|
||||
|
||||
// Undefined rule.
|
||||
$this->assertFalse($customcompletion->is_defined('somerandomrule'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for test_get_available_custom_rules().
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function get_available_custom_rules_provider(): array {
|
||||
return [
|
||||
'Completion submit available' => [
|
||||
COMPLETION_ENABLED, ['completionsubmit']
|
||||
],
|
||||
'Completion submit not available' => [
|
||||
COMPLETION_DISABLED, []
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for get_available_custom_rules().
|
||||
*
|
||||
* @dataProvider get_available_custom_rules_provider
|
||||
* @param int $status
|
||||
* @param array $expected
|
||||
*/
|
||||
public function test_get_available_custom_rules(int $status, array $expected) {
|
||||
$customdataval = [
|
||||
'customcompletionrules' => [
|
||||
'completionsubmit' => $status
|
||||
]
|
||||
];
|
||||
|
||||
// Build a mock cm_info instance.
|
||||
$mockcminfo = $this->getMockBuilder(cm_info::class)
|
||||
->disableOriginalConstructor()
|
||||
->onlyMethods(['__get'])
|
||||
->getMock();
|
||||
|
||||
// Mock the return of magic getter for the customdata attribute.
|
||||
$mockcminfo->expects($this->any())
|
||||
->method('__get')
|
||||
->with('customdata')
|
||||
->willReturn($customdataval);
|
||||
|
||||
$customcompletion = new custom_completion($mockcminfo, 1);
|
||||
$this->assertEquals($expected, $customcompletion->get_available_custom_rules());
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user