-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding basic cakephp test, fixing some test tools warnings (#263)
this adds some basic test coverage for CakePHP. I couldn't get cake's testing framework running, as I couldn't find a phpunit version it is compatible with, so I just created a controller and fumbled my way to running it something like how cake would. We have some coverage now, and a todo for a future improvement.
- Loading branch information
Showing
6 changed files
with
142 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace OpenTelemetry\Tests\Instrumentation\CakePHP\Integration\App; | ||
|
|
||
| use Cake\Controller\Controller; | ||
|
|
||
| /** | ||
| * @psalm-suppress RedundantPropertyInitializationCheck | ||
| */ | ||
| class ArticleController extends Controller | ||
| { | ||
| public function index(): void | ||
| { | ||
| } | ||
| public function update(): void | ||
| { | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace OpenTelemetry\Tests\Instrumentation\CakePHP\Integration; | ||
|
|
||
| use ArrayObject; | ||
| use Cake\Core\Configure; | ||
| use Cake\Http\Response; | ||
| use Cake\Http\ServerRequest; | ||
| use OpenTelemetry\API\Instrumentation\Configurator; | ||
| use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator; | ||
| use OpenTelemetry\API\Trace\SpanKind; | ||
| use OpenTelemetry\API\Trace\StatusCode; | ||
| use OpenTelemetry\Context\ScopeInterface; | ||
| use OpenTelemetry\SDK\Trace\ImmutableSpan; | ||
| use OpenTelemetry\SDK\Trace\SpanExporter\InMemoryExporter; | ||
| use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor; | ||
| use OpenTelemetry\SDK\Trace\TracerProvider; | ||
| use OpenTelemetry\Tests\Instrumentation\CakePHP\Integration\App\ArticleController; | ||
| use PHPUnit\Framework\TestCase; | ||
| use Psr\Http\Message\ResponseInterface; | ||
|
|
||
| /** | ||
| * @covers \OpenTelemetry\Contrib\Instrumentation\CakePHP\CakePHPInstrumentation | ||
| * @todo Use CakePHP's test framework, https://book.cakephp.org/4/en/development/testing.html | ||
| */ | ||
| class CakePHPInstrumentationTest extends TestCase | ||
| { | ||
| private const TRACE_ID = 'ff000000000000000000000000000041'; | ||
| private const SPAN_ID = 'ff00000000000041'; | ||
| private const TRACEPARENT_HEADER = '00-' . self::TRACE_ID . '-' . self::SPAN_ID . '-01'; | ||
| private ScopeInterface $scope; | ||
| /** @var ArrayObject<int, ImmutableSpan> $storage */ | ||
| private ArrayObject $storage; | ||
|
|
||
| public function setUp(): void | ||
| { | ||
| $this->storage = new ArrayObject(); | ||
| $tracerProvider = new TracerProvider( | ||
| new SimpleSpanProcessor( | ||
| new InMemoryExporter($this->storage) | ||
| ) | ||
| ); | ||
|
|
||
| $this->scope = Configurator::create() | ||
| ->withTracerProvider($tracerProvider) | ||
| ->withPropagator(TraceContextPropagator::getInstance()) | ||
| ->activate(); | ||
|
|
||
| Configure::write('App.encoding', 'utf8'); | ||
| } | ||
|
|
||
| public function tearDown(): void | ||
| { | ||
| $this->scope->detach(); | ||
| } | ||
|
|
||
| public function test_index(): void | ||
| { | ||
| $this->assertCount(0, $this->storage); | ||
|
|
||
| $request = new ServerRequest(['environment' => ['HTTP_TRACEPARENT' => self::TRACEPARENT_HEADER]]); | ||
| $controller = new ArticleController($request); | ||
|
|
||
| $controller->invokeAction(function (): ResponseInterface { | ||
| return new Response(['body' => 'hello world']); | ||
| }, []); | ||
|
|
||
| $this->assertCount(1, $this->storage); | ||
| /** @var ImmutableSpan $span */ | ||
| $span = $this->storage[0]; | ||
| $this->assertSame(StatusCode::STATUS_UNSET, $span->getStatus()->getCode()); | ||
| $this->assertSame('GET', $span->getName()); | ||
| $this->assertSame(SpanKind::KIND_SERVER, $span->getKind()); | ||
| $this->assertGreaterThan(0, $span->getAttributes()->count()); | ||
| $attributes = $span->getAttributes()->toArray(); | ||
| $this->assertSame('invokeAction', $attributes['code.function']); | ||
| $this->assertSame('GET', $attributes['http.request.method']); | ||
| $this->assertSame(200, $attributes['http.response.status_code']); | ||
| $this->assertSame(self::TRACE_ID, $span->getParentContext()->getTraceId()); | ||
| $this->assertSame(self::SPAN_ID, $span->getParentContext()->getSpanId()); | ||
| } | ||
|
|
||
| public function test_exception(): void | ||
| { | ||
| $this->assertCount(0, $this->storage); | ||
|
|
||
| $request = new ServerRequest(); | ||
| $controller = new ArticleController($request); | ||
|
|
||
| try { | ||
| $controller->invokeAction(function (): ResponseInterface { | ||
| throw new \Exception('kaboom'); | ||
| }, []); | ||
| } catch (\Exception $e) { | ||
| } | ||
|
|
||
| $this->assertCount(1, $this->storage); | ||
| /** @var ImmutableSpan $span */ | ||
| $span = $this->storage[0]; | ||
| $this->assertSame(StatusCode::STATUS_ERROR, $span->getStatus()->getCode()); | ||
| $event = $span->getEvents()[0]; | ||
| $this->assertSame('exception', $event->getName()); | ||
| $this->assertSame('kaboom', $event->getAttributes()->get('exception.message')); | ||
| } | ||
| } |