tests/ConfigTest.php

   1 <?php
   2 /**
   3  * Config' tests
   4  */
   5
   6 require_once 'application/Config.php';
   7
   8 /**
   9  * Unitary tests for Shaarli config related functions
  10  */
  11 class ConfigTest extends PHPUnit_Framework_TestCase
  12 {
  13     // Configuration input set.
  14     private static $_configFields;
  15
  16     /**
  17      * Executed before each test.
  18      */
  19     public function setUp()
  20     {
  21         self::$_configFields = [
  22             'login' => 'login',
  23             'hash' => 'hash',
  24             'salt' => 'salt',
  25             'timezone' => 'Europe/Paris',
  26             'title' => 'title',
  27             'titleLink' => 'titleLink',
  28             'redirector' => '',
  29             'disablesessionprotection' => false,
  30             'privateLinkByDefault' => false,
  31             'config' => [
  32                 'CONFIG_FILE' => 'tests/config.php',
  33                 'DATADIR' => 'tests',
  34                 'config1' => 'config1data',
  35                 'config2' => 'config2data',
  36             ]
  37         ];
  38     }
  39
  40     /**
  41      * Executed after each test.
  42      *
  43      * @return void
  44      */
  45     public function tearDown()
  46     {
  47         if (is_file(self::$_configFields['config']['CONFIG_FILE'])) {
  48             unlink(self::$_configFields['config']['CONFIG_FILE']);
  49         }
  50     }
  51
  52     /**
  53      * Test writeConfig function, valid use case, while being logged in.
  54      */
  55     public function testWriteConfig()
  56     {
  57         writeConfig(self::$_configFields, true);
  58
  59         include self::$_configFields['config']['CONFIG_FILE'];
  60         $this->assertEquals(self::$_configFields['login'], $GLOBALS['login']);
  61         $this->assertEquals(self::$_configFields['hash'], $GLOBALS['hash']);
  62         $this->assertEquals(self::$_configFields['salt'], $GLOBALS['salt']);
  63         $this->assertEquals(self::$_configFields['timezone'], $GLOBALS['timezone']);
  64         $this->assertEquals(self::$_configFields['title'], $GLOBALS['title']);
  65         $this->assertEquals(self::$_configFields['titleLink'], $GLOBALS['titleLink']);
  66         $this->assertEquals(self::$_configFields['redirector'], $GLOBALS['redirector']);
  67         $this->assertEquals(self::$_configFields['disablesessionprotection'], $GLOBALS['disablesessionprotection']);
  68         $this->assertEquals(self::$_configFields['privateLinkByDefault'], $GLOBALS['privateLinkByDefault']);
  69         $this->assertEquals(self::$_configFields['config']['config1'], $GLOBALS['config']['config1']);
  70         $this->assertEquals(self::$_configFields['config']['config2'], $GLOBALS['config']['config2']);
  71     }
  72
  73     /**
  74      * Test writeConfig option while logged in:
  75      *      1. init fields.
  76      *      2. update fields, add new sub config, add new root config.
  77      *      3. rewrite config.
  78      *      4. check result.
  79      */
  80     public function testWriteConfigFieldUpdate()
  81     {
  82         writeConfig(self::$_configFields, true);
  83         self::$_configFields['title'] = 'ok';
  84         self::$_configFields['config']['config1'] = 'ok';
  85         self::$_configFields['config']['config_new'] = 'ok';
  86         self::$_configFields['new'] = 'should not be saved';
  87         writeConfig(self::$_configFields, true);
  88
  89         include self::$_configFields['config']['CONFIG_FILE'];
  90         $this->assertEquals('ok', $GLOBALS['title']);
  91         $this->assertEquals('ok', $GLOBALS['config']['config1']);
  92         $this->assertEquals('ok', $GLOBALS['config']['config_new']);
  93         $this->assertFalse(isset($GLOBALS['new']));
  94     }
  95
  96     /**
  97      * Test writeConfig function with an empty array.
  98      *
  99      * @expectedException MissingFieldConfigException
 100      */
 101     public function testWriteConfigEmpty()
 102     {
 103         writeConfig(array(), true);
 104     }
 105
 106     /**
 107      * Test writeConfig function with a missing mandatory field.
 108      *
 109      * @expectedException MissingFieldConfigException
 110      */
 111     public function testWriteConfigMissingField()
 112     {
 113         unset(self::$_configFields['login']);
 114         writeConfig(self::$_configFields, true);
 115     }
 116
 117     /**
 118      * Test writeConfig function while being logged out, and there is no config file existing.
 119      */
 120     public function testWriteConfigLoggedOutNoFile()
 121     {
 122         writeConfig(self::$_configFields, false);
 123     }
 124
 125     /**
 126      * Test writeConfig function while being logged out, and a config file already exists.
 127      *
 128      * @expectedException UnauthorizedConfigException
 129      */
 130     public function testWriteConfigLoggedOutWithFile()
 131     {
 132         file_put_contents(self::$_configFields['config']['CONFIG_FILE'], '');
 133         writeConfig(self::$_configFields, false);
 134     }
 135
 136     /**
 137      * Test mergeDeprecatedConfig while being logged in:
 138      *      1. init a config file.
 139      *      2. init a options.php file with update value.
 140      *      3. merge.
 141      *      4. check updated value in config file.
 142      */
 143     public function testMergeDeprecatedConfig()
 144     {
 145         // init
 146         writeConfig(self::$_configFields, true);
 147         $configCopy = self::$_configFields;
 148         $invert = !$configCopy['privateLinkByDefault'];
 149         $configCopy['privateLinkByDefault'] = $invert;
 150
 151         // Use writeConfig to create a options.php
 152         $configCopy['config']['CONFIG_FILE'] = 'tests/options.php';
 153         writeConfig($configCopy, true);
 154
 155         $this->assertTrue(is_file($configCopy['config']['CONFIG_FILE']));
 156
 157         // merge configs
 158         mergeDeprecatedConfig(self::$_configFields, true);
 159
 160         // make sure updated field is changed
 161         include self::$_configFields['config']['CONFIG_FILE'];
 162         $this->assertEquals($invert, $GLOBALS['privateLinkByDefault']);
 163         $this->assertFalse(is_file($configCopy['config']['CONFIG_FILE']));
 164     }
 165
 166     /**
 167      * Test mergeDeprecatedConfig while being logged in without options file.
 168      */
 169     public function testMergeDeprecatedConfigNoFile()
 170     {
 171         writeConfig(self::$_configFields, true);
 172         mergeDeprecatedConfig(self::$_configFields, true);
 173
 174         include self::$_configFields['config']['CONFIG_FILE'];
 175         $this->assertEquals(self::$_configFields['login'], $GLOBALS['login']);
 176     }
 177 }