MDL-38509 Add ability to install add-ons from the remote repository
[moodle.git] / admin / tool / installaddon / tests / installer_test.php
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.
14 //
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  * Provides the unit tests class and some helper classes
20  *
21  * @package     tool_installaddon
22  * @category    test
23  * @copyright   2013 David Mudrak <david@moodle.com>
24  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 global $CFG;
30 require_once($CFG->dirroot.'/'.$CFG->admin.'/tool/installaddon/classes/installer.php');
33 /**
34  * Unit tests for the {@link tool_installaddon_installer} class
35  *
36  * @copyright 2013 David Mudrak <david@moodle.com>
37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class tool_installaddon_installer_test extends advanced_testcase {
41     public function test_get_addons_repository_url() {
42         $installer = testable_tool_installaddon_installer::instance();
43         $url = $installer->get_addons_repository_url();
44         $query = parse_url($url, PHP_URL_QUERY);
45         $this->assertEquals(1, preg_match('~^site=(.+)$~', $query, $matches));
46         $site = rawurldecode($matches[1]);
47         $site = json_decode(base64_decode($site), true);
48         $this->assertEquals('array', gettype($site));
49         $this->assertEquals(3, count($site));
50         $this->assertSame('Nasty site', $site['fullname']);
51         $this->assertSame('file:///etc/passwd', $site['url']);
52         $this->assertSame("2.5'; DROP TABLE mdl_user; --", $site['majorversion']);
53     }
55     public function test_extract_installfromzip_file() {
56         $jobid = md5(rand().uniqid('test_', true));
57         $sourcedir = make_temp_directory('tool_installaddon/'.$jobid.'/source');
58         $contentsdir = make_temp_directory('tool_installaddon/'.$jobid.'/contents');
59         copy(dirname(__FILE__).'/fixtures/zips/invalidroot.zip', $sourcedir.'/testinvalidroot.zip');
61         $installer = tool_installaddon_installer::instance();
62         $files = $installer->extract_installfromzip_file($sourcedir.'/testinvalidroot.zip', $contentsdir, 'fixed_root');
63         $this->assertEquals('array', gettype($files));
64         $this->assertEquals(4, count($files));
65         $this->assertSame(true, $files['fixed_root/']);
66         $this->assertSame(true, $files['fixed_root/lang/']);
67         $this->assertSame(true, $files['fixed_root/lang/en/']);
68         $this->assertSame(true, $files['fixed_root/lang/en/fixed_root.php']);
69         foreach ($files as $file => $status) {
70             if (substr($file, -1) === '/') {
71                 $this->assertTrue(is_dir($contentsdir.'/'.$file));
72             } else {
73                 $this->assertTrue(is_file($contentsdir.'/'.$file));
74             }
75         }
76     }
78     public function test_decode_remote_request() {
79         $installer = testable_tool_installaddon_installer::instance();
81         $request = base64_encode(json_encode(array(
82             'name' => '<h1>Stamp collection</h1>"; DELETE FROM mdl_users; --',
83             'component' => 'mod_stampcoll',
84             'version' => 2013032800,
85         )));
86         $request = $installer->testable_decode_remote_request($request);
87         $this->assertTrue(is_object($request));
88         // One, my little hobbit, never trusts the input parameters!
89         $this->assertEquals('Stamp collection&quot;; DELETE FROM mdl_users; --', $request->name);
90         $this->assertEquals('mod_stampcoll', $request->component);
91         $this->assertEquals(2013032800, $request->version);
93         $request = base64_encode(json_encode(array(
94             'name' => 'Theme with invalid version number',
95             'component' => 'theme_invalid',
96             'version' => '1.0',
97         )));
98         $this->assertSame(false, $installer->testable_decode_remote_request($request));
100         $request = base64_encode(json_encode(array(
101             'name' => 'Invalid activity name',
102             'component' => 'mod_invalid_activity',
103             'version' => 2013032800,
104         )));
105         $this->assertSame(false, $installer->testable_decode_remote_request($request));
107         $request = base64_encode(json_encode(array(
108             'name' => 'Moodle 3.0',
109             'component' => 'core',
110             'version' => 2022010100,
111         )));
112         $this->assertSame(false, $installer->testable_decode_remote_request($request));
114         $request = base64_encode(json_encode(array(
115             'name' => 'Invalid core subsystem',
116             'component' => 'core_cache',
117             'version' => 2014123400,
118         )));
119         $this->assertSame(false, $installer->testable_decode_remote_request($request));
121         $request = base64_encode(json_encode(array(
122             'name' => 'Non-existing plugintype',
123             'component' => 'david_mudrak',
124             'version' => 2012123199,
125         )));
126         $this->assertSame(false, $installer->testable_decode_remote_request($request));
127     }
131 /**
132  * Testable subclass of the tested class
133  *
134  * @copyright 2013 David Mudrak <david@moodle.com>
135  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
136  */
137 class testable_tool_installaddon_installer extends tool_installaddon_installer {
139     public function get_site_fullname() {
140         return strip_tags('<h1 onmouseover="alert(\'Hello Moodle.org!\');">Nasty site</h1>');
141     }
143     public function get_site_url() {
144         return 'file:///etc/passwd';
145     }
147     public function get_site_major_version() {
148         return "2.5'; DROP TABLE mdl_user; --";
149     }
151     public function testable_decode_remote_request($request) {
152         return parent::decode_remote_request($request);
153     }
155     protected function should_send_site_info() {
156         return true;
157     }