LogWriterFactoryTest.php

<?php

declare(strict_types=1);

namespace OpenTelemetry\Tests\Unit\API\Behavior\Internal;

use OpenTelemetry\API\Behavior\Internal\LogWriter\ErrorLogWriter;
use OpenTelemetry\API\Behavior\Internal\LogWriter\NoopLogWriter;
use OpenTelemetry\API\Behavior\Internal\LogWriter\Psr3LogWriter;
use OpenTelemetry\API\Behavior\Internal\LogWriter\StreamLogWriter;
use OpenTelemetry\API\Behavior\Internal\LogWriterFactory;
use OpenTelemetry\API\LoggerHolder;
use OpenTelemetry\Tests\TestState;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

#[CoversClass(LogWriterFactory::class)]
class LogWriterFactoryTest extends TestCase
{
    use TestState;

    #[\Override]
    public function setUp(): void
    {
        LoggerHolder::unset();
    }

    /**
     * @psalm-suppress ArgumentTypeCoercion
     */
    #[DataProvider('logDestinationProvider')]
    public function test_log_destination_from_env(string $value, string $expected): void
    {
        $this->setEnvironmentVariable('OTEL_PHP_LOG_DESTINATION', $value);
        $this->assertInstanceOf($expected, (new LogWriterFactory())->create());
    }

    public static function logDestinationProvider(): array
    {
        return [
            ['error_log', ErrorLogWriter::class],
            ['stdout', StreamLogWriter::class],
            ['stderr', StreamLogWriter::class],
            ['none', NoopLogWriter::class],
            ['', ErrorLogWriter::class],
        ];
    }

    public function test_psr3_log_destination(): void
    {
        LoggerHolder::set($this->createMock(LoggerInterface::class));
        $this->assertInstanceOf(Psr3LogWriter::class, (new LogWriterFactory())->create());
    }

    public function test_psr3_from_env_with_logger(): void
    {
        $this->setEnvironmentVariable('OTEL_PHP_LOG_DESTINATION', 'psr3');
        LoggerHolder::set($this->createMock(LoggerInterface::class));
        $this->assertInstanceOf(Psr3LogWriter::class, (new LogWriterFactory())->create());
    }

    public function test_psr3_from_env_without_logger_falls_back_to_error_log(): void
    {
        $this->setEnvironmentVariable('OTEL_PHP_LOG_DESTINATION', 'psr3');
        $this->assertInstanceOf(ErrorLogWriter::class, (new LogWriterFactory())->create());
    }

    public function test_default_with_logger_uses_psr3(): void
    {
        LoggerHolder::set($this->createMock(LoggerInterface::class));
        $this->setEnvironmentVariable('OTEL_PHP_LOG_DESTINATION', '');
        $this->assertInstanceOf(Psr3LogWriter::class, (new LogWriterFactory())->create());
    }
}