RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Check min/max On Range Constraints Before Use

Browse Source 
Previously it was possible to set only one of the min or max values and
get a schema like:

    "property": {
      "type": "integer",
      "minimum": 1,
      "maximum": 0
    }

Also possible that `Range` would be used with {min,max}PropertyPath and
you'd get a schema with both minimum and max set to zero.

With the checks in place, that's no longer the case.
This commit is contained in:
Christopher Davis 2021-05-25 06:39:21 -05:00
parent 7fd8c0ecfe
commit 5f1645db40
2 changed files with 78 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ModelDescriber/Annotations/SymfonyConstraintAnnotationReader.php
View File

@ -85,8 +85,12 @@ class SymfonyConstraintAnnotationReader
} elseif ($annotation instanceof Assert\Choice) {
$this->applyEnumFromChoiceConstraint($property, $annotation, $reflection);
} elseif ($annotation instanceof Assert\Range) {
$property->minimum = (int) $annotation->min;
$property->maximum = (int) $annotation->max;
if (isset($annotation->min)) {
$property->minimum = (int) $annotation->min;
}
if (isset($annotation->max)) {
$property->maximum = (int) $annotation->max;
}
} elseif ($annotation instanceof Assert\LessThan) {
$property->exclusiveMaximum = true;
$property->maximum = (int) $annotation->value;

72
Tests/ModelDescriber/Annotations/SymfonyConstraintAnnotationReaderTest.php
View File

@ -316,4 +316,76 @@ class SymfonyConstraintAnnotationReaderTest extends TestCase
}];
}
}
/**
* @param object $entity
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1822
* @dataProvider provideRangeConstraintDoesNotSetMaximumIfMaxIsNotSet
*/
public function testRangeConstraintDoesNotSetMaximumIfMaxIsNotSet($entity)
{
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->maximum);
$this->assertSame(10, $schema->properties[0]->minimum);
}
public function provideRangeConstraintDoesNotSetMaximumIfMaxIsNotSet(): iterable
{
yield 'Annotations' => [new class() {
/**
* @Assert\Range(min = 10)
*/
private $property1;
}];
if (\PHP_VERSION_ID >= 80000) {
yield 'Attributes' => [new class() {
#[Assert\Range(min: 10)]
private $property1;
}];
}
}
/**
* @param object $entity
* @group https://github.com/nelmio/NelmioApiDocBundle/issues/1822
* @dataProvider provideRangeConstraintDoesNotSetMinimumIfMinIsNotSet
*/
public function testRangeConstraintDoesNotSetMinimumIfMinIsNotSet($entity)
{
$schema = new OA\Schema([]);
$schema->merge([new OA\Property(['property' => 'property1'])]);
$symfonyConstraintAnnotationReader = new SymfonyConstraintAnnotationReader(new AnnotationReader());
$symfonyConstraintAnnotationReader->setSchema($schema);
$symfonyConstraintAnnotationReader->updateProperty(new \ReflectionProperty($entity, 'property1'), $schema->properties[0]);
$this->assertSame(OA\UNDEFINED, $schema->properties[0]->minimum);
$this->assertSame(10, $schema->properties[0]->maximum);
}
public function provideRangeConstraintDoesNotSetMinimumIfMinIsNotSet(): iterable
{
yield 'Annotations' => [new class() {
/**
* @Assert\Range(max = 10)
*/
private $property1;
}];
if (\PHP_VERSION_ID >= 80000) {
yield 'Attributes' => [new class() {
#[Assert\Range(max: 10)]
private $property1;
}];
}
}
}