Laravel: tests bootstrap via SPI.

Author: ChrisLightfootWild

src/Instrumentation/Laravel/phpunit.xml.dist

@@ -5,6 +5,7 @@
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
     backupGlobals="false"
     backupStaticAttributes="false"
+    bootstrap="tests/bootstrap.php"
     cacheResult="false"
     colors="false"
     convertErrorsToExceptions="true"
@@ -41,7 +42,10 @@
         <env name="MAIL_MAILER" value="array"/>
         <env name="QUEUE_CONNECTION" value="sync"/>
         <env name="SESSION_DRIVER" value="array"/>
-        <env name="TELESCOPE_ENABLED" value="false"/>        
+        <env name="TELESCOPE_ENABLED" value="false"/>
+
+        <server name="OTEL_PHP_AUTOLOAD_ENABLED" value="true"/>
+        <server name="OTEL_EXPERIMENTAL_CONFIG_FILE" value="tests/Fixtures/otel-instrumentation.yaml"/>
     </php>
 
     <testsuites>

src/Instrumentation/Laravel/tests/Fixtures/ComponentProvider/LogRecordExporterInMemory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\ComponentProvider;
+
+use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
+use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\SDK\Logs\Exporter\InMemoryExporter;
+use OpenTelemetry\SDK\Logs\LogRecordExporterInterface;
+use OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\TestStorage;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+
+final class LogRecordExporterInMemory implements ComponentProvider
+{
+    public function createPlugin(array $properties, Context $context): LogRecordExporterInterface
+    {
+        return new InMemoryExporter(TestStorage::getInstance());
+    }
+
+    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    {
+        return new ArrayNodeDefinition('test/in_memory_exporter');
+    }
+}

src/Instrumentation/Laravel/tests/Fixtures/ComponentProvider/SpanExporterInMemory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\ComponentProvider;
+
+use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
+use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\SDK\Trace\SpanExporter\InMemoryExporter;
+use OpenTelemetry\SDK\Trace\SpanExporterInterface;
+use OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\TestStorage;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+
+final class SpanExporterInMemory implements ComponentProvider
+{
+    public function createPlugin(array $properties, Context $context): SpanExporterInterface
+    {
+        return new InMemoryExporter(TestStorage::getInstance());
+    }
+
+    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    {
+        return new ArrayNodeDefinition('test/in_memory_exporter');
+    }
+}

src/Instrumentation/Laravel/tests/Fixtures/TestStorage.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures;
+
+use ArrayObject;
+
+class TestStorage extends ArrayObject
+{
+    private static ?self $instance = null;
+
+    public static function getInstance(): static
+    {
+        return self::$instance ??= new self();
+    }
+
+    public static function reset(): void
+    {
+        self::$instance->exchangeArray([]);
+    }
+}

src/Instrumentation/Laravel/tests/Fixtures/otel-instrumentation.yaml

@@ -0,0 +1,18 @@
+file_format: '0.3'
+
+logger_provider:
+  processors:
+    - simple:
+        exporter:
+          test/in_memory_exporter: {}
+
+tracer_provider:
+  processors:
+    - simple:
+        exporter:
+         test/in_memory_exporter: {}
+
+instrumentation:
+  php:
+    laravel:
+      enabled: true

src/Instrumentation/Laravel/tests/Integration/TestCase.php

@@ -5,56 +5,24 @@
 namespace OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Integration;
 
 use ArrayObject;
-use OpenTelemetry\API\Instrumentation\Configurator;
-use OpenTelemetry\Context\ScopeInterface;
-use OpenTelemetry\SDK\Common\Attribute\Attributes;
-use OpenTelemetry\SDK\Common\Instrumentation\InstrumentationScopeFactory;
-use OpenTelemetry\SDK\Logs\Exporter\InMemoryExporter as LogInMemoryExporter;
-use OpenTelemetry\SDK\Logs\LoggerProvider;
-use OpenTelemetry\SDK\Logs\Processor\SimpleLogRecordProcessor;
-use OpenTelemetry\SDK\Trace\ImmutableSpan;
-use OpenTelemetry\SDK\Trace\SpanExporter\InMemoryExporter as SpanInMemoryExporter;
-use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
-use OpenTelemetry\SDK\Trace\TracerProvider;
+use OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\TestStorage;
 use Orchestra\Testbench\TestCase as BaseTestCase;
+use PHPUnit\Framework\Attributes\After;
+use PHPUnit\Framework\Attributes\Before;
 
 abstract class TestCase extends BaseTestCase
 {
-    protected ScopeInterface $scope;
-    /** @var ArrayObject|ImmutableSpan[] $storage */
     protected ArrayObject $storage;
-    protected ArrayObject $loggerStorage;
-    protected TracerProvider $tracerProvider;
-    protected LoggerProvider $loggerProvider;
 
-    public function setUp(): void
+    #[Before]
+    public function setUpTestStorage(): void
     {
-        parent::setUp();
-
-        $this->storage = new ArrayObject();
-        $this->tracerProvider = new TracerProvider(
-            new SimpleSpanProcessor(
-                new SpanInMemoryExporter($this->storage),
-            ),
-        );
-
-        $this->loggerProvider = new LoggerProvider(
-            new SimpleLogRecordProcessor(
-                new LogInMemoryExporter($this->storage),
-            ),
-            new InstrumentationScopeFactory(Attributes::factory())
-        );
-
-        $this->scope = Configurator::create()
-            ->withTracerProvider($this->tracerProvider)
-            ->withLoggerProvider($this->loggerProvider)
-            ->activate();
+        $this->storage = TestStorage::getInstance();
     }
 
-    public function tearDown(): void
+    #[After]
+    public function tearDownTestStorage(): void
     {
-        parent::tearDown();
-
-        $this->scope->detach();
+        TestStorage::reset();
     }
 }

src/Instrumentation/Laravel/tests/bootstrap.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * This file is loaded by PHPUnit (per phpunit bootstrap configuration).
+ * Necessary OTEL_* env vars have been set in phpunit.xml.dist at this point,
+ * so we can re-trigger autoloading the SDK.
+ */
+
+declare(strict_types=1);
+
+use Nevay\SPI\ServiceLoader;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
+use OpenTelemetry\SDK\SdkAutoloader;
+
+ServiceLoader::register(ComponentProvider::class, \OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\ComponentProvider\LogRecordExporterInMemory::class);
+ServiceLoader::register(ComponentProvider::class, \OpenTelemetry\Tests\Contrib\Instrumentation\Laravel\Fixtures\ComponentProvider\SpanExporterInMemory::class);
+
+// Finally, ensure that the SDK loads with the updated env vars and SPI test components.
+SdkAutoloader::autoload();