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
212
213
214
215
216
217
218
219
220
221
222
223
|
<?php
namespace Wikimedia\Tests\ObjectCache;
use BagOStuff;
use HashBagOStuff;
use InvalidArgumentException;
use MediaWikiCoversValidator;
use NullStatsdDataFactory;
use PHPUnit\Framework\TestCase;
use Psr\Log\NullLogger;
use UDPTransport;
use Wikimedia\Stats\Metrics\MetricInterface;
use Wikimedia\Stats\OutputFormats;
use Wikimedia\Stats\StatsCache;
use Wikimedia\Stats\StatsFactory;
use Wikimedia\TestingAccessWrapper;
/**
* @covers \HashBagOStuff
* @covers \MediumSpecificBagOStuff
* @covers \BagOStuff
* @group BagOStuff
*/
class HashBagOStuffTest extends TestCase {
use MediaWikiCoversValidator;
public function testConstruct() {
$this->assertInstanceOf(
HashBagOStuff::class,
new HashBagOStuff()
);
}
public function testQoS() {
$bag = new HashBagOStuff();
$this->assertSame(
BagOStuff::QOS_DURABILITY_SCRIPT,
$bag->getQoS( BagOStuff::ATTR_DURABILITY )
);
}
public function testConstructBadZero() {
$this->expectException( InvalidArgumentException::class );
$cache = new HashBagOStuff( [ 'maxKeys' => 0 ] );
}
public function testConstructBadNeg() {
$this->expectException( InvalidArgumentException::class );
$cache = new HashBagOStuff( [ 'maxKeys' => -1 ] );
}
public function testConstructBadType() {
$this->expectException( InvalidArgumentException::class );
$cache = new HashBagOStuff( [ 'maxKeys' => 'x' ] );
}
public function testDelete() {
$cache = new HashBagOStuff();
for ( $i = 0; $i < 10; $i++ ) {
$cache->set( "key$i", 1 );
$this->assertSame( 1, $cache->get( "key$i" ) );
$cache->delete( "key$i" );
$this->assertFalse( $cache->get( "key$i" ) );
}
}
public function testClear() {
$cache = new HashBagOStuff();
for ( $i = 0; $i < 10; $i++ ) {
$cache->set( "key$i", 1 );
$this->assertSame( 1, $cache->get( "key$i" ) );
}
$cache->clear();
for ( $i = 0; $i < 10; $i++ ) {
$this->assertFalse( $cache->get( "key$i" ) );
}
}
public function testExpire() {
$cache = new HashBagOStuff();
$cacheInternal = TestingAccessWrapper::newFromObject( $cache );
$cache->set( 'foo', 1 );
$cache->set( 'bar', 1, 10 );
$cache->set( 'baz', 1, -10 );
$this->assertSame( 0, $cacheInternal->bag['foo'][$cache::KEY_EXP], 'Indefinite' );
// 2 seconds tolerance
$this->assertEqualsWithDelta(
time() + 10,
$cacheInternal->bag['bar'][$cache::KEY_EXP],
2,
'Future'
);
$this->assertEqualsWithDelta(
time() - 10,
$cacheInternal->bag['baz'][$cache::KEY_EXP],
2,
'Past'
);
$this->assertSame( 1, $cache->get( 'bar' ), 'Key not expired' );
$this->assertFalse( $cache->get( 'baz' ), 'Key expired' );
}
/**
* Ensure maxKeys eviction prefers keeping new keys.
*/
public function testEvictionAdd() {
$cache = new HashBagOStuff( [ 'maxKeys' => 10 ] );
for ( $i = 0; $i < 10; $i++ ) {
$cache->set( "key$i", 1 );
$this->assertSame( 1, $cache->get( "key$i" ) );
}
for ( $i = 10; $i < 20; $i++ ) {
$cache->set( "key$i", 1 );
$this->assertSame( 1, $cache->get( "key$i" ) );
$this->assertFalse( $cache->get( "key" . ( $i - 10 ) ) );
}
}
/**
* Ensure maxKeys eviction prefers recently set keys
* even if the keys pre-exist.
*/
public function testEvictionSet() {
$cache = new HashBagOStuff( [ 'maxKeys' => 3 ] );
foreach ( [ 'foo', 'bar', 'baz' ] as $key ) {
$cache->set( $key, 1 );
}
// Set existing key
$cache->set( 'foo', 1 );
// Add a 4th key (beyond the allowed maximum)
$cache->set( 'quux', 1 );
// Foo's life should have been extended over Bar
foreach ( [ 'foo', 'baz', 'quux' ] as $key ) {
$this->assertSame( 1, $cache->get( $key ), "Kept $key" );
}
$this->assertFalse( $cache->get( 'bar' ), 'Evicted bar' );
}
/**
* Ensure maxKeys eviction prefers recently retrieved keys (LRU).
*/
public function testEvictionGet() {
$cache = new HashBagOStuff( [ 'maxKeys' => 3 ] );
foreach ( [ 'foo', 'bar', 'baz' ] as $key ) {
$cache->set( $key, 1 );
}
// Get existing key
$cache->get( 'foo', 1 );
// Add a 4th key (beyond the allowed maximum)
$cache->set( 'quux', 1 );
// Foo's life should have been extended over Bar
foreach ( [ 'foo', 'baz', 'quux' ] as $key ) {
$this->assertSame( 1, $cache->get( $key ), "Kept $key" );
}
$this->assertFalse( $cache->get( 'bar' ), 'Evicted bar' );
}
/**
* Ensure updateOpStats doesn't get confused.
*/
public function testUpdateOpStats() {
$statsCache = new StatsCache();
$emitter = OutputFormats::getNewEmitter(
'mediawiki',
$statsCache,
OutputFormats::getNewFormatter( OutputFormats::DOGSTATSD )
);
$transport = $this->createMock( UDPTransport::class );
$transport->expects( $this->once() )->method( "emit" )
->with(
"mediawiki.bagostuff_call_total:1|c|#keygroup:Foo,operation:frob
mediawiki.bagostuff_call_total:1|c|#keygroup:Bar,operation:frob
mediawiki.bagostuff_call_total:1|c|#keygroup:UNKNOWN,operation:frob
mediawiki.bagostuff_bytes_sent_total:5|c|#keygroup:Bar,operation:frob
mediawiki.bagostuff_bytes_sent_total:5|c|#keygroup:UNKNOWN,operation:frob
mediawiki.bagostuff_bytes_read_total:3|c|#keygroup:Bar,operation:frob
mediawiki.bagostuff_bytes_read_total:3|c|#keygroup:UNKNOWN,operation:frob
mediawiki.stats_buffered_total:7|c\n"
);
$emitter = $emitter->withTransport( $transport );
$stats = new StatsFactory( $statsCache, $emitter, new NullLogger );
$stats->withStatsdDataFactory( new NullStatsdDataFactory() );
$cache = new HashBagOStuff( [
'stats' => $stats
] );
$cache = TestingAccessWrapper::newFromObject( $cache );
$cache->updateOpStats(
'frob',
[
// The value is the key
$cache->makeKey( 'Foo', '123456' ),
// The value is a tuble of ( bytes sent, bytes received )
$cache->makeGlobalKey( 'Bar', '123456' ) => [ 5, 3 ],
// The key is not a proper key
'1337BABE-123456' => [ 5, 3 ],
]
);
/** @var MetricInterface[] $metrics */
$metrics = ( TestingAccessWrapper::newFromObject( $stats ) )->cache->getAllMetrics();
$this->assertCount( 3, $metrics );
// send metrics
$stats->flush();
}
}
|
