Doctrine annotations replaced by PHP attributes (#4395)

Author: TomasLudvik

README.md

@@ -21,7 +21,7 @@ composer require --dev shopsys/http-smoke-testing
 ```
 
 This package internally uses [PHPUnit](https://phpunit.de/) to run the tests.
-That means that you need to setup your `phpunit.xml` properly.
+That means that you need to set up your `phpunit.xml` properly.
 Fortunately, Symfony comes with example configuration.
 Renaming the `phpunit.xml.dist` in your project root (or `app/phpunit.xml.dist` on Symfony 2) should be sufficient.
 
@@ -42,7 +42,7 @@ php vendor/bin/phpunit tests/AppBundle/Smoke/SmokeTest.php
 **Warning: This package checks all routes by making real requests.**
 **It is important not to execute it on production data.**
 **You may unknowingly delete or modify your data or real requests on 3rd party services.**
-Even if you implement some way of protecting the application from side-effect (eg. database transaction wrapping) you should never execute tests on production data.
+Even if you implement some way of protecting the application from side effect (e.g., database transaction wrapping) you should never execute tests on production data.
 
 ### Example test class
 
@@ -97,19 +97,19 @@ class SmokeTest extends HttpSmokeTestCase {
 
 ## Documentation
 
-By default the test makes request to every route without using any authentication or providing any parameters and expects the response to have HTTP status code _200 OK_.
+By default, the test makes request to every route without using any authentication or providing any parameters and expects the response to have HTTP status code _200 OK_.
 
 To change this behavior you must implement method `customizeRouteConfigs(RouteConfigCustomizer $routeConfigCustomizer)` in your test.
 
 [`RouteConfigCustomizer`](./src/RouteConfigCustomizer.php) provides two methods for customizing individual route requests:
 
 - `customize` accepts callback `function (RouteConfig $config, RouteInfo $info) {...}` as the only argument.
   This is called with each [`RouteConfig`](./src/RouteConfig.php) along with [`RouteInfo`](./src/RouteInfo.php) collected from your router.  
-  This method is useful when you want to define general rules for multiple routes (eg. skip all routes with name starting with underscore).
+  This method is useful when you want to define general rules for multiple routes (e.g., skip all routes with name starting with underscore).
 - `customizeByRouteName` accepts a single route name or an array of route names as the first argument and same callback as `customize` as the second argument.
   This is called with each [`RouteConfig`](./src/RouteConfig.php) along with [`RouteInfo`](./src/RouteInfo.php) with matching route name.
   If matching route config is not found a [`RouteNameNotFoundException`](./src/Exception/RouteNameNotFoundException.php) is thrown.  
-  This method is useful when you want to define rules for specific routes (eg. logging in to some secured route).
+  This method is useful when you want to define rules for specific routes (e.g., logging in to some secured route).
 
 In your customizing callback you can call three methods on [`RouteConfig`](./src/RouteConfig.php) to change the tested behavior:
 
@@ -122,33 +122,31 @@ In your customizing callback you can call three methods on [`RouteConfig`](./src
       or implement your own method using [`AuthInterface`](./src/Auth/AuthInterface.php).)
     - `setParameter` specifies value of a route parameter by name.
     - `addCallDuringTestExecution` adds a callback `function (RequestDataSet $requestDataSet, ContainerInterface $container) { ... }` to be called before test execution.  
-      (Useful for code that needs to access the same instance of container as the test method, eg. adding CSRF token as a route parameter)
-- `addExtraRequestDataSet` can be used to test more requests on the same route (eg. test a secured route as both logged in and anonymous user).
+      (Useful for code that needs to access the same instance of container as the test method, e.g., adding CSRF token as a route parameter)
+- `addExtraRequestDataSet` can be used to test more requests on the same route (e.g., test a secured route as both logged in and anonymous user).
   Returns [`RequestDataSet`](./src/RequestDataSet.php) that you can use the same way as the result from `changeDefaultRequestDataSet`.
   All configured options will extend the values from default request data set (even when you change the default [`RequestDataSet`](./src/RequestDataSet.php) after you add the extra [`RequestDataSet`](./src/RequestDataSet.php)).
 
 _Note: All three methods of [`RouteConfigCustomizer`](./src/RouteConfigCustomizer.php) accept `string $debugNote` as an argument._
 _It is useful for describing the reasons of your configuration change because it may help you with debugging when the test fails._
 
-Additionally you can override these methods in your implementation of [`HttpSmokeTestCase`](./src/HttpSmokeTestCase.php) to further change the test behavior:
+Additionally, you can override these methods in your implementation of [`HttpSmokeTestCase`](./src/HttpSmokeTestCase.php) to further change the test behavior:
 
-- `setUp` to change the way your kernel is booted (eg. boot it with different options).
+- `setUp` to change the way your kernel is booted (e.g., boot it with different options).
 - `getRouterAdapter` to change the object responsible for collecting routes from your application and generating urls.
 - `createRequest` if you have specific needs about the way `Request` is created from [`RequestDataSet`](./src/RequestDataSet.php).
-- `handleRequest` to customize handling `Request` in your application (eg. you can wrap it in database transaction to roll it back into original state).
+- `handleRequest` to customize handling `Request` in your application (e.g., you can wrap it in database transaction to roll it back into original state).
 
-### Annotations
+### Attributes
 
-To make smoke test configuration a little easier, you can use the annotations:
+To make smoke test configuration a little easier, you can use the PHP attributes:
 
 #### DataSet
 
-Used for setting expected status code based on provided paramteters.
+Used for setting expected status code based on provided parameters.
 
 ```
-@DataSet(statusCode=404, parameters={
-    @Parameter(name="name", value="Batman")
-})
+#[DataSet(statusCode: 404, parameters: [new Parameter(name: 'name', value: 'Batman')])]
 ```
 
 - arguments:
@@ -160,7 +158,7 @@ Used for setting expected status code based on provided paramteters.
 Parameter defines value for specified parameter.
 
 ```
-@Parameter(name="name", value="Batman")
+new Parameter(name: 'name', value: 'Batman')
 ```
 
 - arguments:
@@ -172,7 +170,7 @@ Parameter defines value for specified parameter.
 Mark test as skipped
 
 ```
-@Skipped()
+#[Skipped]
 ```
 
 You can add them directly to your controller methods. See the example in [`Shopsys\HttpSmokeTesting\Test\TestController`](./src/Test/TestController.php).

composer.json

@@ -32,7 +32,6 @@
         "symfony/framework-bundle": "^6.4",
         "symfony/http-foundation": "^6.4",
         "symfony/dependency-injection": "^6.4",
-        "symfony/routing": "^6.4",
-        "doctrine/annotations": "^1.10.4"
+        "symfony/routing": "^6.4"
     }
 }

src/Annotation/DataSet.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\HttpSmokeTesting\Attribute;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
+class DataSet
+{
+    /**
+     * @param int $statusCode
+     * @param \Shopsys\HttpSmokeTesting\Attribute\Parameter[] $parameters
+     */
+    public function __construct(
+        public int $statusCode = 200,
+        public array $parameters = [],
+    ) {
+    }
+}

src/Annotation/Parameter.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\HttpSmokeTesting\Attribute;
+
+class Parameter
+{
+    /**
+     * @param string $name
+     * @param string $value
+     */
+    public function __construct(
+        public string $name,
+        public string $value,
+    ) {
+    }
+}

src/Annotation/Skipped.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\HttpSmokeTesting\Attribute;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Skipped
+{
+}

src/Attribute/DataSet.php

@@ -5,8 +5,8 @@
 namespace Shopsys\HttpSmokeTesting;
 
 use Override;
-use Shopsys\HttpSmokeTesting\Annotation\DataSet;
-use Shopsys\HttpSmokeTesting\Annotation\Skipped;
+use Shopsys\HttpSmokeTesting\Attribute\DataSet;
+use Shopsys\HttpSmokeTesting\Attribute\Skipped;
 
 class RequestDataSetGenerator implements RouteConfig
 {
@@ -52,7 +52,7 @@ private function getRequestDataSetForIteration(int $index): RequestDataSet
 
     /**
      * @param \Shopsys\HttpSmokeTesting\RequestDataSet $requestDataSet
-     * @param \Shopsys\HttpSmokeTesting\Annotation\DataSet $annotation
+     * @param \Shopsys\HttpSmokeTesting\Attribute\DataSet $annotation
      */
     private function fulfillRequestDataSetFromAnnotation(RequestDataSet $requestDataSet, DataSet $annotation): void
     {

src/Attribute/Parameter.php

@@ -4,13 +4,11 @@
 
 namespace Shopsys\HttpSmokeTesting\RouterAdapter;
 
-use Doctrine\Common\Annotations\AnnotationReader;
-use Doctrine\Common\Annotations\AnnotationRegistry;
 use Override;
 use ReflectionException;
 use ReflectionMethod;
-use Shopsys\HttpSmokeTesting\Annotation\DataSet;
-use Shopsys\HttpSmokeTesting\Annotation\Skipped;
+use Shopsys\HttpSmokeTesting\Attribute\DataSet;
+use Shopsys\HttpSmokeTesting\Attribute\Skipped;
 use Shopsys\HttpSmokeTesting\RequestDataSet;
 use Shopsys\HttpSmokeTesting\RouteInfo;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
@@ -19,16 +17,11 @@
 
 class SymfonyRouterAdapter implements RouterAdapterInterface
 {
-    private AnnotationReader $annotationsReader;
-
     /**
      * @param \Symfony\Component\Routing\RouterInterface $router
      */
     public function __construct(private readonly RouterInterface $router)
     {
-        AnnotationRegistry::registerLoader('class_exists');
-
-        $this->annotationsReader = new AnnotationReader();
     }
 
     /**
@@ -40,7 +33,7 @@ public function getAllRouteInfo(): array
         $allRouteInfo = [];
 
         foreach ($this->router->getRouteCollection() as $routeName => $route) {
-            $allRouteInfo[] = new RouteInfo($routeName, $route, $this->extractAnnotationsForRoute($route));
+            $allRouteInfo[] = new RouteInfo($routeName, $route, $this->extractAttributesForRoute($route));
         }
 
         return $allRouteInfo;
@@ -50,10 +43,10 @@ public function getAllRouteInfo(): array
      * @param \Symfony\Component\Routing\Route $route
      * @return array
      */
-    private function extractAnnotationsForRoute(Route $route): array
+    private function extractAttributesForRoute(Route $route): array
     {
         if ($route->hasDefault('_controller')) {
-            return $this->extractAnnotationForController($route->getDefault('_controller'));
+            return $this->extractAttributesForController($route->getDefault('_controller'));
         }
 
         return [];
@@ -63,32 +56,34 @@ private function extractAnnotationsForRoute(Route $route): array
      * @param string $controller
      * @return array
      */
-    private function extractAnnotationForController(string $controller): array
+    private function extractAttributesForController(string $controller): array
     {
         try {
             $reflectionMethod = new ReflectionMethod($controller);
         } catch (ReflectionException $e) {
             return [];
         }
 
-        return $this->getControllerMethodAnnotations($reflectionMethod);
+        return $this->getControllerMethodAttributes($reflectionMethod);
     }
 
     /**
      * @param \ReflectionMethod $reflectionMethod
-     * @return array
+     * @return array<\Shopsys\HttpSmokeTesting\Attribute\DataSet|\Shopsys\HttpSmokeTesting\Attribute\Skipped>
      */
-    private function getControllerMethodAnnotations(ReflectionMethod $reflectionMethod): array
+    private function getControllerMethodAttributes(ReflectionMethod $reflectionMethod): array
     {
-        $annotations = [];
+        $attributes = [];
+
+        foreach ($reflectionMethod->getAttributes(DataSet::class) as $attribute) {
+            $attributes[] = $attribute->newInstance();
+        }
 
-        foreach ($this->annotationsReader->getMethodAnnotations($reflectionMethod) as $annotation) {
-            if ($annotation instanceof DataSet || $annotation instanceof Skipped) {
-                $annotations[] = $annotation;
-            }
+        foreach ($reflectionMethod->getAttributes(Skipped::class) as $attribute) {
+            $attributes[] = $attribute->newInstance();
         }
 
-        return $annotations;
+        return $attributes;
     }
 
     /**