Improve coverage information

Add missing cover annotations and add new coverage annotation style for phpunit 12

Author: TamaroWalter

tests/backup_restore_test.php

@@ -36,7 +36,7 @@
  * @group      mod_ratingallocate
  * @copyright  usener
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \mod_ratingallocate\backup_ratingallocate_activity_structure_step
+ * @covers     \mod_ratingallocate\backup_ratingallocate_activity_structure_step (This is deprecated from phpunit 12 onwards)
  */
 #[CoversClass(backup_ratingallocate_activity_structure_step::class)]
 final class backup_restore_test extends \advanced_testcase {

tests/cron_test.php

@@ -24,6 +24,7 @@
 use mod_ratingallocate\db as this_db;
 use mod_ratingallocate\task\cron_task;
 use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\CoversFunction;
 
 /**
  * mod_ratingallocate cron tests
@@ -39,6 +40,7 @@
  * @covers \mod_ratingallocate\task\cron_task
  */
 #[CoversClass(cron_task::class)]
+#[CoversFunction('execute')]
 final class cron_test extends \advanced_testcase {
 
     /** @var $teacher */

tests/locallib_test.php

@@ -22,19 +22,36 @@
 require_once(dirname(__FILE__) . '/../locallib.php');
 
 use mod_ratingallocate\db as this_db;
+use mod_ratingallocate_generator;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\CoversFunction;
 
 /**
  * mod_ratingallocate generator tests
  *
  * @package    mod_ratingallocate
  * @category   test
- * @group mod_ratingallocate
+ * @group      mod_ratingallocate
  * @copyright  usener
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers \locallib
+ * @covers \mod_ratingallocate\ratingallocate
  */
+#[CoversClass(ratingallocate::class)]
+#[CoversFunction('get_choices_with_allocationcount')]
+#[CoversFunction('distribute_choices')]
+#[CoversFunction('get_options_titles')]
+#[CoversFunction('get_allocations')]
+#[CoversFunction('get_ratings_for_rateable_choices')]
 final class locallib_test extends \advanced_testcase {
 
+    /**
+     * Tests a simple allocation scenario.
+     *
+     * @return void
+     * @throws \coding_exception
+     * @throws \dml_exception
+     * @covers \mod_ratingallocate\ratingallocate::distribute_choices
+     */
     public function test_simple(): void {
         global $DB;
         \core_php_time_limit::raise();
@@ -221,7 +238,9 @@ public function test_get_option_titles_custom1(): void {
     }
 
     /**
-     * Test if option titles are returned according to a mixture of defined and custom values,
+     * Test if option titles are returned according to a mixture of defined and custom values
+     *
+     * @covers \mod_ratingallocate\ratingallocate::get_options_titles
      */
     public function test_get_option_titles_mixed(): void {
         $settings = [1 => 'Ja1234']; // Test data.
@@ -239,6 +258,11 @@ public function test_get_option_titles_mixed(): void {
         $this->assertEquals($expectedresult, $result);
     }
 
+    /**
+     * Test if reset_userdata works as expected.
+     *
+     * @covers \mod_ratingallocate\ratingallocate::distribute_choices
+     */
     public function test_reset_userdata(): void {
         global $DB;
 

tests/mod_generator_test.php

@@ -15,6 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 namespace mod_ratingallocate;
+use mod_ratingallocate_generator;
+use PHPUnit\Framework\Attributes\CoversClass;
+
 defined('MOODLE_INTERNAL') || die();
 
 global $CFG;
@@ -30,8 +33,14 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @covers \mod_ratingallocate_generator
  */
+#[CoversClass(mod_ratingallocate_generator::class)]
 final class mod_generator_test extends \advanced_testcase {
 
+    /**
+     * Test the creation of a mod_ratingallocate instance with choices.
+     *
+     * @covers \mod_ratingallocate_generator::create_instance_with_choices
+     */
     public function test_create_instance(): void {
 
         global $DB, $USER;

tests/mod_ratingallocate_allocate_unrated_test.php

@@ -18,6 +18,9 @@
 
 use coding_exception;
 use mod_ratingallocate_generator;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\CoversFunction;
+use PHPUnit\Framework\Attributes\CoversMethod;
 use stdClass;
 
 defined('MOODLE_INTERNAL') || die();
@@ -36,6 +39,14 @@
  * @author     Philipp Memmel
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+#[CoversClass(ratingallocate::class)]
+#[CoversFunction('get_choice_groups')]
+#[CoversFunction('get_all_groups_of_choices')]
+#[CoversFunction('get_user_groupids')]
+#[CoversFunction('get_undistributed_users_with_groupscount')]
+#[CoversFunction('get_undistributed_users')]
+#[CoversFunction('get_choices_with_allocationcount')]
+#[CoversFunction('get_allocations_for_user')]
 final class mod_ratingallocate_allocate_unrated_test extends \advanced_testcase {
 
     /** @var stdClass Course object. */
@@ -91,6 +102,7 @@ protected function setUp(): void {
      * Asserts that there is no allocation violating the group restrictions. This should be called after the algorithms have been
      * run to assert that the algorithm did respect the group restrictions when allocating.
      *
+     * @covers ::get_choice_groups
      * @return void
      */
     private function test_group_memberships(): void {
@@ -322,6 +334,7 @@ public function test_get_undistributed_users(): void {
      * Helper method to retrieve the choice id by the title.
      *
      * @param string $title title of the choice to get the id
+     * @covers ::get_rateable_choices
      * @return int the id of the choice object
      */
     private function get_choice_id_by_title(string $title): int {
@@ -395,6 +408,7 @@ private function assert_allocation_of_random_users(): void {
      * Test distribution without groups.
      *
      * @return void
+     * @covers ::queue_distribution_of_users_without_choice
      * @throws coding_exception
      */
     public function test_distribution_without_groups(): void {
@@ -464,6 +478,7 @@ public function test_allocation_with_groups_common_features(): void {
      *  test_allocation_with_groups function.
      *
      * @param string $algorithm the algorithm to use for running this test function
+     * @covers ::queue_distribution_of_users_without_choice
      * @return void
      */
     private function test_allocation_with_groups_with_algorithm(string $algorithm): void {
@@ -524,6 +539,7 @@ private function test_allocation_with_groups_with_algorithm(string $algorithm):
     /**
      * Test the distribution of users to choices with group restrictions, using both algorithms.
      *
+     * @covers ::queue_distribution_of_users_without_choice
      * @return void
      * @throws coding_exception
      */
@@ -538,6 +554,7 @@ public function test_allocation_without_groups_common_features(): void {
      * This is a private method because she is being called twice to test both algorithms.
      *
      * @param string $algorithm the algorithm to use for the distribution
+     * @covers ::queue_distribution_of_users_without_choice
      * @return void
      * @throws coding_exception
      */
@@ -586,6 +603,7 @@ private function test_allocation_without_groups_with_algorithm(string $algorithm
      * Test the EQUALLY algorithm without groups. The algorithm tries to distribute the users so that each choice has equal places
      * left or at most there is a difference of one user for the left places per choice.
      *
+     * @covers ::queue_distribution_of_users_without_choice
      * @return void
      * @throws dml_exception
      */
@@ -638,6 +656,7 @@ public function test_distribute_equally_without_groups(): void {
      * Test the FILL algorithm without groups. This algorithm just fills up every choice. Choices with least places left are
      * being filled up first.
      *
+     * @covers ::queue_distribution_of_users_without_choice
      * @return void
      */
     public function test_distribute_fill_without_groups(): void {

tests/mod_ratingallocate_choice_groups_test.php

@@ -15,6 +15,8 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 namespace mod_ratingallocate;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\CoversFunction;
 use stdClass;
 
 defined('MOODLE_INTERNAL') || die();
@@ -31,6 +33,10 @@
  * @author     David Thompson <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+#[CoversClass(ratingallocate::class)]
+#[CoversFunction('get_group_selections')]
+#[CoversFunction('filter_choices_by_groups')]
+#[CoversFunction('update_choice_groups')]
 final class mod_ratingallocate_choice_groups_test extends \advanced_testcase {
 
     /** @var object The environment that will be used for testing