[vividus] Skip reporting of status for @BeforeStories/@AfterStories (#…

…2415)
vividus-framework · Jan 31, 2022 · e3b3562 · e3b3562
1 parent 88e9a10
commit e3b3562
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 11 deletions.
diff --git a/vividus/src/main/java/org/vividus/StatusStoryReporter.java b/vividus/src/main/java/org/vividus/StatusStoryReporter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2021 the original author or authors.
+ * Copyright 2019-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,12 +20,19 @@
 import java.util.concurrent.atomic.AtomicReference;
 
 import org.jbehave.core.model.Scenario;
+import org.vividus.context.ReportControlContext;
+import org.vividus.context.RunContext;
 import org.vividus.softassert.exception.VerificationError;
 
-public class StatusStoryReporter extends ChainedStoryReporter implements IRunStatusProvider
+public class StatusStoryReporter extends AbstractReportControlStoryReporter implements IRunStatusProvider
 {
     private final AtomicReference<Optional<Status>> status = new AtomicReference<>(Optional.empty());
 
+    public StatusStoryReporter(ReportControlContext reportControlContext, RunContext runContext)
+    {
+        super(reportControlContext, runContext);
+    }
+
     @Override
     public Optional<Status> getRunStatus()
     {
@@ -42,7 +49,7 @@ public void scenarioExcluded(Scenario scenario, String filter)
     @Override
     public void successful(String step)
     {
-        changeStatus(Status.PASSED);
+        perform(() -> changeStatus(Status.PASSED));
         super.successful(step);
     }
 
@@ -70,8 +77,11 @@ public void notPerformed(String step)
     @Override
     public void failed(String step, Throwable throwable)
     {
-        Throwable cause = JBehaveFailureUnwrapper.unwrapCause(throwable);
-        changeStatus(getStatus(cause));
+        perform(() ->
+        {
+            Throwable cause = JBehaveFailureUnwrapper.unwrapCause(throwable);
+            changeStatus(getStatus(cause));
+        });
         super.failed(step, throwable);
     }
 

diff --git a/vividus/src/test/java/org/vividus/StatusStoryReporterTests.java b/vividus/src/test/java/org/vividus/StatusStoryReporterTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2021 the original author or authors.
+ * Copyright 2019-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 import java.io.IOException;
 import java.util.List;
@@ -31,6 +32,8 @@
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import org.vividus.context.ReportControlContext;
+import org.vividus.context.RunContext;
 import org.vividus.softassert.exception.VerificationError;
 import org.vividus.softassert.issue.KnownIssueIdentifier;
 import org.vividus.softassert.issue.KnownIssueType;
@@ -40,11 +43,10 @@
 @ExtendWith(MockitoExtension.class)
 class StatusStoryReporterTests
 {
-    @Mock
-    private StoryReporter nextStoryReporter;
-
-    @InjectMocks
-    private StatusStoryReporter statusStoryReporter;
+    @Mock private StoryReporter nextStoryReporter;
+    @Mock private ReportControlContext reportControlContext;
+    @Mock private RunContext runContext;
+    @InjectMocks private StatusStoryReporter statusStoryReporter;
 
     @BeforeEach
     void beforeEach()
@@ -87,6 +89,7 @@ void testNotPerformed()
     @Test
     void testBroken()
     {
+        mockEnabledReporting();
         IOException throwable = new IOException();
         statusStoryReporter.failed(null, throwable);
         assertEquals(Optional.of(Status.BROKEN), statusStoryReporter.getRunStatus());
@@ -96,6 +99,7 @@ void testBroken()
     @Test
     void testFailedAssertionError()
     {
+        mockEnabledReporting();
         UUIDExceptionWrapper throwable = new UUIDExceptionWrapper(new AssertionError());
         statusStoryReporter.failed(null, throwable);
         assertEquals(Optional.of(Status.FAILED), statusStoryReporter.getRunStatus());
@@ -105,6 +109,7 @@ void testFailedAssertionError()
     @Test
     void testFailedVerificationError()
     {
+        mockEnabledReporting();
         VerificationError verificationError = new VerificationError(null, List.of(new SoftAssertionError(null)));
         UUIDExceptionWrapper throwable = new UUIDExceptionWrapper(verificationError);
         statusStoryReporter.failed(null, throwable);
@@ -115,6 +120,7 @@ void testFailedVerificationError()
     @Test
     void testKnownIssuesOnly()
     {
+        mockEnabledReporting();
         SoftAssertionError softAssertionError = new SoftAssertionError(null);
         softAssertionError.setKnownIssue(createKnownIssue(false));
         VerificationError verificationError = new VerificationError(null, List.of(softAssertionError));
@@ -127,6 +133,7 @@ void testKnownIssuesOnly()
     @Test
     void testFailedWithPotentiallyKnownIssue()
     {
+        mockEnabledReporting();
         SoftAssertionError softAssertionError = new SoftAssertionError(null);
         softAssertionError.setKnownIssue(createKnownIssue(true));
         VerificationError verificationError = new VerificationError(null, List.of(softAssertionError));
@@ -139,6 +146,7 @@ void testFailedWithPotentiallyKnownIssue()
     @Test
     void testSuccessful()
     {
+        mockEnabledReporting();
         statusStoryReporter.successful(null);
         assertEquals(Optional.of(Status.PASSED), statusStoryReporter.getRunStatus());
         verify(nextStoryReporter).successful(null);
@@ -147,6 +155,7 @@ void testSuccessful()
     @Test
     void testStatusPriorities()
     {
+        mockEnabledReporting();
         statusStoryReporter.successful(null);
         statusStoryReporter.failed(null, null);
         statusStoryReporter.successful(null);
@@ -157,6 +166,7 @@ void testStatusPriorities()
     @Test
     void shouldSwitchKnownIssuesOnlyToPending()
     {
+        mockEnabledReporting();
         SoftAssertionError softAssertionError = new SoftAssertionError(null);
         softAssertionError.setKnownIssue(createKnownIssue(false));
         VerificationError verificationError = new VerificationError(null, List.of(softAssertionError));
@@ -173,4 +183,10 @@ private KnownIssue createKnownIssue(boolean potentiallyKnown)
         identifier.setType(KnownIssueType.AUTOMATION);
         return new KnownIssue(null, identifier, potentiallyKnown);
     }
+
+    private void mockEnabledReporting()
+    {
+        when(reportControlContext.isReportingEnabled()).thenReturn(true);
+        when(runContext.isRunCompleted()).thenReturn(false);
+    }
 }