kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[APIP3] Refactor a bit the validation of Statistics, enable contract tests (#16908)

Browse source 
| Q               | A
|-----------------|-----
| Branch?         | 2.0 <!-- see the comment below -->
| Bug fix?        | no
| New feature?    | no
| BC breaks?      | no
| License         | MIT

<!--
 - Bug fixes must be submitted against the 1.13 branch
 - Features and deprecations must be submitted against the 1.14 branch
- Features, removing deprecations and BC breaks must be submitted
against the 2.0 branch
 - Make sure that the correct base branch is set

To be sure you are not breaking any Backward Compatibilities, check the
documentation:

https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html
-->
This commit is contained in:
Rafał Jaskulski 2024-09-10 14:13:50 +02:00 • committed by GitHub
commit 54e5afd0a6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 332 additions and 342 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

339
disabledTests/Api/Admin/StatisticsTest.php
View file

@ -1,339 +0,0 @@
<?php
/*
* This file is part of the Sylius package.
*
* (c) Sylius Sp. z o.o.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Sylius\Tests\Api\Admin;
use Sylius\Tests\Api\JsonApiTestCase;
use Sylius\Tests\Api\Utils\OrderPlacerTrait;
final class StatisticsTest extends JsonApiTestCase
{
use OrderPlacerTrait;
protected function setUp(): void
{
$this->setUpOrderPlacer();
parent::setUp();
}
/**
* @test
*
* @dataProvider invalidPeriods
*/
public function it_returns_a_validation_error_if_period_is_invalid(array $parameters): void
{
$this->loadFixturesFromFiles(['authentication/api_administrator.yaml', 'channel/channel.yaml']);
$this->client->request(
method: 'GET',
uri: '/api/v2/admin/statistics',
parameters: $parameters,
server: $this->headerBuilder()->withAdminUserAuthorization('api@example.com')->build(),
);
$this->assertResponseViolations(
$this->client->getResponse(),
[
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
);
}
/**
* @test
*
* @dataProvider missingQueryParameters
* @dataProvider emptyQueryParameters
* @dataProvider invalidQueryParameters
*/
public function it_returns_a_validation_error_if_any_of_required_parameters_is_missing_empty_or_invalid(
array $queryParameters,
array $expectedViolations,
): void {
$this->loadFixturesFromFiles(['authentication/api_administrator.yaml', 'channel/channel.yaml']);
$this->client->request(
method: 'GET',
uri: '/api/v2/admin/statistics',
parameters: $queryParameters,
server: $this->headerBuilder()->withAdminUserAuthorization('api@example.com')->build(),
);
$this->assertResponseViolations($this->client->getResponse(), $expectedViolations);
}
public function missingQueryParameters(): iterable
{
yield 'missing channelCode' => [
'parameters' => [
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'This field is missing.',
],
],
];
yield 'missing startDate' => [
'parameters' => [
'channelCode' => 'WEB',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[startDate]',
'message' => 'This field is missing.',
],
],
];
yield 'missing interval' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[interval]',
'message' => 'This field is missing.',
],
],
];
yield 'missing endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
],
'expectedViolations' => [
[
'propertyPath' => '[endDate]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
];
yield 'missing all parameters' => [
'parameters' => [],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '[startDate]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '[interval]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '[endDate]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
];
}
public function emptyQueryParameters(): iterable
{
yield 'empty channelCode' => [
'parameters' => [
'channelCode' => '',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'Please enter a code.',
],
],
];
yield 'empty startDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[startDate]',
'message' => 'This value should not be blank.',
],
],
];
yield 'empty interval' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => '',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[interval]',
'message' => 'The value you selected is not a valid choice.',
],
],
];
yield 'empty endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '',
],
'expectedViolations' => [
[
'propertyPath' => '[endDate]',
'message' => 'This value should not be blank.',
],
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
];
}
public function invalidQueryParameters(): iterable
{
yield 'invalid channelCode as float value' => [
'parameters' => [
'channelCode' => 1.1,
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'The code should contain only letters, numbers, dashes ("-" symbol) and underscores ("_" symbol).',
],
],
];
yield 'invalid startDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => 'INVALID_START_DATE',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[startDate]',
'message' => 'The date time is not valid ISO 8601 date time in Y-m-d\TH:i:s format.',
],
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
];
yield 'unknown interval' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'invalid',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[interval]',
'message' => 'The value you selected is not a valid choice.',
],
],
];
yield 'invalid endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => 'INVALID_END_DATE',
],
'expectedViolations' => [
[
'propertyPath' => '[endDate]',
'message' => 'The date time is not valid ISO 8601 date time in Y-m-d\TH:i:s format.',
],
],
];
yield 'unexpected parameter' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'day',
'endDate' => '2023-12-31T23:59:59',
'unexpected_parameter' => 'unexpected_value',
],
'expectedViolations' => [
[
'propertyPath' => '[unexpected_parameter]',
'message' => 'This field was not expected.',
],
],
];
}
public function invalidPeriods(): iterable
{
yield 'startDate is after endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2022-12-31T23:59:59',
],
];
yield 'startDate is equal to endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-01-01T00:00:00',
],
];
}
}

