b9fe4903c4a37d6f08dc138f1244bc42bbcb844f
3 * @author Matthias Mullie <mmullie@wikimedia.org>
6 class BagOStuffTest
extends MediaWikiTestCase
{
10 protected function setUp() {
13 // type defined through parameter
14 if ( $this->getCliArg( 'use-bagostuff' ) ) {
15 $name = $this->getCliArg( 'use-bagostuff' );
17 $this->cache
= ObjectCache
::newFromId( $name );
19 // no type defined - use simple hash
20 $this->cache
= new HashBagOStuff
;
23 $this->cache
->delete( wfMemcKey( 'test' ) );
27 * @covers BagOStuff::merge
28 * @covers BagOStuff::mergeViaLock
30 public function testMerge() {
31 $key = wfMemcKey( 'test' );
36 * Callback method: append "merged" to whatever is in cache.
38 * @param BagOStuff $cache
40 * @param int $existingValue
44 $callback = function ( BagOStuff
$cache, $key, $existingValue ) use ( &$usleep ) {
45 // let's pretend this is an expensive callback to test concurrent merge attempts
48 if ( $existingValue === false ) {
52 return $existingValue . 'merged';
55 // merge on non-existing value
56 $merged = $this->cache
->merge( $key, $callback, 0 );
57 $this->assertTrue( $merged );
58 $this->assertEquals( $this->cache
->get( $key ), 'merged' );
60 // merge on existing value
61 $merged = $this->cache
->merge( $key, $callback, 0 );
62 $this->assertTrue( $merged );
63 $this->assertEquals( $this->cache
->get( $key ), 'mergedmerged' );
66 * Test concurrent merges by forking this process, if:
67 * - not manually called with --use-bagostuff
68 * - pcntl_fork is supported by the system
69 * - cache type will correctly support calls over forks
71 $fork = (bool)$this->getCliArg( 'use-bagostuff' );
72 $fork &= function_exists( 'pcntl_fork' );
73 $fork &= !$this->cache
instanceof HashBagOStuff
;
74 $fork &= !$this->cache
instanceof EmptyBagOStuff
;
75 $fork &= !$this->cache
instanceof MultiWriteBagOStuff
;
77 // callback should take awhile now so that we can test concurrent merge attempts
80 // can't fork, ignore this test...
82 // wait a little, making sure that the child process is calling merge
85 // attempt a merge - this should fail
86 $merged = $this->cache
->merge( $key, $callback, 0, 1 );
88 // merge has failed because child process was merging (and we only attempted once)
89 $this->assertFalse( $merged );
91 // make sure the child's merge is completed and verify
93 $this->assertEquals( $this->cache
->get( $key ), 'mergedmergedmerged' );
95 $this->cache
->merge( $key, $callback, 0, 1 );
97 // Note: I'm not even going to check if the merge worked, I'll
98 // compare values in the parent process to test if this merge worked.
99 // I'm just going to exit this child process, since I don't want the
100 // child to output any test results (would be rather confusing to
101 // have test output twice)
108 * @covers BagOStuff::add
110 public function testAdd() {
111 $key = wfMemcKey( 'test' );
112 $this->assertTrue( $this->cache
->add( $key, 'test' ) );
115 public function testGet() {
116 $value = array( 'this' => 'is', 'a' => 'test' );
118 $key = wfMemcKey( 'test' );
119 $this->cache
->add( $key, $value );
120 $this->assertEquals( $this->cache
->get( $key ), $value );
124 * @covers BagOStuff::getWithSetCallback
126 public function testGetWithSetCallback() {
127 $key = wfMemcKey( 'test' );
128 $value = $this->cache
->getWithSetCallback(
132 return 'hello kitty';
136 $this->assertEquals( 'hello kitty', $value );
137 $this->assertEquals( $value, $this->cache
->get( $key ) );
141 * @covers BagOStuff::incr
143 public function testIncr() {
144 $key = wfMemcKey( 'test' );
145 $this->cache
->add( $key, 0 );
146 $this->cache
->incr( $key );
148 $actualValue = $this->cache
->get( $key );
149 $this->assertEquals( $expectedValue, $actualValue, 'Value should be 1 after incrementing' );
153 * @covers BagOStuff::getMulti
155 public function testGetMulti() {
156 $value1 = array( 'this' => 'is', 'a' => 'test' );
157 $value2 = array( 'this' => 'is', 'another' => 'test' );
158 $value3 = array( 'testing a key that may be encoded when sent to cache backend' );
159 $value4 = array( 'another test where chars in key will be encoded' );
161 $key1 = wfMemcKey( 'test1' );
162 $key2 = wfMemcKey( 'test2' );
163 // internally, MemcachedBagOStuffs will encode to will-%25-encode
164 $key3 = wfMemcKey( 'will-%-encode' );
166 'flowdb:flow_ref:wiki:by-source:v3:Parser\'s_"broken"_+_(page)_&_grill:testwiki:1:4.7'
169 $this->cache
->add( $key1, $value1 );
170 $this->cache
->add( $key2, $value2 );
171 $this->cache
->add( $key3, $value3 );
172 $this->cache
->add( $key4, $value4 );
175 array( $key1 => $value1, $key2 => $value2, $key3 => $value3, $key4 => $value4 ),
176 $this->cache
->getMulti( array( $key1, $key2, $key3, $key4 ) )
180 $this->cache
->delete( $key1 );
181 $this->cache
->delete( $key2 );
182 $this->cache
->delete( $key3 );
183 $this->cache
->delete( $key4 );
187 * @covers BagOStuff::getScopedLock
189 public function testGetScopedLock() {
190 $key = wfMemcKey( 'test' );
191 $value1 = $this->cache
->getScopedLock( $key, 0 );
192 $value2 = $this->cache
->getScopedLock( $key, 0 );
194 $this->assertType( 'ScopedCallback', $value1, 'First call returned lock' );
195 $this->assertNull( $value2, 'Duplicate call returned no lock' );
199 $value3 = $this->cache
->getScopedLock( $key, 0 );
200 $this->assertType( 'ScopedCallback', $value3, 'Lock returned callback after release' );
203 $value1 = $this->cache
->getScopedLock( $key, 0, 5, 'reentry' );
204 $value2 = $this->cache
->getScopedLock( $key, 0, 5, 'reentry' );
206 $this->assertType( 'ScopedCallback', $value1, 'First reentrant call returned lock' );
207 $this->assertType( 'ScopedCallback', $value1, 'Second reentrant call returned lock' );