Introduce a configuration manager (not plugged yet)

4 files changed, 265 insertions, 0 deletions

diff --git a/tests/config/ConfigManagerTest.php b/tests/config/ConfigManagerTest.php
new file mode 100644
index 00000000..1b6358f3
--- /dev/null
+++ b/tests/config/ConfigManagerTest.php
@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * Unit tests for Class ConfigManagerTest
+ *
+ * Note: it only test the manager with ConfigJson,
+ *  ConfigPhp is only a workaround to handle the transition to JSON type.
+ */
+class ConfigManagerTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var ConfigManager
+     */
+    protected $conf;
+
+    public function setUp()
+    {
+        ConfigManager::$CONFIG_FILE = 'tests/config/config';
+        $this->conf = ConfigManager::getInstance();
+    }
+
+    public function tearDown()
+    {
+        @unlink($this->conf->getConfigFile());
+    }
+
+    public function testSetWriteGet()
+    {
+        // This won't work with ConfigPhp.
+        $this->markTestIncomplete();
+
+        $this->conf->set('paramInt', 42);
+        $this->conf->set('paramString', 'value1');
+        $this->conf->set('paramBool', false);
+        $this->conf->set('paramArray', array('foo' => 'bar'));
+        $this->conf->set('paramNull', null);
+
+        $this->conf->write(true);
+        $this->conf->reload();
+
+        $this->assertEquals(42, $this->conf->get('paramInt'));
+        $this->assertEquals('value1', $this->conf->get('paramString'));
+        $this->assertFalse($this->conf->get('paramBool'));
+        $this->assertEquals(array('foo' => 'bar'), $this->conf->get('paramArray'));
+        $this->assertEquals(null, $this->conf->get('paramNull'));
+    }
+    
+}
\ No newline at end of file
diff --git a/tests/config/ConfigPhpTest.php b/tests/config/ConfigPhpTest.php
new file mode 100644
index 00000000..0f849bd5
--- /dev/null
+++ b/tests/config/ConfigPhpTest.php
@@ -0,0 +1,82 @@
+<?php
+
+require_once 'application/config/ConfigPhp.php';
+
+/**
+ * Class ConfigPhpTest
+ */
+class ConfigPhpTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @var ConfigPhp
+     */
+    protected $configIO;
+
+    public function setUp()
+    {
+        $this->configIO = new ConfigPhp();
+    }
+
+    /**
+     * Read a simple existing config file.
+     */
+    public function testRead()
+    {
+        $conf = $this->configIO->read('tests/config/php/configOK');
+        $this->assertEquals('root', $conf['login']);
+        $this->assertEquals('lala', $conf['redirector']);
+        $this->assertEquals('data/datastore.php', $conf['config']['DATASTORE']);
+        $this->assertEquals('1', $conf['plugins']['WALLABAG_VERSION']);
+    }
+
+    /**
+     * Read a non existent config file -> empty array.
+     */
+    public function testReadNonExistent()
+    {
+        $this->assertEquals(array(), $this->configIO->read('nope'));
+    }
+
+    /**
+     * Write a new config file.
+     */
+    public function testWriteNew()
+    {
+        $dataFile = 'tests/config/php/configWrite';
+        $data = array(
+            'login' => 'root',
+            'redirector' => 'lala',
+            'config' => array(
+                'DATASTORE' => 'data/datastore.php',
+            ),
+            'plugins' => array(
+                'WALLABAG_VERSION' => '1',
+            )
+        );
+        $this->configIO->write($dataFile, $data);
+        $expected = '<?php 
+$GLOBALS[\'login\'] = \'root\';
+$GLOBALS[\'redirector\'] = \'lala\';
+$GLOBALS[\'config\'][\'DATASTORE\'] = \'data/datastore.php\';
+$GLOBALS[\'plugins\'][\'WALLABAG_VERSION\'] = \'1\';
+';
+        $this->assertEquals($expected, file_get_contents($dataFile .'.php'));
+        unlink($dataFile .'.php');
+    }
+
+    /**
+     * Overwrite an existing setting.
+     */
+    public function testOverwrite()
+    {
+        $source = 'tests/config/php/configOK.php';
+        $dest = 'tests/config/php/configOverwrite';
+        copy($source, $dest . '.php');
+        $conf = $this->configIO->read($dest);
+        $conf['redirector'] = 'blabla';
+        $this->configIO->write($dest, $conf);
+        $conf = $this->configIO->read($dest);
+        $this->assertEquals('blabla', $conf['redirector']);
+        unlink($dest .'.php');
+    }
+}
diff --git a/tests/config/ConfigPluginTest.php b/tests/config/ConfigPluginTest.php
new file mode 100644
index 00000000..716631b0
--- /dev/null
+++ b/tests/config/ConfigPluginTest.php
@@ -0,0 +1,121 @@
+<?php
+/**
+ * Config' tests
+ */
+
+require_once 'application/config/ConfigPlugin.php';
+
+/**
+ * Unitary tests for Shaarli config related functions
+ */
+class ConfigPluginTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * Test save_plugin_config with valid data.
+     *
+     * @throws PluginConfigOrderException
+     */
+    public function testSavePluginConfigValid()
+    {
+        $data = array(
+            'order_plugin1' => 2,   // no plugin related
+            'plugin2' => 0,         // new - at the end
+            'plugin3' => 0,         // 2nd
+            'order_plugin3' => 8,
+            'plugin4' => 0,         // 1st
+            'order_plugin4' => 5,
+        );
+
+        $expected = array(
+            'plugin3',
+            'plugin4',
+            'plugin2',
+        );
+
+        $out = save_plugin_config($data);
+        $this->assertEquals($expected, $out);
+    }
+
+    /**
+     * Test save_plugin_config with invalid data.
+     *
+     * @expectedException              PluginConfigOrderException
+     */
+    public function testSavePluginConfigInvalid()
+    {
+        $data = array(
+            'plugin2' => 0,
+            'plugin3' => 0,
+            'order_plugin3' => 0,
+            'plugin4' => 0,
+            'order_plugin4' => 0,
+        );
+
+        save_plugin_config($data);
+    }
+
+    /**
+     * Test save_plugin_config without data.
+     */
+    public function testSavePluginConfigEmpty()
+    {
+        $this->assertEquals(array(), save_plugin_config(array()));
+    }
+
+    /**
+     * Test validate_plugin_order with valid data.
+     */
+    public function testValidatePluginOrderValid()
+    {
+        $data = array(
+            'order_plugin1' => 2,
+            'plugin2' => 0,
+            'plugin3' => 0,
+            'order_plugin3' => 1,
+            'plugin4' => 0,
+            'order_plugin4' => 5,
+        );
+
+        $this->assertTrue(validate_plugin_order($data));
+    }
+
+    /**
+     * Test validate_plugin_order with invalid data.
+     */
+    public function testValidatePluginOrderInvalid()
+    {
+        $data = array(
+            'order_plugin1' => 2,
+            'order_plugin3' => 1,
+            'order_plugin4' => 1,
+        );
+
+        $this->assertFalse(validate_plugin_order($data));
+    }
+
+    /**
+     * Test load_plugin_parameter_values.
+     */
+    public function testLoadPluginParameterValues()
+    {
+        $plugins = array(
+            'plugin_name' => array(
+                'parameters' => array(
+                    'param1' => true,
+                    'param2' => false,
+                    'param3' => '',
+                )
+            )
+        );
+
+        $parameters = array(
+            'param1' => 'value1',
+            'param2' => 'value2',
+        );
+
+        $result = load_plugin_parameter_values($plugins, $parameters);
+        $this->assertEquals('value1', $result['plugin_name']['parameters']['param1']);
+        $this->assertEquals('value2', $result['plugin_name']['parameters']['param2']);
+        $this->assertEquals('', $result['plugin_name']['parameters']['param3']);
+    }
+}
diff --git a/tests/config/php/configOK.php b/tests/config/php/configOK.php
new file mode 100644
index 00000000..b91ad293
--- /dev/null
+++ b/tests/config/php/configOK.php
@@ -0,0 +1,14 @@
+<?php
+$GLOBALS['login'] = 'root';
+$GLOBALS['hash'] = 'hash';
+$GLOBALS['salt'] = 'salt';
+$GLOBALS['timezone'] = 'Europe/Paris';
+$GLOBALS['title'] = 'BIGBANG';
+$GLOBALS['titleLink'] = '?';
+$GLOBALS['redirector'] = 'lala';
+$GLOBALS['disablesessionprotection'] = false;
+$GLOBALS['privateLinkByDefault'] = true;
+$GLOBALS['config']['DATADIR'] = 'data';
+$GLOBALS['config']['DATASTORE'] = 'data/datastore.php';
+$GLOBALS['plugins']['WALLABAG_URL'] = 'ghf';
+$GLOBALS['plugins']['WALLABAG_VERSION'] = '1';
\ No newline at end of file