tests: fix tests

dunglas · dunglas · commit 8a5494d05e0f · 2020-11-27T12:02:58.000+01:00
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -29,6 +29,7 @@ return PhpCsFixer\Config::create()
         '@PHPUnit60Migration:risky' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
+        'single_line_comment_style' => false, // Temporary fix for compatibility with PHP 8 attributes, see https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5284
         'align_multiline_comment' => [
             'comment_type' => 'phpdocs_like',
         ],
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -21,6 +21,9 @@ parameters:
 		- tests/Bridge/NelmioApiDoc/*
 		- src/Bridge/FosUser/*
 		# BC layer
+		- tests/Annotation/ApiResourceTest.php
+		- tests/Annotation/ApiPropertyTest.php
+		- tests/Metadata/Resource/Factory/AnnotationResourceMetadataFactoryTest.php
 		- tests/Fixtures/TestBundle/BrowserKit/Client.php
 		# The Symfony Configuration API isn't good enough to be analysed
 		- src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
@@ -101,6 +104,13 @@ parameters:
 			message: '#Property Doctrine\\ORM\\Mapping\\ClassMetadataInfo::\$fieldMappings \(array.*\)>\) does not accept array\(.*\)\.#'
 			path: tests/Bridge/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactoryTest.php
 
+		# Expected, due to PHP 8 attributes
+		- '#ReflectionProperty::getAttributes\(\)#'
+		- '#ReflectionMethod::getAttributes\(\)#'
+		- '#ReflectionClass<mixed>::getAttributes\(\)#'
+		- '#Constructor of class ApiPlatform\\Core\\Annotation\\ApiResource has an unused parameter#'
+		- '#Constructor of class ApiPlatform\\Core\\Annotation\\ApiProperty has an unused parameter#'
+
 		# Expected, due to optional interfaces
 		- '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryCollectionExtensionInterface::applyToCollection\(\) invoked with 5 parameters, 3-4 required\.#'
 		- '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryResult(Item|Collection)ExtensionInterface::getResult\(\) invoked with 4 parameters, 1 required\.#'
diff --git a/src/Annotation/ApiProperty.php b/src/Annotation/ApiProperty.php
@@ -94,25 +94,24 @@ final class ApiProperty
     public $example;
 
     /**
-     * @param string $description
-     * @param bool $readable
-     * @param bool $writable
-     * @param bool $readableLink
-     * @param bool $writableLink
-     * @param bool $required
-     * @param bool $iri
-     * @param bool $identifier
-     * @param string|int|float|bool|array $default
+     * @param string                           $description
+     * @param bool                             $readable
+     * @param bool                             $writable
+     * @param bool                             $readableLink
+     * @param bool                             $writableLink
+     * @param bool                             $required
+     * @param string                           $iri
+     * @param bool                             $identifier
+     * @param string|int|float|bool|array      $default
      * @param string|int|float|bool|array|null $example
-     *
-     * @param string $deprecationReason
-     * @param bool $fetchable
-     * @param bool $fetchEager
-     * @param array $jsonldContext
-     * @param array $openapiContext
-     * @param bool $push
-     * @param string $security
-     * @param array $swaggerContext
+     * @param string                           $deprecationReason
+     * @param bool                             $fetchable
+     * @param bool                             $fetchEager
+     * @param array                            $jsonldContext
+     * @param array                            $openapiContext
+     * @param bool                             $push
+     * @param string                           $security
+     * @param array                            $swaggerContext
      *
      * @throws InvalidArgumentException
      */
