Rename allure-junit5 to allure-jupiter (via #1262)

Author: baev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -45,7 +45,10 @@ body:
         - allure-jsonunit
         - allure-junit-platform
         - allure-junit4
+        - allure-jupiter
+        - allure-jupiter-assert
         - allure-junit5
+        - allure-junit5-assert
         - allure-karate
         - allure-okhttp
         - allure-okhttp3

.github/labeler.yml

@@ -48,8 +48,8 @@
   - "allure-junit4-aspect/**"
 
 "theme:junit-platform":
-  - "allure-junit5/**"
-  - "allure-junit5-assert/**"
+  - "allure-jupiter/**"
+  - "allure-jupiter-assert/**"
   - "allure-junit-platform/**"
 
 "theme:karate":

README.md

@@ -37,11 +37,12 @@
 - 📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit4
 - ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
 - 
-## JUnit 5
-
-- 🚀 Documentation — https://allurereport.org/docs/junit5/
-- 📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit5
-- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
+## JUnit Jupiter (JUnit 5 and 6)
+
+- 🚀 Documentation — https://allurereport.org/docs/junit5/
+- 📚 Example project — https://github.com/allure-examples?q=topic%3Ajunit5
+- ✅ Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
+- 🧩 Use `io.qameta.allure:allure-jupiter` for new setups. `allure-junit5` remains available as a deprecated compatibility alias during migration.
 
 ## Cucumber JVM
 

allure-bom/build.gradle.kts

@@ -8,6 +8,8 @@ dependencies {
     constraints {
         rootProject.subprojects.sorted()
                 .forEach { api("${it.group}:${it.name}:${it.version}") }
+        api("io.qameta.allure:allure-junit5:${project.version}")
+        api("io.qameta.allure:allure-junit5-assert:${project.version}")
     }
 }
 

allure-junit5/src/main/services/org.junit.jupiter.api.extension.Extension

@@ -1,4 +1,6 @@
-Adding JUnit5-assert may lead to java.lang.OutOfMemoryError: Java heap space
+Adding Jupiter assert may lead to java.lang.OutOfMemoryError: Java heap space
+
+The primary artifact is now `allure-jupiter-assert`. `allure-junit5-assert` remains available as a deprecated compatibility alias during the transition.
 
 Having a huge class path may lead to OOM, because AspectJ processes all the classes. [Link to documentation](https://www.eclipse.org/aspectj/doc/released/devguide/ltw.html) 
 

allure-junit5/src/test/resources/META-INF/services/org.junit.jupiter.api.extension.Extension

@@ -1,7 +1,7 @@
-description = "Allure Junit5 Assertions Integration"
+description = "Allure Jupiter Assertions Integration"
 
 dependencies {
-    api(project(":allure-junit5"))
+    api(project(":allure-jupiter"))
     compileOnly("org.aspectj:aspectjrt")
     compileOnly("org.junit.jupiter:junit-jupiter-api")
     testAnnotationProcessor(project(":allure-descriptions-javadoc"))
@@ -15,7 +15,7 @@ dependencies {
 tasks.jar {
     manifest {
         attributes(mapOf(
-                "Automatic-Module-Name" to "io.qameta.allure.junit5-assert"
+                "Automatic-Module-Name" to "io.qameta.allure.jupiterassert"
         ))
     }
 }
@@ -24,3 +24,10 @@ tasks.test {
     useJUnitPlatform()
 }
 
+publishing {
+    publications {
+        create<MavenPublication>("legacyJunit5Assert") {
+            artifactId = "allure-junit5-assert"
+        }
+    }
+}

allure-junit5-assert/README.MD allure-jupiter-assert/README.MDallure-junit5-assert/README.MD renamed to allure-jupiter-assert/README.MD

@@ -0,0 +1,26 @@
+/*
+ *  Copyright 2016-2026 Qameta Software Inc
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package io.qameta.allure.junit5assert;
+
+import io.qameta.allure.jupiterassert.AllureJupiterAssert;
+
+/**
+ * @author legionivo (Andrey Konovka).
+ * @deprecated use {@link AllureJupiterAssert}.
+ */
+@Deprecated
+public class AllureJunit5Assert extends AllureJupiterAssert {
+}

allure-junit5-assert/build.gradle.kts allure-jupiter-assert/build.gradle.ktsallure-junit5-assert/build.gradle.kts renamed to allure-jupiter-assert/build.gradle.kts

@@ -13,7 +13,7 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
-package io.qameta.allure.junit5assert;
+package io.qameta.allure.jupiterassert;
 
 import io.qameta.allure.Allure;
 import io.qameta.allure.AllureLifecycle;
@@ -41,13 +41,12 @@
  */
 @SuppressWarnings("all")
 @Aspect
-public class AllureJunit5Assert {
+public class AllureJupiterAssert {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(AllureJunit5Assert.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(AllureJupiterAssert.class);
     private StepResult stepResult;
 
-
-    private static InheritableThreadLocal<AllureLifecycle> lifecycle = new InheritableThreadLocal<AllureLifecycle>() {
+    private static final InheritableThreadLocal<AllureLifecycle> LIFECYCLE = new InheritableThreadLocal<AllureLifecycle>() {
         @Override
         protected AllureLifecycle initialValue() {
             return Allure.getLifecycle();
@@ -69,11 +68,10 @@ public void stepStart(final JoinPoint joinPoint) {
         if (joinPoint.getArgs().length > 1) {
             final String uuid = UUID.randomUUID().toString();
             final String assertName = joinPoint.getSignature().getName();
-            String name;
+            final String name;
             if (joinPoint.getSignature().getName().equalsIgnoreCase("assertAll")) {
-                name = String.format("assert All in " + " \'%s\'", joinPoint.getArgs()[0].toString());
+                name = String.format("assert All in " + " '%s'", joinPoint.getArgs()[0].toString());
             } else {
-
                 final String actual = joinPoint.getArgs().length > 0
                         ? ObjectUtils.toString(joinPoint.getArgs()[1])
                         : "<?>";
@@ -83,12 +81,13 @@ public void stepStart(final JoinPoint joinPoint) {
 
                 final List<String> assertArray = Arrays.asList(assertName.split("(?=[A-Z])"));
                 if (assertArray.size() >= 3) {
-                    name = String.format(assertArray.get(0) + " " + assertArray.get(1) + " \'%s\'", expected)
+                    name = String.format(assertArray.get(0) + " " + assertArray.get(1) + " '%s'", expected)
                             + " " + String.format(assertArray.stream()
                             .skip(2)
-                            .collect(Collectors.joining(" ")) + " \'%s\'", actual);
+                            .collect(Collectors.joining(" ")) + " '%s'", actual);
                 } else {
-                    name = String.format(assertArray.get(0) + " \'%s\'", expected) + " " + String.format(assertArray.get(1) + " \'%s\'", actual);
+                    name = String.format(assertArray.get(0) + " '%s'", expected)
+                            + " " + String.format(assertArray.get(1) + " '%s'", actual);
                 }
             }
             final StepResult result = new StepResult()
@@ -101,7 +100,7 @@ public void stepStart(final JoinPoint joinPoint) {
                     : "<?>";
             final String uuid = UUID.randomUUID().toString();
             final String assertName = joinPoint.getSignature().getName();
-            final String name = String.format(assertName + " \'%s\'", actual);
+            final String name = String.format(assertName + " '%s'", actual);
 
             final StepResult result = new StepResult()
                     .setName(name)
@@ -129,11 +128,10 @@ public void stepStop() {
      * @param allure allure lifecycle to set.
      */
     public static void setLifecycle(final AllureLifecycle allure) {
-        lifecycle.set(allure);
+        LIFECYCLE.set(allure);
     }
 
     public static AllureLifecycle getLifecycle() {
-        return lifecycle.get();
+        return LIFECYCLE.get();
     }
-
 }