weekly release 2.4.6+
[moodle.git] / mdeploytest.php
blob76800ebadb722e9f0f02dd07c9350cf55a9eb40a
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 /**
19 * PHPUnit tests for the mdeploy.php utility
21 * Because the mdeploy.php can't be part of the Moodle code itself, this tests must be
22 * executed using something like:
24 * $ phpunit --no-configuration mdeploytest
26 * @package core
27 * @copyright 2012 David Mudrak <david@moodle.com>
28 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31 require(__DIR__.'/mdeploy.php');
33 /**
34 * Provides testable input options.
36 * @copyright 2012 David Mudrak <david@moodle.com>
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39 class input_fake_provider extends input_provider {
41 /** @var array */
42 protected $fakeoptions = array();
44 /**
45 * Sets fake raw options.
47 * @param array $options
49 public function set_fake_options(array $options) {
50 $this->fakeoptions = $options;
51 $this->populate_options();
54 /**
55 * Returns the explicitly set fake options.
57 * @return array
59 protected function parse_raw_options() {
60 return $this->fakeoptions;
64 /**
65 * Testable subclass.
67 * @copyright 2012 David Mudrak <david@moodle.com>
68 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
70 class testable_input_manager extends input_manager {
72 /**
73 * Provides access to the protected method so we can test it explicitly.
75 public function cast_value($raw, $type) {
76 return parent::cast_value($raw, $type);
79 /**
80 * Sets the fake input provider.
82 protected function initialize() {
83 $this->inputprovider = input_fake_provider::instance();
88 /**
89 * Testable subclass
91 * @copyright 2012 David Mudrak <david@moodle.com>
92 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
94 class testable_worker extends worker {
96 /**
97 * Provides access to the protected method.
99 public function move_directory($source, $target, $keepsourceroot = false) {
100 return parent::move_directory($source, $target, $keepsourceroot);
104 * Provides access to the protected method.
106 public function remove_directory($path, $keeppathroot = false) {
107 return parent::remove_directory($path, $keeppathroot);
113 * Test cases for the mdeploy utility
115 * @copyright 2012 David Mudrak <david@moodle.com>
116 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
118 class mdeploytest extends PHPUnit_Framework_TestCase {
120 public function test_same_singletons() {
121 $a = input_manager::instance();
122 $b = input_manager::instance();
123 $this->assertSame($a, $b);
127 * @dataProvider data_for_cast_value
129 public function test_cast_value($raw, $type, $result) {
130 $input = testable_input_manager::instance();
131 $this->assertSame($input->cast_value($raw, $type), $result);
134 public function data_for_cast_value() {
135 return array(
136 array('3', input_manager::TYPE_INT, 3),
137 array(4, input_manager::TYPE_INT, 4),
138 array('', input_manager::TYPE_INT, 0),
140 array(true, input_manager::TYPE_FLAG, true),
141 array(false, input_manager::TYPE_FLAG, true),
142 array(0, input_manager::TYPE_FLAG, true),
143 array('1', input_manager::TYPE_FLAG, true),
144 array('0', input_manager::TYPE_FLAG, true),
145 array('muhehe', input_manager::TYPE_FLAG, true),
147 array('C:\\WINDOWS\\user.dat', input_manager::TYPE_PATH, 'C:/WINDOWS/user.dat'),
148 array('D:\xampp\htdocs\24_integration/mdeploy.php', input_manager::TYPE_PATH, 'D:/xampp/htdocs/24_integration/mdeploy.php'),
149 array('d:/xampp/htdocs/24_integration/mdeploy.php', input_manager::TYPE_PATH, 'd:/xampp/htdocs/24_integration/mdeploy.php'),
150 array('../../../etc/passwd', input_manager::TYPE_PATH, '/etc/passwd'),
151 array('///////.././public_html/test.php', input_manager::TYPE_PATH, '/public_html/test.php'),
153 array("!@#$%|/etc/qwerty\n\n\t\n\r", input_manager::TYPE_RAW, "!@#$%|/etc/qwerty\n\n\t\n\r"),
155 array("\nrock'n'roll.mp3\t.exe", input_manager::TYPE_FILE, 'rocknroll.mp3.exe'),
157 array('http://localhost/moodle/dev/plugin.zip', input_manager::TYPE_URL, 'http://localhost/moodle/dev/plugin.zip'),
158 array(
159 'https://moodle.org/plugins/download.php/1292/mod_stampcoll_moodle23_2012062201.zip',
160 input_manager::TYPE_URL,
161 'https://moodle.org/plugins/download.php/1292/mod_stampcoll_moodle23_2012062201.zip'
164 array('5e8d2ea4f50d154730100b1645fbad67', input_manager::TYPE_MD5, '5e8d2ea4f50d154730100b1645fbad67'),
169 * @expectedException invalid_option_exception
171 public function test_input_type_path_multiple_colons() {
172 $input = testable_input_manager::instance();
173 $input->cast_value('C:\apache\log:file', input_manager::TYPE_PATH); // must throw exception
177 * @expectedException invalid_option_exception
179 public function test_input_type_path_invalid_drive_label() {
180 $input = testable_input_manager::instance();
181 $input->cast_value('0:/srv/moodledata', input_manager::TYPE_PATH); // must throw exception
185 * @expectedException invalid_option_exception
187 public function test_input_type_path_invalid_colon() {
188 $input = testable_input_manager::instance();
189 $input->cast_value('/var/www/moodle:2.5', input_manager::TYPE_PATH); // must throw exception
193 * @expectedException invalid_coding_exception
195 public function test_cast_array_argument() {
196 $input = testable_input_manager::instance();
197 $input->cast_value(array(1, 2, 3), input_manager::TYPE_INT); // must throw exception
201 * @expectedException invalid_coding_exception
203 public function test_cast_object_argument() {
204 $input = testable_input_manager::instance();
205 $o = new stdClass();
206 $input->cast_value($o, input_manager::TYPE_INT); // must throw exception
210 * @expectedException invalid_option_exception
212 public function test_cast_invalid_url_value() {
213 $input = testable_input_manager::instance();
214 $invalid = 'file:///etc/passwd';
215 $input->cast_value($invalid, input_manager::TYPE_URL); // must throw exception
219 * @expectedException invalid_option_exception
221 public function test_cast_invalid_md5_value() {
222 $input = testable_input_manager::instance();
223 $invalid = 'this is not a valid md5 hash';
224 $input->cast_value($invalid, input_manager::TYPE_MD5); // must throw exception
228 * @expectedException invalid_option_exception
230 public function test_cast_tilde_in_path() {
231 $input = testable_input_manager::instance();
232 $invalid = '~/public_html/moodle_dev';
233 $input->cast_value($invalid, input_manager::TYPE_PATH); // must throw exception
236 public function test_has_option() {
237 $provider = input_fake_provider::instance();
239 $provider->set_fake_options(array());
240 $this->assertFalse($provider->has_option('foo')); // foo not passed
242 $provider->set_fake_options(array('foo' => 1));
243 $this->assertFalse($provider->has_option('foo')); // foo passed but not a known option
245 $provider->set_fake_options(array('foo' => 1, 'help' => false));
246 $this->assertTrue($provider->has_option('help')); // help passed and it is a flag (value ignored)
247 $this->assertTrue($provider->has_option('h')); // 'h' is a shortname for 'help'
250 public function test_get_option() {
251 $input = testable_input_manager::instance();
252 $provider = input_fake_provider::instance();
254 $provider->set_fake_options(array('help' => false, 'passfile' => '_mdeploy.123456'));
255 $this->assertTrue($input->get_option('h'));
256 $this->assertEquals($input->get_option('passfile'), '_mdeploy.123456');
257 $this->assertEquals($input->get_option('password', 'admin123'), 'admin123');
258 try {
259 $this->assertEquals($input->get_option('password'), 'admin123'); // must throw exception (not passed but required)
260 $this->assertTrue(false);
261 } catch (missing_option_exception $e) {
262 $this->assertTrue(true);
266 public function test_moving_and_removing_directories() {
267 $worker = testable_worker::instance();
269 $root = sys_get_temp_dir().'/'.uniqid('mdeploytest', true);
270 mkdir($root.'/a', 0777, true);
271 touch($root.'/a/a.txt');
273 $this->assertTrue(file_exists($root.'/a/a.txt'));
274 $this->assertFalse(file_exists($root.'/b/a.txt'));
275 $this->assertTrue($worker->move_directory($root.'/a', $root.'/b'));
276 $this->assertFalse(is_dir($root.'/a'));
277 $this->assertTrue(file_exists($root.'/b/a.txt'));
278 $this->assertTrue($worker->move_directory($root.'/b', $root.'/c', true));
279 $this->assertTrue(file_exists($root.'/c/a.txt'));
280 $this->assertFalse(file_exists($root.'/b/a.txt'));
281 $this->assertTrue(is_dir($root.'/b'));
282 $this->assertTrue($worker->remove_directory($root.'/c', true));
283 $this->assertFalse(file_exists($root.'/c/a.txt'));
284 $this->assertTrue($worker->remove_directory($root.'/c'));
285 $this->assertFalse(is_dir($root.'/c'));