33
src/Sylius/Bundle/ApiBundle/Controller/GetStatisticsAction.php
View file

@ -13,7 +13,6 @@ declare(strict_types=1);
namespace Sylius\Bundle\ApiBundle\Controller;
use ApiPlatform\Symfony\Validator\Exception\ValidationException;
use Sylius\Bundle\ApiBundle\Query\GetStatistics;
use Sylius\Bundle\ApiBundle\Validator\Constraints;
use Symfony\Component\HttpFoundation\JsonResponse;
@ -25,6 +24,8 @@ use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints as SymfonyConstraints;
use Symfony\Component\Validator\ConstraintViolationListInterface;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;
final class GetStatisticsAction
@ -58,7 +59,7 @@ final class GetStatisticsAction
$violations = $this->validator->validate($parameters, $this->constraints);
if (count($violations) > 0) {
throw new ValidationException($violations);
return $this->createValidationErrorResponse($violations);
}
$interval = $parameters['interval'];
@ -102,7 +103,9 @@ final class GetStatisticsAction
new SymfonyConstraints\DateTime('Y-m-d\TH:i:s', message: 'sylius.date_time.invalid'),
],
]),
new SymfonyConstraints\Expression(expression: 'value["startDate"] < value["endDate"]', message: 'sylius.statistics.end_date.invalid'),
new SymfonyConstraints\Callback(function ($data, ExecutionContextInterface $context) {
$this->validateDateRange($data, $context);
}),
];
}
@ -120,4 +123,28 @@ final class GetStatisticsAction
return $intervals;
}
private function validateDateRange($data, ExecutionContextInterface $context): void
{
if ((isset($data['startDate'], $data['endDate'])) && $data['startDate'] >= $data['endDate']) {
$context->buildViolation('sylius.statistics.end_date.invalid')
->addViolation();
}
}
private function createValidationErrorResponse(ConstraintViolationListInterface $violations): JsonResponse
{
$errors = [];
foreach ($violations as $violation) {
$errors[] = [
'propertyPath' => $violation->getPropertyPath(),
'message' => $violation->getMessage(),
];
}
return new JsonResponse([
'status' => Response::HTTP_UNPROCESSABLE_ENTITY,
'violations' => $errors,
], Response::HTTP_UNPROCESSABLE_ENTITY);
}
}

302
tests/Api/Admin/StatisticsTest.php
View file