@@ -121,7 +120,7 @@ public function __construct(
         ?bool $readable = null,
         ?bool $writable = null,
         ?bool $readableLink = null,
-        ?bool $writableLink =  null,
+        ?bool $writableLink = null,
         ?bool $required = null,
         ?string $iri = null,
         ?bool $identifier = null,
@@ -132,23 +131,23 @@ public function __construct(
         ?array $attributes = null,
         ?string $deprecationReason = null,
         ?bool $fetchable = null,
-        ?bool $fetchEager  = null,
+        ?bool $fetchEager = null,
         ?array $jsonldContext = null,
         ?array $openapiContext = null,
         ?bool $push = null,
         ?string $security = null,
         ?array $swaggerContext = null
     ) {
-        if (!is_array($description)) {
+        if (!\is_array($description)) { // @phpstan-ignore-line Doctrine annotations support
             [$publicProperties, $configurableAttributes] = self::getConfigMetadata();
 
             foreach ($publicProperties as $prop => $_) {
-                $this->{$prop} = $$prop;
+                $this->{$prop} = ${$prop};
             }
 
             $description = [];
             foreach ($configurableAttributes as $attribute => $_) {
-                $description[$attribute] = $$attribute;
+                $description[$attribute] = ${$attribute};
             }
         }
 
diff --git a/src/Annotation/ApiResource.php b/src/Annotation/ApiResource.php
@@ -129,47 +129,46 @@ final class ApiResource
     public $subresourceOperations;
 
     /**
-     * @param string $description
-     * @param array $collectionOperations https://api-platform.com/docs/core/operations
-     * @param array $graphql https://api-platform.com/docs/core/graphql
-     * @param array $itemOperations https://api-platform.com/docs/core/operations
-     * @param array $subresourceOperations https://api-platform.com/docs/core/subresources
-     *
-     * @param array $cacheHeaders https://api-platform.com/docs/core/performance/#setting-custom-http-cache-headers
-     * @param array $denormalizationContext https://api-platform.com/docs/core/serialization/#using-serialization-groups
-     * @param string $deprecationReason https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
-     * @param bool $elasticsearch https://api-platform.com/docs/core/elasticsearch/
-     * @param bool $fetchPartial https://api-platform.com/docs/core/performance/#fetch-partial
-     * @param bool $forceEager https://api-platform.com/docs/core/performance/#force-eager
-     * @param array $formats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
-     * @param string[] $filters https://api-platform.com/docs/core/filters/#doctrine-orm-and-mongodb-odm-filters
-     * @param string[] $hydraContext https://api-platform.com/docs/core/extending-jsonld-context/#hydra
-     * @param string|false $input https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
-     * @param bool|array $mercure https://api-platform.com/docs/core/mercure
-     * @param bool $messenger https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus
-     * @param array $normalizationContext https://api-platform.com/docs/core/serialization/#using-serialization-groups
-     * @param array $openapiContext https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
-     * @param array $order https://api-platform.com/docs/core/default-order/#overriding-default-order
-     * @param string|false $output https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
-     * @param bool $paginationClientEnabled https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1
-     * @param bool $paginationClientItemsPerPage https://api-platform.com/docs/core/pagination/#for-a-specific-resource-3
-     * @param bool $paginationClientPartial https://api-platform.com/docs/core/pagination/#for-a-specific-resource-6
-     * @param array $paginationViaCursor https://api-platform.com/docs/core/pagination/#cursor-based-pagination
-     * @param bool $paginationEnabled https://api-platform.com/docs/core/pagination/#for-a-specific-resource
-     * @param bool $paginationFetchJoinCollection https://api-platform.com/docs/core/pagination/#controlling-the-behavior-of-the-doctrine-orm-paginator
-     * @param int $paginationItemsPerPage https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page
-     * @param int $paginationMaximumItemsPerPage https://api-platform.com/docs/core/pagination/#changing-maximum-items-per-page
-     * @param bool $paginationPartial https://api-platform.com/docs/core/performance/#partial-pagination
-     * @param string $routePrefix https://api-platform.com/docs/core/operations/#prefixing-all-routes-of-all-operations
-     * @param string $security https://api-platform.com/docs/core/security
-     * @param string $securityMessage https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
-     * @param string $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
-     * @param string $securityPostDenormalizeMessage https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
-     * @param bool $stateless
-     * @param string $sunset https://api-platform.com/docs/core/deprecations/#setting-the-sunset-http-header-to-indicate-when-a-resource-or-an-operation-will-be-removed
-     * @param array $swaggerContext https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
-     * @param array $validationGroups https://api-platform.com/docs/core/validation/#using-validation-groups
-     * @param int $urlGenerationStrategy
+     * @param string       $description
+     * @param array        $collectionOperations           https://api-platform.com/docs/core/operations
+     * @param array        $graphql                        https://api-platform.com/docs/core/graphql
+     * @param array        $itemOperations                 https://api-platform.com/docs/core/operations
+     * @param array        $subresourceOperations          https://api-platform.com/docs/core/subresources
+     * @param array        $cacheHeaders                   https://api-platform.com/docs/core/performance/#setting-custom-http-cache-headers
+     * @param array        $denormalizationContext         https://api-platform.com/docs/core/serialization/#using-serialization-groups
+     * @param string       $deprecationReason              https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
+     * @param bool         $elasticsearch                  https://api-platform.com/docs/core/elasticsearch/
+     * @param bool         $fetchPartial                   https://api-platform.com/docs/core/performance/#fetch-partial
+     * @param bool         $forceEager                     https://api-platform.com/docs/core/performance/#force-eager
+     * @param array        $formats                        https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
+     * @param string[]     $filters                        https://api-platform.com/docs/core/filters/#doctrine-orm-and-mongodb-odm-filters
+     * @param string[]     $hydraContext                   https://api-platform.com/docs/core/extending-jsonld-context/#hydra
+     * @param string|false $input                          https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
+     * @param bool|array   $mercure                        https://api-platform.com/docs/core/mercure
+     * @param bool         $messenger                      https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus
+     * @param array        $normalizationContext           https://api-platform.com/docs/core/serialization/#using-serialization-groups
+     * @param array        $openapiContext                 https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
+     * @param array        $order                          https://api-platform.com/docs/core/default-order/#overriding-default-order
+     * @param string|false $output                         https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
+     * @param bool         $paginationClientEnabled        https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1
+     * @param bool         $paginationClientItemsPerPage   https://api-platform.com/docs/core/pagination/#for-a-specific-resource-3
+     * @param bool         $paginationClientPartial        https://api-platform.com/docs/core/pagination/#for-a-specific-resource-6
+     * @param array        $paginationViaCursor            https://api-platform.com/docs/core/pagination/#cursor-based-pagination
+     * @param bool         $paginationEnabled              https://api-platform.com/docs/core/pagination/#for-a-specific-resource
+     * @param bool         $paginationFetchJoinCollection  https://api-platform.com/docs/core/pagination/#controlling-the-behavior-of-the-doctrine-orm-paginator
+     * @param int          $paginationItemsPerPage         https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page
+     * @param int          $paginationMaximumItemsPerPage  https://api-platform.com/docs/core/pagination/#changing-maximum-items-per-page
+     * @param bool         $paginationPartial              https://api-platform.com/docs/core/performance/#partial-pagination
+     * @param string       $routePrefix                    https://api-platform.com/docs/core/operations/#prefixing-all-routes-of-all-operations
+     * @param string       $security                       https://api-platform.com/docs/core/security
+     * @param string       $securityMessage                https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
+     * @param string       $securityPostDenormalize        https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
+     * @param string       $securityPostDenormalizeMessage https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
+     * @param bool         $stateless
+     * @param string       $sunset                         https://api-platform.com/docs/core/deprecations/#setting-the-sunset-http-header-to-indicate-when-a-resource-or-an-operation-will-be-removed
+     * @param array        $swaggerContext                 https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
+     * @param array        $validationGroups               https://api-platform.com/docs/core/validation/#using-validation-groups
+     * @param int          $urlGenerationStrategy
      *
      * @throws InvalidArgumentException
      */
@@ -220,16 +219,16 @@ public function __construct(
         ?array $validationGroups = null,
         ?int $urlGenerationStrategy = null
     ) {
-        if (!is_array($description)) {
+        if (!\is_array($description)) { // @phpstan-ignore-line Doctrine annotations support
             [$publicProperties, $configurableAttributes] = self::getConfigMetadata();
 
             foreach ($publicProperties as $prop => $_) {
-                $this->{$prop} = $$prop;
+                $this->{$prop} = ${$prop};
             }
 
             $description = [];
             foreach ($configurableAttributes as $attribute => $_) {
-                $description[$attribute] = $$attribute;
+                $description[$attribute] = ${$attribute};
             }
         }
 
