Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7404505
TracerTest.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
TracerTest.php
View Options
<?php
namespace
Wikimedia\Tests\Telemetry
;
use
MediaWikiUnitTestCase
;
use
Wikimedia\Telemetry\Clock
;
use
Wikimedia\Telemetry\ExporterInterface
;
use
Wikimedia\Telemetry\NoopSpan
;
use
Wikimedia\Telemetry\SamplerInterface
;
use
Wikimedia\Telemetry\SpanContext
;
use
Wikimedia\Telemetry\SpanInterface
;
use
Wikimedia\Telemetry\Tracer
;
use
Wikimedia\Telemetry\TracerState
;
/**
* @covers \Wikimedia\Telemetry\Tracer
* @covers \Wikimedia\Telemetry\Span
*/
class
TracerTest
extends
MediaWikiUnitTestCase
{
private
Clock
$clock
;
private
SamplerInterface
$sampler
;
private
ExporterInterface
$exporter
;
private
TracerState
$tracerState
;
private
Tracer
$tracer
;
protected
function
setUp
():
void
{
parent
::
setUp
();
$this
->
clock
=
$this
->
createMock
(
Clock
::
class
);
$this
->
sampler
=
$this
->
createMock
(
SamplerInterface
::
class
);
$this
->
exporter
=
$this
->
createMock
(
ExporterInterface
::
class
);
$this
->
tracerState
=
new
TracerState
();
$this
->
clock
->
method
(
'getCurrentNanoTime'
)
->
willReturnCallback
(
fn
()
=>
hrtime
(
true
)
);
$this
->
tracer
=
new
Tracer
(
$this
->
clock
,
$this
->
sampler
,
$this
->
exporter
,
$this
->
tracerState
);
}
public
function
testSpanAndTraceIds
():
void
{
$this
->
sampler
->
method
(
'shouldSample'
)
->
willReturn
(
true
);
$rootSpan
=
$this
->
tracer
->
createRootSpan
(
'test span'
)
->
start
();
$rootSpan
->
activate
();
$span
=
$this
->
tracer
->
createSpan
(
'test'
)
->
start
();
$explicitSpan
=
$this
->
tracer
->
createSpanWithParent
(
'test'
,
$span
->
getContext
()
)
->
start
();
foreach
(
[
$rootSpan
,
$span
,
$explicitSpan
]
as
$span
)
{
$this
->
assertMatchesRegularExpression
(
'/^[a-f0-9]{32}$/'
,
$span
->
getContext
()->
getTraceId
(),
'The trace ID should be a 128-bit hexadecimal string'
);
$this
->
assertMatchesRegularExpression
(
'/^[a-f0-9]{16}$/'
,
$span
->
getContext
()->
getSpanId
(),
'The span ID should be a 64-bit hexadecimal string'
);
}
}
public
function
testSpanCreation
():
void
{
$this
->
sampler
->
method
(
'shouldSample'
)
->
willReturn
(
true
);
$activeSpan
=
$this
->
tracer
->
createRootSpan
(
'test active span'
)
->
start
();
$activeSpan
->
activate
();
$span
=
$this
->
tracer
->
createRootSpan
(
'test span'
,
false
)
->
start
();
$this
->
assertNull
(
$span
->
getContext
()->
getParentSpanId
(),
'The test span should have been explicitly created as a root span, ignoring the active span'
);
$this
->
assertNotEquals
(
$activeSpan
->
getContext
()->
getTraceId
(),
$span
->
getContext
()->
getTraceId
(),
'The test span should have started a new trace because it is a root span'
);
}
public
function
testMultipleSpanCreation
():
void
{
$this
->
sampler
->
method
(
'shouldSample'
)
->
willReturn
(
true
);
/** @var SpanInterface[] $spans */
$spans
=
[];
$spanIds
=
[];
for
(
$i
=
1
;
$i
<=
4
;
$i
++
)
{
$span
=
$i
===
1
?
$this
->
tracer
->
createRootSpan
(
"test span #$i"
)
:
$this
->
tracer
->
createSpan
(
"test span #$i"
);
$span
=
$span
->
start
();
$span
->
activate
();
if
(
$i
===
1
)
{
$this
->
assertNull
(
$span
->
getContext
()->
getParentSpanId
(),
'The first span should have no parent, because there is no active span'
);
}
else
{
$this
->
assertSame
(
$spans
[
$i
-
2
]->
getContext
()->
getSpanId
(),
$span
->
getContext
()->
getParentSpanId
(),
"The parent of span #$i should have been the previous span, which was active"
);
$this
->
assertSame
(
$spans
[
0
]->
getContext
()->
getTraceId
(),
$span
->
getContext
()->
getTraceId
(),
'All spans should be part of the same trace'
);
}
$spans
[]
=
$span
;
$spanIds
[]
=
$span
->
getContext
()->
getSpanId
();
}
$span
=
null
;
while
(
array_pop
(
$spans
)
!==
null
);
$exportedSpanIds
=
array_map
(
fn
(
SpanContext
$spanContext
)
=>
$spanContext
->
getSpanId
(),
$this
->
tracerState
->
getSpanContexts
()
);
$this
->
assertSame
(
array_reverse
(
$spanIds
),
$exportedSpanIds
);
}
public
function
testCreatingSpansWithoutActiveSpan
():
void
{
$this
->
clock
->
method
(
'getCurrentNanoTime'
)
->
willReturnCallback
(
fn
()
=>
hrtime
(
true
)
);
$this
->
sampler
->
method
(
'shouldSample'
)
->
willReturn
(
true
);
$traceIds
=
[];
for
(
$i
=
1
;
$i
<=
2
;
$i
++
)
{
$span
=
$this
->
tracer
->
createRootSpan
(
"test span #$i"
)
->
start
();
$this
->
assertNull
(
$span
->
getContext
()->
getParentSpanId
(),
"span #$i should have no parent"
);
$this
->
assertNotContains
(
$span
->
getContext
()->
getTraceId
(),
$traceIds
,
'All spans should be root spans, starting a new trace'
);
$traceIds
[]
=
$span
->
getContext
()->
getTraceId
();
}
}
public
function
testCreatingSpanWithExplicitParent
():
void
{
$this
->
sampler
->
method
(
'shouldSample'
)
->
willReturn
(
true
);
$activeSpan
=
$this
->
tracer
->
createRootSpan
(
'test active span'
)
->
start
();
$parentSpan
=
$this
->
tracer
->
createRootSpan
(
'parent span'
)
->
start
();
$span
=
$this
->
tracer
->
createSpanWithParent
(
'test span'
,
$parentSpan
->
getContext
()
)
->
start
();
$this
->
assertSame
(
$parentSpan
->
getContext
()->
getSpanId
(),
$span
->
getContext
()->
getParentSpanId
(),
'The test span should have been assigned the given span as the parent, ignoring the active span'
);
$this
->
assertSame
(
$parentSpan
->
getContext
()->
getTraceId
(),
$span
->
getContext
()->
getTraceId
(),
'The test span should have been part of the same trace as its parent'
);
}
public
function
testShouldExportSharedStateOnShutdown
():
void
{
$this
->
exporter
->
expects
(
$this
->
once
()
)
->
method
(
'export'
)
->
with
(
$this
->
tracerState
);
$this
->
tracer
->
shutdown
();
}
public
function
testShouldMakeSpanCreationNoopPostShutdown
():
void
{
$this
->
sampler
->
method
(
'shouldSample'
)
->
willReturn
(
true
);
$this
->
tracer
->
shutdown
();
$orphanedSpan
=
$this
->
tracer
->
createSpan
(
'orphaned span'
)
->
start
();
$rootSpan
=
$this
->
tracer
->
createRootSpan
(
'parent span'
)
->
start
();
$span
=
$this
->
tracer
->
createSpan
(
'orphaned span'
)
->
start
();
$explicitParentSpan
=
$this
->
tracer
->
createSpanWithParent
(
'test span'
,
$orphanedSpan
->
getContext
()
)
->
start
();
$this
->
assertInstanceOf
(
NoopSpan
::
class
,
$orphanedSpan
);
$this
->
assertInstanceOf
(
NoopSpan
::
class
,
$rootSpan
);
$this
->
assertInstanceOf
(
NoopSpan
::
class
,
$span
);
$this
->
assertInstanceOf
(
NoopSpan
::
class
,
$explicitParentSpan
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 19:12 (1 d, 1 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c7/8a/443dd51cfdbcea48e6e85fc0e654
Default Alt Text
TracerTest.php (6 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment