fix: fixes all failing unit tests

- addresses feedback from review (import OpenApi\Attribtues as OAT)
nelmio · Dec 11, 2023 · 4988cfe · 4988cfe
1 parent 4207f88
commit 4988cfe
Show file tree

Hide file tree

Showing 12 changed files with 191 additions and 132 deletions.
diff --git a/Tests/Functional/Controller/ClassApiController.php b/Tests/Functional/Controller/ClassApiController.php
@@ -13,7 +13,7 @@
 
 use Nelmio\ApiDocBundle\Annotation\Security;
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Response;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Annotation\Route;
 
@@ -39,7 +39,7 @@ public function securityAction()
     #[Route('/api', host: 'api.example.com')]
     class ClassApiController
     {
-        #[Response(response: 201, description: '')]
+        #[OAT\Response(response: 201, description: '')]
         #[Route('/security/class')]
         public function securityAction()
         {

diff --git a/Tests/Functional/Controller/InvokableController.php b/Tests/Functional/Controller/InvokableController.php
@@ -12,7 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Controller;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Response;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Annotation\Route;
 
@@ -37,7 +37,7 @@ public function __invoke()
     /**
      * Prevents a regression (see https://github.com/nelmio/NelmioApiDocBundle/issues/1559).
      */
-    #[Response(response: 200, description: 'Invokable!')]
+    #[OAT\Response(response: 200, description: 'Invokable!')]
     #[Route('/api/invoke', host: 'api.example.com', name: 'invokable', methods: ['GET'])]
     class InvokableController
     {

diff --git a/Tests/Functional/Controller/SerializedNameController.php b/Tests/Functional/Controller/SerializedNameController.php
@@ -15,7 +15,7 @@
 use Nelmio\ApiDocBundle\Tests\Functional\EntityExcluded\SerializedNameEnt;
 use Nelmio\ApiDocBundle\Tests\Functional\EntityExcluded\Symfony7\SerializedNameEntity;
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Response;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Annotation\Route;
 
@@ -48,7 +48,7 @@ public function serializedNameAction()
     #[Route('/api', host: 'api.example.com')]
     class SerializedNameController
     {
-        #[Response(response: 200, description: 'success', attachables: [new Model(type: SerializedNameEntity::class)])]
+        #[OAT\Response(response: 200, description: 'success', attachables: [new Model(type: SerializedNameEntity::class)])]
         #[Route('/serializename', methods: ['GET'])]
         public function serializedNameAction()
         {

diff --git a/Tests/Functional/Controller/TestController.php b/Tests/Functional/Controller/TestController.php
@@ -12,7 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Controller;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Response;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Annotation\Route;
 
@@ -38,7 +38,7 @@ public function testAction()
     #[Route('/test', host: 'api-test.example.com')]
     class TestController
     {
-        #[Response(response: 200, description: 'Test')]
+        #[OAT\Response(response: 200, description: 'Test')]
         #[Route('/test/', methods: ['GET'])]
         public function testAction()
         {

diff --git a/Tests/Functional/Entity/EntityWithAlternateType.php b/Tests/Functional/Entity/EntityWithAlternateType.php
@@ -12,8 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Entity;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Items;
-use OpenApi\Attributes\Schema;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 
 if (Kernel::MAJOR_VERSION < 7) {
@@ -36,7 +35,7 @@ public function getIterator(): \ArrayIterator
         }
     }
 } else {
-    #[Schema(type: 'array', items: new Items(type: 'string'))]
+    #[OAT\Schema(type: 'array', items: new OAT\Items(type: 'string'))]
     class EntityWithAlternateType implements \IteratorAggregate
     {
         /**

diff --git a/Tests/Functional/Entity/EntityWithNullableSchemaSet.php b/Tests/Functional/Entity/EntityWithNullableSchemaSet.php
@@ -12,7 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Entity;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Property;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 
 if (Kernel::MAJOR_VERSION < 7) {
@@ -66,37 +66,37 @@ class EntityWithNullableSchemaSet
         /**
          * @var ?string
          */
-        #[Property]
+        #[OAT\Property]
         public $nullablePropertyNullableNotSet;
 
         /**
          * @var ?string
          */
-        #[Property(nullable: false)]
+        #[OAT\Property(nullable: false)]
         public $nullablePropertyNullableFalseSet;
 
         /**
          * @var ?string
          */
-        #[Property(nullable: true)]
+        #[OAT\Property(nullable: true)]
         public $nullablePropertyNullableTrueSet;
 
         /**
          * @var string
          */
-        #[Property]
+        #[OAT\Property]
         public $nonNullablePropertyNullableNotSet;
 
         /**
          * @var string
          */
-        #[Property(nullable: false)]
+        #[OAT\Property(nullable: false)]
         public $nonNullablePropertyNullableFalseSet;
 
         /**
          * @var string
          */
-        #[Property(nullable: true)]
+        #[OAT\Property(nullable: true)]
         public $nonNullablePropertyNullableTrueSet;
     }
 }
diff --git a/Tests/Functional/Entity/EntityWithObjectType.php b/Tests/Functional/Entity/EntityWithObjectType.php
@@ -12,7 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Entity;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Schema;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 
 if (Kernel::MAJOR_VERSION < 7) {
@@ -27,7 +27,7 @@ class EntityWithObjectType
         public $notIgnored = 'this should be read';
     }
 } else {
-    #[Schema(type: 'object')]
+    #[OAT\Schema(type: 'object')]
     class EntityWithObjectType
     {
         /**

diff --git a/Tests/Functional/Entity/EntityWithRef.php b/Tests/Functional/Entity/EntityWithRef.php
@@ -12,7 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Entity;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Schema;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 
 if (Kernel::MAJOR_VERSION < 7) {
@@ -27,7 +27,7 @@ class EntityWithRef
         public $ignored = 'this property should be ignored because of the annotation above';
     }
 } else {
-    #[Schema(ref: '#/components/schemas/Test')]
+    #[OAT\Schema(ref: '#/components/schemas/Test')]
     class EntityWithRef
     {
         /**

diff --git a/Tests/Functional/Entity/SymfonyConstraintsWithValidationGroups.php b/Tests/Functional/Entity/SymfonyConstraintsWithValidationGroups.php
@@ -12,8 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Entity;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Items;
-use OpenApi\Attributes\Property;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -68,7 +67,7 @@ class SymfonyConstraintsWithValidationGroups
         /**
          * @var array
          */
-        #[Property(type: 'array', items: new Items(type: 'string'))]
+        #[OAT\Property(type: 'array', items: new OAT\Items(type: 'string'))]
         #[Assert\Valid]
         public $propertyArray;
     }

diff --git a/Tests/Functional/Entity/User.php b/Tests/Functional/Entity/User.php
@@ -12,7 +12,7 @@
 namespace Nelmio\ApiDocBundle\Tests\Functional\Entity;
 
 use OpenApi\Annotations as OA;
-use OpenApi\Attributes\Property;
+use OpenApi\Attributes as OAT;
 use Symfony\Component\HttpKernel\Kernel;
 
 if (Kernel::MAJOR_VERSION < 7) {
@@ -180,42 +180,42 @@ class User
         /**
          * @var int
          */
-        #[Property(description: 'User id', readOnly: true, title: 'userid', default: null)]
+        #[OAT\Property(description: 'User id', readOnly: true, title: 'userid', default: null)]
         private $id;
 
-        #[Property(type: 'string', readOnly: false)]
+        #[OAT\Property(type: 'string', readOnly: false)]
         private $email;
 
         /**
          * User Roles Comment.
          *
          * @var string[]
          */
-        #[Property(description: 'User roles', title: 'roles', example: ['ADMIN', 'SUPERUSER'], default: ['USER'])]
+        #[OAT\Property(description: 'User roles', title: 'roles', example: ['ADMIN', 'SUPERUSER'], default: ['USER'])]
         private $roles;
 
         /**
          * User Location.
          */
-        #[Property(type: 'string')]
+        #[OAT\Property(type: 'string')]
         private $location;
 
         /**
          * @var int
          */
-        #[Property(type: 'string')]
+        #[OAT\Property(type: 'string')]
         private $friendsNumber;
 
         /**
          * @var float
          */
-        #[Property(default: 0.0)]
+        #[OAT\Property(default: 0.0)]
         private $money;
 
         /**
          * @var \DateTime
          */
-        #[Property(property: 'creationDate')]
+        #[OAT\Property(property: 'creationDate')]
         private $createdAt;
 
         /**
@@ -236,7 +236,7 @@ class User
         /**
          * @var string
          */
-        #[Property(enum: ['disabled', 'enabled'])]
+        #[OAT\Property(enum: ['disabled', 'enabled'])]
         private $status;
 
         /**
@@ -249,7 +249,7 @@ public function setMoney(float $money)
             $this->money = $money;
         }
 
-        #[Property(example: 1)]
+        #[OAT\Property(example: 1)]
         public function setId(int $id)
         {
             $this->id = $id;

diff --git a/Tests/Functional/WebTestCase.php b/Tests/Functional/WebTestCase.php
@@ -171,14 +171,19 @@ public function assertNotHasProperty($property, OA\AbstractAnnotation $annotatio
     }
 
     /**
-     * BC symfony < 5.3.
+     * BC symfony < 5.3 and symfony >= 7
+     *
+     * KernelTestCase::getContainer has a Container return type object in symfony 7
+     * which is incompatible with the return type of previous versions or
+     * at least the return type of overridden method (which was added for BC compatibility),
+     * hence moving it to the magic method.
      */
-    protected static function getContainer(): ContainerInterface
+    public static function __callStatic(string $name, array $arguments)
     {
-        if (method_exists(parent::class, 'getContainer')) {
-            return parent::getContainer();
+        if ('getContainer' === $name) {
+            return static::$container;
         }
 
-        return static::$container;
+        return null;
     }
 }