Merge pull request #1645 from TNG/fix/Issue-1625-thorough-assumption-…

…handling Fix assumption errors
TNG · Dec 3, 2024 · d88d026 · d88d026
2 parents de91135 + 46f9fda
commit d88d026
Show file tree

Hide file tree

Showing 43 changed files with 750 additions and 219 deletions.
diff --git a/build.gradle b/build.gradle
@@ -257,6 +257,18 @@ configure(subprojects.findAll { !it.name.contains("android") }) {
         classpath = configurations.testRuntimeClasspath
     }
 
+    tasks.register("jgivenPlainTextReport",JavaExec) {
+        //noinspection GroovyAccessibility
+        mainClass = 'com.tngtech.jgiven.report.ReportGenerator'
+        args '--sourceDir=build/reports/jgiven/json',
+                '--targetDir=build/reports/jgiven/text',
+                '--format=text',
+                '--exclude-empty-scenarios=true',
+                '--title=JGiven Report'
+
+        classpath = configurations.testRuntimeClasspath
+    }
+
     asciidoctor {
         sourceDir = new File('build/reports/jgiven/asciidoc')
         outputDir = new File('build/reports/jgiven/htmladoc')

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/impl/ScenarioBase.java b/jgiven-core/src/main/java/com/tngtech/jgiven/impl/ScenarioBase.java
@@ -57,6 +57,10 @@ public void finished() throws Throwable {
         executor.finished();
     }
 
+    public void aborted(Throwable e){
+        executor.aborted(e);
+    }
+
     public ScenarioExecutor getExecutor() {
         return executor;
     }

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/impl/ScenarioExecutor.java b/jgiven-core/src/main/java/com/tngtech/jgiven/impl/ScenarioExecutor.java
@@ -74,6 +74,12 @@ enum State {
      */
     private Throwable failedException;
 
+    /**
+     * Set if an exception was thrown during the execution of the scenario and
+     * suppressStepExceptions is true.
+     */
+    private Throwable abortedException;
+
     private boolean failIfPass;
 
     /**
@@ -356,6 +362,7 @@ public void finished() throws Throwable {
         }
     }
 
+
     private void callFinishLifeCycleMethods() throws Throwable {
         Throwable firstThrownException = failedException;
         if (beforeScenarioMethodsExecuted) {
@@ -415,6 +422,10 @@ public boolean hasFailed() {
         return failedException != null;
     }
 
+    public boolean hasAborted() {
+        return abortedException!= null;
+    }
+
     public Throwable getFailedException() {
         return failedException;
     }
@@ -423,6 +434,14 @@ public void setFailedException(Exception e) {
         failedException = e;
     }
 
+    public Throwable getAbortedException() {
+        return abortedException;
+    }
+
+    public void setAbortedException(Exception e) {
+        abortedException= e;
+    }
+
     /**
      * Handle ocurred exception and continue.
      */
@@ -438,6 +457,16 @@ public void failed(Throwable e) {
         }
     }
 
+    public void aborted(Throwable e) {
+        if (hasAborted()){
+            log.error(e.getMessage(), e);
+        }else {
+            listener.scenarioAborted(e);
+            methodInterceptor.disableMethodExecution();
+            abortedException = e;
+        }
+    }
+
     /**
      * Starts a scenario with the given description.
      *

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/impl/ScenarioModelBuilder.java b/jgiven-core/src/main/java/com/tngtech/jgiven/impl/ScenarioModelBuilder.java
@@ -314,6 +314,13 @@ public void stepMethodFailed(Throwable t) {
         }
     }
 
+    @Override
+    public void stepMethodAborted(Throwable t) {
+        if (currentStep != null) {
+            currentStep.setStatus(StepStatus.ABORTED);
+        }
+    }
+
     @Override
     public void stepMethodFinished(long durationInNanos, boolean hasNestedSteps) {
         if (hasNestedSteps && !parentSteps.isEmpty()) {
@@ -364,6 +371,12 @@ public void scenarioFailed(Throwable e) {
         setException(e);
     }
 
+    @Override
+    public void scenarioAborted(Throwable e){
+        setStatus(ExecutionStatus.ABORTED);
+        setException(e);
+    }
+
     private void setCaseDescription(Class<?> testClass, Method method, List<NamedArgument> namedArguments) {
 
         CaseAs annotation = null;

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/NoOpScenarioListener.java b/jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/NoOpScenarioListener.java
@@ -13,6 +13,9 @@ public class NoOpScenarioListener implements ScenarioListener {
     @Override
     public void scenarioFailed( Throwable e ) {}
 
+    @Override
+    public void scenarioAborted(Throwable e) {}
+
     @Override
     public void scenarioStarted( String string ) {}
 
@@ -31,6 +34,9 @@ public void stepCommentUpdated( String comment ) {}
     @Override
     public void stepMethodFailed( Throwable t ) {}
 
+    @Override
+    public void stepMethodAborted( Throwable t ) {}
+
     @Override
     public void stepMethodFinished( long durationInNanos, boolean hasNestedSteps ) {}
 

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/ScenarioListener.java b/jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/ScenarioListener.java
@@ -12,6 +12,8 @@ public interface ScenarioListener {
 
     void scenarioFailed( Throwable e );
 
+    void scenarioAborted(Throwable e);
+
     void scenarioStarted( String string );
 
     void scenarioStarted( Class<?> testClass, Method method, List<NamedArgument> arguments );
@@ -24,6 +26,8 @@ public interface ScenarioListener {
 
     void stepMethodFailed( Throwable t );
 
+    void stepMethodAborted( Throwable t );
+
     void stepMethodFinished( long durationInNanos, boolean hasNestedSteps );
 
     void scenarioFinished();

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/StepInterceptorImpl.java b/jgiven-core/src/main/java/com/tngtech/jgiven/impl/intercept/StepInterceptorImpl.java
@@ -109,9 +109,7 @@ private Object doIntercept(Object receiver, Method method, Object[] parameters,
 
         try {
             return invoker.proceed();
-        } catch( Exception e ) {
-            return handleThrowable( receiver, method, e, System.nanoTime() - started, handleMethod );
-        } catch( AssertionError e ) {
+        } catch(Exception | AssertionError e ) {
             return handleThrowable( receiver, method, e, System.nanoTime() - started, handleMethod );
         } finally {
             if( hasNestedSteps ) {
@@ -217,13 +215,13 @@ private void handleMethod(Object stageInstance, Method paramMethod, Object[] arg
 
     private void handleThrowable( Throwable t ) throws Throwable {
         if( ThrowableUtil.isAssumptionException(t) ) {
-            throw t;
+            listener.stepMethodAborted(t);
+            scenarioExecutor.aborted(t);
+        }else {
+            listener.stepMethodFailed(t);
+            scenarioExecutor.failed( t );
         }
 
-        listener.stepMethodFailed( t );
-
-        scenarioExecutor.failed( t );
-
         if (!suppressExceptions) {
             throw t;
         }

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocBlockConverter.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocBlockConverter.java
@@ -39,6 +39,7 @@ public String convertStatisticsBlock(final ListMultimap<String, ReportStatistics
         statisticsTable.append("| successful scenarios ");
         statisticsTable.append("| failed scenarios ");
         statisticsTable.append("| pending scenarios ");
+        statisticsTable.append("| aborted scenarios ");
         statisticsTable.append("| total scenarios ");
         statisticsTable.append("| failed cases ");
         statisticsTable.append("| total cases ");
@@ -68,6 +69,8 @@ public String convertFeatureHeaderBlock(final String featureName, final ReportSt
                 .append(statistics.numFailedScenarios).append(" Failed, ");
         blockContent.append(MetadataMapper.toHumanReadableStatus(ExecutionStatus.SCENARIO_PENDING)).append(" ")
                 .append(statistics.numPendingScenarios).append(" Pending, ");
+        blockContent.append(MetadataMapper.toHumanReadableStatus(ExecutionStatus.ABORTED)).append(" ")
+                .append(statistics.numAbortedScenarios).append(" Aborted, ");
         blockContent.append(statistics.numScenarios).append(" Total");
         blockContent.append(" (").append(MetadataMapper.toHumanReadableScenarioDuration(statistics.durationInNanos))
                 .append(")");
@@ -326,6 +329,7 @@ private static void appendStatisticsRowFragment(final StringBuilder builder, fin
         builder.append(" | ").append(statistics.numSuccessfulScenarios);
         builder.append(" | ").append(statistics.numFailedScenarios);
         builder.append(" | ").append(statistics.numPendingScenarios);
+        builder.append(" | ").append(statistics.numAbortedScenarios);
         builder.append(" | ").append(statistics.numScenarios);
         builder.append(" | ").append(statistics.numFailedCases);
         builder.append(" | ").append(statistics.numCases);

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocReportGenerator.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocReportGenerator.java
@@ -43,6 +43,7 @@ public class AsciiDocReportGenerator extends AbstractReportGenerator {
     private final List<String> featureFiles = new ArrayList<>();
     private final List<String> failedScenarioFiles = new ArrayList<>();
     private final List<String> pendingScenarioFiles = new ArrayList<>();
+    private final List<String> abortedScenarioFiles = new ArrayList<>();
     private File targetDir;
     private File featuresDir;
 
@@ -73,6 +74,8 @@ public void generate() {
 
         writeIndexFileForPendingScenarios();
 
+        writeIndexFileForAbortedScenarios();
+
         writeTotalStatisticsFile();
 
         writeIndexFileForFullReport(config.getTitle());
@@ -115,6 +118,9 @@ private List<String> collectReportBlocks(final ReportModelFile reportModelFile,
         if (statistics.numPendingScenarios > 0) {
             pendingScenarioFiles.add(featureFileName);
         }
+        if (statistics.numAbortedScenarios >0){
+            abortedScenarioFiles.add(featureFileName);
+        }
 
         final AsciiDocReportModelVisitor visitor = new AsciiDocReportModelVisitor(blockConverter, statistics);
         reportModelFile.model().accept(visitor);
@@ -151,6 +157,16 @@ private void writeIndexFileForPendingScenarios() {
                 snippetGenerator.generateIndexSnippet());
     }
 
+    private void writeIndexFileForAbortedScenarios() {
+        final String scenarioKind = "aborted";
+        final AsciiDocSnippetGenerator snippetGenerator = new AsciiDocSnippetGenerator(
+                "Aborted Scenarios", "aborted scenarios", this.abortedScenarioFiles, scenarioKind,
+                this.completeReportModel.getTotalStatistics().numAbortedScenarios);
+
+        writeAsciiDocBlocksToFile(new File(targetDir, scenarioKind + "Scenarios.asciidoc"),
+                snippetGenerator.generateIndexSnippet());
+    }
+
     private void writeTotalStatisticsFile() {
 
         final ListMultimap<String, ReportStatistics> featureStatistics = completeReportModel.getAllReportModels()

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/MetadataMapper.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/MetadataMapper.java
@@ -8,6 +8,7 @@ final class MetadataMapper {
     private static final String ICON_CHECK_MARK = "icon:check-square[role=green]";
     private static final String ICON_EXCLAMATION_MARK = "icon:exclamation-circle[role=red]";
     private static final String ICON_BANNED = "icon:ban[role=silver]";
+    private static final String ICON_TIMES_CIRCLE = "icon:times-circle[role=gray]";
     private static final String ICON_STEP_FORWARD = "icon:step-forward[role=silver]";
     private static final int NANOSECONDS_PER_MILLISECOND = 1000000;
 
@@ -46,6 +47,8 @@ static String toHumanReadableStatus(final ExecutionStatus executionStatus) {
                 return ICON_CHECK_MARK;
             case FAILED:
                 return ICON_EXCLAMATION_MARK;
+            case ABORTED:
+                return ICON_TIMES_CIRCLE;
             default:
                 return executionStatus.toString();
         }

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/ExecutionStatus.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/ExecutionStatus.java
@@ -4,5 +4,6 @@ public enum ExecutionStatus {
     SCENARIO_PENDING,
     SUCCESS,
     FAILED,
-    SOME_STEPS_PENDING;
+    ABORTED,
+    SOME_STEPS_PENDING
 }
diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/ReportStatistics.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/ReportStatistics.java
@@ -5,6 +5,7 @@ public class ReportStatistics {
     public int numScenarios;
     public int numFailedScenarios;
     public int numPendingScenarios;
+    public int numAbortedScenarios;
     public int numSuccessfulScenarios;
     public int numCases;
     public int numFailedCases;
@@ -23,6 +24,7 @@ private void addModifying( ReportStatistics statistics ) {
         this.numScenarios += statistics.numScenarios;
         this.numFailedScenarios += statistics.numFailedScenarios;
         this.numPendingScenarios += statistics.numPendingScenarios;
+        this.numAbortedScenarios += statistics.numAbortedScenarios;
         this.numSuccessfulScenarios += statistics.numSuccessfulScenarios;
         this.numCases += statistics.numCases;
         this.numFailedCases += statistics.numFailedCases;

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/StatisticsCalculator.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/StatisticsCalculator.java
@@ -29,6 +29,8 @@ public void visit( ScenarioModel scenarioModel ) {
                 statistics.numFailedScenarios += 1;
             } else if( executionStatus == ExecutionStatus.SCENARIO_PENDING || executionStatus == ExecutionStatus.SOME_STEPS_PENDING) {
                 statistics.numPendingScenarios += 1;
+            } else if (executionStatus == ExecutionStatus.ABORTED){
+                statistics.numAbortedScenarios += 1;
             } else {
                 statistics.numSuccessfulScenarios += 1;
             }

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/StepStatus.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/model/StepStatus.java
@@ -4,5 +4,6 @@ public enum StepStatus {
     PASSED,
     FAILED,
     SKIPPED,
-    PENDING;
+    PENDING,
+    ABORTED
 }
diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/text/PlainTextReportGenerator.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/text/PlainTextReportGenerator.java
@@ -10,19 +10,32 @@
 import com.tngtech.jgiven.report.AbstractReportGenerator;
 import com.tngtech.jgiven.report.model.ReportModel;
 import com.tngtech.jgiven.report.model.ReportModelFile;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class PlainTextReportGenerator extends AbstractReportGenerator {
 
+    private static final Logger log = LoggerFactory.getLogger( PlainTextReportGenerator.class );
+
     public AbstractReportConfig createReportConfig( String... args ) {
         return new PlainTextReportConfig(args);
     }
 
     public void generate() {
+        generateOutputDirectory();
         for( ReportModelFile reportModelFile : completeReportModel.getAllReportModels() ) {
             handleReportModel(reportModelFile.model(), reportModelFile.file());
         }
     }
 
+    private void generateOutputDirectory() {
+        var outputDir = config.getTargetDir();
+        if( !outputDir.exists()  && !outputDir.mkdirs()) {
+            log.error( "Could not create target directory " + outputDir);
+            return;
+        }
+    }
+
     public void handleReportModel( ReportModel model, File file ) {
         String targetFileName = Files.getNameWithoutExtension( file.getName() ) + ".feature";
         PrintWriter printWriter = PrintWriterUtil.getPrintWriter( new File( config.getTargetDir(), targetFileName ) );
@@ -33,4 +46,5 @@ public void handleReportModel( ReportModel model, File file ) {
             ResourceUtil.close( printWriter );
         }
     }
+
 }