Merge pull request #1137 from altro3/fix_groovy_enum_set

Fixed cannot generate schema for response having a collection of enums (Groovy)
micronaut-projects · Jul 19, 2023 · 1fda776 · 1fda776
2 parents dfd5735 + 350afbe
commit 1fda776
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 0 deletions.
diff --git a/openapi/src/main/java/io/micronaut/openapi/visitor/AbstractOpenApiVisitor.java b/openapi/src/main/java/io/micronaut/openapi/visitor/AbstractOpenApiVisitor.java
@@ -792,6 +792,11 @@ protected Schema resolveSchema(OpenAPI openAPI, @Nullable Element definingElemen
         Boolean isIterable = null;
 
         ClassElement componentType = type != null ? type.getFirstTypeArgument().orElse(null) : null;
+        if (componentType != null && !componentType.isIterable() && !componentType.isArray()) {
+            // bug in micronaut-core, see "test build OpenAPI for set of enums"
+            // type.getFirstTypeArgument() return ClassElement, but must be EnumElement
+            componentType = context.getClassElement(componentType.getName()).orElse(componentType);
+        }
         if (type instanceof WildcardElement) {
             WildcardElement wildcardEl = (WildcardElement) type;
             type = CollectionUtils.isNotEmpty(wildcardEl.getUpperBounds()) ? wildcardEl.getUpperBounds().get(0) : null;

diff --git a/openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiPojoControllerGroovySpec.groovy b/openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiPojoControllerGroovySpec.groovy
@@ -88,4 +88,83 @@ class MyBean {}
         !schema.required.contains('battingAverage')
     }
 
+    @Issue("https://github.com/micronaut-projects/micronaut-openapi/issues/1135")
+    void "test build OpenAPI for set of enums"() {
+        given: "An API definition"
+        when:
+        buildBeanDefinition('test.MyBean', '''
+package test
+
+import groovy.transform.CompileStatic
+import io.micronaut.core.annotation.Nullable
+import io.micronaut.http.HttpResponse
+import io.micronaut.http.annotation.Controller
+import io.micronaut.http.annotation.Get
+import io.swagger.v3.oas.annotations.media.Schema
+
+@CompileStatic
+@Controller
+class DogController {
+
+    @Get('/dog')
+    HttpResponse<Dog> get() {
+        Dog dog = new Dog(
+                name: 'Rex', breed: Breed.GERMAN_SHEPHERD,
+                traits: EnumSet.of(Trait.QUICKNESS, Trait.COURAGE, Trait.LOYALTY)
+        )
+
+        return HttpResponse.ok(dog)
+    }
+}
+
+@CompileStatic
+class Dog {
+
+    String name
+    Breed breed
+    Set<Trait> traits
+}
+
+@CompileStatic
+enum Breed {
+
+    GERMAN_SHEPHERD,
+    BULLDOG,
+    GOLDEN_RETRIEVER
+}
+
+@CompileStatic
+enum Trait {
+
+    QUICKNESS,
+    COURAGE,
+    LOYALTY
+}
+
+@jakarta.inject.Singleton
+class MyBean {}
+''')
+        then: "the state is correct"
+        Utils.testReference != null
+
+        when: "The OpenAPI is retrieved"
+        OpenAPI openAPI = Utils.testReference
+        Schema breedSchema = openAPI.components.schemas['Breed']
+        Schema dogSchema = openAPI.components.schemas['Dog']
+        Schema traitSchema = openAPI.components.schemas['Trait']
+
+        then: "the components are valid"
+        breedSchema
+        dogSchema
+        traitSchema
+
+        dogSchema.properties.traits
+        dogSchema.properties.traits.type == 'array'
+        dogSchema.properties.traits.items.$ref == '#/components/schemas/Trait'
+
+        traitSchema.type == 'string'
+        traitSchema.enum.get(0) == 'QUICKNESS'
+        traitSchema.enum.get(1) == 'COURAGE'
+        traitSchema.enum.get(2) == 'LOYALTY'
+    }
 }