1 |
efrain |
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 |
namespace core;
|
|
|
18 |
|
|
|
19 |
defined('MOODLE_INTERNAL') || die();
|
|
|
20 |
|
|
|
21 |
global $CFG;
|
|
|
22 |
require_once(__DIR__.'/fixtures/testable_update_api.php');
|
|
|
23 |
|
|
|
24 |
/**
|
|
|
25 |
* Tests for \core\update\api client.
|
|
|
26 |
*
|
|
|
27 |
* Please note many of these tests heavily depend on the behaviour of the
|
|
|
28 |
* testable_api client. It is important to make sure that the behaviour of the
|
|
|
29 |
* testable_api client perfectly matches the actual behaviour of the live
|
|
|
30 |
* services on the given API version.
|
|
|
31 |
*
|
|
|
32 |
* @package core
|
|
|
33 |
* @category test
|
|
|
34 |
* @copyright 2015 David Mudrak <david@moodle.com>
|
|
|
35 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
36 |
*/
|
|
|
37 |
class update_api_test extends \advanced_testcase {
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Make sure the $CFG->branch is mapped correctly to the format used by the API.
|
|
|
41 |
*/
|
11 |
efrain |
42 |
public function test_convert_branch_numbering_format(): void {
|
1 |
efrain |
43 |
|
|
|
44 |
/** @var \core\update\testable_api $client */
|
|
|
45 |
$client = \core\update\testable_api::client();
|
|
|
46 |
|
|
|
47 |
$this->assertSame('2.9', $client->convert_branch_numbering_format(29));
|
|
|
48 |
$this->assertSame('3.0', $client->convert_branch_numbering_format('30'));
|
|
|
49 |
$this->assertSame('3.1', $client->convert_branch_numbering_format(3.1));
|
|
|
50 |
$this->assertSame('3.1', $client->convert_branch_numbering_format('3.1'));
|
|
|
51 |
$this->assertSame('10.1', $client->convert_branch_numbering_format(101));
|
|
|
52 |
$this->assertSame('10.2', $client->convert_branch_numbering_format('102'));
|
|
|
53 |
}
|
|
|
54 |
|
|
|
55 |
/**
|
|
|
56 |
* Getting info about particular plugin version.
|
|
|
57 |
*/
|
11 |
efrain |
58 |
public function test_get_plugin_info(): void {
|
1 |
efrain |
59 |
|
|
|
60 |
$client = \core\update\testable_api::client();
|
|
|
61 |
|
|
|
62 |
// The plugin is not found in the plugins directory.
|
|
|
63 |
$this->assertFalse($client->get_plugin_info('non_existing', 2015093000));
|
|
|
64 |
|
|
|
65 |
// The plugin is known but there is no such version.
|
|
|
66 |
$info = $client->get_plugin_info('foo_bar', 2014010100);
|
|
|
67 |
$this->assertInstanceOf('\core\update\remote_info', $info);
|
|
|
68 |
$this->assertFalse($info->version);
|
|
|
69 |
|
|
|
70 |
// Both plugin and the version are available.
|
|
|
71 |
foreach (array(2015093000 => MATURITY_STABLE, 2015100400 => MATURITY_STABLE,
|
|
|
72 |
2015100500 => MATURITY_BETA) as $version => $maturity) {
|
|
|
73 |
$info = $client->get_plugin_info('foo_bar', $version);
|
|
|
74 |
$this->assertInstanceOf('\core\update\remote_info', $info);
|
|
|
75 |
$this->assertNotEmpty($info->version);
|
|
|
76 |
$this->assertEquals($maturity, $info->version->maturity);
|
|
|
77 |
}
|
|
|
78 |
}
|
|
|
79 |
|
|
|
80 |
/**
|
|
|
81 |
* Getting info about the most suitable plugin version for us.
|
|
|
82 |
*/
|
11 |
efrain |
83 |
public function test_find_plugin(): void {
|
1 |
efrain |
84 |
|
|
|
85 |
$client = \core\update\testable_api::client();
|
|
|
86 |
|
|
|
87 |
// The plugin is not found in the plugins directory.
|
|
|
88 |
$this->assertFalse($client->find_plugin('non_existing'));
|
|
|
89 |
|
|
|
90 |
// The plugin is known but there is no sufficient version.
|
|
|
91 |
$info = $client->find_plugin('foo_bar', 2016010100);
|
|
|
92 |
$this->assertFalse($info->version);
|
|
|
93 |
|
|
|
94 |
// Both plugin and the version are available. Of the two available
|
|
|
95 |
// stable versions, the more recent one is returned.
|
|
|
96 |
$info = $client->find_plugin('foo_bar', 2015093000);
|
|
|
97 |
$this->assertInstanceOf('\core\update\remote_info', $info);
|
|
|
98 |
$this->assertEquals(2015100400, $info->version->version);
|
|
|
99 |
|
|
|
100 |
// If any version is required, the most recent most mature one is
|
|
|
101 |
// returned.
|
|
|
102 |
$info = $client->find_plugin('foo_bar', ANY_VERSION);
|
|
|
103 |
$this->assertInstanceOf('\core\update\remote_info', $info);
|
|
|
104 |
$this->assertEquals(2015100400, $info->version->version);
|
|
|
105 |
|
|
|
106 |
// Less matured versions are returned if needed.
|
|
|
107 |
$info = $client->find_plugin('foo_bar', 2015100500);
|
|
|
108 |
$this->assertInstanceOf('\core\update\remote_info', $info);
|
|
|
109 |
$this->assertEquals(2015100500, $info->version->version);
|
|
|
110 |
}
|
|
|
111 |
|
|
|
112 |
/**
|
|
|
113 |
* Validating the pluginfo.php response data.
|
|
|
114 |
*/
|
11 |
efrain |
115 |
public function test_validate_pluginfo_format(): void {
|
1 |
efrain |
116 |
|
|
|
117 |
$client = \core\update\testable_api::client();
|
|
|
118 |
|
|
|
119 |
$json = '{"id":127,"name":"Course contents","component":"block_course_contents","source":"https:\/\/github.com\/mudrd8mz\/moodle-block_course_contents","doc":"http:\/\/docs.moodle.org\/20\/en\/Course_contents_block","bugs":"https:\/\/github.com\/mudrd8mz\/moodle-block_course_contents\/issues","discussion":null,"version":{"id":8100,"version":"2015030300","release":"3.0","maturity":200,"downloadurl":"https:\/\/moodle.org\/plugins\/download.php\/8100\/block_course_contents_moodle29_2015030300.zip","downloadmd5":"8d8ae64822f38d278420776f8b42eaa5","vcssystem":"git","vcssystemother":null,"vcsrepositoryurl":"https:\/\/github.com\/mudrd8mz\/moodle-block_course_contents","vcsbranch":"master","vcstag":"v3.0","supportedmoodles":[{"version":2014041100,"release":"2.7"},{"version":2014101000,"release":"2.8"},{"version":2015041700,"release":"2.9"}]}}';
|
|
|
120 |
|
|
|
121 |
$data = json_decode($json);
|
|
|
122 |
$this->assertInstanceOf('\core\update\remote_info', $client->validate_pluginfo_format($data));
|
|
|
123 |
$this->assertEquals(json_encode($data), json_encode($client->validate_pluginfo_format($data)));
|
|
|
124 |
|
|
|
125 |
// All properties must be present.
|
|
|
126 |
unset($data->version);
|
|
|
127 |
$this->assertFalse($client->validate_pluginfo_format($data));
|
|
|
128 |
|
|
|
129 |
$data->version = false;
|
|
|
130 |
$this->assertEquals(json_encode($data), json_encode($client->validate_pluginfo_format($data)));
|
|
|
131 |
|
|
|
132 |
// Some properties may be empty.
|
|
|
133 |
$data = json_decode($json);
|
|
|
134 |
$data->version->release = null;
|
|
|
135 |
$this->assertEquals(json_encode($data), json_encode($client->validate_pluginfo_format($data)));
|
|
|
136 |
|
|
|
137 |
// Some properties must not be empty.
|
|
|
138 |
$data = json_decode($json);
|
|
|
139 |
$data->version->downloadurl = '';
|
|
|
140 |
$this->assertFalse($client->validate_pluginfo_format($data));
|
|
|
141 |
|
|
|
142 |
// Download URL may be http:// or https:// only.
|
|
|
143 |
$data = json_decode($json);
|
|
|
144 |
$data->version->downloadurl = 'ftp://archive.moodle.org/block_course_contents/2014041100.zip';
|
|
|
145 |
$this->assertFalse($client->validate_pluginfo_format($data));
|
|
|
146 |
}
|
|
|
147 |
}
|