2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Testing general functions
20 * Note: these functions must be self contained and must not rely on any library or include
24 * @copyright 2012 Petr Skoda {@link http://skodak.org}
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 * Returns relative path against current working directory,
30 * to be used for shell execution hints.
31 * @param string $moodlepath starting with "/", ex: "/admin/tool/cli/init.php"
32 * @return string path relative to current directory or absolute path
34 function testing_cli_argument_path($moodlepath) {
37 if (isset($CFG->admin
) and $CFG->admin
!== 'admin') {
38 $moodlepath = preg_replace('|^/admin/|', "/$CFG->admin/", $moodlepath);
41 if (isset($_SERVER['REMOTE_ADDR'])) {
42 // Web access, this should not happen often.
43 $cwd = dirname(dirname(__DIR__
));
45 // This is the real CLI script, work with relative paths.
48 if (substr($cwd, -1) !== DIRECTORY_SEPARATOR
) {
49 $cwd .= DIRECTORY_SEPARATOR
;
51 $path = realpath($CFG->dirroot
.$moodlepath);
53 if (strpos($path, $cwd) === 0) {
54 $path = substr($path, strlen($cwd));
57 if (testing_is_cygwin()) {
58 $path = str_replace('\\', '/', $path);
65 * Try to change permissions to $CFG->dirroot or $CFG->dataroot if possible
67 * @return bool success
69 function testing_fix_file_permissions($file) {
72 $permissions = fileperms($file);
73 if ($permissions & $CFG->filepermissions
!= $CFG->filepermissions
) {
74 $permissions = $permissions |
$CFG->filepermissions
;
75 return chmod($file, $permissions);
82 * Find out if running under Cygwin on Windows.
85 function testing_is_cygwin() {
86 if (empty($_SERVER['OS']) or $_SERVER['OS'] !== 'Windows_NT') {
89 } else if (!empty($_SERVER['SHELL']) and $_SERVER['SHELL'] === '/bin/bash') {
92 } else if (!empty($_SERVER['TERM']) and $_SERVER['TERM'] === 'cygwin') {
101 * Mark empty dataroot to be used for testing.
102 * @param string $dataroot The dataroot directory
103 * @param string $framework The test framework
106 function testing_initdataroot($dataroot, $framework) {
109 $filename = $dataroot . '/' . $framework . 'testdir.txt';
112 if (!file_exists($filename)) {
113 file_put_contents($filename, 'Contents of this directory are used during tests only, do not delete this file!');
115 testing_fix_file_permissions($filename);
117 $varname = $framework . '_dataroot';
118 $datarootdir = $CFG->{$varname} . '/' . $framework;
119 if (!file_exists($datarootdir)) {
120 mkdir($datarootdir, $CFG->directorypermissions
);
125 * Prints an error and stops execution
127 * @param integer $errorcode
128 * @param string $text
131 function testing_error($errorcode, $text = '') {
133 // do not write to error stream because we need the error message in PHP exec result from web ui
139 * Updates the composer installer and the dependencies.
141 * Includes --dev dependencies.
143 * @return void exit() if something goes wrong
145 function testing_update_composer_dependencies() {
147 // To restore the value after finishing.
151 chdir(__DIR__
. '/../..');
153 // Download composer.phar if we can.
154 if (!file_exists(__DIR__
. '/../../composer.phar')) {
155 passthru("curl http://getcomposer.org/installer | php", $code);
161 // If it is already there update the installer.
162 passthru("php composer.phar self-update", $code);
168 // Update composer dependencies.
169 passthru("php composer.phar update --dev", $code);