Skip to content

chore: apply trace structure assertion to pdo test #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2025
Merged

chore: apply trace structure assertion to pdo test #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Instrumentation/PDO/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"phpstan/phpstan-phpunit": "^1.0",
"psalm/plugin-phpunit": "^0.19.2",
"open-telemetry/sdk": "^1.0",
"open-telemetry/test-utils": "^0.2.0",
"phpunit/phpunit": "^9.5",
"vimeo/psalm": "6.4.0"
},
Expand Down
66 changes: 63 additions & 3 deletions src/Instrumentation/PDO/tests/Integration/PDOInstrumentationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@
use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
use OpenTelemetry\SDK\Trace\TracerProvider;
use OpenTelemetry\SemConv\TraceAttributes;
use OpenTelemetry\TestUtils\TraceStructureAssertionTrait;
use PDO;
use PHPUnit\Framework\TestCase;

class PDOInstrumentationTest extends TestCase
{
use TraceStructureAssertionTrait;

private ScopeInterface $scope;
/** @var ArrayObject<array-key, mixed> */
private ArrayObject $storage;
Expand Down Expand Up @@ -113,7 +116,7 @@ public function test_pdo_sqlite_subclass(): void

// Test that the subclass-specific methods work
$db->createFunction('test_function', static fn ($value) => strtoupper($value));

// Test that standard PDO operations still work
$db->exec($this->fillDB());
$span = $this->storage->offsetGet(1);
Expand Down Expand Up @@ -288,7 +291,7 @@ public function test_span_hierarchy_with_pdo_operations(): void
$serverSpan = $tracer->spanBuilder('HTTP GET /api/users')
->setSpanKind(SpanKind::KIND_SERVER)
->startSpan();

// Create scope for server span
$serverScope = Context::storage()->attach($serverSpan->storeInContext(Context::getCurrent()));

Expand All @@ -297,7 +300,7 @@ public function test_span_hierarchy_with_pdo_operations(): void
$internalSpan = $tracer->spanBuilder('processUserData')
->setSpanKind(SpanKind::KIND_INTERNAL)
->startSpan();

// Create scope for internal span
$internalScope = Context::storage()->attach($internalSpan->storeInContext(Context::getCurrent()));

Expand Down Expand Up @@ -340,6 +343,63 @@ public function test_span_hierarchy_with_pdo_operations(): void

// Detach scopes
$internalScope->detach();
$internalSpan->end();
$serverScope->detach();
$serverSpan->end();

$this->assertTraceStructure(
$this->storage,
[
[
'name' => 'HTTP GET /api/users',
'kind' => SpanKind::KIND_SERVER,
'attributes' => [],
'children' => [
[
'name' => 'processUserData',
'kind' => SpanKind::KIND_INTERNAL,
'attributes' => [],
'children' => [
[
'name' => 'PDO::__construct',
'kind' => SpanKind::KIND_CLIENT,
'attributes' => [
TraceAttributes::DB_SYSTEM_NAME => 'sqlite',
],
],
[
'name' => 'PDO::exec',
'kind' => SpanKind::KIND_CLIENT,
'attributes' => [
TraceAttributes::DB_SYSTEM_NAME => 'sqlite',
],
],
[
'name' => 'PDO::prepare',
'kind' => SpanKind::KIND_CLIENT,
'attributes' => [
TraceAttributes::DB_SYSTEM_NAME => 'sqlite',
],
],
[
'name' => 'PDOStatement::execute',
'kind' => SpanKind::KIND_CLIENT,
'attributes' => [
TraceAttributes::DB_SYSTEM_NAME => 'sqlite',
],
],
[
'name' => 'PDOStatement::fetchAll',
'kind' => SpanKind::KIND_CLIENT,
'attributes' => [
TraceAttributes::DB_SYSTEM_NAME => 'sqlite',
],
],
],
],
],
],
]
);
}
}