Skip to content

Commit

Permalink
draft of the test_rule_on_enrollink_and_enroll_via_waitinglists() (#711)
Browse files Browse the repository at this point in the history
  • Loading branch information
@semteacher
semteacher committed Jan 27, 2025
1 parent 8c946e0 commit 5173439
Showing 1 changed file with 300 additions and 0 deletions.
300 changes: 300 additions & 0 deletions tests/booking_rules/rules_enrollink_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,306 @@ public function test_rule_on_enrollink_and_enroll(array $bdata): void {
booking_rules::$rules = [];
}

/**
* Test rule on answer and option being cancelled.
*
* @covers \mod_booking\event\enrollink_triggered
* @covers \mod_booking\booking_rules\rules\rule_react_on_event->execute
* @covers \mod_booking\booking_rules\conditions\select_student_in_bo->execute
* @covers \mod_booking\booking_rules\actions\send_mail->execute
*
* @param array $bdata
* @throws \coding_exception
*
* @dataProvider booking_common_settings_provider
*/
public function test_rule_on_enrollink_and_enroll_via_waitinglists(array $bdata): void {
global $USER;

set_config('timezone', 'Europe/Kyiv');
set_config('forcetimezone', 'Europe/Kyiv');

// Setup test data.
$course = $this->getDataGenerator()->create_course(['enablecompletion' => 1]);
$course2 = $this->getDataGenerator()->create_course(['enablecompletion' => 1]);
$teacher1 = $this->getDataGenerator()->create_user();
$student1 = $this->getDataGenerator()->create_user();
$student2 = $this->getDataGenerator()->create_user();
$student3 = $this->getDataGenerator()->create_user();
$student4 = $this->getDataGenerator()->create_user();
$student5 = $this->getDataGenerator()->create_user();

$bdata['course'] = $course->id;
$bdata['bookingmanager'] = $teacher1->username;
// Autoenroll must be enabled!
$bdata['autoenrol'] = 1;

$booking = $this->getDataGenerator()->create_module('booking', $bdata);

$this->setAdminUser();

$this->getDataGenerator()->enrol_user($teacher1->id, $course->id, 'editingteacher');
$this->getDataGenerator()->enrol_user($student1->id, $course->id, 'student');

/** @var local_shopping_cart_generator $plugingenerator */
$plugingenerator = self::getDataGenerator()->get_plugin_generator('local_shopping_cart');
$usercreditdata = [
'userid' => $teacher1->id,
'credit' => 300,
'currency' => 'EUR',
];
$ucredit = $plugingenerator->create_user_credit($usercreditdata);

/** @var mod_booking_generator $plugingenerator */
$plugingenerator = self::getDataGenerator()->get_plugin_generator('mod_booking');

// Create booking rule - "bookinganswer_cancelled".
$actstr = '{"subject":"Enrollinksubj",';
$actstr .= '"template":';
$actstr .= '"<p>{enrollink}<\/p><p>{qrenrollink}<\/p><p>{#customform}<\/p><p>{customform}<\/p><p>{\/customform}<\/p>",';
$actstr .= '"templateformat":"1"}';
$ruledata1 = [
'name' => 'enrollink',
'conditionname' => 'select_student_in_bo',
'contextid' => 1,
'conditiondata' => '{"borole":"0"}',
'actionname' => 'send_mail',
'actiondata' => $actstr,
'rulename' => 'rule_react_on_event',
'ruledata' => '{"boevent":"\\\\mod_booking\\\\event\\\\enrollink_triggered","aftercompletion":"","condition":"0"}',
];
$rule1 = $plugingenerator->create_rule($ruledata1);

// Create price categories.
$pricecategorydata1 = (object)[
'ordernum' => 1,
'name' => 'default',
'identifier' => 'default',
'defaultvalue' => 25,
'pricecatsortorder' => 1,
];
$pricecategory1 = $plugingenerator->create_pricecategory($pricecategorydata1);

$pricecategorydata2 = (object)[
'ordernum' => 2,
'name' => 'discount1',
'identifier' => 'discount1',
'defaultvalue' => 20,
'pricecatsortorder' => 2,
];
$pricecategory2 = $plugingenerator->create_pricecategory($pricecategorydata2);

// Create booking option 1.
$record = new stdClass();
$record->bookingid = $booking->id;
$record->text = 'Option-2050';
$record->description = 'Will start 2050';
$record->optiondateid_0 = "0";
$record->daystonotify_0 = "0";
$record->coursestarttime_0 = strtotime('20 June 2050 15:00');
$record->courseendtime_0 = strtotime('20 July 2050 14:00');
$record->teachersforoption = $teacher1->username;
$record->importing = 1;
// Set test objective setting(s).
$record->chooseorcreatecourse = 1; // Connected existing course.
$record->courseid = $course2->id;
$record->useprice = 1;
$record->enrolmentstatus = 2;
$record->bo_cond_customform_restrict = 1;
$record->bo_cond_customform_select_1_1 = 'enrolusersaction';
$record->bo_cond_customform_label_1_1 = 'Number of user';
$record->bo_cond_customform_value_1_1 = 1;
// Waiting lists ARE forced.
$record->bo_cond_customform_enroluserstowaitinglist1 = 1;
$record->waitforconfirmation = 1;

$option1 = $plugingenerator->create_option($record);
singleton_service::destroy_booking_option_singleton($option1->id);

$settings = singleton_service::get_instance_of_booking_option_settings($option1->id);
singleton_service::destroy_booking_singleton_by_cmid($settings->cmid); // Require to avoid caching issues.
$boinfo = new bo_info($settings);

// Try to book option1 by the teacher1.
$this->setUser($teacher1);
singleton_service::destroy_user($teacher1->id);
list($id, $isavailable, $description) = $boinfo->is_available($settings->id, $teacher1->id);
$this->assertEquals(MOD_BOOKING_BO_COND_JSON_CUSTOMFORM, $id);

$price = price::get_price('option', $settings->id);
$this->assertEquals($pricecategorydata1->defaultvalue, $price["price"]);

// Submit customform data 1st.
$customformdata = (object) [
'id' => $settings->id,
'userid' => $teacher1->id,
'customform_enrolusersaction_1' => 3,
'customform_enroluserwhobookedcheckbox_enrolusersaction_1' => 1,
];
$customformstore = new customformstore($teacher1->id, $settings->id);
$customformstore->set_customform_data($customformdata);

// Verify 3x price.
$price = price::get_price('option', $settings->id);
$this->assertEquals(75, $price["price"]);

list($id, $isavailable, $description) = $boinfo->is_available($settings->id, $teacher1->id);
$this->assertEquals(MOD_BOOKING_BO_COND_JSON_CUSTOMFORM, $id);
//TODO: I would expect MOD_BOOKING_BO_COND_ONWAITINGLIST there now.

// Admin confirms the users booking.
$this->setAdminUser();
// Purchase item in behalf of teacher1.
shopping_cart::delete_all_items_from_cart($teacher1->id);
shopping_cart::buy_for_user($teacher1->id);

// Get cached data or setup defaults.
$cartstore = cartstore::instance($teacher1->id);

// Put in a test item with given ID (or default if ID > 4).
$item = shopping_cart::add_item_to_cart('mod_booking', 'option', $settings->id, -1);

shopping_cart::save_used_credit_state($teacher1->id, 1);

// Confirm credit payment.
$res = shopping_cart::confirm_payment($teacher1->id, LOCAL_SHOPPING_CART_PAYMENT_METHOD_CREDITS);
// Validate payment.
$this->assertIsArray($res);
$this->assertEmpty($res['error']);
$this->assertEquals(225, $res['credit']);

// In this test, we book the teacher into option directly.
$option = singleton_service::get_instance_of_booking_option($settings->cmid, $settings->id);
$option->user_submit_response($teacher1, 0, 0, 0, MOD_BOOKING_VERIFIED);
// Teacher1 should be booked now.
list($id, $isavailable, $description) = $boinfo->is_available($settings->id, $teacher1->id, true);
$this->assertEquals(MOD_BOOKING_BO_COND_ALREADYBOOKED, $id);

// Get messages.
$messagesobjs = \core\task\manager::get_adhoc_tasks('\mod_booking\task\send_mail_by_rule_adhoc');

ob_start();
$messagesink = $this->redirectMessages();
$this->runAdhocTasks();
$messages = $messagesink->get_messages();
$res = ob_get_clean();
$messagesink->close();

// Validate scheduled adhoc tasks. Validate messages - order might be free.
foreach ($messagesobjs as $key => $messageobj) {
$customdata = $messageobj->get_custom_data();
if (strpos($customdata->customsubject, "Enrollinksubj") !== false) {
// Validate message on the option's enrol link.
$this->assertEquals($teacher1->id, $customdata->userid);
$this->assertStringContainsString('enrollink_triggered', $customdata->rulejson);
$this->assertStringContainsString($ruledata1['conditiondata'], $customdata->rulejson);
$this->assertStringContainsString($ruledata1['actiondata'], $customdata->rulejson);
}
}

// Validate console output.
$expected = "send_mail_by_rule_adhoc task: mail successfully sent for option " . $option->id . " to user " . $teacher1->id;
$this->assertStringContainsString($expected, $res);

// Validate emails. Might be more than one dependitg to Moodle's version.
foreach ($messages as $key => $message) {
if (strpos($message->subject, "Enrollinksubj")) {
// Validate email on enrol link.
$this->assertStringContainsString("mod/booking/enrollink.php?erlid=", $message->fullmessage);
$this->assertStringContainsString("Number of user: 3", $message->fullmessage);
}
}

// Validate incorrect erlid.
$enrollink = enrollink::get_instance('dummy');
$info1 = $enrollink->enrolment_blocking();
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_LINK_NOT_VALID, $enrollink->errorinfo);
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_LINK_NOT_VALID, $info1);

