promote attachment and log steps

Author: baev

allure-awaitility/src/main/java/io/qameta/allure/awaitility/AllureAwaitilityListener.java

@@ -164,16 +164,13 @@ public void onTimeout(final TimeoutEvent timeoutEvent) {
         if (currentConditionStepKey == null) {
             return;
         }
-        final AllureExternalKey timeoutStepKey = AllureExternalKey.random(AllureAwaitilityListener.class);
-        getLifecycle().startStep(
+        getLifecycle().logStep(
                 currentConditionStepKey,
-                timeoutStepKey,
                 new StepResult()
                         .setName(String.format(onTimeoutStepTextPattern, timeoutEvent.getDescription()))
                         .setDescription("Awaitility condition timeout")
                         .setStatus(Status.BROKEN)
         );
-        getLifecycle().stopStep(timeoutStepKey);
         getLifecycle().stopStep(currentConditionStepKey);
     }
 
@@ -202,16 +199,13 @@ public void conditionEvaluated(final EvaluatedCondition<Object> condition) {
         if (currentConditionStepKey == null) {
             return;
         }
-        final AllureExternalKey lastAwaitStepKey = AllureExternalKey.random(AllureAwaitilityListener.class);
-        getLifecycle().startStep(
+        getLifecycle().logStep(
                 currentConditionStepKey,
-                lastAwaitStepKey,
                 new StepResult()
                         .setName(message)
                         .setDescription("Awaitility condition satisfied or not, but awaiting still in progress")
                         .setStatus(Status.PASSED)
         );
-        getLifecycle().stopStep(lastAwaitStepKey);
         if (condition.isSatisfied()) {
             getLifecycle().updateStep(
                     currentConditionStepKey, awaitilityCondition -> awaitilityCondition.setStatus(Status.PASSED)

allure-java-commons/src/main/java/io/qameta/allure/Allure.java

@@ -17,7 +17,6 @@
 
 import io.qameta.allure.http.HttpExchange;
 import io.qameta.allure.http.HttpExchangeSerializer;
-import io.qameta.allure.listener.LifecycleNotifier;
 import io.qameta.allure.model.Label;
 import io.qameta.allure.model.Link;
 import io.qameta.allure.model.Parameter;
@@ -47,7 +46,7 @@
 /**
  * The class contains some useful methods to work with {@link AllureLifecycle}.
  */
-@SuppressWarnings({"PMD.TooManyMethods", "PMD.GodClass"})
+@SuppressWarnings("PMD.TooManyMethods")
 public final class Allure {
 
     private static final String TEXT_PLAIN = "text/plain";
@@ -98,8 +97,7 @@ public static void step(final String name) {
      * @param status the step status.
      */
     public static void step(final String name, final Status status) {
-        getLifecycle().startStep(new StepResult().setName(name).setStatus(status));
-        getLifecycle().stopStep();
+        getLifecycle().logStep(new StepResult().setName(name).setStatus(status));
     }
 
     /**
@@ -479,31 +477,7 @@ public static CompletableFuture<Void> attachmentAsync(
                                                           final String name, final String type,
                                                           final CompletionStage<? extends InputStream> body,
                                                           final AttachmentOptions options) {
-        final AllureLifecycle lifecycle = getLifecycle();
-        if (isDirectAttachmentWrite()) {
-            return lifecycle.addAttachmentAsync(name, type, body, options);
-        }
-
-        final StepResult step = new StepResult()
-                .setName(attachmentStepName(name))
-                .setStatus(Status.PASSED);
-        lifecycle.startStep(step);
-        try {
-            // the status update runs inside the tracked future, so a failed async attachment is
-            // guaranteed to mark the step before the owning test result is written
-            return lifecycle.addAttachmentAsync(name, type, body, options, (result, throwable) -> {
-                if (Objects.nonNull(throwable)) {
-                    step.setStatus(getStatus(throwable).orElse(Status.BROKEN))
-                            .setStatusDetails(getStatusDetails(throwable).orElse(null));
-                }
-            });
-        } catch (Throwable throwable) {
-            step.setStatus(getStatus(throwable).orElse(Status.BROKEN))
-                    .setStatusDetails(getStatusDetails(throwable).orElse(null));
-            throw ExceptionUtils.sneakyThrow(throwable);
-        } finally {
-            lifecycle.stopStep();
-        }
+        return getLifecycle().addAttachmentStepAsync(name, type, body, options);
     }
 
     /**
@@ -538,41 +512,7 @@ private static void addAttachmentAsStep(final String name, final String type,
 
     private static void addAttachmentAsStep(final String name, final String type,
                                             final InputStream content, final AttachmentOptions options) {
-        final AllureLifecycle lifecycle = getLifecycle();
-        if (isDirectAttachmentWrite()) {
-            addAttachmentDirect(lifecycle, name, type, content, options);
-            return;
-        }
-
-        lifecycle.startStep(new StepResult().setName(attachmentStepName(name)));
-        try {
-            lifecycle.addAttachment(name, type, content, options);
-            lifecycle.updateStep(step -> step.setStatus(Status.PASSED));
-        } catch (Throwable throwable) {
-            lifecycle.updateStep(
-                    step -> step
-                            .setStatus(getStatus(throwable).orElse(Status.BROKEN))
-                            .setStatusDetails(getStatusDetails(throwable).orElse(null))
-            );
-            throw ExceptionUtils.sneakyThrow(throwable);
-        } finally {
-            lifecycle.stopStep();
-        }
-    }
-
-    private static void addAttachmentDirect(final AllureLifecycle lifecycle,
-                                            final String name, final String type,
-                                            final InputStream content, final AttachmentOptions options) {
-        lifecycle.addAttachment(name, type, content, options);
-    }
-
-    private static boolean isDirectAttachmentWrite() {
-        return LifecycleNotifier.isListenerCallbackRunning()
-                || getLifecycle().getCurrentExecutableKey().isEmpty();
-    }
-
-    private static String attachmentStepName(final String name) {
-        return Objects.isNull(name) || name.isEmpty() ? "Attachment" : name;
+        getLifecycle().addAttachmentStep(name, type, content, options);
     }
 
     /**