123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- <?php
- require_once 'application/config/ConfigManager.php';
- require_once 'tests/Updater/DummyUpdater.php';
- /**
- * Class UpdaterTest.
- * Runs unit tests against the Updater class.
- */
- class UpdaterTest extends PHPUnit_Framework_TestCase
- {
- /**
- * @var string Path to test datastore.
- */
- protected static $testDatastore = 'sandbox/datastore.php';
- /**
- * @var string Config file path (without extension).
- */
- protected static $configFile = 'tests/utils/config/configJson';
- /**
- * @var ConfigManager
- */
- protected $conf;
- /**
- * Executed before each test.
- */
- public function setUp()
- {
- $this->conf = new ConfigManager(self::$configFile);
- }
- /**
- * Test read_updates_file with an empty/missing file.
- */
- public function testReadEmptyUpdatesFile()
- {
- $this->assertEquals(array(), read_updates_file(''));
- $updatesFile = $this->conf->get('resource.data_dir') . '/updates.txt';
- touch($updatesFile);
- $this->assertEquals(array(), read_updates_file($updatesFile));
- unlink($updatesFile);
- }
- /**
- * Test read/write updates file.
- */
- public function testReadWriteUpdatesFile()
- {
- $updatesFile = $this->conf->get('resource.data_dir') . '/updates.txt';
- $updatesMethods = array('m1', 'm2', 'm3');
- write_updates_file($updatesFile, $updatesMethods);
- $readMethods = read_updates_file($updatesFile);
- $this->assertEquals($readMethods, $updatesMethods);
- // Update
- $updatesMethods[] = 'm4';
- write_updates_file($updatesFile, $updatesMethods);
- $readMethods = read_updates_file($updatesFile);
- $this->assertEquals($readMethods, $updatesMethods);
- unlink($updatesFile);
- }
- /**
- * Test errors in write_updates_file(): empty updates file.
- *
- * @expectedException Exception
- * @expectedExceptionMessageRegExp /Updates file path is not set(.*)/
- */
- public function testWriteEmptyUpdatesFile()
- {
- write_updates_file('', array('test'));
- }
- /**
- * Test errors in write_updates_file(): not writable updates file.
- *
- * @expectedException Exception
- * @expectedExceptionMessageRegExp /Unable to write(.*)/
- */
- public function testWriteUpdatesFileNotWritable()
- {
- $updatesFile = $this->conf->get('resource.data_dir') . '/updates.txt';
- touch($updatesFile);
- chmod($updatesFile, 0444);
- try {
- @write_updates_file($updatesFile, array('test'));
- } catch (Exception $e) {
- unlink($updatesFile);
- throw $e;
- }
- }
- /**
- * Test the update() method, with no update to run.
- * 1. Everything already run.
- * 2. User is logged out.
- */
- public function testNoUpdates()
- {
- $updates = array(
- 'updateMethodDummy1',
- 'updateMethodDummy2',
- 'updateMethodDummy3',
- 'updateMethodException',
- );
- $updater = new DummyUpdater($updates, array(), $this->conf, true);
- $this->assertEquals(array(), $updater->update());
- $updater = new DummyUpdater(array(), array(), $this->conf, false);
- $this->assertEquals(array(), $updater->update());
- }
- /**
- * Test the update() method, with all updates to run (except the failing one).
- */
- public function testUpdatesFirstTime()
- {
- $updates = array('updateMethodException',);
- $expectedUpdates = array(
- 'updateMethodDummy1',
- 'updateMethodDummy2',
- 'updateMethodDummy3',
- );
- $updater = new DummyUpdater($updates, array(), $this->conf, true);
- $this->assertEquals($expectedUpdates, $updater->update());
- }
- /**
- * Test the update() method, only one update to run.
- */
- public function testOneUpdate()
- {
- $updates = array(
- 'updateMethodDummy1',
- 'updateMethodDummy3',
- 'updateMethodException',
- );
- $expectedUpdate = array('updateMethodDummy2');
- $updater = new DummyUpdater($updates, array(), $this->conf, true);
- $this->assertEquals($expectedUpdate, $updater->update());
- }
- /**
- * Test Update failed.
- *
- * @expectedException UpdaterException
- */
- public function testUpdateFailed()
- {
- $updates = array(
- 'updateMethodDummy1',
- 'updateMethodDummy2',
- 'updateMethodDummy3',
- );
- $updater = new DummyUpdater($updates, array(), $this->conf, true);
- $updater->update();
- }
- /**
- * Test update mergeDeprecatedConfig:
- * 1. init a config file.
- * 2. init a options.php file with update value.
- * 3. merge.
- * 4. check updated value in config file.
- */
- public function testUpdateMergeDeprecatedConfig()
- {
- $this->conf->setConfigFile('tests/utils/config/configPhp');
- $this->conf->reset();
- $optionsFile = 'tests/Updater/options.php';
- $options = '<?php
- $GLOBALS[\'privateLinkByDefault\'] = true;';
- file_put_contents($optionsFile, $options);
- // tmp config file.
- $this->conf->setConfigFile('tests/Updater/config');
- // merge configs
- $updater = new Updater(array(), array(), $this->conf, true);
- // This writes a new config file in tests/Updater/config.php
- $updater->updateMethodMergeDeprecatedConfigFile();
- // make sure updated field is changed
- $this->conf->reload();
- $this->assertTrue($this->conf->get('privacy.default_private_links'));
- $this->assertFalse(is_file($optionsFile));
- // Delete the generated file.
- unlink($this->conf->getConfigFileExt());
- }
- /**
- * Test mergeDeprecatedConfig in without options file.
- */
- public function testMergeDeprecatedConfigNoFile()
- {
- $updater = new Updater(array(), array(), $this->conf, true);
- $updater->updateMethodMergeDeprecatedConfigFile();
- $this->assertEquals('root', $this->conf->get('credentials.login'));
- }
- /**
- * Test renameDashTags update method.
- */
- public function testRenameDashTags()
- {
- $refDB = new ReferenceLinkDB();
- $refDB->write(self::$testDatastore);
- $linkDB = new LinkDB(self::$testDatastore, true, false);
- $this->assertEmpty($linkDB->filterSearch(array('searchtags' => 'exclude')));
- $updater = new Updater(array(), $linkDB, $this->conf, true);
- $updater->updateMethodRenameDashTags();
- $this->assertNotEmpty($linkDB->filterSearch(array('searchtags' => 'exclude')));
- }
- /**
- * Convert old PHP config file to JSON config.
- */
- public function testConfigToJson()
- {
- $configFile = 'tests/utils/config/configPhp';
- $this->conf->setConfigFile($configFile);
- $this->conf->reset();
- // The ConfigIO is initialized with ConfigPhp.
- $this->assertTrue($this->conf->getConfigIO() instanceof ConfigPhp);
- $updater = new Updater(array(), array(), $this->conf, false);
- $done = $updater->updateMethodConfigToJson();
- $this->assertTrue($done);
- // The ConfigIO has been updated to ConfigJson.
- $this->assertTrue($this->conf->getConfigIO() instanceof ConfigJson);
- $this->assertTrue(file_exists($this->conf->getConfigFileExt()));
- // Check JSON config data.
- $this->conf->reload();
- $this->assertEquals('root', $this->conf->get('credentials.login'));
- $this->assertEquals('lala', $this->conf->get('redirector.url'));
- $this->assertEquals('data/datastore.php', $this->conf->get('resource.datastore'));
- $this->assertEquals('1', $this->conf->get('plugins.WALLABAG_VERSION'));
- rename($configFile . '.save.php', $configFile . '.php');
- unlink($this->conf->getConfigFileExt());
- }
- /**
- * Launch config conversion update with an existing JSON file => nothing to do.
- */
- public function testConfigToJsonNothingToDo()
- {
- $filetime = filemtime($this->conf->getConfigFileExt());
- $updater = new Updater(array(), array(), $this->conf, false);
- $done = $updater->updateMethodConfigToJson();
- $this->assertTrue($done);
- $expected = filemtime($this->conf->getConfigFileExt());
- $this->assertEquals($expected, $filetime);
- }
- /**
- * Test escapeUnescapedConfig with valid data.
- */
- public function testEscapeConfig()
- {
- $sandbox = 'sandbox/config';
- copy(self::$configFile .'.json.php', $sandbox .'.json.php');
- $this->conf = new ConfigManager($sandbox);
- $title = '<script>alert("title");</script>';
- $headerLink = '<script>alert("header_link");</script>';
- $redirectorUrl = '<script>alert("redirector");</script>';
- $this->conf->set('general.title', $title);
- $this->conf->set('general.header_link', $headerLink);
- $this->conf->set('redirector.url', $redirectorUrl);
- $updater = new Updater(array(), array(), $this->conf, true);
- $done = $updater->updateMethodEscapeUnescapedConfig();
- $this->assertTrue($done);
- $this->conf->reload();
- $this->assertEquals(escape($title), $this->conf->get('general.title'));
- $this->assertEquals(escape($headerLink), $this->conf->get('general.header_link'));
- $this->assertEquals(escape($redirectorUrl), $this->conf->get('redirector.url'));
- unlink($sandbox .'.json.php');
- }
- }
|