// Get erlid string.
$erlid = str_replace('Number of user: 3', '', $message->fullmessage);
$erlid = (explode('=', $erlid))[1];
$enrollink = enrollink::get_instance($erlid);
$this->assertEquals(2, $enrollink->free_places_left());
// TODO: returns 0 ?
// Validate redirect for not logged users.
require_logout();
$info1 = $enrollink->enrolment_blocking();
$this->assertEmpty($info1);
$info2 = $enrollink->enrol_user($USER->id);
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_EXCEPTION, $info2);

// Validate that student1 already booked and no consumtion.
$this->setUser($student1);
$info1 = $enrollink->enrolment_blocking();
$this->assertEmpty($info1);
$info2 = $enrollink->enrol_user($student1->id);
$courselink = $enrollink->get_courselink_url();
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_ALREADY_ENROLLED, $info2);
$this->assertStringContainsString('/moodle/course/view.php?id=' . $course2->id, $courselink);
$this->assertEquals(3, $enrollink->free_places_left());

// Proceed with enrolling of student2.
$this->setUser($student2);
$info1 = $enrollink->enrolment_blocking();
$this->assertEmpty($info1);
$info2 = $enrollink->enrol_user($student2->id);
$infostring = $enrollink->get_readable_info($info2);
$courselink = $enrollink->get_courselink_url();
// Validate enrollment status and remainaing free places.
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_SUCCESS, $info2);
$this->assertEquals('Successfully enrolled', $infostring);
$this->assertStringContainsString('/moodle/course/view.php?id=' . $course2->id, $courselink);
$this->assertEquals(2, $enrollink->free_places_left());

