Fixing Moodle Code Checker issues.

Author: lucaboesch

.github/workflows/ci.yml

@@ -92,7 +92,7 @@ jobs:
 
       - name: Moodle Code Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci codechecker || true
+        run: moodle-plugin-ci codechecker
 
       - name: Moodle PHPDoc Checker
         if: ${{ always() }}

tests/csvexport_test.php

@@ -14,15 +14,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Performance test for questionnaire module.
- * @package mod_questionnaire
- * @group mod_questionnaire
- * @author     Guy Thomas
- * @copyright Copyright (c) 2015 Moodlerooms Inc. (http://www.moodlerooms.com)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
 namespace mod_questionnaire;
 
 /**
@@ -59,9 +50,9 @@ private function get_csv_text(array $rows) {
     }
 
     /**
-     * Tests the CSV export.
+     * Test case for the csvexport method.
      *
-     * @covers \questionnaire::generate_csv
+     * @covers ::csvexport
      */
     public function test_csvexport() {
         $this->resetAfterTest();

tests/custom_completion_test.php

@@ -117,7 +117,7 @@ public function test_get_state(string $rule, int $available, ?bool $submitted, ?
     /**
      * Test for get_defined_custom_rules().
      *
-     * @covers \mod_questionnaire\completion\custom_completion
+     * @covers \mod_questionnaire\completion\custom_completion::get_defined_custom_rules
      */
     public function test_get_defined_custom_rules() {
         $rules = custom_completion::get_defined_custom_rules();
@@ -128,7 +128,7 @@ public function test_get_defined_custom_rules() {
     /**
      * Test for get_defined_custom_rule_descriptions().
      *
-     * @covers \mod_questionnaire\completion\custom_completion
+     * @covers \mod_questionnaire\completion\custom_completion::get_custom_rule_descriptions
      */
     public function test_get_custom_rule_descriptions() {
         // Get defined custom rules.
@@ -156,7 +156,7 @@ public function test_get_custom_rule_descriptions() {
     /**
      * Test for is_defined().
      *
-     * @covers \mod_questionnaire\completion\custom_completion
+     * @covers \mod_questionnaire\completion\custom_completion::is_defined
      */
     public function test_is_defined() {
         // Build a mock cm_info instance.

tests/generator_test.php

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace mod_questionnaire;
+
 /**
  * PHPUnit questionnaire generator tests
  *
@@ -23,21 +25,11 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace mod_questionnaire;
-
-/**
- * Unit tests for questionnaire_generator_testcase.
- * @group mod_questionnaire
- */
 class generator_test extends \advanced_testcase {
     /**
-     * Test generator create_instance function.
+     * Test case for the create_instance function.
      *
-     * @return void
-     * @throws coding_exception
-     * @throws dml_exception
-     *
-     * @covers \mod_questionnaire\generator\
+     * @covers \mod_questionnaire_generator::create_instance
      */
     public function test_create_instance() {
         global $DB;
@@ -74,13 +66,9 @@ public function test_create_instance() {
     }
 
     /**
-     * Test generator create_content function.
-     *
-     * @return void
-     * @throws coding_exception
-     * @throws dml_exception
+     * Test case for the create_content function.
      *
-     * @covers \mod_questionnaire\generator\
+     * @covers \mod_questionnaire_generator::create_content
      */
     public function test_create_content() {
         global $DB;

tests/lib_test.php

@@ -14,15 +14,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * PHPUnit questionnaire generator tests
- *
- * @package    mod_questionnaire
- * @copyright  2015 Mike Churchward ([email protected])
- * @author     Mike Churchward
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
 namespace mod_questionnaire;
 
 use mod_questionnaire\question\question;
@@ -34,17 +25,19 @@
 require_once($CFG->dirroot.'/mod/questionnaire/classes/question/question.php');
 
 /**
- * Unit tests for questionnaire_lib_testcase.
- * @group mod_questionnaire
+ * PHPUnit questionnaire lib tests
+ *
+ * @package    mod_questionnaire
+ * @copyright  2015 Mike Churchward ([email protected])
+ * @author     Mike Churchward
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class lib_test extends \advanced_testcase {
 
     /**
-     * Test for questionnaire_supports.
+     * Test case for the questionnaire_supports function.
      *
-     * @return void
-     *
-     * @covers \questionnaire_supports
+     * @covers ::questionnaire_supports
      */
     public function test_questionnaire_supports() {
         $this->assertTrue(questionnaire_supports(FEATURE_BACKUP_MOODLE2));
@@ -60,11 +53,9 @@ public function test_questionnaire_supports() {
     }
 
     /**
-     * Test for questionnaire_get_extra_capabilities.
-     *
-     * @return void
+     * Test case for the questionnaire_get_extra_capabilities function.
      *
-     * @covers \questionnaire_get_extra_capabilities
+     * @covers ::questionnaire_get_extra_capabilities
      */
     public function test_questionnaire_get_extra_capabilities() {
         $caps = questionnaire_get_extra_capabilities();
@@ -74,12 +65,9 @@ public function test_questionnaire_get_extra_capabilities() {
     }
 
     /**
-     * Test for questionnaire_add_instance.
+     * Test case for the questionnaire_add_instance function.
      *
-     * @return void
-     * @throws moodle_exception
-     *
-     * @covers \questionnaire_add_instance
+     * @covers ::questionnaire_add_instance
      */
     public function test_add_instance() {
         $this->resetAfterTest();
@@ -112,12 +100,9 @@ public function test_add_instance() {
     }
 
     /**
-     * Test for questionnaire_update_instance().
-     *
-     * @return void
-     * @throws dml_exception
+     * Test case for the questionnaire_update_instance function.
      *
-     * @covers \questionnaire_update_instance
+     * @covers ::questionnaire_update_instance
      */
     public function test_update_instance() {
         global $DB;
@@ -176,13 +161,9 @@ public function test_update_instance() {
 
     /**
      * Test for questionnaire_delete_instance().
-     *
      * Need to verify that delete_instance deletes all data associated with a questionnaire.
      *
-     * @return void
-     * @throws dml_exception
-     *
-     * @covers \questionnaire_delete_instance
+     * @covers ::questionnaire_delete_instance
      */
     public function test_delete_instance() {
         global $DB;
@@ -216,12 +197,9 @@ public function test_delete_instance() {
     }
 
     /**
-     * Test for questionnaire_user_outline().
-     *
-     * @return void
-     * @throws coding_exception
+     * Test case for the questionnaire_user_outline function.
      *
-     * @covers \questionnaire_user_outline
+     * @covers ::questionnaire_user_outline
      */
     public function test_questionnaire_user_outline() {
         $this->resetAfterTest();
@@ -244,12 +222,9 @@ public function test_questionnaire_user_outline() {
     }
 
     /**
-     * Test for questionnaire_user_complete().
+     * Test case for the questionnaire_user_complete function.
      *
-     * @return void
-     * @throws coding_exception
-     *
-     * @covers \questionnaire_user_complete
+     * @covers ::questionnaire_user_complete
      */
     public function test_questionnaire_user_complete() {
         $this->resetAfterTest();
@@ -264,11 +239,9 @@ public function test_questionnaire_user_complete() {
     }
 
     /**
-     * Test for questionnaire_print_recent_activity().
-     *
-     * @return void
+     * Test case for the questionnaire_print_recent_activity function.
      *
-     * @covers \questionnaire_print_recent_activity
+     * @covers ::questionnaire_print_recent_activity
      */
     public function test_questionnaire_print_recent_activity() {
         $this->resetAfterTest();
@@ -277,11 +250,9 @@ public function test_questionnaire_print_recent_activity() {
     }
 
     /**
-     * Test for questionnaire_grades().
-     *
-     * @return void
+     * Test case for the questionnaire_grades function.
      *
-     * @covers \questionnaire_grades
+     * @covers ::questionnaire_grades
      */
     public function test_questionnaire_grades() {
         $this->resetAfterTest();
@@ -290,11 +261,9 @@ public function test_questionnaire_grades() {
     }
 
     /**
-     * Test for questionnaire_get_user_grades().
+     * Test case for the questionnaire_get_user_grades function.
      *
-     * @return void
-     *
-     * @covers \questionnaire_get_user_grades
+     * @covers ::questionnaire_get_user_grades
      */
     public function test_questionnaire_get_user_grades() {
         $this->resetAfterTest();
@@ -315,23 +284,19 @@ public function test_questionnaire_get_user_grades() {
     }
 
     /**
-     * Test for questionnaire_update_grades().
-     *
-     * @return void
+     * Test case for the questionnaire_update_grades function.
      *
-     * @covers \questionnaire_update_grades
+     * @covers ::questionnaire_update_grades
      */
     public function test_questionnaire_update_grades() {
         // Don't know how to test this yet! It doesn't return anything.
         $this->assertNull(questionnaire_update_grades());
     }
 
     /**
-     * Test for questionnaire_grade_item_update().
-     *
-     * @return void
+     * Test case for the questionnaire_grade_item_update function.
      *
-     * @covers \questionnaire_grade_item_update
+     * @covers ::questionnaire_grade_item_update
      */
     public function test_questionnaire_grade_item_update() {
         $this->resetAfterTest();

tests/privacy_provider_test.php

@@ -14,14 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * Privacy test for the mod questionnaire.
- *
- * @package    mod_questionnaire
- * @copyright  2019, onwards Poet
- * @author     Mike Churchward
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+namespace mod_questionnaire;
 
 namespace mod_questionnaire;