mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
1bce3a70d9
AMOS BEGIN MOV ['gspath','assignfeedback_editpdf'],['pathtogs','admin'] MOV ['gspath_help','assignfeedback_editpdf'],['pathtogs_help','admin'] AMOS END
302 lines
10 KiB
PHP
302 lines
10 KiB
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/>.
|
|
|
|
/**
|
|
* Behat basic functions
|
|
*
|
|
* It does not include MOODLE_INTERNAL because is part of the bootstrap
|
|
*
|
|
* @package core
|
|
* @category test
|
|
* @copyright 2012 David Monllaó
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
require_once(__DIR__ . '/../testing/lib.php');
|
|
|
|
define('BEHAT_EXITCODE_CONFIG', 250);
|
|
define('BEHAT_EXITCODE_REQUIREMENT', 251);
|
|
define('BEHAT_EXITCODE_PERMISSIONS', 252);
|
|
define('BEHAT_EXITCODE_REINSTALL', 253);
|
|
define('BEHAT_EXITCODE_INSTALL', 254);
|
|
define('BEHAT_EXITCODE_COMPOSER', 255);
|
|
define('BEHAT_EXITCODE_INSTALLED', 256);
|
|
|
|
/**
|
|
* Exits with an error code
|
|
*
|
|
* @param mixed $errorcode
|
|
* @param string $text
|
|
* @return void Stops execution with error code
|
|
*/
|
|
function behat_error($errorcode, $text = '') {
|
|
|
|
// Adding error prefixes.
|
|
switch ($errorcode) {
|
|
case BEHAT_EXITCODE_CONFIG:
|
|
$text = 'Behat config error: ' . $text;
|
|
break;
|
|
case BEHAT_EXITCODE_REQUIREMENT:
|
|
$text = 'Behat requirement not satisfied: ' . $text;
|
|
break;
|
|
case BEHAT_EXITCODE_PERMISSIONS:
|
|
$text = 'Behat permissions problem: ' . $text . ', check the permissions';
|
|
break;
|
|
case BEHAT_EXITCODE_REINSTALL:
|
|
$path = testing_cli_argument_path('/admin/tool/behat/cli/init.php');
|
|
$text = "Reinstall Behat: ".$text.", use:\n php ".$path;
|
|
break;
|
|
case BEHAT_EXITCODE_INSTALL:
|
|
$path = testing_cli_argument_path('/admin/tool/behat/cli/init.php');
|
|
$text = "Install Behat before enabling it, use:\n php ".$path;
|
|
break;
|
|
case BEHAT_EXITCODE_INSTALLED:
|
|
$text = "The Behat site is already installed";
|
|
break;
|
|
default:
|
|
$text = 'Unknown error ' . $errorcode . ' ' . $text;
|
|
break;
|
|
}
|
|
|
|
testing_error($errorcode, $text);
|
|
}
|
|
|
|
/**
|
|
* PHP errors handler to use when running behat tests.
|
|
*
|
|
* Adds specific CSS classes to identify
|
|
* the messages.
|
|
*
|
|
* @param int $errno
|
|
* @param string $errstr
|
|
* @param string $errfile
|
|
* @param int $errline
|
|
* @param array $errcontext
|
|
* @return bool
|
|
*/
|
|
function behat_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
|
|
|
|
// If is preceded by an @ we don't show it.
|
|
if (!error_reporting()) {
|
|
return true;
|
|
}
|
|
|
|
// This error handler receives E_ALL | E_STRICT, running the behat test site the debug level is
|
|
// set to DEVELOPER and will always include E_NOTICE,E_USER_NOTICE... as part of E_ALL, if the current
|
|
// error_reporting() value does not include one of those levels is because it has been forced through
|
|
// the moodle code (see fix_utf8() for example) in that cases we respect the forced error level value.
|
|
$respect = array(E_NOTICE, E_USER_NOTICE, E_STRICT, E_WARNING, E_USER_WARNING);
|
|
foreach ($respect as $respectable) {
|
|
|
|
// If the current value does not include this kind of errors and the reported error is
|
|
// at that level don't print anything.
|
|
if ($errno == $respectable && !(error_reporting() & $respectable)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// Using the default one in case there is a fatal catchable error.
|
|
default_error_handler($errno, $errstr, $errfile, $errline, $errcontext);
|
|
|
|
switch ($errno) {
|
|
case E_USER_ERROR:
|
|
$errnostr = 'Fatal error';
|
|
break;
|
|
case E_WARNING:
|
|
case E_USER_WARNING:
|
|
$errnostr = 'Warning';
|
|
break;
|
|
case E_NOTICE:
|
|
case E_USER_NOTICE:
|
|
case E_STRICT:
|
|
$errnostr = 'Notice';
|
|
break;
|
|
case E_RECOVERABLE_ERROR:
|
|
$errnostr = 'Catchable';
|
|
break;
|
|
default:
|
|
$errnostr = 'Unknown error type';
|
|
}
|
|
|
|
// Wrapping the output.
|
|
echo '<div class="phpdebugmessage" data-rel="phpdebugmessage">' . PHP_EOL;
|
|
echo "$errnostr: $errstr in $errfile on line $errline" . PHP_EOL;
|
|
echo '</div>';
|
|
|
|
// Also use the internal error handler so we keep the usual behaviour.
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Restrict the config.php settings allowed.
|
|
*
|
|
* When running the behat features the config.php
|
|
* settings should not affect the results.
|
|
*
|
|
* @return void
|
|
*/
|
|
function behat_clean_init_config() {
|
|
global $CFG;
|
|
|
|
$allowed = array_flip(array(
|
|
'wwwroot', 'dataroot', 'dirroot', 'admin', 'directorypermissions', 'filepermissions',
|
|
'umaskpermissions', 'dbtype', 'dblibrary', 'dbhost', 'dbname', 'dbuser', 'dbpass', 'prefix',
|
|
'dboptions', 'proxyhost', 'proxyport', 'proxytype', 'proxyuser', 'proxypassword',
|
|
'proxybypass', 'theme', 'pathtogs', 'pathtoclam', 'pathtodu', 'aspellpath', 'pathtodot'
|
|
));
|
|
|
|
// Add extra allowed settings.
|
|
if (!empty($CFG->behat_extraallowedsettings)) {
|
|
$allowed = array_merge($allowed, array_flip($CFG->behat_extraallowedsettings));
|
|
}
|
|
|
|
// Also allowing behat_ prefixed attributes.
|
|
foreach ($CFG as $key => $value) {
|
|
if (!isset($allowed[$key]) && strpos($key, 'behat_') !== 0) {
|
|
unset($CFG->{$key});
|
|
}
|
|
}
|
|
|
|
// Here we are forcing the navbar to be absolutely positioned in Chrome, Safari and IE in order to
|
|
// avoid a driver bug whereby when the browser scrolls something into view it doesn't account
|
|
// for fixed positioned elements that end up obscuring the item thus leading to errors that
|
|
// could be avoided by scrolling an additional amount.
|
|
// This should be removed as soon as the affected drivers have been fixed.
|
|
$CFG->forced_plugin_settings['theme_clean'] = array(
|
|
'customcss' => 'body.safari .navbar-fixed-top, body.ie .navbar-fixed-top {position: absolute;}'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Checks that the behat config vars are properly set.
|
|
*
|
|
* @return void Stops execution with error code if something goes wrong.
|
|
*/
|
|
function behat_check_config_vars() {
|
|
global $CFG;
|
|
|
|
// Verify prefix value.
|
|
if (empty($CFG->behat_prefix)) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'Define $CFG->behat_prefix in config.php');
|
|
}
|
|
if (!empty($CFG->prefix) and $CFG->behat_prefix == $CFG->prefix) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'$CFG->behat_prefix in config.php must be different from $CFG->prefix');
|
|
}
|
|
if (!empty($CFG->phpunit_prefix) and $CFG->behat_prefix == $CFG->phpunit_prefix) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'$CFG->behat_prefix in config.php must be different from $CFG->phpunit_prefix');
|
|
}
|
|
|
|
// Verify behat wwwroot value.
|
|
if (empty($CFG->behat_wwwroot)) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'Define $CFG->behat_wwwroot in config.php');
|
|
}
|
|
if (!empty($CFG->wwwroot) and $CFG->behat_wwwroot == $CFG->wwwroot) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'$CFG->behat_wwwroot in config.php must be different from $CFG->wwwroot');
|
|
}
|
|
|
|
// Verify behat dataroot value.
|
|
if (empty($CFG->behat_dataroot)) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'Define $CFG->behat_dataroot in config.php');
|
|
}
|
|
if (!file_exists($CFG->behat_dataroot)) {
|
|
$permissions = isset($CFG->directorypermissions) ? $CFG->directorypermissions : 02777;
|
|
umask(0);
|
|
if (!mkdir($CFG->behat_dataroot, $permissions, true)) {
|
|
behat_error(BEHAT_EXITCODE_PERMISSIONS, '$CFG->behat_dataroot directory can not be created');
|
|
}
|
|
}
|
|
$CFG->behat_dataroot = realpath($CFG->behat_dataroot);
|
|
if (empty($CFG->behat_dataroot) or !is_dir($CFG->behat_dataroot) or !is_writable($CFG->behat_dataroot)) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'$CFG->behat_dataroot in config.php must point to an existing writable directory');
|
|
}
|
|
if (!empty($CFG->dataroot) and $CFG->behat_dataroot == realpath($CFG->dataroot)) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'$CFG->behat_dataroot in config.php must be different from $CFG->dataroot');
|
|
}
|
|
if (!empty($CFG->phpunit_dataroot) and $CFG->behat_dataroot == realpath($CFG->phpunit_dataroot)) {
|
|
behat_error(BEHAT_EXITCODE_CONFIG,
|
|
'$CFG->behat_dataroot in config.php must be different from $CFG->phpunit_dataroot');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Should we switch to the test site data?
|
|
* @return bool
|
|
*/
|
|
function behat_is_test_site() {
|
|
global $CFG;
|
|
|
|
if (defined('BEHAT_UTIL')) {
|
|
// This is the admin tool that installs/drops the test site install.
|
|
return true;
|
|
}
|
|
if (defined('BEHAT_TEST')) {
|
|
// This is the main vendor/bin/behat script.
|
|
return true;
|
|
}
|
|
if (empty($CFG->behat_wwwroot)) {
|
|
return false;
|
|
}
|
|
if (isset($_SERVER['REMOTE_ADDR']) and behat_is_requested_url($CFG->behat_wwwroot)) {
|
|
// Something is accessing the web server like a real browser.
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks if the URL requested by the user matches the provided argument
|
|
*
|
|
* @param string $url
|
|
* @return bool Returns true if it matches.
|
|
*/
|
|
function behat_is_requested_url($url) {
|
|
|
|
$parsedurl = parse_url($url . '/');
|
|
$parsedurl['port'] = isset($parsedurl['port']) ? $parsedurl['port'] : 80;
|
|
$parsedurl['path'] = rtrim($parsedurl['path'], '/');
|
|
|
|
// Removing the port.
|
|
$pos = strpos($_SERVER['HTTP_HOST'], ':');
|
|
if ($pos !== false) {
|
|
$requestedhost = substr($_SERVER['HTTP_HOST'], 0, $pos);
|
|
} else {
|
|
$requestedhost = $_SERVER['HTTP_HOST'];
|
|
}
|
|
|
|
// The path should also match.
|
|
if (empty($parsedurl['path'])) {
|
|
$matchespath = true;
|
|
} else if (strpos($_SERVER['SCRIPT_NAME'], $parsedurl['path']) === 0) {
|
|
$matchespath = true;
|
|
}
|
|
|
|
// The host and the port should match
|
|
if ($parsedurl['host'] == $requestedhost && $parsedurl['port'] == $_SERVER['SERVER_PORT'] && !empty($matchespath)) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|