@ -156,4 +156,306 @@ final class StatisticsTest extends JsonApiTestCase
yield ['month'];
yield ['year'];
}
/**
* @test
*
* @dataProvider invalidPeriods
*/
public function it_returns_a_validation_error_if_period_is_invalid(array $parameters): void
{
$this->loadFixturesFromFiles(['authentication/api_administrator.yaml', 'channel/channel.yaml']);
$this->client->request(
method: 'GET',
uri: '/api/v2/admin/statistics',
parameters: $parameters,
server: $this->headerBuilder()->withAdminUserAuthorization('api@example.com')->build(),
);
$this->assertResponseViolations(
$this->client->getResponse(),
[
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
);
}
/**
* @test
*
* @dataProvider missingQueryParameters
* @dataProvider emptyQueryParameters
* @dataProvider invalidQueryParameters
*/
public function it_returns_a_validation_error_if_any_of_required_parameters_is_missing_empty_or_invalid(
array $queryParameters,
array $expectedViolations,
): void {
$this->loadFixturesFromFiles(['authentication/api_administrator.yaml', 'channel/channel.yaml']);
$this->client->request(
method: 'GET',
uri: '/api/v2/admin/statistics',
parameters: $queryParameters,
server: $this->headerBuilder()->withAdminUserAuthorization('api@example.com')->build(),
);
$this->assertResponseViolations($this->client->getResponse(), $expectedViolations);
}
public function missingQueryParameters(): iterable
{
yield 'missing channelCode' => [
'parameters' => [
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'This field is missing.',
],
],
];
yield 'missing startDate' => [
'parameters' => [
'channelCode' => 'WEB',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[startDate]',
'message' => 'This field is missing.',
],
],
];
yield 'missing interval' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[interval]',
'message' => 'This field is missing.',
],
],
];
yield 'missing endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
],
'expectedViolations' => [
[
'propertyPath' => '[endDate]',
'message' => 'This field is missing.',
],
],
];
yield 'missing all parameters' => [
'parameters' => [],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '[startDate]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '[interval]',
'message' => 'This field is missing.',
],
[
'propertyPath' => '[endDate]',
'message' => 'This field is missing.',
],
],
];
}
public function emptyQueryParameters(): iterable
{
yield 'empty channelCode' => [
'parameters' => [
'channelCode' => '',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'Please enter a code.',
],
],
];
yield 'empty startDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[startDate]',
'message' => 'This value should not be blank.',
],
],
];
yield 'empty interval' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => '',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[interval]',
'message' => 'The value you selected is not a valid choice.',
],
],
];
yield 'empty endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '',
],
'expectedViolations' => [
[
'propertyPath' => '[endDate]',
'message' => 'This value should not be blank.',
],
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
];
}
public function invalidQueryParameters(): iterable
{
yield 'invalid channelCode as float value' => [
'parameters' => [
'channelCode' => 1.1,
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[channelCode]',
'message' => 'The code should contain only letters, numbers, dashes ("-" symbol) and underscores ("_" symbol).',
],
],
];
yield 'invalid startDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => 'INVALID_START_DATE',
'interval' => 'month',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[startDate]',
'message' => 'The date time is not valid ISO 8601 date time in Y-m-d\TH:i:s format.',
],
[
'propertyPath' => '',
'message' => 'The start date must be earlier than the end date.',
],
],
];
yield 'unknown interval' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'invalid',
'endDate' => '2023-12-31T23:59:59',
],
'expectedViolations' => [
[
'propertyPath' => '[interval]',
'message' => 'The value you selected is not a valid choice.',
],
],
];
yield 'invalid endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => 'INVALID_END_DATE',
],
'expectedViolations' => [
[
'propertyPath' => '[endDate]',
'message' => 'The date time is not valid ISO 8601 date time in Y-m-d\TH:i:s format.',
],
],
];
yield 'unexpected parameter' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'day',
'endDate' => '2023-12-31T23:59:59',
'unexpected_parameter' => 'unexpected_value',
],
'expectedViolations' => [
[
'propertyPath' => '[unexpected_parameter]',
'message' => 'This field was not expected.',
],
],
];
}
public function invalidPeriods(): iterable
{
yield 'startDate is after endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2022-12-31T23:59:59',
],
];
yield 'startDate is equal to endDate' => [
'parameters' => [
'channelCode' => 'WEB',
'startDate' => '2023-01-01T00:00:00',
'interval' => 'month',
'endDate' => '2023-01-01T00:00:00',
],
];
}
}