tests/HTMLPurifier/DefinitionCache/SerializerTest.php

   1 <?php
   2
   3 class HTMLPurifier_DefinitionCache_SerializerTest extends HTMLPurifier_DefinitionCacheHarness
   4 {
   5
   6     function test() {
   7
   8         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
   9
  10         $config = $this->generateConfigMock('serial');
  11         $config->setReturnValue('get', 2, array('Test.DefinitionRev'));
  12         $config->version = '1.0.0';
  13
  14         $config_md5   = '1.0.0,serial,2';
  15
  16         $file = realpath(
  17             $rel_file = HTMLPURIFIER_PREFIX . '/HTMLPurifier/DefinitionCache/Serializer/Test/' .
  18             $config_md5 . '.ser'
  19         );
  20         if($file && file_exists($file)) unlink($file); // prevent previous failures from causing problems
  21
  22         $this->assertIdentical($config_md5, $cache->generateKey($config));
  23
  24         $def_original = $this->generateDefinition();
  25
  26         $cache->add($def_original, $config);
  27         $this->assertFileExist($rel_file);
  28
  29         $file_generated = $cache->generateFilePath($config);
  30         $this->assertIdentical(realpath($rel_file), realpath($file_generated));
  31
  32         $def_1 = $cache->get($config);
  33         $this->assertIdentical($def_original, $def_1);
  34
  35         $def_original->info_random = 'changed';
  36
  37         $cache->set($def_original, $config);
  38         $def_2 = $cache->get($config);
  39
  40         $this->assertIdentical($def_original, $def_2);
  41         $this->assertNotEqual ($def_original, $def_1);
  42
  43         $def_original->info_random = 'did it change?';
  44
  45         $this->assertFalse($cache->add($def_original, $config));
  46         $def_3 = $cache->get($config);
  47
  48         $this->assertNotEqual ($def_original, $def_3); // did not change!
  49         $this->assertIdentical($def_3, $def_2);
  50
  51         $cache->replace($def_original, $config);
  52         $def_4 = $cache->get($config);
  53         $this->assertIdentical($def_original, $def_4);
  54
  55         $cache->remove($config);
  56         $this->assertFileNotExist($file);
  57
  58         $this->assertFalse($cache->replace($def_original, $config));
  59         $def_5 = $cache->get($config);
  60         $this->assertFalse($def_5);
  61
  62     }
  63
  64     function test_errors() {
  65         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
  66         $def = $this->generateDefinition();
  67         $def->setup = true;
  68         $def->type = 'NotTest';
  69         $config = $this->generateConfigMock('testfoo');
  70
  71         $this->expectError('Cannot use definition of type NotTest in cache for Test');
  72         $cache->add($def, $config);
  73
  74         $this->expectError('Cannot use definition of type NotTest in cache for Test');
  75         $cache->set($def, $config);
  76
  77         $this->expectError('Cannot use definition of type NotTest in cache for Test');
  78         $cache->replace($def, $config);
  79     }
  80
  81     function test_flush() {
  82
  83         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
  84
  85         $config1 = $this->generateConfigMock('test1');
  86         $config2 = $this->generateConfigMock('test2');
  87         $config3 = $this->generateConfigMock('test3');
  88
  89         $def1 = $this->generateDefinition(array('info_candles' => 1));
  90         $def2 = $this->generateDefinition(array('info_candles' => 2));
  91         $def3 = $this->generateDefinition(array('info_candles' => 3));
  92
  93         $cache->add($def1, $config1);
  94         $cache->add($def2, $config2);
  95         $cache->add($def3, $config3);
  96
  97         $this->assertEqual($def1, $cache->get($config1));
  98         $this->assertEqual($def2, $cache->get($config2));
  99         $this->assertEqual($def3, $cache->get($config3));
 100
 101         $cache->flush($config1); // only essential directive is %Cache.SerializerPath
 102
 103         $this->assertFalse($cache->get($config1));
 104         $this->assertFalse($cache->get($config2));
 105         $this->assertFalse($cache->get($config3));
 106
 107     }
 108
 109     function testCleanup() {
 110
 111         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
 112
 113         // in order of age, oldest first
 114         // note that configurations are all identical, but version/revision
 115         // are different
 116
 117         $config1 = $this->generateConfigMock();
 118         $config1->version = '0.9.0';
 119         $config1->setReturnValue('get', 574, array('Test.DefinitionRev'));
 120         $def1 = $this->generateDefinition(array('info' => 1));
 121
 122         $config2 = $this->generateConfigMock();
 123         $config2->version = '1.0.0beta';
 124         $config2->setReturnValue('get', 1, array('Test.DefinitionRev'));
 125         $def2 = $this->generateDefinition(array('info' => 3));
 126
 127         $cache->set($def1, $config1);
 128         $cache->cleanup($config1);
 129         $this->assertEqual($def1, $cache->get($config1)); // no change
 130
 131         $cache->cleanup($config2);
 132         $this->assertFalse($cache->get($config1));
 133         $this->assertFalse($cache->get($config2));
 134
 135     }
 136
 137     function testCleanupOnlySameID() {
 138
 139         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
 140
 141         $config1 = $this->generateConfigMock('serial1');
 142         $config1->version = '1.0.0';
 143         $config1->setReturnValue('get', 1, array('Test.DefinitionRev'));
 144         $def1 = $this->generateDefinition(array('info' => 1));
 145
 146         $config2 = $this->generateConfigMock('serial2');
 147         $config2->version = '1.0.0';
 148         $config2->setReturnValue('get', 34, array('Test.DefinitionRev'));
 149         $def2 = $this->generateDefinition(array('info' => 3));
 150
 151         $cache->set($def1, $config1);
 152         $cache->cleanup($config1);
 153         $this->assertEqual($def1, $cache->get($config1)); // no change
 154
 155         $cache->set($def2, $config2);
 156         $cache->cleanup($config2);
 157         $this->assertEqual($def1, $cache->get($config1));
 158         $this->assertEqual($def2, $cache->get($config2));
 159
 160         $cache->flush($config1);
 161     }
 162
 163     /**
 164      * Asserts that a file exists, ignoring the stat cache
 165      */
 166     function assertFileExist($file) {
 167         clearstatcache();
 168         $this->assertTrue(file_exists($file), 'Expected ' . $file . ' exists');
 169     }
 170
 171     /**
 172      * Asserts that a file does not exist, ignoring the stat cache
 173      */
 174     function assertFileNotExist($file) {
 175         clearstatcache();
 176         $this->assertFalse(file_exists($file), 'Expected ' . $file . ' does not exist');
 177     }
 178
 179     function testAlternatePath() {
 180
 181         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
 182         $config = $this->generateConfigMock('serial');
 183         $config->version = '1.0.0';
 184         $config->setReturnValue('get', 1, array('Test.DefinitionRev'));
 185         $dir = dirname(__FILE__) . '/SerializerTest';
 186         $config->setReturnValue('get', $dir, array('Cache.SerializerPath'));
 187
 188         $def_original = $this->generateDefinition();
 189         $cache->add($def_original, $config);
 190         $this->assertFileExist($dir . '/Test/1.0.0,serial,1.ser');
 191
 192         unlink($dir . '/Test/1.0.0,serial,1.ser');
 193         rmdir( $dir . '/Test');
 194
 195     }
 196
 197     function testAlternatePermissions() {
 198
 199         $cache = new HTMLPurifier_DefinitionCache_Serializer('Test');
 200         $config = $this->generateConfigMock('serial');
 201         $config->version = '1.0.0';
 202         $config->setReturnValue('get', 1, array('Test.DefinitionRev'));
 203         $dir = dirname(__FILE__) . '/SerializerTest';
 204         $config->setReturnValue('get', $dir, array('Cache.SerializerPath'));
 205         $config->setReturnValue('get', 0777, array('Cache.SerializerPermissions'));
 206
 207         $def_original = $this->generateDefinition();
 208         $cache->add($def_original, $config);
 209         $this->assertFileExist($dir . '/Test/1.0.0,serial,1.ser');
 210
 211         $this->assertEqual(0666, 0777 & fileperms($dir . '/Test/1.0.0,serial,1.ser'));
 212         $this->assertEqual(0777, 0777 & fileperms($dir . '/Test'));
 213
 214         unlink($dir . '/Test/1.0.0,serial,1.ser');
 215         rmdir( $dir . '/Test');
 216
 217     }
 218 }
 219
 220 // vim: et sw=4 sts=4