Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?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/>.

< /** < * Auth oauth2 api functions tests. < * < * @package auth_oauth2 < * @copyright 2017 Damyon Wiese < * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later < */ < < defined('MOODLE_INTERNAL') || die(); < < global $CFG;
> namespace auth_oauth2;
/** * External auth oauth2 API tests. * * @package auth_oauth2 * @copyright 2017 Damyon Wiese * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */
< class auth_oauth2_external_testcase extends advanced_testcase {
> class api_test extends \advanced_testcase {
/** * Test the cleaning of orphaned linked logins for all issuers. */ public function test_clean_orphaned_linked_logins() { $this->resetAfterTest(); $this->setAdminUser(); $issuer = \core\oauth2\api::create_standard_issuer('google'); \core\oauth2\api::create_standard_issuer('microsoft'); $user = $this->getDataGenerator()->create_user(); $info = []; $info['username'] = 'banana'; $info['email'] = 'banana@example.com'; \auth_oauth2\api::link_login($info, $issuer, $user->id, false); \core\oauth2\api::delete_issuer($issuer->get('id')); $linkedlogins = \auth_oauth2\api::get_linked_logins($user->id, $issuer); $this->assertCount(1, $linkedlogins); \auth_oauth2\api::clean_orphaned_linked_logins(); $linkedlogins = \auth_oauth2\api::get_linked_logins($user->id, $issuer); $this->assertCount(0, $linkedlogins); $match = \auth_oauth2\api::match_username_to_user('banana', $issuer); $this->assertFalse($match); } /** * Test the cleaning of orphaned linked logins for a specific issuer. */ public function test_clean_orphaned_linked_logins_with_issuer_id() { $this->resetAfterTest(); $this->setAdminUser(); $issuer1 = \core\oauth2\api::create_standard_issuer('google'); $issuer2 = \core\oauth2\api::create_standard_issuer('microsoft'); $user1 = $this->getDataGenerator()->create_user(); $info = []; $info['username'] = 'banana'; $info['email'] = 'banana@example.com'; \auth_oauth2\api::link_login($info, $issuer1, $user1->id, false); $user2 = $this->getDataGenerator()->create_user(); $info = []; $info['username'] = 'apple'; $info['email'] = 'apple@example.com'; \auth_oauth2\api::link_login($info, $issuer2, $user2->id, false); \core\oauth2\api::delete_issuer($issuer1->get('id')); \auth_oauth2\api::clean_orphaned_linked_logins($issuer1->get('id')); $linkedlogins = \auth_oauth2\api::get_linked_logins($user1->id, $issuer1); $this->assertCount(0, $linkedlogins); $linkedlogins = \auth_oauth2\api::get_linked_logins($user2->id, $issuer2); $this->assertCount(1, $linkedlogins); } /**
> * Test creating a new confirmed account. * Test auto-confirming linked logins. > * Including testing that user profile fields are correctly set. */ > * public function test_linked_logins() { > * @covers \auth_oauth2\api::create_new_confirmed_account $this->resetAfterTest(); > */ > public function test_create_new_confirmed_account() { $this->setAdminUser(); > global $DB; $issuer = \core\oauth2\api::create_standard_issuer('google'); > $this->resetAfterTest(); > $this->setAdminUser(); $user = $this->getDataGenerator()->create_user(); > > $issuer = \core\oauth2\api::create_standard_issuer('microsoft'); $info = []; > $info['username'] = 'banana'; > $info = []; $info['email'] = 'banana@example.com'; > $info['username'] = 'apple'; > $info['email'] = 'apple@example.com'; \auth_oauth2\api::link_login($info, $issuer, $user->id, false); > $info['firstname'] = 'Apple'; > $info['lastname'] = 'Fruit'; // Try and match a user with a linked login. > $info['alternatename'] = 'Beatles'; $match = \auth_oauth2\api::match_username_to_user('banana', $issuer); > $info['idnumber'] = '123456'; > $info['city'] = 'Melbourne'; $this->assertEquals($user->id, $match->get('userid')); > $info['country'] = 'AU'; $linkedlogins = \auth_oauth2\api::get_linked_logins($user->id, $issuer); > $info['institution'] = 'ACME Inc'; \auth_oauth2\api::delete_linked_login($linkedlogins[0]->get('id')); > $info['department'] = 'Misc Explosives'; > $match = \auth_oauth2\api::match_username_to_user('banana', $issuer); > $createduser = \auth_oauth2\api::create_new_confirmed_account($info, $issuer); $this->assertFalse($match); > > // Get actual user record from DB to check. $info = []; > $userdata = $DB->get_record('user', ['id' => $createduser->id]); $info['username'] = 'apple'; > $info['email'] = 'apple@example.com'; > // Confirm each value supplied from issuers is saved into the user record. $info['firstname'] = 'Apple'; > foreach ($info as $key => $value) { $info['lastname'] = 'Fruit'; > $this->assertEquals($value, $userdata->$key); $info['url'] = 'http://apple.com/'; > } $info['alternamename'] = 'Beatles'; > > // Explicitly test the user is confirmed. $newuser = \auth_oauth2\api::create_new_confirmed_account($info, $issuer); > $this->assertEquals(1, $userdata->confirmed); > } $match = \auth_oauth2\api::match_username_to_user('apple', $issuer); > > /**
$this->assertEquals($newuser->id, $match->get('userid')); } /** * Test that is_enabled correctly identifies when the plugin is enabled. */ public function test_is_enabled() { $this->resetAfterTest(); set_config('auth', 'manual,oauth2'); $this->assertTrue(\auth_oauth2\api::is_enabled()); } /** * Test that is_enabled correctly identifies when the plugin is disabled. */ public function test_is_enabled_disabled() { $this->resetAfterTest(); set_config('auth', 'manual'); $this->assertFalse(\auth_oauth2\api::is_enabled());
> } } > } > /** > * Test creating a user via the send confirm account email method. > * Including testing that user profile fields are correctly set. > * > * @covers \auth_oauth2\api::send_confirm_account_email > */ > public function test_send_confirm_account_email() { > global $DB; > $this->resetAfterTest(); > $this->setAdminUser(); > > $issuer = \core\oauth2\api::create_standard_issuer('microsoft'); > > $info = []; > $info['username'] = 'apple'; > $info['email'] = 'apple@example.com'; > $info['firstname'] = 'Apple'; > $info['lastname'] = 'Fruit'; > $info['alternatename'] = 'Beatles'; > $info['idnumber'] = '123456'; > $info['city'] = 'Melbourne'; > $info['country'] = 'AU'; > $info['institution'] = 'ACME Inc'; > $info['department'] = 'Misc Explosives'; > > $createduser = \auth_oauth2\api::send_confirm_account_email($info, $issuer); > > // Get actual user record from DB to check. > $userdata = $DB->get_record('user', ['id' => $createduser->id]); > > // Confirm each value supplied from issuers is saved into the user record. > foreach ($info as $key => $value) { > $this->assertEquals($value, $userdata->$key); > } > > // Explicitly test the user is not yet confirmed. > $this->assertEquals(0, $userdata->confirmed);