MDL-37458 testing common methods generalization
[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');
33 require_once(__DIR__.'/../../../../lib/testing/lib.php');
35 // now get cli options
36 list($options, $unrecognized) = cli_get_params(
37     array(
38         'drop'                  => false,
39         'install'               => false,
40         'buildconfig'           => false,
41         'buildcomponentconfigs' => false,
42         'diag'                  => false,
43         'run'                   => false,
44         'help'                  => false,
45     ),
46     array(
47         'h' => 'help'
48     )
49 );
51 if (file_exists(__DIR__.'/../../../../vendor/autoload.php')) {
52     // Composer packages present.
53     require_once(__DIR__.'/../../../../vendor/autoload.php');
54 }
56 // Verify PHPUnit libs can be loaded.
57 if (!include_once('PHPUnit/Autoload.php')) {
58     phpunit_bootstrap_error(PHPUNIT_EXITCODE_PHPUNITMISSING);
59 }
61 if ($options['run']) {
62     unset($options);
63     unset($unrecognized);
65     foreach ($_SERVER['argv'] as $k=>$v) {
66         if (strpos($v, '--run') === 0) {
67             unset($_SERVER['argv'][$k]);
68             $_SERVER['argc'] = $_SERVER['argc'] - 1;
69         }
70     }
71     $_SERVER['argv'] = array_values($_SERVER['argv']);
72     PHPUnit_TextUI_Command::main();
73     exit(0);
74 }
76 define('PHPUNIT_UTIL', true);
78 require(__DIR__ . '/../../../../lib/phpunit/bootstrap.php');
80 // from now on this is a regular moodle CLI_SCRIPT
82 require_once($CFG->libdir.'/adminlib.php');
83 require_once($CFG->libdir.'/upgradelib.php');
84 require_once($CFG->libdir.'/clilib.php');
85 require_once($CFG->libdir.'/pluginlib.php');
86 require_once($CFG->libdir.'/installlib.php');
88 if ($unrecognized) {
89     $unrecognized = implode("\n  ", $unrecognized);
90     cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
91 }
93 $diag = $options['diag'];
94 $drop = $options['drop'];
95 $install = $options['install'];
96 $buildconfig = $options['buildconfig'];
97 $buildcomponentconfigs = $options['buildcomponentconfigs'];
99 if ($options['help'] or (!$drop and !$install and !$buildconfig and !$buildcomponentconfigs and !$diag)) {
100     $help = "Various PHPUnit utility functions
102 Options:
103 --drop         Drop database and dataroot
104 --install      Install database
105 --diag         Diagnose installation and return error code only
106 --run          Execute PHPUnit tests (alternative for standard phpunit binary)
107 --buildconfig  Build /phpunit.xml from /phpunit.xml.dist that runs all tests
108 --buildcomponentconfigs
109                Build distributed phpunit.xml files for each component
111 -h, --help     Print out this help
113 Example:
114 \$ php ".testing_cli_argument_path('/admin/tool/phpunit/cli/util.php')." --install
115 ";
116     echo $help;
117     exit(0);
120 if ($diag) {
121     list($errorcode, $message) = phpunit_util::testing_ready_problem();
122     if ($errorcode) {
123         phpunit_bootstrap_error($errorcode, $message);
124     }
125     exit(0);
127 } else if ($buildconfig) {
128     if (phpunit_util::build_config_file()) {
129         exit(0);
130     } else {
131         phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGWARNING, 'Can not create main /phpunit.xml configuration file, verify dirroot permissions');
132     }
134 } else if ($buildcomponentconfigs) {
135     phpunit_util::build_component_config_files();
136     exit(0);
138 } else if ($drop) {
139     // make sure tests do not run in parallel
140     test_lock::acquire('phpunit');
141     phpunit_util::drop_site(true);
142     // note: we must stop here because $CFG is messed up and we can not reinstall, sorry
143     exit(0);
145 } else if ($install) {
146     phpunit_util::install_site();
147     exit(0);