From 6d9f91c9c2f26aaadfe6bd764fe5c51978a719ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9lie-Dzovinar?= Date: Thu, 28 Nov 2024 10:17:59 +0100 Subject: [PATCH] Revert "feat(api tester): exclude 400 test cases for openapi endpoints" --- .../Loader/OpenApiDefinitionLoader.php | 1 - src/Definition/Operation.php | 23 --------- .../Error400BadFormatsPreparatorConfig.php | 9 ---- .../Error400BadTypesPreparatorConfig.php | 9 ---- ...0MissingRequiredFieldsPreparatorConfig.php | 9 ---- .../Config/Error400PreparatorConfig.php | 10 ---- src/Preparator/Error400Preparator.php | 10 +--- ...400MissingRequiredFieldsPreparatorTest.php | 47 +------------------ 8 files changed, 2 insertions(+), 116 deletions(-) delete mode 100644 src/Preparator/Config/Error400BadFormatsPreparatorConfig.php delete mode 100644 src/Preparator/Config/Error400BadTypesPreparatorConfig.php delete mode 100644 src/Preparator/Config/Error400MissingRequiredFieldsPreparatorConfig.php delete mode 100644 src/Preparator/Config/Error400PreparatorConfig.php diff --git a/src/Definition/Loader/OpenApiDefinitionLoader.php b/src/Definition/Loader/OpenApiDefinitionLoader.php index fdc9843e..5a5f40da 100644 --- a/src/Definition/Loader/OpenApiDefinitionLoader.php +++ b/src/Definition/Loader/OpenApiDefinitionLoader.php @@ -133,7 +133,6 @@ private function getOperations(array $paths, array $securitySchemes, array $filt ->setTags($this->getTags($operation->tags)) ->setSecurities($this->getSecurities($securitySchemes, $requirements)) ->setExamples($this->getExamples($operation, $parameters)) - ->setExtensions($operation->getExtensions()) ); } } diff --git a/src/Definition/Operation.php b/src/Definition/Operation.php index 94a503c2..b5f406bd 100644 --- a/src/Definition/Operation.php +++ b/src/Definition/Operation.php @@ -43,11 +43,6 @@ final class Operation implements Filterable private OperationExamples $examples; - /** - * @var array - */ - private array $extensions; - public function __construct( private readonly string $id, private readonly string $path, @@ -205,14 +200,6 @@ public function setResponses(Responses $responses): self return $this; } - /** - * @return array $extensions - */ - public function getExtensions(): array - { - return $this->extensions; - } - public function getResponse(int $status): ?Response { return $this->responses->get($status); @@ -290,16 +277,6 @@ public function setExamples(OperationExamples $examples): self return $this; } - /** - * @param array $extensions - */ - public function setExtensions(array $extensions): self - { - $this->extensions = $extensions; - - return $this; - } - /** * @param array $params * diff --git a/src/Preparator/Config/Error400BadFormatsPreparatorConfig.php b/src/Preparator/Config/Error400BadFormatsPreparatorConfig.php deleted file mode 100644 index 18e17d0d..00000000 --- a/src/Preparator/Config/Error400BadFormatsPreparatorConfig.php +++ /dev/null @@ -1,9 +0,0 @@ - */ return $operations - ->map(fn (Operation $operation) => $this->prepareTestCases($operation)) + ->map(fn (Operation $op) => $this->prepareTestCases($op)) ->flatten() ; } @@ -122,10 +118,6 @@ protected function getStatusCode(): string */ private function prepareTestCases(Operation $operation): array { - if ($this->config->excludeOpenApiEndpoints - && isset($operation->getExtensions()['x-usecase'])) { - return []; - } $requiredParams = $operation->getParameters(true); return array_merge( diff --git a/tests/Preparator/Error400MissingRequiredFieldsPreparatorTest.php b/tests/Preparator/Error400MissingRequiredFieldsPreparatorTest.php index b762e1f8..524573e0 100644 --- a/tests/Preparator/Error400MissingRequiredFieldsPreparatorTest.php +++ b/tests/Preparator/Error400MissingRequiredFieldsPreparatorTest.php @@ -21,13 +21,11 @@ final class Error400MissingRequiredFieldsPreparatorTest extends \PHPUnit\Framewo /** * @dataProvider getData * - * @param array> $config * @param TestCase[] $expected */ - public function test(Api $api, array $expected, array $config = []): void + public function test(Api $api, array $expected): void { $preparator = new Error400MissingRequiredFieldsPreparator(); - $preparator->configure($config); Assert::objectsEqual( $expected, $preparator->doPrepare($api->getOperations()), @@ -165,48 +163,5 @@ public function getData(): iterable ), ], ]; - - yield 'openapi endpoint is ignored' => [ - Api::create() - ->addOperation( - Operation::create( - 'test', - '/test', - 'POST' - ) - ->addRequestBody( - (new Body( - new Schema([ - 'type' => 'object', - 'properties' => [ - 'foo' => [ - 'type' => 'string', - ], - 'bar' => [ - 'type' => 'string', - ], - ], - 'required' => ['foo'], - ]), - 'application/json' - )) - ) - ->addExample( - OperationExample::create('foo') - ->setBodyContent([ - 'foo' => 'foo_body1', - 'bar' => 'bar_body1', - ]) - ->setQueryParameter('foo_query', 'foo1') - )->setExtensions([ - 'x-usecase' => 'UseCaseName', - ]) - ), - [ - ], - [ - 'excludeOpenApiEndpoints' => true, - ], - ]; } }