Handle unknown attributes (#1100)

zircote · Feb 3, 2022 · 3a4e7ef · 3a4e7ef
1 parent 84312fc
commit 3a4e7ef
Show file tree

Hide file tree

Showing 4 changed files with 115 additions and 19 deletions.
diff --git a/Examples/using-links-php81/MyAttribute.php b/Examples/using-links-php81/MyAttribute.php
@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace OpenApi\Examples\UsingLinksPhp81;
+
+#[\Attribute]
+class MyAttribute
+{
+}
diff --git a/Examples/using-links-php81/User.php b/Examples/using-links-php81/User.php
@@ -2,6 +2,7 @@
 
 namespace OpenApi\Examples\UsingLinksPhp81;
 
+use JetBrains\PhpStorm\ArrayShape;
 use OpenApi\Attributes as OAT;
 
 #[OAT\Schema(schema: 'user')]
@@ -18,5 +19,9 @@ class User
      * @var string
      */
     #[OAT\Property(type: 'string')]
+    #[MyAttribute]
     public $uuid;
+
+    #[ArrayShape(['ping' => 'pong'])]
+    public array $arrayShape;
 }
diff --git a/src/Analysers/AttributeAnnotationFactory.php b/src/Analysers/AttributeAnnotationFactory.php
@@ -43,9 +43,16 @@ public function build(\Reflector $reflector, Context $context): array
         $annotations = [];
         try {
             foreach ($reflector->getAttributes() as $attribute) {
-                $instance = $attribute->newInstance();
-                $annotations[] = $instance;
+                try {
+                    $instance = $attribute->newInstance();
+                    if ($instance instanceof AbstractAnnotation) {
+                        $annotations[] = $instance;
+                    }
+                } catch (\Error $e) {
+                    $context->logger->warning('Could not instantiate attribute: ' . $e->getMessage(), ['exception' => $e]);
+                }
             }
+
             if ($reflector instanceof \ReflectionMethod) {
                 // also look at parameter attributes
                 foreach ($reflector->getParameters() as $rp) {

diff --git a/tests/ExamplesTest.php b/tests/ExamplesTest.php
@@ -7,6 +7,7 @@
 namespace OpenApi\Tests;
 
 use Composer\Autoload\ClassLoader;
+use OpenApi\Analysers\AnalyserInterface;
 use OpenApi\Analysers\AttributeAnnotationFactory;
 use OpenApi\Analysers\DocBlockAnnotationFactory;
 use OpenApi\Analysers\ReflectionAnalyser;
@@ -24,19 +25,84 @@ public function exampleMappings()
         ];
 
         $examples = [
-            'example-object' => [OpenApi::VERSION_3_0_0, 'example-object', 'example-object.yaml'],
-            'misc' => [OpenApi::VERSION_3_0_0, 'misc', 'misc.yaml'],
-            'nesting' => [OpenApi::VERSION_3_0_0, 'nesting', 'nesting.yaml'],
-            'petstore-3.0' => [OpenApi::VERSION_3_0_0, 'petstore-3.0', 'petstore-3.0.yaml'],
-            'petstore.swagger.io' => [OpenApi::VERSION_3_0_0, 'petstore.swagger.io', 'petstore.swagger.io.yaml'],
-            'swagger-spec/petstore' => [OpenApi::VERSION_3_0_0, 'swagger-spec/petstore', 'petstore.yaml'],
-            'swagger-spec/petstore-simple' => [OpenApi::VERSION_3_0_0, 'swagger-spec/petstore-simple', 'petstore-simple.yaml'],
-            'swagger-spec/petstore-simple-3.1.0' => [OpenApi::VERSION_3_1_0, 'swagger-spec/petstore-simple', 'petstore-simple-3.1.0.yaml'],
-            'swagger-spec/petstore-with-external-docs' => [OpenApi::VERSION_3_0_0, 'swagger-spec/petstore-with-external-docs', 'petstore-with-external-docs.yaml'],
-            'using-interfaces' => [OpenApi::VERSION_3_0_0, 'using-interfaces', 'using-interfaces.yaml'],
-            'using-refs' => [OpenApi::VERSION_3_0_0, 'using-refs', 'using-refs.yaml'],
-            'using-traits' => [OpenApi::VERSION_3_0_0, 'using-traits', 'using-traits.yaml'],
-            'using-links' => [OpenApi::VERSION_3_0_0, 'using-links', 'using-links.yaml'],
+            'example-object' => [
+                OpenApi::VERSION_3_0_0,
+                'example-object',
+                'example-object.yaml',
+                [],
+            ],
+            'misc' => [
+                OpenApi::VERSION_3_0_0,
+                'misc',
+                'misc.yaml',
+                [],
+            ],
+            'nesting' => [
+                OpenApi::VERSION_3_0_0,
+                'nesting',
+                'nesting.yaml',
+                [],
+            ],
+            'petstore-3.0' => [
+                OpenApi::VERSION_3_0_0,
+                'petstore-3.0',
+                'petstore-3.0.yaml',
+                [],
+            ],
+            'petstore.swagger.io' => [
+                OpenApi::VERSION_3_0_0,
+                'petstore.swagger.io',
+                'petstore.swagger.io.yaml',
+                [],
+            ],
+            'swagger-spec/petstore' => [
+                OpenApi::VERSION_3_0_0,
+                'swagger-spec/petstore',
+                'petstore.yaml',
+                [],
+            ],
+            'swagger-spec/petstore-simple' => [
+                OpenApi::VERSION_3_0_0,
+                'swagger-spec/petstore-simple',
+                'petstore-simple.yaml',
+                [],
+            ],
+            'swagger-spec/petstore-simple-3.1.0' => [
+                OpenApi::VERSION_3_1_0,
+                'swagger-spec/petstore-simple',
+                'petstore-simple-3.1.0.yaml',
+                [],
+            ],
+            'swagger-spec/petstore-with-external-docs' => [
+                OpenApi::VERSION_3_0_0,
+                'swagger-spec/petstore-with-external-docs',
+                'petstore-with-external-docs.yaml',
+                [],
+            ],
+            'using-interfaces' => [
+                OpenApi::VERSION_3_0_0,
+                'using-interfaces',
+                'using-interfaces.yaml',
+                [],
+            ],
+            'using-refs' => [
+                OpenApi::VERSION_3_0_0,
+                'using-refs',
+                'using-refs.yaml',
+                [],
+            ],
+            'using-traits' => [
+                OpenApi::VERSION_3_0_0,
+                'using-traits',
+                'using-traits.yaml',
+                [],
+            ],
+            'using-links' => [
+                OpenApi::VERSION_3_0_0,
+                'using-links',
+                'using-links.yaml',
+                [],
+            ],
         ];
 
         foreach ($examples as $ekey => $example) {
@@ -49,7 +115,13 @@ public function exampleMappings()
         }
 
         if (\PHP_VERSION_ID >= 80100) {
-            yield 'reflection/attribute:using-links-php81' => [OpenApi::VERSION_3_0_0, 'using-links-php81', 'using-links-php81.yaml', new ReflectionAnalyser([new AttributeAnnotationFactory()])];
+            yield 'reflection/attribute:using-links-php81' => [
+                OpenApi::VERSION_3_0_0,
+                'using-links-php81',
+                'using-links-php81.yaml',
+                ['JetBrains\PhpStorm\ArrayShape'],
+                new ReflectionAnalyser([new AttributeAnnotationFactory()]),
+            ];
         }
     }
 
@@ -58,7 +130,7 @@ public function exampleMappings()
      *
      * @dataProvider exampleMappings
      */
-    public function testExamples($version, $example, $spec, $analyser): void
+    public function testExamples(string $version, string $example, string $spec, array $expectedLog, AnalyserInterface $analyser): void
     {
         // register autoloader for examples that require autoloading due to inheritance, etc.
         $path = $this->example($example);
@@ -67,11 +139,15 @@ public function testExamples($version, $example, $spec, $analyser): void
         $classloader->addPsr4('OpenApi\\Examples\\' . $exampleNS . '\\', $path);
         $classloader->register();
 
+        foreach ($expectedLog as $logLine) {
+            $this->assertOpenApiLogEntryContains($logLine);
+        }
+
         $path = $this->example($example);
-        $openapi = (new Generator())
+        $openapi = (new Generator($this->getTrackingLogger()))
             ->setVersion($version)
             ->setAnalyser($analyser)
-            ->generate([$path], null, true);
+            ->generate([$path]);
         //file_put_contents($path . '/' . $spec, $openapi->toYaml());
         $this->assertSpecEquals(
             $openapi,