tests/config/ConfigManagerTest.php

   1 <?php
   2 namespace Shaarli\Config;
   3
   4 /**
   5  * Unit tests for Class ConfigManagerTest
   6  *
   7  * Note: it only test the manager with ConfigJson,
   8  *  ConfigPhp is only a workaround to handle the transition to JSON type.
   9  */
  10 class ConfigManagerTest extends \PHPUnit_Framework_TestCase
  11 {
  12     /**
  13      * @var ConfigManager
  14      */
  15     protected $conf;
  16
  17     public function setUp()
  18     {
  19         $this->conf = new ConfigManager('tests/utils/config/configJson');
  20     }
  21
  22     /**
  23      * Simple config test:
  24      *   1. Set settings.
  25      *   2. Check settings value.
  26      */
  27     public function testSetGet()
  28     {
  29         $this->conf->set('paramInt', 42);
  30         $this->conf->set('paramString', 'value1');
  31         $this->conf->set('paramBool', false);
  32         $this->conf->set('paramArray', array('foo' => 'bar'));
  33         $this->conf->set('paramNull', null);
  34
  35         $this->assertEquals(42, $this->conf->get('paramInt'));
  36         $this->assertEquals('value1', $this->conf->get('paramString'));
  37         $this->assertFalse($this->conf->get('paramBool'));
  38         $this->assertEquals(array('foo' => 'bar'), $this->conf->get('paramArray'));
  39         $this->assertEquals(null, $this->conf->get('paramNull'));
  40     }
  41
  42     /**
  43      * Set/write/get config test:
  44      *   1. Set settings.
  45      *   2. Write it to the config file.
  46      *   3. Read the file.
  47      *   4. Check settings value.
  48      */
  49     public function testSetWriteGet()
  50     {
  51         $this->conf->set('paramInt', 42);
  52         $this->conf->set('paramString', 'value1');
  53         $this->conf->set('paramBool', false);
  54         $this->conf->set('paramArray', array('foo' => 'bar'));
  55         $this->conf->set('paramNull', null);
  56
  57         $this->conf->setConfigFile('tests/utils/config/configTmp');
  58         $this->conf->write(true);
  59         $this->conf->reload();
  60         unlink($this->conf->getConfigFileExt());
  61
  62         $this->assertEquals(42, $this->conf->get('paramInt'));
  63         $this->assertEquals('value1', $this->conf->get('paramString'));
  64         $this->assertFalse($this->conf->get('paramBool'));
  65         $this->assertEquals(array('foo' => 'bar'), $this->conf->get('paramArray'));
  66         $this->assertEquals(null, $this->conf->get('paramNull'));
  67     }
  68
  69     /**
  70      * Test set/write/get with nested keys.
  71      */
  72     public function testSetWriteGetNested()
  73     {
  74         $this->conf->set('foo.bar.key.stuff', 'testSetWriteGetNested');
  75
  76         $this->conf->setConfigFile('tests/utils/config/configTmp');
  77         $this->conf->write(true);
  78         $this->conf->reload();
  79         unlink($this->conf->getConfigFileExt());
  80
  81         $this->assertEquals('testSetWriteGetNested', $this->conf->get('foo.bar.key.stuff'));
  82     }
  83
  84     /**
  85      * Set with an empty key.
  86      *
  87      * @expectedException \Exception
  88      * @expectedExceptionMessageRegExp #^Invalid setting key parameter. String expected, got.*#
  89      */
  90     public function testSetEmptyKey()
  91     {
  92         $this->conf->set('', 'stuff');
  93     }
  94
  95     /**
  96      * Set with an array key.
  97      *
  98      * @expectedException \Exception
  99      * @expectedExceptionMessageRegExp #^Invalid setting key parameter. String expected, got.*#
 100      */
 101     public function testSetArrayKey()
 102     {
 103         $this->conf->set(array('foo' => 'bar'), 'stuff');
 104     }
 105
 106     /**
 107      * Try to write the config without mandatory parameter (e.g. 'login').
 108      *
 109      * @expectedException Shaarli\Config\Exception\MissingFieldConfigException
 110      */
 111     public function testWriteMissingParameter()
 112     {
 113         $this->conf->setConfigFile('tests/utils/config/configTmp');
 114         $this->assertFalse(file_exists($this->conf->getConfigFileExt()));
 115         $this->conf->reload();
 116
 117         $this->conf->write(true);
 118     }
 119
 120     /**
 121      * Try to get non existent config keys.
 122      */
 123     public function testGetNonExistent()
 124     {
 125         $this->assertEquals('', $this->conf->get('nope.test'));
 126         $this->assertEquals('default', $this->conf->get('nope.test', 'default'));
 127     }
 128
 129     /**
 130      * Test the 'exists' method with existent values.
 131      */
 132     public function testExistsOk()
 133     {
 134         $this->assertTrue($this->conf->exists('credentials.login'));
 135         $this->assertTrue($this->conf->exists('config.foo'));
 136     }
 137
 138     /**
 139      * Test the 'exists' method with non existent or invalid values.
 140      */
 141     public function testExistsKo()
 142     {
 143         $this->assertFalse($this->conf->exists('nope'));
 144         $this->assertFalse($this->conf->exists('nope.nope'));
 145         $this->assertFalse($this->conf->exists(''));
 146         $this->assertFalse($this->conf->exists(false));
 147     }
 148
 149     /**
 150      * Reset the ConfigManager instance.
 151      */
 152     public function testReset()
 153     {
 154         $confIO = $this->conf->getConfigIO();
 155         $this->conf->reset();
 156         $this->assertFalse($confIO === $this->conf->getConfigIO());
 157     }
 158
 159     /**
 160      * Reload the config from file.
 161      */
 162     public function testReload()
 163     {
 164         $this->conf->setConfigFile('tests/utils/config/configTmp');
 165         $newConf = ConfigJson::getPhpHeaders() . '{ "key": "value" }';
 166         file_put_contents($this->conf->getConfigFileExt(), $newConf);
 167         $this->conf->reload();
 168         unlink($this->conf->getConfigFileExt());
 169         // Previous conf no longer exists, and new values have been loaded.
 170         $this->assertFalse($this->conf->exists('credentials.login'));
 171         $this->assertEquals('value', $this->conf->get('key'));
 172     }
 173 }