Skip to content

test(openapi): assert the yaml export structurally, not by key order #8464

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
soyuka merged 1 commit into from
Aug 16, 2026
Merged

test(openapi): assert the yaml export structurally, not by key order #8464

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
26 changes: 10 additions & 16 deletions tests/OpenApi/Command/OpenApiCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,27 +76,21 @@ public function testExecuteWithYaml(): void

$this->assertYaml($result);

$operationId = 'api_dummy_cars_get_collection';
// the serializer does not guarantee property order, so assert the structure rather than a
// rendered block, and keep separate assertions for the formatting this test cares about
$parsed = Yaml::parse($result);

$this->assertSame('api_dummy_cars_get_collection', $parsed['paths']['/dummy_cars']['get']['operationId'], 'nested object should be present.');
$this->assertSame(['DummyCar'], $parsed['paths']['/dummy_cars']['get']['tags']);
$this->assertSame('api_dummy_cars_id_get', $parsed['paths']['/dummy_cars/{id}']['get']['operationId']);
$this->assertSame([], $parsed['paths']['/dummy_cars/{id}']['get']['tags']);

$expected = <<<YAML
/dummy_cars:
get:
operationId: $operationId
tags:
- DummyCar
YAML;

$this->assertStringContainsString($expected, $result, 'nested object should be present.');

$operationId = 'api_dummy_cars_id_get';
$expected = <<<YAML
'/dummy_cars/{id}':
get:
operationId: $operationId
tags: []
YAML;

$this->assertStringContainsString($expected, $result, 'arrays should be correctly formatted.');
$this->assertStringContainsString($expected, $result, 'sequences should be correctly formatted.');
$this->assertStringContainsString(' tags: []', $result, 'arrays should be correctly formatted.');
$this->assertStringContainsString('openapi: '.OpenApi::VERSION, $result);

$expected = <<<YAML
Expand Down
Loading