RequestParameter: add parameter location validation and its default v…

…alue

Signed-off-by: Roman Ondráček <ondracek.roman@centrum.cz>

src/Annotation/Controller/RequestParameter.php

@@ -2,6 +2,7 @@
 
 namespace Apitte\Core\Annotation\Controller;
 
+use Apitte\Core\Schema\EndpointParameter;
 use Attribute;
 use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
 use Doctrine\Common\Annotations\Annotation\Target;
@@ -40,7 +41,7 @@ final class RequestParameter
 	public function __construct(
 		string $name,
 		string $type,
-		string $in,
+		string $in = EndpointParameter::IN_PATH,
 		bool $required = true,
 		bool $allowEmpty = false,
 		bool $deprecated = false,
@@ -55,6 +56,10 @@ public function __construct(
 			throw new AnnotationException('Empty @RequestParameter type given');
 		}
 
+		if (!in_array($in, EndpointParameter::IN, true)) {
+			throw new AnnotationException('Invalid @RequestParameter in given');
+		}
+
 		$this->name = $name;
 		$this->type = $type;
 		$this->required = $required;

tests/cases/Annotation/Controller/RequestParameter.phpt

@@ -24,9 +24,28 @@ test(function (): void {
 	);
 
 	Assert::same('Parameter', $requestParameter->getName());
-	Assert::same('Desc', $requestParameter->getDescription());
 	Assert::same(EndpointParameter::TYPE_STRING, $requestParameter->getType());
 	Assert::same(EndpointParameter::IN_QUERY, $requestParameter->getIn());
+	Assert::true($requestParameter->isRequired());
+	Assert::false($requestParameter->isAllowEmpty());
+	Assert::false($requestParameter->isDeprecated());
+	Assert::same('Desc', $requestParameter->getDescription());
+});
+
+// OK - short
+test(function (): void {
+	$requestParameter = new RequestParameter(
+		'Parameter',
+		EndpointParameter::TYPE_STRING
+	);
+
+	Assert::same('Parameter', $requestParameter->getName());
+	Assert::same(EndpointParameter::TYPE_STRING, $requestParameter->getType());
+	Assert::same(EndpointParameter::IN_PATH, $requestParameter->getIn());
+	Assert::true($requestParameter->isRequired());
+	Assert::false($requestParameter->isAllowEmpty());
+	Assert::false($requestParameter->isDeprecated());
+	Assert::null($requestParameter->getDescription());
 });
 
 // Exception - no type
@@ -35,3 +54,10 @@ test(function (): void {
 		new RequestParameter('Param', '', EndpointParameter::IN_PATH);
 	}, AnnotationException::class, 'Empty @RequestParameter type given');
 });
+
+// Exception - invalid parameter location
+test(function (): void {
+	Assert::exception(function (): void {
+		new RequestParameter('Param', EndpointParameter::TYPE_STRING, 'invalid');
+	}, AnnotationException::class, 'Invalid @RequestParameter in given');
+});

tests/cases/DI/Loader/DoctrineMultiAnnotationLoader.phpt

@@ -8,6 +8,7 @@ require_once __DIR__ . '/../../../bootstrap.php';
 
 use Apitte\Core\DI\Loader\DoctrineAnnotationLoader;
 use Apitte\Core\Schema\Builder\Controller\Controller;
+use Apitte\Core\Schema\EndpointParameter;
 use Apitte\Core\Schema\SchemaBuilder;
 use Nette\DI\ContainerBuilder;
 use Tester\Assert;
@@ -62,14 +63,14 @@ function testRequestParameters(Controller $controller): void
 
 	Assert::equal('name_value', $firstParameter->getName());
 	Assert::equal('type_value', $firstParameter->getType());
-	Assert::equal('in_value', $firstParameter->getIn());
+	Assert::equal(EndpointParameter::IN_PATH, $firstParameter->getIn());
 	Assert::null($firstParameter->getDescription());
 
 	$secondParameter = $requestParametersMethod->getParameters()['name_value_2'];
 
 	Assert::equal('name_value_2', $secondParameter->getName());
 	Assert::equal('type_value_2', $secondParameter->getType());
-	Assert::equal('in_value_2', $secondParameter->getIn());
+	Assert::equal(EndpointParameter::IN_QUERY, $secondParameter->getIn());
 	Assert::null($secondParameter->getDescription());
 }
 

tests/fixtures/Controllers/AnnotationMultiController.php

@@ -29,8 +29,8 @@ public function responses(): void
 
 	/**
 	 * @RequestParameters({
-	 *		@RequestParameter(name="name_value", type="type_value", in="in_value"),
-	 *		@RequestParameter(in="in_value_2", type="type_value_2", name="name_value_2")
+	 *		@RequestParameter(name="name_value", type="type_value", in="path"),
+	 *		@RequestParameter(in="query", type="type_value_2", name="name_value_2")
 	 * })
 	 */
 	public function requestParameters(): void

tests/fixtures/Controllers/AttributeMultiController.php

@@ -18,8 +18,8 @@ public function responses(): void
 	{
 	}
 
-	#[RequestParameter(name: 'name_value', type: 'type_value', in: 'in_value')]
-	#[RequestParameter(in: 'in_value_2', type: 'type_value_2', name: 'name_value_2')]
+	#[RequestParameter(name: 'name_value', type: 'type_value', in: 'path')]
+	#[RequestParameter(in: 'query', type: 'type_value_2', name: 'name_value_2')]
 	public function requestParameters(): void
 	{
 	}