opentelemetry-php/tests/Unit/Context/ContextTest.php

<?php

declare(strict_types=1);

namespace OpenTelemetry\Tests\Unit\Context;

use OpenTelemetry\Context\Context;
use OpenTelemetry\Context\ContextKey;
use PHPUnit\Framework\TestCase;

/**
 * @covers \OpenTelemetry\Context\Context
 */
class ContextTest extends TestCase
{
    public function test_activate(): void
    {
        $context = Context::getRoot();

        $context->activate();
        $this->assertSame($context, Context::getCurrent());
    }

    public function test_ctx_can_store_values_by_key(): void
    {
        $key1 = new ContextKey('key1');
        $key2 = new ContextKey('key2');

        $ctx = Context::getRoot()->with($key1, 'val1')->with($key2, 'val2');

        $this->assertSame($ctx->get($key1), 'val1');
        $this->assertSame($ctx->get($key2), 'val2');
    }

    public function test_set_does_not_mutate_the_original(): void
    {
        $key1 = new ContextKey();
        $key2 = new ContextKey();

        $parent = Context::getRoot()->with($key1, 'foo');
        $child = $parent->with($key2, 'bar');

        $this->assertSame($child->get($key1), 'foo');
        $this->assertSame($child->get($key2), 'bar');
        $this->assertSame($parent->get($key1), 'foo');

        $this->assertNull($parent->get($key2));
    }

    public function test_ctx_key_names_are_not_ids(): void
    {
        $key_name = 'foo';

        $key1 = new ContextKey($key_name);
        $key2 = new ContextKey($key_name);

        $ctx = Context::getRoot()->with($key1, 'val1')->with($key2, 'val2');

        $this->assertSame($ctx->get($key1), 'val1');
        $this->assertSame($ctx->get($key2), 'val2');
    }

    public function test_empty_ctx_keys_are_valid(): void
    {
        $key1 = new ContextKey();
        $key2 = new ContextKey();

        $ctx = Context::getRoot()->with($key1, 'val1')->with($key2, 'val2');

        $this->assertSame($ctx->get($key1), 'val1');
        $this->assertSame($ctx->get($key2), 'val2');
    }

    public function test_ctx_can_store_scalar_array_null_and_obj(): void
    {
        $scalar_val = 42;
        $array_val = ['foo', 'bar'];
        $null_val = null;
        $obj_val = new \stdClass();

        $scalar_key = new ContextKey();
        $array_key = new ContextKey();
        $null_key = new ContextKey();
        $obj_key = new ContextKey();

        $ctx = Context::getRoot()
            ->with($scalar_key, $scalar_val)
            ->with($array_key, $array_val)
            ->with($null_key, $null_val)
            ->with($obj_key, $obj_val);

        $this->assertSame($ctx->get($scalar_key), $scalar_val);
        $this->assertSame($ctx->get($array_key), $array_val);
        $this->assertSame($ctx->get($null_key), $null_val);
        $this->assertSame($ctx->get($obj_key), $obj_val);
    }

    public function test_storage_order_doesnt_matter(): void
    {
        $context = Context::getRoot();
        $arr = [];
        foreach (range(0, 9) as $i) {
            $r = rand(0, 100);
            $key = new ContextKey((string) $r);
            $context = $context->with($key, $r);
            $arr[$r] = $key;
        }

        ksort($arr);

        foreach ($arr as $v => $k) {
            $this->assertSame($context->get($k), $v);
        }
    }

    public function test_reusing_key_overwrites_value(): void
    {
        $key = new ContextKey();
        $ctx = Context::getRoot()->with($key, 'val1');
        $this->assertSame($ctx->get($key), 'val1');

        $ctx = $ctx->with($key, 'val2');
        $this->assertSame($ctx->get($key), 'val2');
    }

    public function test_ctx_value_not_found_returns_null(): void
    {
        $ctx = Context::getRoot()->with(new ContextKey('foo'), 'bar');
        $this->assertNull($ctx->get(new ContextKey('baz')));
    }

    public function test_attach_and_detach_set_current_ctx(): void
    {
        $key = new ContextKey();
        Context::getRoot()->with($key, '111')->activate();

        $token = Context::getRoot()->with($key, '222')->activate();
        $this->assertSame(Context::getValue($key), '222');

        $token->detach();
        $this->assertSame(Context::getValue($key), '111');
    }

    public function test_instance_set_and_static_get_use_same_ctx(): void
    {
        $key = new ContextKey('ofoba');
        $val = 'foobar';

        $ctx = Context::getRoot()->with($key, $val);
        $ctx->activate();

        $this->assertSame(Context::getValue($key, $ctx), $val);
        $this->assertSame(Context::getValue($key, null), $val);
    }
}