// Proceed with enrolling of student3.
$this->setUser($student3);
$info1 = $enrollink->enrolment_blocking();
$this->assertEmpty($info1);
$info2 = $enrollink->enrol_user($student3->id);
$courselink = $enrollink->get_courselink_url();
// Validate enrollment status and remainaing free places.
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_SUCCESS, $info2);
$this->assertStringContainsString('/moodle/course/view.php?id=' . $course2->id, $courselink);
$this->assertEquals(1, $enrollink->free_places_left());

// An attempt to enroll guest.
$this->setGuestUser();
$info1 = $enrollink->enrolment_blocking();
$this->assertEmpty($info1);
$info2 = $enrollink->enrol_user($USER->id);
$courselink = $enrollink->get_courselink_url();
// Validate enrollment status and remainaing free places.
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_LOGGED_IN_AS_GUEST, $info2);
$this->assertStringContainsString('/moodle/course/view.php?id=' . $course2->id, $courselink);
$this->assertEquals(1, $enrollink->free_places_left());

// Proceed with enrolling of student4.
$this->setUser($student4);
$info1 = $enrollink->enrolment_blocking();
$this->assertEmpty($info1);
$info2 = $enrollink->enrol_user($USER->id);
$courselink = $enrollink->get_courselink_url();
// Validate enrollment status and remainaing free places.
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_SUCCESS, $info2);
$this->assertStringContainsString('/moodle/course/view.php?id=' . $course2->id, $courselink);
$this->assertEquals(0, $enrollink->free_places_left());

// Proceed with enrolling of student5 - no more seats.
$this->setUser($student5);
$info1 = $enrollink->enrolment_blocking();
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_NO_MORE_SEATS, $info1);
$info2 = $enrollink->enrol_user($student4->id);
// Validate "nomoreseats" enrollment status and remainaing free places.
$this->assertEquals(MOD_BOOKING_AUTOENROL_STATUS_NO_MORE_SEATS, $info2);
$this->assertEquals(0, $enrollink->free_places_left());

// Mandatory to deal with static variable in the booking_rules.
rules_info::$rulestoexecute = [];
booking_rules::$rules = [];
}

/**
* Data provider for condition_bookingpolicy_test
*
Expand Down

0 comments on commit 5173439

Please sign in to comment.