lib/behat/classes/behat_command.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   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.
   8 //
   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.
  13 //
  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/>.
  16
  17 /**
  18  * Behat command utils
  19  *
  20  * @package    core
  21  * @category   test
  22  * @copyright  2012 David Monllaó
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 require_once(__DIR__ . '/../lib.php');
  29
  30 /**
  31  * Behat command related utils
  32  *
  33  * @package    core
  34  * @category   test
  35  * @copyright  2013 David Monllaó
  36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37  */
  38 class behat_command {
  39
  40     /**
  41      * Docs url
  42      */
  43     const DOCS_URL = 'http://docs.moodle.org/dev/Acceptance_testing';
  44
  45     /**
  46      * @var Allowed types when using text selectors arguments.
  47      */
  48     public static $allowedtextselectors = array(
  49         'css_element' => 'css_element',
  50         'xpath_element' => 'xpath_element'
  51     );
  52
  53     /**
  54      * @var Allowed types when using selector arguments.
  55      */
  56     public static $allowedselectors = array(
  57         'link' => 'link',
  58         'button' => 'button',
  59         'link_or_button' => 'link_or_button',
  60         'select' => 'select',
  61         'checkbox' => 'checkbox',
  62         'radio' => 'radio',
  63         'file' => 'file',
  64         'optgroup' => 'optgroup',
  65         'option' => 'option',
  66         'table' => 'table',
  67         'field' => 'field',
  68         'fieldset' => 'fieldset',
  69         'css_element' => 'css_element',
  70         'xpath_element' => 'xpath_element'
  71     );
  72
  73     /**
  74      * Ensures the behat dir exists in moodledata
  75      * @return string Full path
  76      */
  77     public static function get_behat_dir() {
  78         global $CFG;
  79
  80         $behatdir = $CFG->behat_dataroot . '/behat';
  81
  82         if (!is_dir($behatdir)) {
  83             if (!mkdir($behatdir, $CFG->directorypermissions, true)) {
  84                 behat_error(BEHAT_EXITCODE_PERMISSIONS, 'Directory ' . $behatdir . ' can not be created');
  85             }
  86         }
  87
  88         if (!is_writable($behatdir)) {
  89             behat_error(BEHAT_EXITCODE_PERMISSIONS, 'Directory ' . $behatdir . ' is not writable');
  90         }
  91
  92         return $behatdir;
  93     }
  94
  95     /**
  96      * Returns the executable path
  97      * @return string
  98      */
  99     public final static function get_behat_command() {
 100         return 'vendor' . DIRECTORY_SEPARATOR . 'bin' . DIRECTORY_SEPARATOR . 'behat';
 101     }
 102
 103     /**
 104      * Runs behat command with provided options
 105      *
 106      * Execution continues when the process finishes
 107      *
 108      * @param  string $options  Defaults to '' so tests would be executed
 109      * @return array            CLI command outputs [0] => string, [1] => integer
 110      */
 111     public final static function run($options = '') {
 112         global $CFG;
 113
 114         $currentcwd = getcwd();
 115         chdir($CFG->dirroot);
 116         exec(self::get_behat_command() . ' ' . $options, $output, $code);
 117         chdir($currentcwd);
 118
 119         return array($output, $code);
 120     }
 121
 122     /**
 123      * Checks if behat is set up and working
 124      *
 125      * Uses notice() instead of behat_error() because is
 126      * also called from web interface
 127      *
 128      * It checks behat dependencies have been installed and runs
 129      * the behat help command to ensure it works as expected
 130      *
 131      * @param  bool $checkphp Extra check for the PHP version
 132      * @return int Error code or 0 if all ok
 133      */
 134     public static function behat_setup_problem($checkphp = false) {
 135         global $CFG;
 136
 137         // We don't check the PHP version if $CFG->behat_switchcompletely has been enabled.
 138         // Here we are in CLI.
 139         if (empty($CFG->behat_switchcompletely) && $checkphp && version_compare(PHP_VERSION, '5.4.0', '<')) {
 140             behat_error(BEHAT_EXITCODE_REQUIREMENT, 'PHP 5.4 is required. See config-dist.php for possible alternatives');
 141         }
 142
 143         $clibehaterrorstr = "Behat dependencies not installed. Ensure you ran the composer installer. " . self::DOCS_URL . "#Installation\n";
 144
 145         // Moodle setting.
 146         if (!self::are_behat_dependencies_installed()) {
 147
 148
 149             // With HTML.
 150             if (!CLI_SCRIPT) {
 151
 152                 $msg = get_string('wrongbehatsetup', 'tool_behat');
 153                 $docslink = self::DOCS_URL . '#Installation';
 154                 $docslink = html_writer::tag('a', $docslink, array('href' => $docslink, 'target' => '_blank'));
 155                 $msg .= get_string('moreinfoin', 'tool_behat', $docslink);
 156             } else {
 157                 $msg = $clibehaterrorstr;
 158             }
 159
 160             self::output_msg($msg);
 161             return BEHAT_EXITCODE_COMPOSER;
 162         }
 163
 164         // Behat test command.
 165         list($output, $code) = self::run(' --help');
 166
 167         if ($code != 0) {
 168             // Returning composer error code to avoid conflicts with behat and moodle error codes.
 169             if (!CLI_SCRIPT) {
 170                 $msg = get_string('wrongbehatsetup', 'tool_behat');
 171             } else {
 172                 $msg = $clibehaterrorstr;
 173             }
 174             self::output_msg($msg);
 175             return BEHAT_EXITCODE_COMPOSER;
 176         }
 177
 178         // Checking behat dataroot existence otherwise echo about admin/tool/behat/cli/util.php.
 179         if (empty($CFG->behat_dataroot) || !is_dir($CFG->behat_dataroot) || !is_writable($CFG->behat_dataroot)) {
 180             self::output_msg(get_string('runclitool', 'tool_behat', 'php admin/tool/behat/cli/util.php'));
 181             return BEHAT_EXITCODE_CONFIG;
 182         }
 183
 184         return 0;
 185     }
 186
 187     /**
 188      * Has the site installed composer with --dev option
 189      * @return bool
 190      */
 191     public static function are_behat_dependencies_installed() {
 192         if (!is_dir(__DIR__ . '/../../../vendor/behat')) {
 193             return false;
 194         }
 195         return true;
 196     }
 197
 198     /**
 199      * Outputs a message.
 200      *
 201      * Used in CLI + web UI methods. Stops the
 202      * execution in web.
 203      *
 204      * @param string $msg
 205      * @return void
 206      */
 207     protected static function output_msg($msg) {
 208
 209         if (!CLI_SCRIPT) {
 210             notice($msg);
 211         } else {
 212             echo $msg;
 213         }
 214     }
 215
 216 }