1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
<?php
namespace MediaWiki\Tests\Unit\Settings\Cache;
use MediaWiki\Settings\Cache\CacheableSource;
use MediaWiki\Settings\Cache\CachedSource;
use MediaWiki\Settings\SettingsBuilderException;
use PHPUnit\Framework\TestCase;
use Wikimedia\ObjectCache\HashBagOStuff;
/**
* @covers \MediaWiki\Settings\Cache\CachedSource
*/
class CachedSourceTest extends TestCase {
public function testLoadWithMiss() {
$settings = [ 'config' => [ 'Foo' => 'value' ] ];
$hashKey = 'abc123';
$ttl = 123;
[ $cache, $key ] = $this->createCacheMock( $hashKey );
$source = $this->createMock( CacheableSource::class );
$cacheSource = new CachedSource( $cache, $source );
$source
->expects( $this->once() )
->method( 'getHashKey' )
->willReturn( $hashKey );
$cache
->expects( $this->once() )
->method( 'get' )
->with( $key )
->willReturn( false );
$source
->expects( $this->atLeastOnce() )
->method( 'getExpiryTtl' )
->willReturn( $ttl );
$source
->expects( $this->once() )
->method( 'load' )
->willReturn( $settings );
$cache
->expects( $this->once() )
->method( 'set' )
->with(
$key,
$this->logicalAnd(
$this->arrayHasKey( 'value' ),
$this->arrayHasKey( 'expiry' ),
$this->arrayHasKey( 'generation' ),
$this->callback( function ( $item ) use ( $settings ) {
$this->assertSame( $settings, $item['value'] );
$this->assertGreaterThan( 0, $item['expiry'] );
$this->assertGreaterThan( 0, $item['generation'] );
return true;
} )
),
$ttl
);
$this->assertSame( $settings, $cacheSource->load() );
}
public function testLoadWithHit() {
$settings = [ 'config' => [ 'Foo' => 'value' ] ];
$hashKey = 'abc123';
[ $cache, $key ] = $this->createCacheMock( $hashKey );
$source = $this->createMock( CacheableSource::class );
$cacheSource = new CachedSource( $cache, $source );
$source
->expects( $this->once() )
->method( 'getHashKey' )
->willReturn( $hashKey );
$cache
->expects( $this->once() )
->method( 'get' )
->with( $key )
->willReturn(
[
'value' => $settings,
'expiry' => microtime( true ) + 60,
'generation' => 1.0
]
);
// Effectively disable early expiry for the test since it's
// probabilistic and thus cannot be tested reliably without more
// dependency injection, but at least ensure that the code path is
// exercised.
$source
->expects( $this->once() )
->method( 'getExpiryWeight' )
->willReturn( 0.0 );
$source
->expects( $this->never() )
->method( 'load' );
$this->assertSame( $settings, $cacheSource->load() );
}
public function testLoadStaleOnSourceException() {
$settings = [ 'config' => [ 'Foo' => 'value' ] ];
$hashKey = 'abc123';
$expired = microtime( true ) - 1;
[ $cache, $key ] = $this->createCacheMock( $hashKey );
$source = $this->createMock( CacheableSource::class );
$cacheSource = new CachedSource( $cache, $source );
$source
->expects( $this->atLeastOnce() )
->method( 'allowsStaleLoad' )
->willReturn( true );
$source
->expects( $this->once() )
->method( 'getHashKey' )
->willReturn( $hashKey );
$cache
->expects( $this->once() )
->method( 'get' )
->with( $key )
->willReturn(
[
'value' => $settings,
'expiry' => $expired,
'generation' => 1.0
]
);
$source
->expects( $this->once() )
->method( 'load' )
->willThrowException( new SettingsBuilderException( 'foo' ) );
$this->assertSame( $settings, $cacheSource->load() );
}
public function testLoadStaleOnLockFailure() {
$settings = [ 'config' => [ 'Foo' => 'value' ] ];
$hashKey = 'abc123';
$expired = microtime( true ) - 1;
[ $cache, $key ] = $this->createCacheMock( $hashKey, [ 'lock' ] );
$source = $this->createMock( CacheableSource::class );
$cacheSource = new CachedSource( $cache, $source );
$source
->expects( $this->atLeastOnce() )
->method( 'allowsStaleLoad' )
->willReturn( true );
$source
->expects( $this->once() )
->method( 'getHashKey' )
->willReturn( $hashKey );
$cache
->expects( $this->once() )
->method( 'get' )
->with( $key )
->willReturn(
[
'value' => $settings,
'expiry' => $expired,
'generation' => 1.0
]
);
$cache
->expects( $this->once() )
->method( 'lock' )
->willReturn( false );
$this->assertSame( $settings, $cacheSource->load() );
}
/**
* Creates a mock interface to the cache for the given key.
*
* @param string $hashKey Source hash key.
* @param ?array $methods Additional methods to mock.
*
* @return array The cache mock and global cache key.
*/
private function createCacheMock( string $hashKey, ?array $methods = [] ): array {
$cache = $this->createPartialMock(
HashBagOStuff::class,
array_merge( [ 'get', 'makeGlobalKey', 'set' ], $methods )
);
$key = 'global:' . self::class . ':' . $hashKey;
$cache
->expects( $this->once() )
->method( 'makeGlobalKey' )
->with( CachedSource::class, $hashKey )
->willReturn( $key );
return [ $cache, $key ];
}
}
|
