Your IP : 192.168.165.1
<?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/>.
/**
* Unit tests for setuplib.php
*
* @package core
* @category phpunit
* @copyright 2012 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Unit tests for setuplib.php
*
* @copyright 2012 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_setuplib_testcase extends advanced_testcase {
/**
* Test get_docs_url_standard in the normal case when we should link to Moodle docs.
*/
public function test_get_docs_url_standard() {
global $CFG;
if (empty($CFG->docroot)) {
$docroot = 'http://docs.moodle.org/';
} else {
$docroot = $CFG->docroot;
}
$this->assertRegExp('~^' . preg_quote($docroot, '') . '/\d{2}/' . current_language() . '/course/editing$~',
get_docs_url('course/editing'));
}
/**
* Test get_docs_url_standard in the special case of an absolute HTTP URL.
*/
public function test_get_docs_url_http() {
$url = 'http://moodle.org/';
$this->assertEquals($url, get_docs_url($url));
}
/**
* Test get_docs_url_standard in the special case of an absolute HTTPS URL.
*/
public function test_get_docs_url_https() {
$url = 'https://moodle.org/';
$this->assertEquals($url, get_docs_url($url));
}
/**
* Test get_docs_url_standard in the special case of a link relative to wwwroot.
*/
public function test_get_docs_url_wwwroot() {
global $CFG;
$this->assertSame($CFG->wwwroot . '/lib/tests/setuplib_test.php',
get_docs_url('%%WWWROOT%%/lib/tests/setuplib_test.php'));
}
/**
* Test if get_exception_info() removes file system paths.
*/
public function test_exception_info_removes_serverpaths() {
global $CFG;
// This doesn't test them all possible ones, but these are set for unit tests.
$cfgnames = array('dataroot', 'dirroot', 'tempdir', 'backuptempdir', 'cachedir', 'localcachedir');
$fixture = '';
$expected = '';
foreach ($cfgnames as $cfgname) {
if (!empty($CFG->$cfgname)) {
$fixture .= $CFG->$cfgname.' ';
$expected .= "[$cfgname] ";
}
}
$exception = new moodle_exception('generalexceptionmessage', 'error', '', $fixture, $fixture);
$exceptioninfo = get_exception_info($exception);
$this->assertContains($expected, $exceptioninfo->message, 'Exception message does not contain system paths');
$this->assertContains($expected, $exceptioninfo->debuginfo, 'Exception debug info does not contain system paths');
}
public function test_localcachedir() {
global $CFG;
$this->resetAfterTest(true);
// Test default location - can not be modified in phpunit tests because we override everything in config.php.
$this->assertSame("$CFG->dataroot/localcache", $CFG->localcachedir);
$this->setCurrentTimeStart();
$timestampfile = "$CFG->localcachedir/.lastpurged";
// Delete existing localcache directory, as this is testing first call
// to make_localcache_directory.
remove_dir($CFG->localcachedir, true);
$dir = make_localcache_directory('', false);
$this->assertSame($CFG->localcachedir, $dir);
$this->assertFileNotExists("$CFG->localcachedir/.htaccess");
$this->assertFileExists($timestampfile);
$this->assertTimeCurrent(filemtime($timestampfile));
$dir = make_localcache_directory('test/test', false);
$this->assertSame("$CFG->localcachedir/test/test", $dir);
// Test custom location.
$CFG->localcachedir = "$CFG->dataroot/testlocalcache";
$this->setCurrentTimeStart();
$timestampfile = "$CFG->localcachedir/.lastpurged";
$this->assertFileNotExists($timestampfile);
$dir = make_localcache_directory('', false);
$this->assertSame($CFG->localcachedir, $dir);
$this->assertFileExists("$CFG->localcachedir/.htaccess");
$this->assertFileExists($timestampfile);
$this->assertTimeCurrent(filemtime($timestampfile));
$dir = make_localcache_directory('test', false);
$this->assertSame("$CFG->localcachedir/test", $dir);
$prevtime = filemtime($timestampfile);
$dir = make_localcache_directory('pokus', false);
$this->assertSame("$CFG->localcachedir/pokus", $dir);
$this->assertSame($prevtime, filemtime($timestampfile));
// Test purging.
$testfile = "$CFG->localcachedir/test/test.txt";
$this->assertTrue(touch($testfile));
$now = $this->setCurrentTimeStart();
set_config('localcachedirpurged', $now - 2);
purge_all_caches();
$this->assertFileNotExists($testfile);
$this->assertFileNotExists(dirname($testfile));
$this->assertFileExists($timestampfile);
$this->assertTimeCurrent(filemtime($timestampfile));
$this->assertTimeCurrent($CFG->localcachedirpurged);
// Simulates purge_all_caches() on another server node.
make_localcache_directory('test', false);
$this->assertTrue(touch($testfile));
set_config('localcachedirpurged', $now - 1);
$this->assertTrue(touch($timestampfile, $now - 2));
clearstatcache();
$this->assertSame($now - 2, filemtime($timestampfile));
$this->setCurrentTimeStart();
$dir = make_localcache_directory('', false);
$this->assertSame("$CFG->localcachedir", $dir);
$this->assertFileNotExists($testfile);
$this->assertFileNotExists(dirname($testfile));
$this->assertFileExists($timestampfile);
$this->assertTimeCurrent(filemtime($timestampfile));
}
public function test_make_unique_directory_basedir_is_file() {
global $CFG;
// Start with a file instead of a directory.
$base = $CFG->tempdir . DIRECTORY_SEPARATOR . md5(microtime(true) + rand());
touch($base);
// First the false test.
$this->assertFalse(make_unique_writable_directory($base, false));
// Now check for exception.
$this->expectException('invalid_dataroot_permissions');
$this->expectExceptionMessage($base . ' is not writable. Unable to create a unique directory within it.');
make_unique_writable_directory($base);
unlink($base);
}
public function test_make_unique_directory() {
global $CFG;
// Create directories should be both directories, and writable.
$firstdir = make_unique_writable_directory($CFG->tempdir);
$this->assertTrue(is_dir($firstdir));
$this->assertTrue(is_writable($firstdir));
$seconddir = make_unique_writable_directory($CFG->tempdir);
$this->assertTrue(is_dir($seconddir));
$this->assertTrue(is_writable($seconddir));
// Directories should be different each iteration.
$this->assertNotEquals($firstdir, $seconddir);
}
public function test_get_request_storage_directory() {
// Making a call to get_request_storage_directory should always give the same result.
$firstdir = get_request_storage_directory();
$seconddir = get_request_storage_directory();
$this->assertTrue(is_dir($firstdir));
$this->assertEquals($firstdir, $seconddir);
// Removing the directory and calling get_request_storage_directory() again should cause a new directory to be created.
remove_dir($firstdir);
$this->assertFalse(file_exists($firstdir));
$this->assertFalse(is_dir($firstdir));
$thirddir = get_request_storage_directory();
$this->assertTrue(is_dir($thirddir));
$this->assertNotEquals($firstdir, $thirddir);
// Removing it and replacing it with a file should cause it to be regenerated again.
remove_dir($thirddir);
$this->assertFalse(file_exists($thirddir));
$this->assertFalse(is_dir($thirddir));
touch($thirddir);
$this->assertTrue(file_exists($thirddir));
$this->assertFalse(is_dir($thirddir));
$fourthdir = get_request_storage_directory();
$this->assertTrue(is_dir($fourthdir));
$this->assertNotEquals($thirddir, $fourthdir);
}
public function test_make_request_directory() {
// Every request directory should be unique.
$firstdir = make_request_directory();
$seconddir = make_request_directory();
$thirddir = make_request_directory();
$fourthdir = make_request_directory();
$this->assertNotEquals($firstdir, $seconddir);
$this->assertNotEquals($firstdir, $thirddir);
$this->assertNotEquals($firstdir, $fourthdir);
$this->assertNotEquals($seconddir, $thirddir);
$this->assertNotEquals($seconddir, $fourthdir);
$this->assertNotEquals($thirddir, $fourthdir);
// They should also all be within the request storage directory.
$requestdir = get_request_storage_directory();
$this->assertEquals(0, strpos($firstdir, $requestdir));
$this->assertEquals(0, strpos($seconddir, $requestdir));
$this->assertEquals(0, strpos($thirddir, $requestdir));
$this->assertEquals(0, strpos($fourthdir, $requestdir));
// Removing the requestdir should mean that new request directories are still created successfully.
remove_dir($requestdir);
$this->assertFalse(file_exists($requestdir));
$this->assertFalse(is_dir($requestdir));
$fifthdir = make_request_directory();
$this->assertNotEquals($firstdir, $fifthdir);
$this->assertNotEquals($seconddir, $fifthdir);
$this->assertNotEquals($thirddir, $fifthdir);
$this->assertNotEquals($fourthdir, $fifthdir);
$this->assertTrue(is_dir($fifthdir));
$this->assertFalse(strpos($fifthdir, $requestdir));
// And it should be within the new request directory.
$newrequestdir = get_request_storage_directory();
$this->assertEquals(0, strpos($fifthdir, $newrequestdir));
}
public function test_merge_query_params() {
$original = array(
'id' => '1',
'course' => '2',
'action' => 'delete',
'grade' => array(
0 => 'a',
1 => 'b',
2 => 'c',
),
'items' => array(
'a' => 'aa',
'b' => 'bb',
),
'mix' => array(
0 => '2',
),
'numerical' => array(
'2' => array('a' => 'b'),
'1' => '2',
),
);
$chunk = array(
'numerical' => array(
'0' => 'z',
'2' => array('d' => 'e'),
),
'action' => 'create',
'next' => '2',
'grade' => array(
0 => 'e',
1 => 'f',
2 => 'g',
),
'mix' => 'mix',
);
$expected = array(
'id' => '1',
'course' => '2',
'action' => 'create',
'grade' => array(
0 => 'a',
1 => 'b',
2 => 'c',
3 => 'e',
4 => 'f',
5 => 'g',
),
'items' => array(
'a' => 'aa',
'b' => 'bb',
),
'mix' => 'mix',
'numerical' => array(
'2' => array('a' => 'b', 'd' => 'e'),
'1' => '2',
'0' => 'z',
),
'next' => '2',
);
$array = $original;
merge_query_params($array, $chunk);
$this->assertSame($expected, $array);
$this->assertNotSame($original, $array);
$query = "id=1&course=2&action=create&grade%5B%5D=a&grade%5B%5D=b&grade%5B%5D=c&grade%5B%5D=e&grade%5B%5D=f&grade%5B%5D=g&items%5Ba%5D=aa&items%5Bb%5D=bb&mix=mix&numerical%5B2%5D%5Ba%5D=b&numerical%5B2%5D%5Bd%5D=e&numerical%5B1%5D=2&numerical%5B0%5D=z&next=2";
$decoded = array();
parse_str($query, $decoded);
$this->assertSame($expected, $decoded);
// Prove that we cannot use array_merge_recursive() instead.
$this->assertNotSame($expected, array_merge_recursive($original, $chunk));
}
/**
* Test the link processed by get_exception_info().
*/
public function test_get_exception_info_link() {
global $CFG, $SESSION;
$httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
// Simple local URL.
$url = $CFG->wwwroot . '/something/here?really=yes';
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($url, $infos->link);
// Relative local URL.
$url = '/something/here?really=yes';
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
// HTTPS URL when login HTTPS is not enabled (default) and site is HTTP.
$CFG->wwwroot = str_replace('https:', 'http:', $CFG->wwwroot);
$url = $httpswwwroot . '/something/here?really=yes';
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
// HTTPS URL when login HTTPS is not enabled and site is HTTPS.
$CFG->wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
$url = $httpswwwroot . '/something/here?really=yes';
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($url, $infos->link);
// External HTTP URL.
$url = 'http://moodle.org/something/here?really=yes';
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
// External HTTPS URL.
$url = 'https://moodle.org/something/here?really=yes';
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
// External URL containing local URL.
$url = 'http://moodle.org/something/here?' . $CFG->wwwroot;
$exception = new moodle_exception('none', 'error', $url);
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
// Internal link from fromurl.
$SESSION->fromurl = $url = $CFG->wwwroot . '/something/here?really=yes';
$exception = new moodle_exception('none');
$infos = $this->get_exception_info($exception);
$this->assertSame($url, $infos->link);
// Internal HTTPS link from fromurl.
$SESSION->fromurl = $url = $httpswwwroot . '/something/here?really=yes';
$exception = new moodle_exception('none');
$infos = $this->get_exception_info($exception);
$this->assertSame($url, $infos->link);
// External link from fromurl.
$SESSION->fromurl = 'http://moodle.org/something/here?really=yes';
$exception = new moodle_exception('none');
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
// External HTTPS link from fromurl.
$SESSION->fromurl = 'https://moodle.org/something/here?really=yes';
$exception = new moodle_exception('none');
$infos = $this->get_exception_info($exception);
$this->assertSame($CFG->wwwroot . '/', $infos->link);
$SESSION->fromurl = '';
}
/**
* Wrapper to call {@link get_exception_info()}.
*
* @param Exception $ex An exception.
* @return stdClass of information.
*/
public function get_exception_info($ex) {
try {
throw $ex;
} catch (moodle_exception $e) {
return get_exception_info($e);
}
}
/**
* Data provider for test_get_real_size().
*
* @return array An array of arrays contain test data
*/
public function data_for_test_get_real_size() {
return array(
array('8KB', 8192),
array('8Kb', 8192),
array('8K', 8192),
array('8k', 8192),
array('50MB', 52428800),
array('50Mb', 52428800),
array('50M', 52428800),
array('50m', 52428800),
array('8Gb', 8589934592),
array('8GB', 8589934592),
array('8G', 8589934592),
);
}
/**
* Test the get_real_size() function.
*
* @dataProvider data_for_test_get_real_size
*
* @param string $input the input for get_real_size()
* @param int $expectedbytes the expected bytes
*/
public function test_get_real_size($input, $expectedbytes) {
$this->assertEquals($expectedbytes, get_real_size($input));
}
/**
* Validate the given V4 UUID.
*
* @param string $value The candidate V4 UUID
* @return bool True if valid; otherwise, false.
*/
protected static function is_valid_uuid_v4($value) {
// Version 4 UUIDs have the form xxxxxxxx-xxxx-4xxx-Yxxx-xxxxxxxxxxxx
// where x is any hexadecimal digit and Y is one of 8, 9, aA, or bB.
// First, the size is 36 (32 + 4 dashes).
if (strlen($value) != 36) {
return false;
}
// Finally, check the format.
$uuidv4pattern = '/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i';
return (preg_match($uuidv4pattern, $value) === 1);
}
/**
* Test the \core\uuid::generate_uuid_via_pecl_uuid_extension() function.
*/
public function test_core_uuid_generate_uuid_via_pecl_uuid_extension() {
if (!extension_loaded('uuid')) {
$this->markTestSkipped("PHP 'uuid' extension not loaded.");
}
if (!function_exists('uuid_time')) {
$this->markTestSkipped("PHP PECL 'uuid' extension not loaded.");
}
// The \core\uuid::generate_uuid_via_pecl_uuid_extension static method is protected. Use Reflection to call the method.
$method = new ReflectionMethod('\core\uuid', 'generate_uuid_via_pecl_uuid_extension');
$method->setAccessible(true);
$uuid = $method->invoke(null);
$this->assertTrue(self::is_valid_uuid_v4($uuid), "Invalid v4 uuid: '$uuid'");
}
/**
* Test the \core\uuid::generate_uuid_via_random_bytes() function.
*/
public function test_core_uuid_generate_uuid_via_random_bytes() {
try {
random_bytes(1);
} catch (Exception $e) {
$this->markTestSkipped('No source of entropy for random_bytes. ' . $e->getMessage());
}
// The \core\uuid::generate_uuid_via_random_bytes static method is protected. Use Reflection to call the method.
$method = new ReflectionMethod('\core\uuid', 'generate_uuid_via_random_bytes');
$method->setAccessible(true);
$uuid = $method->invoke(null);
$this->assertTrue(self::is_valid_uuid_v4($uuid), "Invalid v4 uuid: '$uuid'");
}
/**
* Test the \core\uuid::generate() function.
*/
public function test_core_uuid_generate() {
$uuid = \core\uuid::generate();
$this->assertTrue(self::is_valid_uuid_v4($uuid), "Invalid v4 UUID: '$uuid'");
}
}