- provided ability to handle package annotations

s.tikhomirov · s.tikhomirov · commit ea390355350c · 2024-09-10T14:38:50.000+03:00
- add package target to Epic(s), Feature(s), Flaky, Issue(s), Link(s), Muted, Owner, Severity, Story(es), TmsLink(s)
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Epic.java b/allure-java-commons/src/main/java/io/qameta/allure/Epic.java
@@ -31,7 +31,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @Repeatable(Epics.class)
 @LabelAnnotation(name = EPIC_LABEL_NAME)
 public @interface Epic {
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Epics.java b/allure-java-commons/src/main/java/io/qameta/allure/Epics.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Epics {
 
     Epic[] value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Feature.java b/allure-java-commons/src/main/java/io/qameta/allure/Feature.java
@@ -31,7 +31,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @Repeatable(Features.class)
 @LabelAnnotation(name = FEATURE_LABEL_NAME)
 public @interface Feature {
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Features.java b/allure-java-commons/src/main/java/io/qameta/allure/Features.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Features {
 
     Feature[] value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Flaky.java b/allure-java-commons/src/main/java/io/qameta/allure/Flaky.java
@@ -28,6 +28,6 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Flaky {
 }
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Issue.java b/allure-java-commons/src/main/java/io/qameta/allure/Issue.java
@@ -31,7 +31,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @LinkAnnotation(type = ISSUE_LINK_TYPE)
 @Repeatable(Issues.class)
 public @interface Issue {
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Issues.java b/allure-java-commons/src/main/java/io/qameta/allure/Issues.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Issues {
 
     Issue[] value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Link.java b/allure-java-commons/src/main/java/io/qameta/allure/Link.java
@@ -37,7 +37,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @LinkAnnotation
 @Repeatable(Links.class)
 public @interface Link {
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Links.java b/allure-java-commons/src/main/java/io/qameta/allure/Links.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Links {
 
     Link[] value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Muted.java b/allure-java-commons/src/main/java/io/qameta/allure/Muted.java
@@ -28,6 +28,6 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Muted {
 }
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Owner.java b/allure-java-commons/src/main/java/io/qameta/allure/Owner.java
@@ -33,7 +33,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @LabelAnnotation(name = OWNER_LABEL_NAME)
 public @interface Owner {
 
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Severity.java b/allure-java-commons/src/main/java/io/qameta/allure/Severity.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Severity {
 
     SeverityLevel value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Stories.java b/allure-java-commons/src/main/java/io/qameta/allure/Stories.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface Stories {
 
     Story[] value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/Story.java b/allure-java-commons/src/main/java/io/qameta/allure/Story.java
@@ -31,7 +31,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @Repeatable(Stories.class)
 @LabelAnnotation(name = STORY_LABEL_NAME)
 public @interface Story {
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/TmsLink.java b/allure-java-commons/src/main/java/io/qameta/allure/TmsLink.java
@@ -31,7 +31,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 @LinkAnnotation(type = TMS_LINK_TYPE)
 @Repeatable(TmsLinks.class)
 public @interface TmsLink {
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/TmsLinks.java b/allure-java-commons/src/main/java/io/qameta/allure/TmsLinks.java
@@ -28,7 +28,7 @@
 @Documented
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})
 public @interface TmsLinks {
 
     TmsLink[] value();
diff --git a/allure-java-commons/src/main/java/io/qameta/allure/util/AnnotationUtils.java b/allure-java-commons/src/main/java/io/qameta/allure/util/AnnotationUtils.java
@@ -29,8 +29,10 @@
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Objects;
 import java.util.Set;
 import java.util.function.BiFunction;
@@ -39,7 +41,11 @@
 
 import static io.qameta.allure.util.ResultsUtils.createLabel;
 import static io.qameta.allure.util.ResultsUtils.createLink;
+import static java.lang.String.join;
 import static java.util.Arrays.asList;
+import static java.util.Arrays.copyOfRange;
+import static java.util.Arrays.stream;
+import static java.util.Optional.ofNullable;
 
 /**
  * Collection of utils used by Allure integration to extract meta information from
@@ -64,7 +70,7 @@ private AnnotationUtils() {
      * @return true if {@link io.qameta.allure.Flaky} annotation is present, false otherwise.
      */
     public static boolean isFlaky(final AnnotatedElement annotatedElement) {
-        return annotatedElement.isAnnotationPresent(Flaky.class);
+        return isAnnotationPresent(annotatedElement, Flaky.class);
     }
 
     /**
@@ -74,7 +80,7 @@ public static boolean isFlaky(final AnnotatedElement annotatedElement) {
      * @return true if {@link io.qameta.allure.Muted} annotation is present, false otherwise.
      */
     public static boolean isMuted(final AnnotatedElement annotatedElement) {
-        return annotatedElement.isAnnotationPresent(Muted.class);
+        return isAnnotationPresent(annotatedElement, Muted.class);
     }
 
     /**
@@ -84,7 +90,7 @@ public static boolean isMuted(final AnnotatedElement annotatedElement) {
      * @return discovered links.
      */
     public static Set<Link> getLinks(final AnnotatedElement annotatedElement) {
-        return getLinks(annotatedElement.getAnnotations());
+        return getLinks(getAnnotationsFrom(annotatedElement));
     }
 
     /**
@@ -116,7 +122,7 @@ public static Set<Link> getLinks(final Collection<Annotation> annotations) {
      * @return discovered labels.
      */
     public static Set<Label> getLabels(final AnnotatedElement annotatedElement) {
-        return getLabels(annotatedElement.getAnnotations());
+        return getLabels(getAnnotationsFrom(annotatedElement));
     }
 
     /**
@@ -140,6 +146,29 @@ public static Set<Label> getLabels(final Collection<Annotation> annotations) {
                 .collect(Collectors.toSet());
     }
 
+    private static <T extends Annotation> boolean isAnnotationPresent(final AnnotatedElement annotatedElement, Class<T> annotationClass) {
+        boolean isPresent = annotatedElement.isAnnotationPresent(annotationClass);
+        if (!isPresent && annotatedElement instanceof Class<?>) {
+            Annotation[] packageAnnotations = PackageUtil.getPackageAnnotations((Class<?>) annotatedElement);
+            return stream(packageAnnotations).anyMatch(a -> a.annotationType().equals(annotationClass));
+        }
+
+        return isPresent;
+    }
+
+    private static Annotation[] getAnnotationsFrom(AnnotatedElement annotatedElement) {
+        Annotation[] result = annotatedElement.getAnnotations();
+        if (annotatedElement instanceof Class<?>) {
+            Annotation[] packageAnnotations = PackageUtil.getPackageAnnotations((Class<?>) annotatedElement);
+            List<Annotation> annotationList = new ArrayList<>(asList(result));
+            List<Annotation> packageAnnotationList = new ArrayList<>(asList(packageAnnotations));
+            annotationList.addAll(packageAnnotationList);
+            result = annotationList.toArray(new Annotation[]{});
+        }
+
+        return result;
+    }
+
     private static <T, U extends Annotation> Stream<T> extractMetaAnnotations(
             final Class<U> annotationType,
             final BiFunction<U, Annotation, Stream<T>> mapper,
@@ -262,4 +291,41 @@ private static boolean isInJavaLangAnnotationPackage(final Class<? extends Annot
         return annotationType != null && annotationType.getName().startsWith("java.lang.annotation");
     }
 
+    /**
+     * Extracts annotations from packages hierarchically by given classes
+     *
+     * @author TikhomirovSergey (Sergey Tikhomirov).
+     */
+    static class PackageUtil {
+
+        static Annotation[] getPackageAnnotations(Class<?> clz) {
+            Objects.requireNonNull(clz, "Class should not be a null value");
+            return getPackageAnnotations(clz.getPackage().getName());
+        }
+
+        static Annotation[] getPackageAnnotations(String packageName) {
+            Objects.requireNonNull(packageName, "Package name should not be a null value");
+
+            //the code below would look better if allure supported Java from 9 and higher versions
+            Class<?> packInfo;
+            try {
+                packInfo = Class.forName(packageName + ".package-info", false, PackageUtil.class.getClassLoader());
+            } catch (ClassNotFoundException e) {
+                packInfo = null;
+            }
+
+            Annotation[] annotations = ofNullable(packInfo).map(clazz -> clazz.getPackage().getAnnotations()).orElse(new Annotation[]{});
+            String[] pathElements = packageName.split("[.]");
+            if (pathElements.length == 1) {
+                return annotations;
+            }
+
+            Annotation[] upperPackageAnnotations = getPackageAnnotations(join(".", copyOfRange(pathElements, 0, pathElements.length - 1)));
+            List<Annotation> annotationList = new ArrayList<>(asList(annotations));
+            List<Annotation> result = new ArrayList<>(asList(upperPackageAnnotations));
+            result.addAll(annotationList);
+            return result.toArray(new Annotation[] {});
+        }
+    }
+
 }
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/MutedAndFlakyTest.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/MutedAndFlakyTest.java
@@ -0,0 +1,15 @@
+package io.qameta.allure.annotatedpack;
+
+import io.qameta.allure.Flaky;
+import io.qameta.allure.Muted;
+
+@Muted
+@Flaky
+public class MutedAndFlakyTest {
+
+    @Muted
+    @Flaky
+    public void mutedAndFlakyMethod() {
+
+    }
+}
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/NotMutedAndFlakyTest.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/NotMutedAndFlakyTest.java
@@ -0,0 +1,8 @@
+package io.qameta.allure.annotatedpack;
+
+public class NotMutedAndFlakyTest {
+
+    public void notMutedAndFlakyMethod() {
+
+    }
+}
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/muted/and/flaky/MutedAndFlakyByPackageTest.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/muted/and/flaky/MutedAndFlakyByPackageTest.java
@@ -0,0 +1,8 @@
+package io.qameta.allure.annotatedpack.muted.and.flaky;
+
+public class MutedAndFlakyByPackageTest {
+
+    public void notMutedAndFlakyMethod() {
+
+    }
+}
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/muted/and/flaky/package-info.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/muted/and/flaky/package-info.java
@@ -0,0 +1,6 @@
+@Muted
+@Flaky
+package io.qameta.allure.annotatedpack.muted.and.flaky;
+
+import io.qameta.allure.Flaky;
+import io.qameta.allure.Muted;
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/package-info.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/package-info.java
@@ -0,0 +1,6 @@
+@Epic("High level epic")
+@Link("General link")
+package io.qameta.allure.annotatedpack;
+
+import io.qameta.allure.Epic;
+import io.qameta.allure.Link;
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/subpack/innerpack/SomeTest.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/subpack/innerpack/SomeTest.java
@@ -0,0 +1,7 @@
+package io.qameta.allure.annotatedpack.subpack.innerpack;
+
+import io.qameta.allure.Story;
+
+@Story("Marked pack story")
+public class SomeTest {
+}
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/subpack/package-info.java b/allure-java-commons/src/test/java/io/qameta/allure/annotatedpack/subpack/package-info.java
@@ -0,0 +1,6 @@
+@Feature("Some general feature")
+@Link("Some second level link")
+package io.qameta.allure.annotatedpack.subpack;
+
+import io.qameta.allure.Feature;
+import io.qameta.allure.Link;
diff --git a/allure-java-commons/src/test/java/io/qameta/allure/util/AnnotationUtilsTest.java b/allure-java-commons/src/test/java/io/qameta/allure/util/AnnotationUtilsTest.java

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@`
`28`	`28`	`@Documented`
`29`	`29`	`@Inherited`
`30`	`30`	`@Retention(RetentionPolicy.RUNTIME)`
`31`		`-@Target({ElementType.METHOD, ElementType.TYPE})`
	`31`	`+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PACKAGE})`
`32`	`32`	`public @interface Flaky {`
`33`	`33`	`}`