Skip to content

Commit a9ca15b

Browse files
lucaboeschlucaboesch
authored
Fixing Moodle Code Checker issues. (#548)
1 parent 743b2fb commit a9ca15b

9 files changed

+312
-28
lines changed

‎externallib.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626

2727
namespace mod_questionnaire;
2828

29+
defined('MOODLE_INTERNAL') || die();
30+
2931
require_once($CFG->libdir . '/externallib.php');
3032

3133
use external_api;

‎tests/csvexport_test.php‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,14 @@
2222
* @copyright Copyright (c) 2015 Moodlerooms Inc. (http://www.moodlerooms.com)
2323
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2424
*/
25-
class mod_questionnaire_csvexport_test extends advanced_testcase {
25+
26+
namespace mod_questionnaire;
27+
28+
/**
29+
* Unit tests for questionnaire_csvexport_test.
30+
* @group mod_questionnaire
31+
*/
32+
class csvexport_test extends \advanced_testcase {
2633

2734
public function setUp(): void {
2835
global $CFG;
@@ -53,6 +60,8 @@ private function get_csv_text(array $rows) {
5360

5461
/**
5562
* Tests the CSV export.
63+
*
64+
* @covers \questionnaire::generate_csv
5665
*/
5766
public function test_csvexport() {
5867
$this->resetAfterTest();
@@ -64,7 +73,7 @@ public function test_csvexport() {
6473
$questionnaires = $qdg->questionnaires();
6574
foreach ($questionnaires as $questionnaire) {
6675
list ($course, $cm) = get_course_and_cm_from_instance($questionnaire->id, 'questionnaire', $questionnaire->course);
67-
$questionnaireinst = new questionnaire($course, $cm, 0, $questionnaire);
76+
$questionnaireinst = new \questionnaire($course, $cm, 0, $questionnaire);
6877

6978
// Test for only complete responses.
7079
$newoutput = $this->get_csv_text($questionnaireinst->generate_csv(0, '', '', 0, 0, 0));
@@ -84,6 +93,8 @@ public function test_csvexport() {
8493

8594
/**
8695
* Tests the CSV export with identity fields and anonymous questionnaires.
96+
*
97+
* @covers \questionnaire::generate_csv
8798
*/
8899
public function test_csvexport_identity_fields() {
89100
global $DB;
@@ -142,7 +153,7 @@ private function do_test_csvexport_identity_fields($course, $cm, $user, $roleid,
142153
assign_capability('moodle/site:viewuseridentity', CAP_ALLOW, $roleid, $context);
143154

144155
// Generate CSV output.
145-
$questionnaire = new questionnaire($course, $cm, $item->id);
156+
$questionnaire = new \questionnaire($course, $cm, $item->id);
146157
$output = $questionnaire->generate_csv(0, '', '', 0, 0, 1);
147158

148159
$this->assertNotNull($output);

‎tests/custom_completion_test.php‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626

2727
namespace mod_questionnaire;
2828

29-
use advanced_testcase;
3029
use cm_info;
3130
use coding_exception;
3231
use mod_questionnaire\completion\custom_completion;
@@ -45,7 +44,7 @@
4544
* @copyright 2022 The Open University
4645
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4746
*/
48-
class custom_completion_test extends advanced_testcase {
47+
class custom_completion_test extends \advanced_testcase {
4948

5049
/**
5150
* Data provider for get_state().
@@ -79,6 +78,8 @@ public function get_state_provider(): array {
7978
* @param int|null $status Expected status.
8079
* @param string|null $exception Expected exception.
8180
* @throws coding_exception
81+
*
82+
* @covers \mod_questionnaire\completion\custom_completion
8283
*/
8384
public function test_get_state(string $rule, int $available, ?bool $submitted, ?int $status, ?string $exception) {
8485
if (!is_null($exception)) {
@@ -114,6 +115,8 @@ public function test_get_state(string $rule, int $available, ?bool $submitted, ?
114115

115116
/**
116117
* Test for get_defined_custom_rules().
118+
*
119+
* @covers \mod_questionnaire\completion\custom_completion
117120
*/
118121
public function test_get_defined_custom_rules() {
119122
$rules = custom_completion::get_defined_custom_rules();
@@ -123,6 +126,8 @@ public function test_get_defined_custom_rules() {
123126

124127
/**
125128
* Test for get_defined_custom_rule_descriptions().
129+
*
130+
* @covers \mod_questionnaire\completion\custom_completion
126131
*/
127132
public function test_get_custom_rule_descriptions() {
128133
// Get defined custom rules.
@@ -149,6 +154,8 @@ public function test_get_custom_rule_descriptions() {
149154

150155
/**
151156
* Test for is_defined().
157+
*
158+
* @covers \mod_questionnaire\completion\custom_completion
152159
*/
153160
public function test_is_defined() {
154161
// Build a mock cm_info instance.
@@ -187,6 +194,8 @@ public function get_available_custom_rules_provider(): array {
187194
* @dataProvider get_available_custom_rules_provider
188195
* @param int $status
189196
* @param array $expected
197+
*
198+
* @covers \mod_questionnaire\completion\custom_completion
190199
*/
191200
public function test_get_available_custom_rules(int $status, array $expected) {
192201
$customdataval = [

‎tests/generator/lib.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public function create_instance($record = null, array $options = null) {
108108
$instance = parent::create_instance($record, (array)$options);
109109
$cm = get_coursemodule_from_instance('questionnaire', $instance->id);
110110
$course = get_course($cm->course);
111-
$questionnaire = new questionnaire($course, $cm, 0, $instance, false);
111+
$questionnaire = new \questionnaire($course, $cm, 0, $instance, false);
112112

113113
$this->questionnaires[$instance->id] = $questionnaire;
114114

@@ -220,7 +220,7 @@ public function create_test_questionnaire($course, $qtype = null, $questiondata
220220
$questiondata['content'] = isset($questiondata['content']) ? $questiondata['content'] : 'Test content';
221221
$this->create_question($questionnaire, $questiondata, $choicedata);
222222
}
223-
$questionnaire = new questionnaire($course, $cm, $questionnaire->id, null, true);
223+
$questionnaire = new \questionnaire($course, $cm, $questionnaire->id, null, true);
224224
return $questionnaire;
225225
}
226226

‎tests/generator_test.php‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,22 @@
2323
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2424
*/
2525

26+
namespace mod_questionnaire;
27+
2628
/**
2729
* Unit tests for questionnaire_generator_testcase.
2830
* @group mod_questionnaire
2931
*/
30-
class mod_questionnaire_generator_testcase extends advanced_testcase {
32+
class generator_test extends \advanced_testcase {
33+
/**
34+
* Test generator create_instance function.
35+
*
36+
* @return void
37+
* @throws coding_exception
38+
* @throws dml_exception
39+
*
40+
* @covers \mod_questionnaire\generator\
41+
*/
3142
public function test_create_instance() {
3243
global $DB;
3344

@@ -49,7 +60,7 @@ public function test_create_instance() {
4960
$this->assertEquals('questionnaire', $cm->modname);
5061
$this->assertEquals($course->id, $cm->course);
5162

52-
$context = context_module::instance($cm->id);
63+
$context = \context_module::instance($cm->id);
5364
$this->assertEquals($questionnaire->cmid, $context->instanceid);
5465

5566
$survey = $DB->get_record('questionnaire_survey', array('id' => $questionnaire->sid));
@@ -62,6 +73,15 @@ public function test_create_instance() {
6273
// Should test event creation if open dates and close dates are specified?
6374
}
6475

76+
/**
77+
* Test generator create_content function.
78+
*
79+
* @return void
80+
* @throws coding_exception
81+
* @throws dml_exception
82+
*
83+
* @covers \mod_questionnaire\generator\
84+
*/
6585
public function test_create_content() {
6686
global $DB;
6787

@@ -71,7 +91,7 @@ public function test_create_content() {
7191
$generator = $this->getDataGenerator()->get_plugin_generator('mod_questionnaire');
7292
$questionnaire = $generator->create_instance(array('course' => $course->id));
7393
$cm = get_coursemodule_from_instance('questionnaire', $questionnaire->id);
74-
$questionnaire = new questionnaire($course, $cm, $questionnaire->id, null, false);
94+
$questionnaire = new \questionnaire($course, $cm, $questionnaire->id, null, false);
7595

7696
$newcontent = array(
7797
'title' => 'New title',

‎tests/lib_test.php‎

Lines changed: 94 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@
2323
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2424
*/
2525

26-
defined('MOODLE_INTERNAL') || die();
26+
namespace mod_questionnaire;
2727

2828
use mod_questionnaire\question\question;
2929

30+
defined('MOODLE_INTERNAL') || die();
31+
3032
global $CFG;
3133
require_once($CFG->dirroot.'/mod/questionnaire/lib.php');
3234
require_once($CFG->dirroot.'/mod/questionnaire/classes/question/question.php');
@@ -35,7 +37,15 @@
3537
* Unit tests for questionnaire_lib_testcase.
3638
* @group mod_questionnaire
3739
*/
38-
class mod_questionnaire_lib_testcase extends advanced_testcase {
40+
class lib_test extends \advanced_testcase {
41+
42+
/**
43+
* Test for questionnaire_supports.
44+
*
45+
* @return void
46+
*
47+
* @covers \questionnaire_supports
48+
*/
3949
public function test_questionnaire_supports() {
4050
$this->assertTrue(questionnaire_supports(FEATURE_BACKUP_MOODLE2));
4151
$this->assertFalse(questionnaire_supports(FEATURE_COMPLETION_TRACKS_VIEWS));
@@ -49,20 +59,35 @@ public function test_questionnaire_supports() {
4959
$this->assertNull(questionnaire_supports('unknown option'));
5060
}
5161

62+
/**
63+
* Test for questionnaire_get_extra_capabilities.
64+
*
65+
* @return void
66+
*
67+
* @covers \questionnaire_get_extra_capabilities
68+
*/
5269
public function test_questionnaire_get_extra_capabilities() {
5370
$caps = questionnaire_get_extra_capabilities();
5471
$this->assertIsArray($caps);
5572
$this->assertEquals(1, count($caps));
5673
$this->assertEquals('moodle/site:accessallgroups', reset($caps));
5774
}
5875

76+
/**
77+
* Test for questionnaire_add_instance.
78+
*
79+
* @return void
80+
* @throws moodle_exception
81+
*
82+
* @covers \questionnaire_add_instance
83+
*/
5984
public function test_add_instance() {
6085
$this->resetAfterTest();
6186
$this->setAdminUser();
6287
$course = $this->getDataGenerator()->create_course();
6388

6489
// Create test data as a record.
65-
$questdata = new stdClass();
90+
$questdata = new \stdClass();
6691
$questdata->course = $course->id;
6792
$questdata->coursemodule = '';
6893
$questdata->name = 'Test questionnaire';
@@ -86,6 +111,14 @@ public function test_add_instance() {
86111
$this->assertTrue(questionnaire_add_instance($questdata) > 0);
87112
}
88113

114+
/**
115+
* Test for questionnaire_update_instance().
116+
*
117+
* @return void
118+
* @throws dml_exception
119+
*
120+
* @covers \questionnaire_update_instance
121+
*/
89122
public function test_update_instance() {
90123
global $DB;
91124

@@ -141,9 +174,15 @@ public function test_update_instance() {
141174
$this->assertEquals($qrow->autonum, $questrecord->autonum);
142175
}
143176

144-
/*
177+
/**
178+
* Test for questionnaire_delete_instance().
179+
*
145180
* Need to verify that delete_instance deletes all data associated with a questionnaire.
146181
*
182+
* @return void
183+
* @throws dml_exception
184+
*
185+
* @covers \questionnaire_delete_instance
147186
*/
148187
public function test_delete_instance() {
149188
global $DB;
@@ -176,6 +215,14 @@ public function test_delete_instance() {
176215
$this->assertEmpty($DB->get_records('event', array("modulename" => 'questionnaire', "instance" => $questionnaire->id)));
177216
}
178217

218+
/**
219+
* Test for questionnaire_user_outline().
220+
*
221+
* @return void
222+
* @throws coding_exception
223+
*
224+
* @covers \questionnaire_user_outline
225+
*/
179226
public function test_questionnaire_user_outline() {
180227
$this->resetAfterTest();
181228
$this->setAdminUser();
@@ -196,6 +243,14 @@ public function test_questionnaire_user_outline() {
196243
$this->assertEquals('1 '.get_string("response", "questionnaire"), $outline->info);
197244
}
198245

246+
/**
247+
* Test for questionnaire_user_complete().
248+
*
249+
* @return void
250+
* @throws coding_exception
251+
*
252+
* @covers \questionnaire_user_complete
253+
*/
199254
public function test_questionnaire_user_complete() {
200255
$this->resetAfterTest();
201256
$this->setAdminUser();
@@ -208,18 +263,39 @@ public function test_questionnaire_user_complete() {
208263
$this->expectOutputString(get_string('noresponses', 'questionnaire'));
209264
}
210265

266+
/**
267+
* Test for questionnaire_print_recent_activity().
268+
*
269+
* @return void
270+
*
271+
* @covers \questionnaire_print_recent_activity
272+
*/
211273
public function test_questionnaire_print_recent_activity() {
212274
$this->resetAfterTest();
213275
$this->setAdminUser();
214276
$this->assertFalse(questionnaire_print_recent_activity(null, null, null));
215277
}
216278

279+
/**
280+
* Test for questionnaire_grades().
281+
*
282+
* @return void
283+
*
284+
* @covers \questionnaire_grades
285+
*/
217286
public function test_questionnaire_grades() {
218287
$this->resetAfterTest();
219288
$this->setAdminUser();
220289
$this->assertNull(questionnaire_grades(null));
221290
}
222291

292+
/**
293+
* Test for questionnaire_get_user_grades().
294+
*
295+
* @return void
296+
*
297+
* @covers \questionnaire_get_user_grades
298+
*/
223299
public function test_questionnaire_get_user_grades() {
224300
$this->resetAfterTest();
225301
$this->setAdminUser();
@@ -238,11 +314,25 @@ public function test_questionnaire_get_user_grades() {
238314
$this->assertIsArray($grades);
239315
}
240316

317+
/**
318+
* Test for questionnaire_update_grades().
319+
*
320+
* @return void
321+
*
322+
* @covers \questionnaire_update_grades
323+
*/
241324
public function test_questionnaire_update_grades() {
242325
// Don't know how to test this yet! It doesn't return anything.
243326
$this->assertNull(questionnaire_update_grades());
244327
}
245328

329+
/**
330+
* Test for questionnaire_grade_item_update().
331+
*
332+
* @return void
333+
*
334+
* @covers \questionnaire_grade_item_update
335+
*/
246336
public function test_questionnaire_grade_item_update() {
247337
$this->resetAfterTest();
248338
$this->setAdminUser();

0 commit comments

Comments
 (0)