]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | use Shaarli\Config\ConfigJson; | |
3 | use Shaarli\Config\ConfigManager; | |
4 | use Shaarli\Config\ConfigPhp; | |
5 | use Shaarli\Thumbnailer; | |
6 | ||
7 | require_once 'tests/Updater/DummyUpdater.php'; | |
8 | require_once 'inc/rain.tpl.class.php'; | |
9 | ||
10 | /** | |
11 | * Class UpdaterTest. | |
12 | * Runs unit tests against the Updater class. | |
13 | */ | |
14 | class UpdaterTest extends PHPUnit_Framework_TestCase | |
15 | { | |
16 | /** | |
17 | * @var string Path to test datastore. | |
18 | */ | |
19 | protected static $testDatastore = 'sandbox/datastore.php'; | |
20 | ||
21 | /** | |
22 | * @var string Config file path (without extension). | |
23 | */ | |
24 | protected static $configFile = 'sandbox/config'; | |
25 | ||
26 | /** | |
27 | * @var ConfigManager | |
28 | */ | |
29 | protected $conf; | |
30 | ||
31 | /** | |
32 | * Executed before each test. | |
33 | */ | |
34 | public function setUp() | |
35 | { | |
36 | copy('tests/utils/config/configJson.json.php', self::$configFile .'.json.php'); | |
37 | $this->conf = new ConfigManager(self::$configFile); | |
38 | } | |
39 | ||
40 | /** | |
41 | * Test read_updates_file with an empty/missing file. | |
42 | */ | |
43 | public function testReadEmptyUpdatesFile() | |
44 | { | |
45 | $this->assertEquals(array(), read_updates_file('')); | |
46 | $updatesFile = $this->conf->get('resource.data_dir') . '/updates.txt'; | |
47 | touch($updatesFile); | |
48 | $this->assertEquals(array(), read_updates_file($updatesFile)); | |
49 | unlink($updatesFile); | |
50 | } | |
51 | ||
52 | /** | |
53 | * Test read/write updates file. | |
54 | */ | |
55 | public function testReadWriteUpdatesFile() | |
56 | { | |
57 | $updatesFile = $this->conf->get('resource.data_dir') . '/updates.txt'; | |
58 | $updatesMethods = array('m1', 'm2', 'm3'); | |
59 | ||
60 | write_updates_file($updatesFile, $updatesMethods); | |
61 | $readMethods = read_updates_file($updatesFile); | |
62 | $this->assertEquals($readMethods, $updatesMethods); | |
63 | ||
64 | // Update | |
65 | $updatesMethods[] = 'm4'; | |
66 | write_updates_file($updatesFile, $updatesMethods); | |
67 | $readMethods = read_updates_file($updatesFile); | |
68 | $this->assertEquals($readMethods, $updatesMethods); | |
69 | unlink($updatesFile); | |
70 | } | |
71 | ||
72 | /** | |
73 | * Test errors in write_updates_file(): empty updates file. | |
74 | * | |
75 | * @expectedException Exception | |
76 | * @expectedExceptionMessageRegExp /Updates file path is not set(.*)/ | |
77 | */ | |
78 | public function testWriteEmptyUpdatesFile() | |
79 | { | |
80 | write_updates_file('', array('test')); | |
81 | } | |
82 | ||
83 | /** | |
84 | * Test errors in write_updates_file(): not writable updates file. | |
85 | * | |
86 | * @expectedException Exception | |
87 | * @expectedExceptionMessageRegExp /Unable to write(.*)/ | |
88 | */ | |
89 | public function testWriteUpdatesFileNotWritable() | |
90 | { | |
91 | $updatesFile = $this->conf->get('resource.data_dir') . '/updates.txt'; | |
92 | touch($updatesFile); | |
93 | chmod($updatesFile, 0444); | |
94 | try { | |
95 | @write_updates_file($updatesFile, array('test')); | |
96 | } catch (Exception $e) { | |
97 | unlink($updatesFile); | |
98 | throw $e; | |
99 | } | |
100 | } | |
101 | ||
102 | /** | |
103 | * Test the update() method, with no update to run. | |
104 | * 1. Everything already run. | |
105 | * 2. User is logged out. | |
106 | */ | |
107 | public function testNoUpdates() | |
108 | { | |
109 | $updates = array( | |
110 | 'updateMethodDummy1', | |
111 | 'updateMethodDummy2', | |
112 | 'updateMethodDummy3', | |
113 | 'updateMethodException', | |
114 | ); | |
115 | $updater = new DummyUpdater($updates, array(), $this->conf, true); | |
116 | $this->assertEquals(array(), $updater->update()); | |
117 | ||
118 | $updater = new DummyUpdater(array(), array(), $this->conf, false); | |
119 | $this->assertEquals(array(), $updater->update()); | |
120 | } | |
121 | ||
122 | /** | |
123 | * Test the update() method, with all updates to run (except the failing one). | |
124 | */ | |
125 | public function testUpdatesFirstTime() | |
126 | { | |
127 | $updates = array('updateMethodException',); | |
128 | $expectedUpdates = array( | |
129 | 'updateMethodDummy1', | |
130 | 'updateMethodDummy2', | |
131 | 'updateMethodDummy3', | |
132 | ); | |
133 | $updater = new DummyUpdater($updates, array(), $this->conf, true); | |
134 | $this->assertEquals($expectedUpdates, $updater->update()); | |
135 | } | |
136 | ||
137 | /** | |
138 | * Test the update() method, only one update to run. | |
139 | */ | |
140 | public function testOneUpdate() | |
141 | { | |
142 | $updates = array( | |
143 | 'updateMethodDummy1', | |
144 | 'updateMethodDummy3', | |
145 | 'updateMethodException', | |
146 | ); | |
147 | $expectedUpdate = array('updateMethodDummy2'); | |
148 | ||
149 | $updater = new DummyUpdater($updates, array(), $this->conf, true); | |
150 | $this->assertEquals($expectedUpdate, $updater->update()); | |
151 | } | |
152 | ||
153 | /** | |
154 | * Test Update failed. | |
155 | * | |
156 | * @expectedException UpdaterException | |
157 | */ | |
158 | public function testUpdateFailed() | |
159 | { | |
160 | $updates = array( | |
161 | 'updateMethodDummy1', | |
162 | 'updateMethodDummy2', | |
163 | 'updateMethodDummy3', | |
164 | ); | |
165 | ||
166 | $updater = new DummyUpdater($updates, array(), $this->conf, true); | |
167 | $updater->update(); | |
168 | } | |
169 | ||
170 | /** | |
171 | * Test update mergeDeprecatedConfig: | |
172 | * 1. init a config file. | |
173 | * 2. init a options.php file with update value. | |
174 | * 3. merge. | |
175 | * 4. check updated value in config file. | |
176 | */ | |
177 | public function testUpdateMergeDeprecatedConfig() | |
178 | { | |
179 | $this->conf->setConfigFile('tests/utils/config/configPhp'); | |
180 | $this->conf->reset(); | |
181 | ||
182 | $optionsFile = 'tests/Updater/options.php'; | |
183 | $options = '<?php | |
184 | $GLOBALS[\'privateLinkByDefault\'] = true;'; | |
185 | file_put_contents($optionsFile, $options); | |
186 | ||
187 | // tmp config file. | |
188 | $this->conf->setConfigFile('tests/Updater/config'); | |
189 | ||
190 | // merge configs | |
191 | $updater = new Updater(array(), array(), $this->conf, true); | |
192 | // This writes a new config file in tests/Updater/config.php | |
193 | $updater->updateMethodMergeDeprecatedConfigFile(); | |
194 | ||
195 | // make sure updated field is changed | |
196 | $this->conf->reload(); | |
197 | $this->assertTrue($this->conf->get('privacy.default_private_links')); | |
198 | $this->assertFalse(is_file($optionsFile)); | |
199 | // Delete the generated file. | |
200 | unlink($this->conf->getConfigFileExt()); | |
201 | } | |
202 | ||
203 | /** | |
204 | * Test mergeDeprecatedConfig in without options file. | |
205 | */ | |
206 | public function testMergeDeprecatedConfigNoFile() | |
207 | { | |
208 | $updater = new Updater(array(), array(), $this->conf, true); | |
209 | $updater->updateMethodMergeDeprecatedConfigFile(); | |
210 | ||
211 | $this->assertEquals('root', $this->conf->get('credentials.login')); | |
212 | } | |
213 | ||
214 | /** | |
215 | * Test renameDashTags update method. | |
216 | */ | |
217 | public function testRenameDashTags() | |
218 | { | |
219 | $refDB = new ReferenceLinkDB(); | |
220 | $refDB->write(self::$testDatastore); | |
221 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
222 | ||
223 | $this->assertEmpty($linkDB->filterSearch(array('searchtags' => 'exclude'))); | |
224 | $updater = new Updater(array(), $linkDB, $this->conf, true); | |
225 | $updater->updateMethodRenameDashTags(); | |
226 | $this->assertNotEmpty($linkDB->filterSearch(array('searchtags' => 'exclude'))); | |
227 | } | |
228 | ||
229 | /** | |
230 | * Convert old PHP config file to JSON config. | |
231 | */ | |
232 | public function testConfigToJson() | |
233 | { | |
234 | $configFile = 'tests/utils/config/configPhp'; | |
235 | $this->conf->setConfigFile($configFile); | |
236 | $this->conf->reset(); | |
237 | ||
238 | // The ConfigIO is initialized with ConfigPhp. | |
239 | $this->assertTrue($this->conf->getConfigIO() instanceof ConfigPhp); | |
240 | ||
241 | $updater = new Updater(array(), array(), $this->conf, false); | |
242 | $done = $updater->updateMethodConfigToJson(); | |
243 | $this->assertTrue($done); | |
244 | ||
245 | // The ConfigIO has been updated to ConfigJson. | |
246 | $this->assertTrue($this->conf->getConfigIO() instanceof ConfigJson); | |
247 | $this->assertTrue(file_exists($this->conf->getConfigFileExt())); | |
248 | ||
249 | // Check JSON config data. | |
250 | $this->conf->reload(); | |
251 | $this->assertEquals('root', $this->conf->get('credentials.login')); | |
252 | $this->assertEquals('lala', $this->conf->get('redirector.url')); | |
253 | $this->assertEquals('data/datastore.php', $this->conf->get('resource.datastore')); | |
254 | $this->assertEquals('1', $this->conf->get('plugins.WALLABAG_VERSION')); | |
255 | ||
256 | rename($configFile . '.save.php', $configFile . '.php'); | |
257 | unlink($this->conf->getConfigFileExt()); | |
258 | } | |
259 | ||
260 | /** | |
261 | * Launch config conversion update with an existing JSON file => nothing to do. | |
262 | */ | |
263 | public function testConfigToJsonNothingToDo() | |
264 | { | |
265 | $filetime = filemtime($this->conf->getConfigFileExt()); | |
266 | $updater = new Updater(array(), array(), $this->conf, false); | |
267 | $done = $updater->updateMethodConfigToJson(); | |
268 | $this->assertTrue($done); | |
269 | $expected = filemtime($this->conf->getConfigFileExt()); | |
270 | $this->assertEquals($expected, $filetime); | |
271 | } | |
272 | ||
273 | /** | |
274 | * Test escapeUnescapedConfig with valid data. | |
275 | */ | |
276 | public function testEscapeConfig() | |
277 | { | |
278 | $sandbox = 'sandbox/config'; | |
279 | copy(self::$configFile . '.json.php', $sandbox . '.json.php'); | |
280 | $this->conf = new ConfigManager($sandbox); | |
281 | $title = '<script>alert("title");</script>'; | |
282 | $headerLink = '<script>alert("header_link");</script>'; | |
283 | $redirectorUrl = '<script>alert("redirector");</script>'; | |
284 | $this->conf->set('general.title', $title); | |
285 | $this->conf->set('general.header_link', $headerLink); | |
286 | $this->conf->set('redirector.url', $redirectorUrl); | |
287 | $updater = new Updater(array(), array(), $this->conf, true); | |
288 | $done = $updater->updateMethodEscapeUnescapedConfig(); | |
289 | $this->assertTrue($done); | |
290 | $this->conf->reload(); | |
291 | $this->assertEquals(escape($title), $this->conf->get('general.title')); | |
292 | $this->assertEquals(escape($headerLink), $this->conf->get('general.header_link')); | |
293 | $this->assertEquals(escape($redirectorUrl), $this->conf->get('redirector.url')); | |
294 | unlink($sandbox . '.json.php'); | |
295 | } | |
296 | ||
297 | /** | |
298 | * Test updateMethodApiSettings(): create default settings for the API (enabled + secret). | |
299 | */ | |
300 | public function testUpdateApiSettings() | |
301 | { | |
302 | $confFile = 'sandbox/config'; | |
303 | copy(self::$configFile .'.json.php', $confFile .'.json.php'); | |
304 | $conf = new ConfigManager($confFile); | |
305 | $updater = new Updater(array(), array(), $conf, true); | |
306 | ||
307 | $this->assertFalse($conf->exists('api.enabled')); | |
308 | $this->assertFalse($conf->exists('api.secret')); | |
309 | $updater->updateMethodApiSettings(); | |
310 | $conf->reload(); | |
311 | $this->assertTrue($conf->get('api.enabled')); | |
312 | $this->assertTrue($conf->exists('api.secret')); | |
313 | unlink($confFile .'.json.php'); | |
314 | } | |
315 | ||
316 | /** | |
317 | * Test updateMethodApiSettings(): already set, do nothing. | |
318 | */ | |
319 | public function testUpdateApiSettingsNothingToDo() | |
320 | { | |
321 | $confFile = 'sandbox/config'; | |
322 | copy(self::$configFile .'.json.php', $confFile .'.json.php'); | |
323 | $conf = new ConfigManager($confFile); | |
324 | $conf->set('api.enabled', false); | |
325 | $conf->set('api.secret', ''); | |
326 | $updater = new Updater(array(), array(), $conf, true); | |
327 | $updater->updateMethodApiSettings(); | |
328 | $this->assertFalse($conf->get('api.enabled')); | |
329 | $this->assertEmpty($conf->get('api.secret')); | |
330 | unlink($confFile .'.json.php'); | |
331 | } | |
332 | ||
333 | /** | |
334 | * Test updateMethodDatastoreIds(). | |
335 | */ | |
336 | public function testDatastoreIds() | |
337 | { | |
338 | $links = array( | |
339 | '20121206_182539' => array( | |
340 | 'linkdate' => '20121206_182539', | |
341 | 'title' => 'Geek and Poke', | |
342 | 'url' => 'http://geek-and-poke.com/', | |
343 | 'description' => 'desc', | |
344 | 'tags' => 'dev cartoon tag1 tag2 tag3 tag4 ', | |
345 | 'updated' => '20121206_190301', | |
346 | 'private' => false, | |
347 | ), | |
348 | '20121206_172539' => array( | |
349 | 'linkdate' => '20121206_172539', | |
350 | 'title' => 'UserFriendly - Samba', | |
351 | 'url' => 'http://ars.userfriendly.org/cartoons/?id=20010306', | |
352 | 'description' => '', | |
353 | 'tags' => 'samba cartoon web', | |
354 | 'private' => false, | |
355 | ), | |
356 | '20121206_142300' => array( | |
357 | 'linkdate' => '20121206_142300', | |
358 | 'title' => 'UserFriendly - Web Designer', | |
359 | 'url' => 'http://ars.userfriendly.org/cartoons/?id=20121206', | |
360 | 'description' => 'Naming conventions... #private', | |
361 | 'tags' => 'samba cartoon web', | |
362 | 'private' => true, | |
363 | ), | |
364 | ); | |
365 | $refDB = new ReferenceLinkDB(); | |
366 | $refDB->setLinks($links); | |
367 | $refDB->write(self::$testDatastore); | |
368 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
369 | ||
370 | $checksum = hash_file('sha1', self::$testDatastore); | |
371 | ||
372 | $this->conf->set('resource.data_dir', 'sandbox'); | |
373 | $this->conf->set('resource.datastore', self::$testDatastore); | |
374 | ||
375 | $updater = new Updater(array(), $linkDB, $this->conf, true); | |
376 | $this->assertTrue($updater->updateMethodDatastoreIds()); | |
377 | ||
378 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
379 | ||
380 | $backup = glob($this->conf->get('resource.data_dir') . '/datastore.'. date('YmdH') .'*.php'); | |
381 | $backup = $backup[0]; | |
382 | ||
383 | $this->assertFileExists($backup); | |
384 | $this->assertEquals($checksum, hash_file('sha1', $backup)); | |
385 | unlink($backup); | |
386 | ||
387 | $this->assertEquals(3, count($linkDB)); | |
388 | $this->assertTrue(isset($linkDB[0])); | |
389 | $this->assertFalse(isset($linkDB[0]['linkdate'])); | |
390 | $this->assertEquals(0, $linkDB[0]['id']); | |
391 | $this->assertEquals('UserFriendly - Web Designer', $linkDB[0]['title']); | |
392 | $this->assertEquals('http://ars.userfriendly.org/cartoons/?id=20121206', $linkDB[0]['url']); | |
393 | $this->assertEquals('Naming conventions... #private', $linkDB[0]['description']); | |
394 | $this->assertEquals('samba cartoon web', $linkDB[0]['tags']); | |
395 | $this->assertTrue($linkDB[0]['private']); | |
396 | $this->assertEquals( | |
397 | DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_142300'), | |
398 | $linkDB[0]['created'] | |
399 | ); | |
400 | ||
401 | $this->assertTrue(isset($linkDB[1])); | |
402 | $this->assertFalse(isset($linkDB[1]['linkdate'])); | |
403 | $this->assertEquals(1, $linkDB[1]['id']); | |
404 | $this->assertEquals('UserFriendly - Samba', $linkDB[1]['title']); | |
405 | $this->assertEquals( | |
406 | DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_172539'), | |
407 | $linkDB[1]['created'] | |
408 | ); | |
409 | ||
410 | $this->assertTrue(isset($linkDB[2])); | |
411 | $this->assertFalse(isset($linkDB[2]['linkdate'])); | |
412 | $this->assertEquals(2, $linkDB[2]['id']); | |
413 | $this->assertEquals('Geek and Poke', $linkDB[2]['title']); | |
414 | $this->assertEquals( | |
415 | DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_182539'), | |
416 | $linkDB[2]['created'] | |
417 | ); | |
418 | $this->assertEquals( | |
419 | DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_190301'), | |
420 | $linkDB[2]['updated'] | |
421 | ); | |
422 | } | |
423 | ||
424 | /** | |
425 | * Test updateMethodDatastoreIds() with the update already applied: nothing to do. | |
426 | */ | |
427 | public function testDatastoreIdsNothingToDo() | |
428 | { | |
429 | $refDB = new ReferenceLinkDB(); | |
430 | $refDB->write(self::$testDatastore); | |
431 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
432 | ||
433 | $this->conf->set('resource.data_dir', 'sandbox'); | |
434 | $this->conf->set('resource.datastore', self::$testDatastore); | |
435 | ||
436 | $checksum = hash_file('sha1', self::$testDatastore); | |
437 | $updater = new Updater(array(), $linkDB, $this->conf, true); | |
438 | $this->assertTrue($updater->updateMethodDatastoreIds()); | |
439 | $this->assertEquals($checksum, hash_file('sha1', self::$testDatastore)); | |
440 | } | |
441 | ||
442 | /** | |
443 | * Test defaultTheme update with default settings: nothing to do. | |
444 | */ | |
445 | public function testDefaultThemeWithDefaultSettings() | |
446 | { | |
447 | $sandbox = 'sandbox/config'; | |
448 | copy(self::$configFile . '.json.php', $sandbox . '.json.php'); | |
449 | $this->conf = new ConfigManager($sandbox); | |
450 | $updater = new Updater([], [], $this->conf, true); | |
451 | $this->assertTrue($updater->updateMethodDefaultTheme()); | |
452 | ||
453 | $this->assertEquals('tpl/', $this->conf->get('resource.raintpl_tpl')); | |
454 | $this->assertEquals('default', $this->conf->get('resource.theme')); | |
455 | $this->conf = new ConfigManager($sandbox); | |
456 | $this->assertEquals('tpl/', $this->conf->get('resource.raintpl_tpl')); | |
457 | $this->assertEquals('default', $this->conf->get('resource.theme')); | |
458 | unlink($sandbox . '.json.php'); | |
459 | } | |
460 | ||
461 | /** | |
462 | * Test defaultTheme update with a custom theme in a subfolder | |
463 | */ | |
464 | public function testDefaultThemeWithCustomTheme() | |
465 | { | |
466 | $theme = 'iamanartist'; | |
467 | $sandbox = 'sandbox/config'; | |
468 | copy(self::$configFile . '.json.php', $sandbox . '.json.php'); | |
469 | $this->conf = new ConfigManager($sandbox); | |
470 | mkdir('sandbox/'. $theme); | |
471 | touch('sandbox/'. $theme .'/linklist.html'); | |
472 | $this->conf->set('resource.raintpl_tpl', 'sandbox/'. $theme .'/'); | |
473 | $updater = new Updater([], [], $this->conf, true); | |
474 | $this->assertTrue($updater->updateMethodDefaultTheme()); | |
475 | ||
476 | $this->assertEquals('sandbox', $this->conf->get('resource.raintpl_tpl')); | |
477 | $this->assertEquals($theme, $this->conf->get('resource.theme')); | |
478 | $this->conf = new ConfigManager($sandbox); | |
479 | $this->assertEquals('sandbox', $this->conf->get('resource.raintpl_tpl')); | |
480 | $this->assertEquals($theme, $this->conf->get('resource.theme')); | |
481 | unlink($sandbox . '.json.php'); | |
482 | unlink('sandbox/'. $theme .'/linklist.html'); | |
483 | rmdir('sandbox/'. $theme); | |
484 | } | |
485 | ||
486 | /** | |
487 | * Test updateMethodEscapeMarkdown with markdown plugin enabled | |
488 | * => setting markdown_escape set to false. | |
489 | */ | |
490 | public function testEscapeMarkdownSettingToFalse() | |
491 | { | |
492 | $sandboxConf = 'sandbox/config'; | |
493 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
494 | $this->conf = new ConfigManager($sandboxConf); | |
495 | ||
496 | $this->conf->set('general.enabled_plugins', ['markdown']); | |
497 | $updater = new Updater([], [], $this->conf, true); | |
498 | $this->assertTrue($updater->updateMethodEscapeMarkdown()); | |
499 | $this->assertFalse($this->conf->get('security.markdown_escape')); | |
500 | ||
501 | // reload from file | |
502 | $this->conf = new ConfigManager($sandboxConf); | |
503 | $this->assertFalse($this->conf->get('security.markdown_escape')); | |
504 | } | |
505 | ||
506 | ||
507 | /** | |
508 | * Test updateMethodEscapeMarkdown with markdown plugin disabled | |
509 | * => setting markdown_escape set to true. | |
510 | */ | |
511 | public function testEscapeMarkdownSettingToTrue() | |
512 | { | |
513 | $sandboxConf = 'sandbox/config'; | |
514 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
515 | $this->conf = new ConfigManager($sandboxConf); | |
516 | ||
517 | $this->conf->set('general.enabled_plugins', []); | |
518 | $updater = new Updater([], [], $this->conf, true); | |
519 | $this->assertTrue($updater->updateMethodEscapeMarkdown()); | |
520 | $this->assertTrue($this->conf->get('security.markdown_escape')); | |
521 | ||
522 | // reload from file | |
523 | $this->conf = new ConfigManager($sandboxConf); | |
524 | $this->assertTrue($this->conf->get('security.markdown_escape')); | |
525 | } | |
526 | ||
527 | /** | |
528 | * Test updateMethodEscapeMarkdown with nothing to do (setting already enabled) | |
529 | */ | |
530 | public function testEscapeMarkdownSettingNothingToDoEnabled() | |
531 | { | |
532 | $sandboxConf = 'sandbox/config'; | |
533 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
534 | $this->conf = new ConfigManager($sandboxConf); | |
535 | $this->conf->set('security.markdown_escape', true); | |
536 | $updater = new Updater([], [], $this->conf, true); | |
537 | $this->assertTrue($updater->updateMethodEscapeMarkdown()); | |
538 | $this->assertTrue($this->conf->get('security.markdown_escape')); | |
539 | } | |
540 | ||
541 | /** | |
542 | * Test updateMethodEscapeMarkdown with nothing to do (setting already disabled) | |
543 | */ | |
544 | public function testEscapeMarkdownSettingNothingToDoDisabled() | |
545 | { | |
546 | $this->conf->set('security.markdown_escape', false); | |
547 | $updater = new Updater([], [], $this->conf, true); | |
548 | $this->assertTrue($updater->updateMethodEscapeMarkdown()); | |
549 | $this->assertFalse($this->conf->get('security.markdown_escape')); | |
550 | } | |
551 | ||
552 | /** | |
553 | * Test updateMethodPiwikUrl with valid data | |
554 | */ | |
555 | public function testUpdatePiwikUrlValid() | |
556 | { | |
557 | $sandboxConf = 'sandbox/config'; | |
558 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
559 | $this->conf = new ConfigManager($sandboxConf); | |
560 | $url = 'mypiwik.tld'; | |
561 | $this->conf->set('plugins.PIWIK_URL', $url); | |
562 | $updater = new Updater([], [], $this->conf, true); | |
563 | $this->assertTrue($updater->updateMethodPiwikUrl()); | |
564 | $this->assertEquals('http://'. $url, $this->conf->get('plugins.PIWIK_URL')); | |
565 | ||
566 | // reload from file | |
567 | $this->conf = new ConfigManager($sandboxConf); | |
568 | $this->assertEquals('http://'. $url, $this->conf->get('plugins.PIWIK_URL')); | |
569 | } | |
570 | ||
571 | /** | |
572 | * Test updateMethodPiwikUrl without setting | |
573 | */ | |
574 | public function testUpdatePiwikUrlEmpty() | |
575 | { | |
576 | $updater = new Updater([], [], $this->conf, true); | |
577 | $this->assertTrue($updater->updateMethodPiwikUrl()); | |
578 | $this->assertEmpty($this->conf->get('plugins.PIWIK_URL')); | |
579 | } | |
580 | ||
581 | /** | |
582 | * Test updateMethodPiwikUrl: valid URL, nothing to do | |
583 | */ | |
584 | public function testUpdatePiwikUrlNothingToDo() | |
585 | { | |
586 | $url = 'https://mypiwik.tld'; | |
587 | $this->conf->set('plugins.PIWIK_URL', $url); | |
588 | $updater = new Updater([], [], $this->conf, true); | |
589 | $this->assertTrue($updater->updateMethodPiwikUrl()); | |
590 | $this->assertEquals($url, $this->conf->get('plugins.PIWIK_URL')); | |
591 | } | |
592 | ||
593 | /** | |
594 | * Test updateMethodAtomDefault with show_atom set to false | |
595 | * => update to true. | |
596 | */ | |
597 | public function testUpdateMethodAtomDefault() | |
598 | { | |
599 | $sandboxConf = 'sandbox/config'; | |
600 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
601 | $this->conf = new ConfigManager($sandboxConf); | |
602 | $this->conf->set('feed.show_atom', false); | |
603 | $updater = new Updater([], [], $this->conf, true); | |
604 | $this->assertTrue($updater->updateMethodAtomDefault()); | |
605 | $this->assertTrue($this->conf->get('feed.show_atom')); | |
606 | // reload from file | |
607 | $this->conf = new ConfigManager($sandboxConf); | |
608 | $this->assertTrue($this->conf->get('feed.show_atom')); | |
609 | } | |
610 | /** | |
611 | * Test updateMethodAtomDefault with show_atom not set. | |
612 | * => nothing to do | |
613 | */ | |
614 | public function testUpdateMethodAtomDefaultNoExist() | |
615 | { | |
616 | $sandboxConf = 'sandbox/config'; | |
617 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
618 | $this->conf = new ConfigManager($sandboxConf); | |
619 | $updater = new Updater([], [], $this->conf, true); | |
620 | $this->assertTrue($updater->updateMethodAtomDefault()); | |
621 | $this->assertTrue($this->conf->get('feed.show_atom')); | |
622 | } | |
623 | /** | |
624 | * Test updateMethodAtomDefault with show_atom set to true. | |
625 | * => nothing to do | |
626 | */ | |
627 | public function testUpdateMethodAtomDefaultAlreadyTrue() | |
628 | { | |
629 | $sandboxConf = 'sandbox/config'; | |
630 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
631 | $this->conf = new ConfigManager($sandboxConf); | |
632 | $this->conf->set('feed.show_atom', true); | |
633 | $updater = new Updater([], [], $this->conf, true); | |
634 | $this->assertTrue($updater->updateMethodAtomDefault()); | |
635 | $this->assertTrue($this->conf->get('feed.show_atom')); | |
636 | } | |
637 | ||
638 | /** | |
639 | * Test updateMethodDownloadSizeAndTimeoutConf, it should be set if none is already defined. | |
640 | */ | |
641 | public function testUpdateMethodDownloadSizeAndTimeoutConf() | |
642 | { | |
643 | $sandboxConf = 'sandbox/config'; | |
644 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
645 | $this->conf = new ConfigManager($sandboxConf); | |
646 | $updater = new Updater([], [], $this->conf, true); | |
647 | $this->assertTrue($updater->updateMethodDownloadSizeAndTimeoutConf()); | |
648 | $this->assertEquals(4194304, $this->conf->get('general.download_max_size')); | |
649 | $this->assertEquals(30, $this->conf->get('general.download_timeout')); | |
650 | ||
651 | $this->conf = new ConfigManager($sandboxConf); | |
652 | $this->assertEquals(4194304, $this->conf->get('general.download_max_size')); | |
653 | $this->assertEquals(30, $this->conf->get('general.download_timeout')); | |
654 | } | |
655 | ||
656 | /** | |
657 | * Test updateMethodDownloadSizeAndTimeoutConf, it shouldn't be set if it is already defined. | |
658 | */ | |
659 | public function testUpdateMethodDownloadSizeAndTimeoutConfIgnore() | |
660 | { | |
661 | $sandboxConf = 'sandbox/config'; | |
662 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
663 | $this->conf = new ConfigManager($sandboxConf); | |
664 | $this->conf->set('general.download_max_size', 38); | |
665 | $this->conf->set('general.download_timeout', 70); | |
666 | $updater = new Updater([], [], $this->conf, true); | |
667 | $this->assertTrue($updater->updateMethodDownloadSizeAndTimeoutConf()); | |
668 | $this->assertEquals(38, $this->conf->get('general.download_max_size')); | |
669 | $this->assertEquals(70, $this->conf->get('general.download_timeout')); | |
670 | } | |
671 | ||
672 | /** | |
673 | * Test updateMethodDownloadSizeAndTimeoutConf, only the maz size should be set here. | |
674 | */ | |
675 | public function testUpdateMethodDownloadSizeAndTimeoutConfOnlySize() | |
676 | { | |
677 | $sandboxConf = 'sandbox/config'; | |
678 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
679 | $this->conf = new ConfigManager($sandboxConf); | |
680 | $this->conf->set('general.download_max_size', 38); | |
681 | $updater = new Updater([], [], $this->conf, true); | |
682 | $this->assertTrue($updater->updateMethodDownloadSizeAndTimeoutConf()); | |
683 | $this->assertEquals(38, $this->conf->get('general.download_max_size')); | |
684 | $this->assertEquals(30, $this->conf->get('general.download_timeout')); | |
685 | } | |
686 | ||
687 | /** | |
688 | * Test updateMethodDownloadSizeAndTimeoutConf, only the time out should be set here. | |
689 | */ | |
690 | public function testUpdateMethodDownloadSizeAndTimeoutConfOnlyTimeout() | |
691 | { | |
692 | $sandboxConf = 'sandbox/config'; | |
693 | copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); | |
694 | $this->conf = new ConfigManager($sandboxConf); | |
695 | $this->conf->set('general.download_timeout', 3); | |
696 | $updater = new Updater([], [], $this->conf, true); | |
697 | $this->assertTrue($updater->updateMethodDownloadSizeAndTimeoutConf()); | |
698 | $this->assertEquals(4194304, $this->conf->get('general.download_max_size')); | |
699 | $this->assertEquals(3, $this->conf->get('general.download_timeout')); | |
700 | } | |
701 | ||
702 | /** | |
703 | <<<<<<< HEAD | |
704 | * Test updateMethodWebThumbnailer with thumbnails enabled. | |
705 | */ | |
706 | public function testUpdateMethodWebThumbnailerEnabled() | |
707 | { | |
708 | $this->conf->remove('thumbnails'); | |
709 | $this->conf->set('thumbnail.enable_thumbnails', true); | |
710 | $updater = new Updater([], [], $this->conf, true, $_SESSION); | |
711 | $this->assertTrue($updater->updateMethodWebThumbnailer()); | |
712 | $this->assertFalse($this->conf->exists('thumbnail')); | |
713 | $this->assertEquals(\Shaarli\Thumbnailer::MODE_ALL, $this->conf->get('thumbnails.mode')); | |
714 | $this->assertEquals(125, $this->conf->get('thumbnails.width')); | |
715 | $this->assertEquals(90, $this->conf->get('thumbnails.height')); | |
716 | $this->assertContains('You have enabled or changed thumbnails', $_SESSION['warnings'][0]); | |
717 | } | |
718 | ||
719 | /** | |
720 | * Test updateMethodWebThumbnailer with thumbnails disabled. | |
721 | */ | |
722 | public function testUpdateMethodWebThumbnailerDisabled() | |
723 | { | |
724 | $this->conf->remove('thumbnails'); | |
725 | $this->conf->set('thumbnail.enable_thumbnails', false); | |
726 | $updater = new Updater([], [], $this->conf, true, $_SESSION); | |
727 | $this->assertTrue($updater->updateMethodWebThumbnailer()); | |
728 | $this->assertFalse($this->conf->exists('thumbnail')); | |
729 | $this->assertEquals(Thumbnailer::MODE_NONE, $this->conf->get('thumbnails.mode')); | |
730 | $this->assertEquals(125, $this->conf->get('thumbnails.width')); | |
731 | $this->assertEquals(90, $this->conf->get('thumbnails.height')); | |
732 | $this->assertTrue(empty($_SESSION['warnings'])); | |
733 | } | |
734 | ||
735 | /** | |
736 | * Test updateMethodWebThumbnailer with thumbnails disabled. | |
737 | */ | |
738 | public function testUpdateMethodWebThumbnailerNothingToDo() | |
739 | { | |
740 | $updater = new Updater([], [], $this->conf, true, $_SESSION); | |
741 | $this->assertTrue($updater->updateMethodWebThumbnailer()); | |
742 | $this->assertFalse($this->conf->exists('thumbnail')); | |
743 | $this->assertEquals(Thumbnailer::MODE_COMMON, $this->conf->get('thumbnails.mode')); | |
744 | $this->assertEquals(90, $this->conf->get('thumbnails.width')); | |
745 | $this->assertEquals(53, $this->conf->get('thumbnails.height')); | |
746 | $this->assertTrue(empty($_SESSION['warnings'])); | |
747 | } | |
748 | ||
749 | /** | |
750 | * Test updateMethodSetSticky(). | |
751 | */ | |
752 | public function testUpdateStickyValid() | |
753 | { | |
754 | $blank = [ | |
755 | 'id' => 1, | |
756 | 'url' => 'z', | |
757 | 'title' => '', | |
758 | 'description' => '', | |
759 | 'tags' => '', | |
760 | 'created' => new DateTime(), | |
761 | ]; | |
762 | $links = [ | |
763 | 1 => ['id' => 1] + $blank, | |
764 | 2 => ['id' => 2] + $blank, | |
765 | ]; | |
766 | $refDB = new ReferenceLinkDB(); | |
767 | $refDB->setLinks($links); | |
768 | $refDB->write(self::$testDatastore); | |
769 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
770 | ||
771 | $updater = new Updater(array(), $linkDB, $this->conf, true); | |
772 | $this->assertTrue($updater->updateMethodSetSticky()); | |
773 | ||
774 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
775 | foreach ($linkDB as $link) { | |
776 | $this->assertFalse($link['sticky']); | |
777 | } | |
778 | } | |
779 | ||
780 | /** | |
781 | * Test updateMethodSetSticky(). | |
782 | */ | |
783 | public function testUpdateStickyNothingToDo() | |
784 | { | |
785 | $blank = [ | |
786 | 'id' => 1, | |
787 | 'url' => 'z', | |
788 | 'title' => '', | |
789 | 'description' => '', | |
790 | 'tags' => '', | |
791 | 'created' => new DateTime(), | |
792 | ]; | |
793 | $links = [ | |
794 | 1 => ['id' => 1, 'sticky' => true] + $blank, | |
795 | 2 => ['id' => 2] + $blank, | |
796 | ]; | |
797 | $refDB = new ReferenceLinkDB(); | |
798 | $refDB->setLinks($links); | |
799 | $refDB->write(self::$testDatastore); | |
800 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
801 | ||
802 | $updater = new Updater(array(), $linkDB, $this->conf, true); | |
803 | $this->assertTrue($updater->updateMethodSetSticky()); | |
804 | ||
805 | $linkDB = new LinkDB(self::$testDatastore, true, false); | |
806 | $this->assertTrue($linkDB[1]['sticky']); | |
807 | } | |
808 | } |