Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7420081
ChronologyProtectorTest.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
8 KB
Referenced Files
None
Subscribers
None
ChronologyProtectorTest.php
View Options
<?php
/**
* @license GPL-2.0-or-later
* @file
*/
use
PHPUnit\Framework\TestCase
;
use
Wikimedia\ObjectCache\HashBagOStuff
;
use
Wikimedia\Rdbms\ChronologyProtector
;
use
Wikimedia\Rdbms\ILoadBalancer
;
use
Wikimedia\Rdbms\MySQLPrimaryPos
;
/**
* @covers \Wikimedia\Rdbms\ChronologyProtector
*/
class
ChronologyProtectorTest
extends
TestCase
{
use
MediaWikiCoversValidator
;
/**
* @dataProvider provideClientId
*/
public
function
testClientId
(
array
$client
,
string
$secret
,
string
$expectedId
)
{
$bag
=
new
HashBagOStuff
();
$cp
=
new
ChronologyProtector
(
$bag
,
$secret
,
false
);
$cp
->
setRequestInfo
(
$client
);
$this
->
assertEquals
(
$expectedId
,
$cp
->
getClientId
()
);
}
public
static
function
provideClientId
()
{
return
[
[
[
'IPAddress'
=>
'127.0.0.1'
,
'UserAgent'
=>
"Totally-Not-FireFox"
],
''
,
'45e93a9c215c031d38b7c42d8e4700ca'
,
],
[
[
'IPAddress'
=>
'127.0.0.7'
,
'UserAgent'
=>
"Totally-Not-FireFox"
],
''
,
'b1d604117b51746c35c3df9f293c84dc'
],
[
[
'IPAddress'
=>
'127.0.0.1'
,
'UserAgent'
=>
"Totally-FireFox"
],
''
,
'731b4e06a65e2346b497fc811571c4d7'
],
[
[
'IPAddress'
=>
'127.0.0.1'
,
'UserAgent'
=>
"Totally-Not-FireFox"
],
'secret'
,
'defff51ded73cd901253d874c9b2077d'
]
];
}
public
static
function
providePresistAndLoad
()
{
$pos
=
new
MySQLPrimaryPos
(
'1-2-3'
,
1301648400
);
yield
'pageview on minimal default install (SQLite, no cache)'
=>
[
new
EmptyBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
false
,
'pos'
=>
false
],
null
,
false
,
null
,
];
yield
'pageview on single-host MySQL and no cache'
=>
[
new
EmptyBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
false
,
'pos'
=>
$pos
],
null
,
false
,
null
,
];
yield
'pageview on SQLite with a cache'
=>
[
new
HashBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
false
,
'pos'
=>
false
],
null
,
false
,
null
,
];
yield
'pageview on single-host MySQL with a cache'
=>
[
new
HashBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
false
,
'pos'
=>
$pos
],
null
,
false
,
null
,
];
yield
'pageview on MySQL with replicas and a cache'
=>
[
new
HashBagOStuff
(),
[
'replicas'
=>
true
,
'writes'
=>
false
,
'pos'
=>
$pos
],
null
,
false
,
null
,
];
yield
'edit on minimal default install (SQLite, no cache)'
=>
[
new
EmptyBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
true
,
'pos'
=>
false
],
null
,
false
,
null
,
];
yield
'edit on single-host MySQL and no cache'
=>
[
new
EmptyBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
true
,
'pos'
=>
$pos
],
null
,
false
,
null
,
];
yield
'edit on SQLite with a cache'
=>
[
new
HashBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
true
,
'pos'
=>
false
],
1
,
true
,
null
,
];
yield
'edit on single-host MySQL with a cache'
=>
[
new
HashBagOStuff
(),
[
'replicas'
=>
false
,
'writes'
=>
true
,
'pos'
=>
$pos
],
1
,
true
,
null
,
];
yield
'edit on MySQL with replicas and a cache'
=>
[
new
HashBagOStuff
(),
[
'replicas'
=>
true
,
'writes'
=>
true
,
'pos'
=>
$pos
],
1
,
true
,
$pos
,
];
}
/**
* Simulate staging and persisting position data,
* and then in a new instance (as if in a future web request),
* loading those same positions.
*
* @dataProvider providePresistAndLoad
*/
public
function
testPresistAndLoad
(
BagOStuff
$bag
,
array
$state
,
$expectPosIndex
,
bool
$expectTouched
,
$expectPos
)
{
$reqInfo
=
[
'IPAddress'
=>
'127.0.0.1'
,
'UserAgent'
=>
'FireFox'
,
'ChronologyClientId'
=>
'd84af39036'
,
];
// Request 1
$cp1
=
new
ChronologyProtector
(
$bag
,
'mysecret'
,
false
);
$cp1
->
setRequestInfo
(
$reqInfo
);
$lb1
=
$this
->
createMock
(
ILoadBalancer
::
class
);
$lb1
->
method
(
'getClusterName'
)->
willReturn
(
'test'
);
$lb1
->
method
(
'getServerName'
)->
willReturn
(
'example'
);
$lb1
->
method
(
'hasOrMadeRecentPrimaryChanges'
)->
willReturn
(
$state
[
'writes'
]
);
$lb1
->
method
(
'hasStreamingReplicaServers'
)->
willReturn
(
$state
[
'replicas'
]
);
$lb1
->
method
(
'getPrimaryPos'
)->
willReturn
(
$state
[
'pos'
]
);
$cp1
->
stageSessionPrimaryPos
(
$lb1
);
$clientPosIndex
=
null
;
$cp1
->
persistSessionReplicationPositions
(
$clientPosIndex
);
$cp1
=
$lb1
=
null
;
$this
->
assertSame
(
$expectPosIndex
,
$clientPosIndex
,
'clientPosIndex after first request'
);
// Request 2
$cp2
=
new
ChronologyProtector
(
$bag
,
'mysecret'
,
false
);
$cp2
->
setRequestInfo
(
$reqInfo
+
[
'ChronologyPositionIndex'
=>
$clientPosIndex
]
);
$lb2
=
$this
->
createMock
(
ILoadBalancer
::
class
);
$lb2
->
method
(
'getClusterName'
)->
willReturn
(
'test'
);
$lb2
->
method
(
'getServerName'
)->
willReturn
(
'example'
);
$lb2
->
method
(
'hasOrMadeRecentPrimaryChanges'
)->
willReturn
(
false
);
$lb2
->
method
(
'hasStreamingReplicaServers'
)->
willReturn
(
$state
[
'replicas'
]
);
$lb2
->
method
(
'getPrimaryPos'
)->
willReturn
(
false
);
$this
->
assertSame
(
$expectTouched
,
$cp2
->
getTouched
(),
'getTouched on second request'
);
$actualPos
=
$cp2
->
getSessionPrimaryPos
(
$lb2
);
$actualPostStr
=
$actualPos
?
$actualPos
->
__toString
()
:
$actualPos
;
$expectPosStr
=
$expectPos
?
$expectPos
->
__toString
()
:
$expectPos
;
$this
->
assertSame
(
$expectPosStr
,
$actualPostStr
,
'getSessionPrimaryPos on second request'
);
}
/**
* @covers \Wikimedia\Rdbms\MySQLPrimaryPos
*/
public
function
testPositionMarshalling
()
{
$replicationPos
=
'1-2-3'
;
$time
=
100
;
$lb
=
$this
->
createMock
(
ILoadBalancer
::
class
);
$lb
->
method
(
'getClusterName'
)->
willReturn
(
'test'
);
$lb
->
method
(
'getServerName'
)->
willReturn
(
'primary'
);
$lb
->
method
(
'hasOrMadeRecentPrimaryChanges'
)->
willReturn
(
true
);
$lb
->
method
(
'hasStreamingReplicaServers'
)->
willReturn
(
true
);
$lb
->
method
(
'getPrimaryPos'
)->
willReturnCallback
(
static
function
()
use
(
&
$replicationPos
,
&
$time
)
{
return
new
MySQLPrimaryPos
(
$replicationPos
,
$time
);
}
);
$client
=
[
'IPAddress'
=>
'127.0.0.1'
,
'UserAgent'
=>
"Burninator"
,
'ChronologyClientId'
=>
'random id'
];
$secret
=
'0815'
;
$bag
=
new
HashBagOStuff
();
$cp
=
new
ChronologyProtector
(
$bag
,
$secret
,
false
);
$cp
->
setRequestInfo
(
$client
);
$clientPosIndex
=
0
;
$cp
->
stageSessionPrimaryPos
(
$lb
);
$cp
->
persistSessionReplicationPositions
(
$clientPosIndex
);
// Do it a second time so the values that were written the first
// time get read from the cache.
$replicationPos
=
'3-4-5'
;
$time
++;
$cp
->
stageSessionPrimaryPos
(
$lb
);
$cp
->
persistSessionReplicationPositions
(
$clientPosIndex
);
$waitForPos
=
$cp
->
getSessionPrimaryPos
(
$lb
);
$this
->
assertNotNull
(
$waitForPos
);
$this
->
assertSame
(
$time
,
$waitForPos
->
asOfTime
()
);
$this
->
assertSame
(
"$replicationPos"
,
"$waitForPos"
);
}
public
function
testCPPosIndexCookieValues
()
{
$time
=
1526522031
;
$agentId
=
md5
(
'Ramsey
\'
s Loyal Presa Canario'
);
$this
->
assertEquals
(
'3@542#c47dcfb0566e7d7bc110a6128a45c93a'
,
ChronologyProtector
::
makeCookieValueFromCPIndex
(
3
,
542
,
$agentId
)
);
$this
->
assertEquals
(
'1@542#c47dcfb0566e7d7bc110a6128a45c93a'
,
ChronologyProtector
::
makeCookieValueFromCPIndex
(
1
,
542
,
$agentId
)
);
$this
->
assertSame
(
null
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"5#$agentId"
,
$time
-
10
)[
'index'
],
'No time set'
);
$this
->
assertSame
(
null
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"5@$time"
,
$time
-
10
)[
'index'
],
'No agent set'
);
$this
->
assertSame
(
null
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"0@$time#$agentId"
,
$time
-
10
)[
'index'
],
'Bad index'
);
$this
->
assertSame
(
2
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"2@$time#$agentId"
,
$time
-
10
)[
'index'
],
'Fresh'
);
$this
->
assertSame
(
2
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"2@$time#$agentId"
,
$time
+
9
-
10
)[
'index'
],
'Almost stale'
);
$this
->
assertSame
(
null
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"0@$time#$agentId"
,
$time
+
9
-
10
)[
'index'
],
'Almost stale; bad index'
);
$this
->
assertSame
(
null
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"2@$time#$agentId"
,
$time
+
11
-
10
)[
'index'
],
'Stale'
);
$this
->
assertSame
(
$agentId
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"5@$time#$agentId"
,
$time
-
10
)[
'clientId'
],
'Live (client ID)'
);
$this
->
assertSame
(
null
,
ChronologyProtector
::
getCPInfoFromCookieValue
(
"5@$time#$agentId"
,
$time
+
11
-
10
)[
'clientId'
],
'Stale (client ID)'
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 04:49 (1 d, 3 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ed/8a/513c759913ecfc7e000a4f432bf5
Default Alt Text
ChronologyProtectorTest.php (8 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment