a7552fe8e433bd6ba01b8cfee3e2087eeb020979
[moodle.git] / admin / tool / phpunit / cli / util.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/>.
17 /**
18  * PHPUnit related utilities.
19  *
20  * Exit codes: {@see phpunit_bootstrap_error()}
21  *
22  * @package    tool_phpunit
23  * @copyright  2012 Petr Skoda {@link http://skodak.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 if (isset($_SERVER['REMOTE_ADDR'])) {
28     die; // no access from web!
29 }
31 require_once(__DIR__.'/../../../../lib/clilib.php');
32 require_once(__DIR__.'/../../../../lib/phpunit/bootstraplib.php');
34 // now get cli options
35 list($options, $unrecognized) = cli_get_params(
36     array(
37         'drop'                  => false,
38         'install'               => false,
39         'buildconfig'           => false,
40         'buildcomponentconfigs' => false,
41         'diag'                  => false,
42         'run'                   => false,
43         'help'                  => false,
44     ),
45     array(
46         'h' => 'help'
47     )
48 );
50 if (file_exists(__DIR__.'/../../../../vendor/autoload.php')) {
51     // Composer packages present.
52     require_once(__DIR__.'/../../../../vendor/autoload.php');
53 }
55 // Verify PHPUnit libs can be loaded.
56 if (!include_once('PHPUnit/Autoload.php')) {
57     phpunit_bootstrap_error(PHPUNIT_EXITCODE_PHPUNITMISSING);
58 }
60 if ($options['run']) {
61     unset($options);
62     unset($unrecognized);
64     foreach ($_SERVER['argv'] as $k=>$v) {
65         if (strpos($v, '--run') === 0) {
66             unset($_SERVER['argv'][$k]);
67             $_SERVER['argc'] = $_SERVER['argc'] - 1;
68         }
69     }
70     $_SERVER['argv'] = array_values($_SERVER['argv']);
71     PHPUnit_TextUI_Command::main();
72     exit(0);
73 }
75 define('PHPUNIT_UTIL', true);
77 require(__DIR__ . '/../../../../lib/phpunit/bootstrap.php');
79 // from now on this is a regular moodle CLI_SCRIPT
81 require_once($CFG->libdir.'/adminlib.php');
82 require_once($CFG->libdir.'/upgradelib.php');
83 require_once($CFG->libdir.'/clilib.php');
84 require_once($CFG->libdir.'/pluginlib.php');
85 require_once($CFG->libdir.'/installlib.php');
87 if ($unrecognized) {
88     $unrecognized = implode("\n  ", $unrecognized);
89     cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
90 }
92 $diag = $options['diag'];
93 $drop = $options['drop'];
94 $install = $options['install'];
95 $buildconfig = $options['buildconfig'];
96 $buildcomponentconfigs = $options['buildcomponentconfigs'];
98 if ($options['help'] or (!$drop and !$install and !$buildconfig and !$buildcomponentconfigs and !$diag)) {
99     $help = "Various PHPUnit utility functions
101 Options:
102 --drop         Drop database and dataroot
103 --install      Install database
104 --diag         Diagnose installation and return error code only
105 --run          Execute PHPUnit tests (alternative for standard phpunit binary)
106 --buildconfig  Build /phpunit.xml from /phpunit.xml.dist that runs all tests
107 --buildcomponentconfigs
108                Build distributed phpunit.xml files for each component
110 -h, --help     Print out this help
112 Example:
113 \$ php ".phpunit_bootstrap_cli_argument_path('/admin/tool/phpunit/cli/util.php')." --install
114 ";
115     echo $help;
116     exit(0);
119 if ($diag) {
120     list($errorcode, $message) = phpunit_util::testing_ready_problem();
121     if ($errorcode) {
122         phpunit_bootstrap_error($errorcode, $message);
123     }
124     exit(0);
126 } else if ($buildconfig) {
127     if (phpunit_util::build_config_file()) {
128         exit(0);
129     } else {
130         phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGWARNING, 'Can not create main /phpunit.xml configuration file, verify dirroot permissions');
131     }
133 } else if ($buildcomponentconfigs) {
134     phpunit_util::build_component_config_files();
135     exit(0);
137 } else if ($drop) {
138     // make sure tests do not run in parallel
139     test_lock::acquire('phpunit');
140     phpunit_util::drop_site(true);
141     // note: we must stop here because $CFG is messed up and we can not reinstall, sorry
142     exit(0);
144 } else if ($install) {
145     phpunit_util::install_site();
146     exit(0);