Current File : /home/vacivi36/ava/enrol/lti/tests/local/ltiadvantage/service/tool_deployment_service_test.php
<?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/>.
namespace enrol_lti\local\ltiadvantage\service;
use enrol_lti\helper;
use enrol_lti\local\ltiadvantage\entity\application_registration;
use enrol_lti\local\ltiadvantage\entity\deployment;
use enrol_lti\local\ltiadvantage\repository\application_registration_repository;
use enrol_lti\local\ltiadvantage\repository\context_repository;
use enrol_lti\local\ltiadvantage\repository\user_repository;
use enrol_lti\local\ltiadvantage\repository\deployment_repository;
use enrol_lti\local\ltiadvantage\repository\resource_link_repository;
defined('MOODLE_INTERNAL') || die();
require_once(__DIR__ . '/../lti_advantage_testcase.php');
/**
* Tests for the tool_deployment_service.
*
* @package enrol_lti
* @copyright 2021 Jake Dallimore <jrhdallimore@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @coversDefaultClass \enrol_lti\local\ltiadvantage\service\tool_deployment_service
*/
class tool_deployment_service_test extends \lti_advantage_testcase {
/**
* Return a pre-existing application_registration object for testing.
*
* @return application_registration
*/
protected function generate_application_registration(): application_registration {
$reg = application_registration::create(
'Example LMS application',
'a2c94a2c94',
new \moodle_url('https://lms.example.org'),
'123',
new \moodle_url('https://example.org/authrequesturl'),
new \moodle_url('https://example.org/jwksurl'),
new \moodle_url('https://example.org/accesstokenurl')
);
$regrepo = new application_registration_repository();
return $regrepo->save($reg);
}
/**
* Helper to get a tool_deployment_service instance.
*
* @return tool_deployment_service the instance.
*/
protected function get_tool_deployment_service(): tool_deployment_service {
return new tool_deployment_service(
new application_registration_repository(),
new deployment_repository(),
new resource_link_repository(),
new context_repository(),
new user_repository()
);
}
/**
* Test the use case "As an admin, I can register an application as an LTI consumer (platform)".
*
* @covers ::add_tool_deployment
*/
public function test_add_tool_deployment() {
$this->resetAfterTest();
$testreg = $this->generate_application_registration();
$deploymentrepo = new deployment_repository();
$service = $this->get_tool_deployment_service();
$createddeployment = $service->add_tool_deployment(
(object) [
'registration_id' => $testreg->get_id(),
'deployment_id' => 'Deploy_ID_123',
'deployment_name' => "Tool deployment in location x"
]
);
$this->assertInstanceOf(deployment::class, $createddeployment);
$this->assertTrue($deploymentrepo->exists($createddeployment->get_id()));
}
/**
* Test trying to add a tool deployment when a registration identified by the specified id cannot be found.
*
* @covers ::add_tool_deployment
*/
public function test_add_tool_deployment_registration_missing() {
$this->resetAfterTest();
$service = $this->get_tool_deployment_service();
$this->expectException(\coding_exception::class);
$this->expectExceptionMessageMatches('/Cannot add deployment to non-existent application registration/');
$service->add_tool_deployment(
(object) [
'registration_id' => 1234,
'deployment_id' => 'Deploy_ID_123',
'deployment_name' => "Tool deployment in location x"
]
);
}
/**
* Test that removal of a deployment removes all associated data.
*
* @covers ::delete_tool_deployment
*/
public function test_delete_deployment() {
$this->resetAfterTest();
// Setup.
$registrationrepo = new application_registration_repository();
$deploymentrepo = new deployment_repository();
$contextrepo = new context_repository();
$resourcelinkrepo = new resource_link_repository();
$userrepo = new user_repository();
[$course, $resource] = $this->create_test_environment();
// Launch the tool for a user.
$mocklaunch = $this->get_mock_launch($resource, $this->get_mock_launch_users_with_ids(['1'])[0]);
$instructoruser = $this->getDataGenerator()->create_user();
$launchservice = $this->get_tool_launch_service();
$launchservice->user_launches_tool($instructoruser, $mocklaunch);
// Check all the expected data exists for the deployment after setup.
$registrations = $registrationrepo->find_all();
$this->assertCount(1, $registrations);
$registration = array_pop($registrations);
$deployments = $deploymentrepo->find_all_by_registration($registration->get_id());
$this->assertCount(1, $deployments);
$deployment = array_pop($deployments);
$resourcelinks = $resourcelinkrepo->find_by_resource($resource->id);
$this->assertCount(1, $resourcelinks);
$resourcelink = array_pop($resourcelinks);
$context = $contextrepo->find($resourcelink->get_contextid());
$this->assertNotNull($context);
$users = $userrepo->find_by_resource($resource->id);
$this->assertCount(1, $users);
$user = array_pop($users);
$enrolledusers = get_enrolled_users(\context_course::instance($course->id));
$this->assertCount(1, $enrolledusers);
// Now delete the deployment using the service.
$service = $this->get_tool_deployment_service();
$service->delete_tool_deployment($deployment->get_id());
// Verify that the context, resourcelink, user and deployment instances are all deleted but the registration
// instance remains.
$this->assertTrue($registrationrepo->exists($registration->get_id()));
$this->assertFalse($deploymentrepo->exists($deployment->get_id()));
$this->assertFalse($contextrepo->exists($context->get_id()));
$this->assertFalse($resourcelinkrepo->exists($resourcelink->get_id()));
$this->assertFalse($userrepo->exists($user->get_id()));
// Verify that all users are unenrolled.
$enrolledusers = get_enrolled_users(\context_course::instance($course->id));
$this->assertCount(0, $enrolledusers);
// Verify the tool record stays in place (I.e. the published resource is still available).
$this->assertNotEmpty(helper::get_lti_tool($resource->id));
}
}
Mini Shell