mirror of
https://github.com/moodle/moodle.git
synced 2025-08-07 01:46:45 +02:00
MDL-70817 core_completion: Unit tests for cm_completion_details
This commit is contained in:
Jun Pataleta
parent
34a690634d
commit
430d25d96f
1 changed files with 285 additions and 0 deletions
285
completion/tests/cm_completion_details_test.php
Normal file
285
completion/tests/cm_completion_details_test.php
Normal file
|
|
@ -0,0 +1,285 @@
|
|||
<?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/>.
|
||||
|
||||
/**
|
||||
* Contains unit tests for core_completion/cm_completion_details.
|
||||
*
|
||||
* @package core_completion
|
||||
* @copyright Jun Pataleta <jun@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace core_completion;
|
||||
|
||||
use advanced_testcase;
|
||||
use cm_info;
|
||||
use completion_info;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
global $CFG;
|
||||
require_once($CFG->libdir . '/completionlib.php');
|
||||
|
||||
/**
|
||||
* Class for unit testing core_completion/cm_completion_details.
|
||||
*
|
||||
* @package core_completion
|
||||
* @copyright Jun Pataleta <jun@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class cm_completion_details_test extends advanced_testcase {
|
||||
|
||||
/** @var completion_info A completion object. */
|
||||
protected $completioninfo = null;
|
||||
|
||||
/**
|
||||
* Fetches a mocked cm_completion_details instance.
|
||||
*
|
||||
* @param int|null $completion The completion tracking mode for the module.
|
||||
* @param array $completionoptions Completion options (e.g. completionview, completionusegrade, etc.)
|
||||
* @return cm_completion_details
|
||||
*/
|
||||
protected function setup_data(?int $completion, array $completionoptions = []): cm_completion_details {
|
||||
if (is_null($completion)) {
|
||||
$completion = COMPLETION_TRACKING_AUTOMATIC;
|
||||
}
|
||||
|
||||
// Mock a completion_info instance so we can simply mock the returns of completion_info::get_data() later.
|
||||
$this->completioninfo = $this->getMockBuilder(completion_info::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
|
||||
// Mock return of completion_info's is_enabled() method to match the expected completion tracking for the module.
|
||||
$this->completioninfo->expects($this->any())
|
||||
->method('is_enabled')
|
||||
->willReturn($completion);
|
||||
|
||||
// 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([
|
||||
['completion', $completion],
|
||||
['instance', 1],
|
||||
['modname', 'somenonexistentmod'],
|
||||
['completionview', $completionoptions['completionview'] ?? COMPLETION_VIEW_NOT_REQUIRED],
|
||||
['completiongradeitemnumber', $completionoptions['completionusegrade'] ?? null],
|
||||
]));
|
||||
|
||||
return new cm_completion_details($this->completioninfo, $mockcminfo, 2);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides data for test_has_completion().
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function has_completion_provider(): array {
|
||||
return [
|
||||
'Automatic' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, true
|
||||
],
|
||||
'Manual' => [
|
||||
COMPLETION_TRACKING_MANUAL, true
|
||||
],
|
||||
'None' => [
|
||||
COMPLETION_TRACKING_NONE, false
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for has_completion().
|
||||
*
|
||||
* @dataProvider has_completion_provider
|
||||
* @param int $completion The completion tracking mode.
|
||||
* @param bool $expectedresult Expected result.
|
||||
*/
|
||||
public function test_has_completion(int $completion, bool $expectedresult) {
|
||||
$cmcompletion = $this->setup_data($completion);
|
||||
|
||||
$this->assertEquals($expectedresult, $cmcompletion->has_completion());
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides data for test_is_automatic().
|
||||
*
|
||||
* @return array[]
|
||||
*/
|
||||
public function is_automatic_provider(): array {
|
||||
return [
|
||||
'Automatic' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, true
|
||||
],
|
||||
'Manual' => [
|
||||
COMPLETION_TRACKING_MANUAL, false
|
||||
],
|
||||
'None' => [
|
||||
COMPLETION_TRACKING_NONE, false
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for is_available().
|
||||
*
|
||||
* @dataProvider is_automatic_provider
|
||||
* @param int $completion The completion tracking mode.
|
||||
* @param bool $expectedresult Expected result.
|
||||
*/
|
||||
public function test_is_automatic(int $completion, bool $expectedresult) {
|
||||
$cmcompletion = $this->setup_data($completion);
|
||||
|
||||
$this->assertEquals($expectedresult, $cmcompletion->is_automatic());
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for test_get_overall_completion().
|
||||
* @return array[]
|
||||
*/
|
||||
public function overall_completion_provider(): array {
|
||||
return [
|
||||
'Complete' => [COMPLETION_COMPLETE],
|
||||
'Incomplete' => [COMPLETION_INCOMPLETE],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for get_overall_completion().
|
||||
*
|
||||
* @dataProvider overall_completion_provider
|
||||
* @param int $state
|
||||
*/
|
||||
public function test_get_overall_completion(int $state) {
|
||||
$cmcompletion = $this->setup_data(COMPLETION_TRACKING_AUTOMATIC);
|
||||
|
||||
$this->completioninfo->expects($this->once())
|
||||
->method('get_data')
|
||||
->willReturn((object)['completionstate' => $state]);
|
||||
|
||||
$this->assertEquals($state, $cmcompletion->get_overall_completion());
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for test_get_details().
|
||||
* @return array[]
|
||||
*/
|
||||
public function get_details_provider() {
|
||||
return [
|
||||
'No completion tracking' => [
|
||||
COMPLETION_TRACKING_NONE, null, null, []
|
||||
],
|
||||
'Manual completion tracking' => [
|
||||
COMPLETION_TRACKING_MANUAL, null, null, []
|
||||
],
|
||||
'Automatic, require view, not viewed' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, COMPLETION_INCOMPLETE, null, [
|
||||
'completionview' => (object)[
|
||||
'status' => COMPLETION_INCOMPLETE,
|
||||
'description' => get_string('detail_desc:view', 'completion'),
|
||||
]
|
||||
]
|
||||
],
|
||||
'Automatic, require view, viewed' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, COMPLETION_COMPLETE, null, [
|
||||
'completionview' => (object)[
|
||||
'status' => COMPLETION_COMPLETE,
|
||||
'description' => get_string('detail_desc:view', 'completion'),
|
||||
]
|
||||
]
|
||||
],
|
||||
'Automatic, require grade, incomplete' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, null, COMPLETION_INCOMPLETE, [
|
||||
'completionusegrade' => (object)[
|
||||
'status' => COMPLETION_INCOMPLETE,
|
||||
'description' => get_string('detail_desc:receivegrade', 'completion'),
|
||||
]
|
||||
]
|
||||
],
|
||||
'Automatic, require grade, complete' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, null, COMPLETION_COMPLETE, [
|
||||
'completionusegrade' => (object)[
|
||||
'status' => COMPLETION_COMPLETE,
|
||||
'description' => get_string('detail_desc:receivegrade', 'completion'),
|
||||
]
|
||||
]
|
||||
],
|
||||
'Automatic, require view (complete) and grade (incomplete)' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, COMPLETION_COMPLETE, COMPLETION_INCOMPLETE, [
|
||||
'completionview' => (object)[
|
||||
'status' => COMPLETION_COMPLETE,
|
||||
'description' => get_string('detail_desc:view', 'completion'),
|
||||
],
|
||||
'completionusegrade' => (object)[
|
||||
'status' => COMPLETION_INCOMPLETE,
|
||||
'description' => get_string('detail_desc:receivegrade', 'completion'),
|
||||
]
|
||||
]
|
||||
],
|
||||
'Automatic, require view (incomplete) and grade (complete)' => [
|
||||
COMPLETION_TRACKING_AUTOMATIC, COMPLETION_INCOMPLETE, COMPLETION_COMPLETE, [
|
||||
'completionview' => (object)[
|
||||
'status' => COMPLETION_INCOMPLETE,
|
||||
'description' => get_string('detail_desc:view', 'completion'),
|
||||
],
|
||||
'completionusegrade' => (object)[
|
||||
'status' => COMPLETION_COMPLETE,
|
||||
'description' => get_string('detail_desc:receivegrade', 'completion'),
|
||||
]
|
||||
]
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test for \core_completion\cm_completion_details::get_details().
|
||||
*
|
||||
* @dataProvider get_details_provider
|
||||
* @param int $completion The completion tracking mode.
|
||||
* @param int|null $completionview Completion status of the "view" completion condition.
|
||||
* @param int|null $completiongrade Completion status of the "must receive grade" completion condition.
|
||||
* @param array $expecteddetails Expected completion details returned by get_details().
|
||||
*/
|
||||
public function test_get_details(int $completion, ?int $completionview, ?int $completiongrade, array $expecteddetails) {
|
||||
$options = [];
|
||||
$getdatareturn = (object)[
|
||||
'viewed' => $completionview,
|
||||
'completiongrade' => $completiongrade,
|
||||
];
|
||||
|
||||
if (!is_null($completionview)) {
|
||||
$options['completionview'] = true;
|
||||
}
|
||||
if (!is_null($completiongrade)) {
|
||||
$options['completionusegrade'] = true;
|
||||
}
|
||||
|
||||
$cmcompletion = $this->setup_data($completion, $options);
|
||||
|
||||
$this->completioninfo->expects($this->any())
|
||||
->method('get_data')
|
||||
->willReturn($getdatareturn);
|
||||
|
||||
$this->assertEquals($expecteddetails, $cmcompletion->get_details());
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue