#1574: Added compiler error for missing name parameter in AnnotateWit…

…h.Element when using multiple Element annotations.
mapstruct · filiphr · Aug 20, 2022 · Mar 7, 2022 · Mar 8, 2022 · Mar 9, 2022
commit 8bc4aa8477893aa96f25679b1d188859ee60a0bb
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/AdditionalAnnotationsBuilder.java b/processor/src/main/java/org/mapstruct/ap/internal/model/AdditionalAnnotationsBuilder.java
@@ -217,16 +217,19 @@ private boolean isValid(Type annotationType, List<ElementGem> eleGems, Element e
         if ( !annotationIsAllowed( annotationType, element, annotationMirror ) ) {
             isValid = false;
         }
+        if ( !annotationIsComplete( annotationType, eleGems, element ) ) {
+            isValid = false;
+        }
 
-        List<ExecutableElement> annotationParameters = methodsIn( annotationType.getTypeElement()
+        List<ExecutableElement> annotationElements = methodsIn( annotationType.getTypeElement()
             .getEnclosedElements() );
-        if ( !allRequiredParametersArePresent( annotationType, annotationParameters, eleGems, element ) ) {
+        if ( !allRequiredElementsArePresent( annotationType, annotationElements, eleGems, element ) ) {
             isValid = false;
         }
-        if ( !allParametersAreKnownInAnnotation( annotationType, annotationParameters, eleGems, element ) ) {
+        if ( !allElementsAreKnownInAnnotation( annotationType, annotationElements, eleGems, element ) ) {
             isValid = false;
         }
-        if ( !allParametersAreOfCorrectType( annotationType, annotationParameters, eleGems, element ) ) {
+        if ( !allElementsAreOfCorrectType( annotationType, annotationElements, eleGems, element ) ) {
             isValid = false;
         }
         if ( !enumConstructionIsCorrectlyUsed( eleGems, element ) ) {
@@ -272,6 +275,23 @@ private boolean enumConstructionIsCorrectlyUsed(List<ElementGem> eleGems, Elemen
         return isValid;
     }
 
+    private boolean annotationIsComplete(Type annotationType, List<ElementGem> eleGems, Element element) {
+        boolean isValid = true;
+        if ( eleGems.size() > 1 ) {
+            for ( ElementGem elementGem : eleGems ) {
+                if ( elementGem.name().getValue() == null ) {
+                    isValid = false;
+                    messager.printMessage(
+                                element,
+                                elementGem.mirror(),
+                                Message.ANNOTATE_WITH_NAME_NOT_DEFINED,
+                                annotationType.describe() );
+                }
+            }
+        }
+        return isValid;
+    }
+
     private boolean annotationIsAllowed(Type annotationType, Element element, AnnotationMirror annotationMirror) {
         Target target = annotationType.getTypeElement().getAnnotation( Target.class );
         if ( target == null ) {
@@ -314,7 +334,7 @@ private boolean isMethodTarget(Element element) {
         return element.getKind() == ElementKind.METHOD;
     }
 
-    private boolean allParametersAreKnownInAnnotation(Type annotationType, List<ExecutableElement> annotationParameters,
+    private boolean allElementsAreKnownInAnnotation(Type annotationType, List<ExecutableElement> annotationParameters,
                                                       List<ElementGem> eleGems, Element element) {
         List<String> allowedAnnotationParameters = annotationParameters.stream()
                                                                  .map( ee -> ee.getSimpleName().toString() )
@@ -338,7 +358,7 @@ private boolean allParametersAreKnownInAnnotation(Type annotationType, List<Exec
         return isValid;
     }
 
-    private boolean allRequiredParametersArePresent(Type annotationType, List<ExecutableElement> annotationParameters,
+    private boolean allRequiredElementsArePresent(Type annotationType, List<ExecutableElement> annotationParameters,
                                                     List<ElementGem> elements, Element element) {
 
         boolean valid = true;
@@ -371,7 +391,7 @@ private boolean allRequiredParametersArePresent(Type annotationType, List<Execut
         return valid;
     }
 
-    private boolean allParametersAreOfCorrectType(Type annotationType, List<ExecutableElement> annotationParameters,
+    private boolean allElementsAreOfCorrectType(Type annotationType, List<ExecutableElement> annotationParameters,
                                                   List<ElementGem> elements,
                                                   Element element) {
         Map<String, ExecutableElement> annotationParametersByName =

diff --git a/processor/src/main/java/org/mapstruct/ap/internal/util/Message.java b/processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
@@ -204,7 +204,8 @@ public enum Message {
     ANNOTATE_WITH_NOT_ALLOWED_ON_CLASS( "Annotation \"%s\" is not allowed on classes." ),
     ANNOTATE_WITH_NOT_ALLOWED_ON_METHODS( "Annotation \"%s\" is not allowed on methods." ),
     ANNOTATE_WITH_ENUM_VALUE_DOES_NOT_EXIST( "Enum \"%s\" does not have value \"%s\"." ),
-    ANNOTATE_WITH_ENUM_CLASS_NOT_DEFINED( "\"enumClass=...\" is required when using \"enums=...\"." ),
+    ANNOTATE_WITH_ENUM_CLASS_NOT_DEFINED( "\"enumClass=...\" is required when using \"enums=...\" for \"%s\"." ),
+    ANNOTATE_WITH_NAME_NOT_DEFINED( "\"name=...\" is required in each @AnnotateWith.Element annotation with multiple annotations for annotation \"%s\"." ),
     ;
     // CHECKSTYLE:ON
 

diff --git a/processor/src/test/java/org/mapstruct/ap/test/annotatewith/AnnotateWithTest.java b/processor/src/test/java/org/mapstruct/ap/test/annotatewith/AnnotateWithTest.java
@@ -456,4 +456,22 @@ public void erroneousMapperWithWrongParameter() {
     @WithClasses({ ErroneousMultipleArrayValuesMapper.class, CustomAnnotationWithParams.class })
     public void erroneousMapperUsingMultipleValuesInsteadOfSingle() {
     }
+
+    @ProcessorTest
+    @ExpectedCompilationOutcome(
+        value = CompilationResult.FAILED,
+        diagnostics = {
+            @Diagnostic(
+               kind = javax.tools.Diagnostic.Kind.ERROR,
+               type = ErroneousMapperWithMissingAnnotationElementName.class,
+               line = 16,
+               alternativeLine = 19,
+               message = "\"name=...\" is required in each @AnnotateWith.Element annotation with multiple annotations "
+                    + "for annotation \"CustomAnnotationWithTwoAnnotationElements\"."
+            )
+        }
+    )
+    @WithClasses({ErroneousMapperWithMissingAnnotationElementName.class, CustomAnnotationWithTwoAnnotationElements.class})
+    public void erroneousMapperWithMissingAnnotationElementName() {
+    }
 }