[break] implemented configure abortedStepsShouldPass #755

Author: ptrthomas

README.md

@@ -1998,6 +1998,7 @@ You can adjust configuration settings for the HTTP client used by Karate using t
 `retry` | JSON | defaults to `{ count: 3, interval: 3000 }` - see [`retry until`](#retry-until)
 `outlineVariablesAuto` | boolean | defaults to `true`, whether each key-value pair in the `Scenario Outline` example-row is automatically injected into the context as a variable (and not just `__row`), see [`Scenario Outline` Enhancements](#scenario-outline-enhancements)
  `lowerCaseResponseHeaders` | boolean | Converts every key and value in the [`responseHeaders`](#responseheaders) to lower-case which makes it easier to validate for e.g. using [`match header`](#match-header) (default `false`) [(example)](karate-demo/src/test/java/demo/headers/content-type.feature).
+ `abortedStepsShouldPass` | boolean | defaults to `false`, whether steps after a [`karate.abort()`](#karate-abort) should be marked as `PASSED` instead of `SKIPPED` - this can impact the behavior of 3rd-party reports, see [this issue](https://github.com/intuit/karate/issues/755) for details
 `logModifier` | Java Object | See [Log Masking](#log-masking)
 `httpClientClass` | string | See [`karate-mock-servlet`](karate-mock-servlet)
 `httpClientInstance` | Java Object | See [`karate-mock-servlet`](karate-mock-servlet)
@@ -3150,7 +3151,7 @@ A JavaScript function or [Karate expression](#karate-expressions) at runtime has
 
 Operation | Description
 --------- | -----------
-<a name="karate-abort"><code>karate.abort()</code></a> | you can prematurely exit a `Scenario` by combining this with [conditional logic](#conditional-logic) like so: `* if (condition) karate.abort()` - please use [sparingly](https://martinfowler.com/articles/nonDeterminism.html) !
+<a name="karate-abort"><code>karate.abort()</code></a> | you can prematurely exit a `Scenario` by combining this with [conditional logic](#conditional-logic) like so: `* if (condition) karate.abort()` - please use [sparingly](https://martinfowler.com/articles/nonDeterminism.html) ! and also see [`configure abortedStepsShouldPass`](#configure)
 <a name="karate-append"><code>karate.append(... items)</code></a> | useful to create lists out of items (which can be lists as well), see [JSON transforms](#json-transforms)
 <a name="karate-appendto"><code>karate.appendTo(name, ... items)</code></a> | useful to append to a list-like variable (that has to exist) in scope, see [JSON transforms](#json-transforms)
 <a name="karate-call"><code>karate.call(fileName, [arg])</code></a> | invoke a [`*.feature` file](#calling-other-feature-files) or a [JavaScript function](#calling-javascript-functions) the same way that [`call`](#call) works (with an optional solitary argument)

karate-core/src/main/java/com/intuit/karate/Config.java

@@ -38,7 +38,7 @@
 public class Config {
 
     public static final int DEFAULT_RETRY_INTERVAL = 3000;
-    public static final int DEFAULT_RETRY_COUNT = 3;    
+    public static final int DEFAULT_RETRY_COUNT = 3;
 
     private boolean sslEnabled = false;
     private String sslAlgorithm = "TLS";
@@ -67,6 +67,7 @@ public class Config {
     private boolean logPrettyResponse;
     private boolean printEnabled = true;
     private boolean outlineVariablesAuto = true;
+    private boolean abortedStepsShouldPass = false;
     private String clientClass;
     private HttpClient clientInstance;
     private Map<String, Object> userDefined;
@@ -87,7 +88,7 @@ public class Config {
     public Config() {
         // zero arg constructor
     }
-    
+
     private static <T> T get(Map<String, Object> map, String key, T defaultValue) {
         Object o = map.get(key);
         return o == null ? defaultValue : (T) o;
@@ -158,18 +159,21 @@ public boolean configure(String key, ScriptValue value) { // TODO use enum
                 if (value.isMapLike()) {
                     Map<String, Object> map = value.getAsMap();
                     retryInterval = get(map, "interval", retryInterval);
-                    retryCount = get(map, "count", retryCount);                    
+                    retryCount = get(map, "count", retryCount);
                 }
                 return false;
             case "outlineVariablesAuto":
                 outlineVariablesAuto = value.isBooleanTrue();
                 return false;
+            case "abortedStepsShouldPass":
+                abortedStepsShouldPass = value.isBooleanTrue();
+                return false;
             // here on the http client has to be re-constructed ================
             case "httpClientClass":
                 clientClass = value.getAsString();
                 return true;
             case "logModifier":
-                logModifier = value.getValue(HttpLogModifier.class);               
+                logModifier = value.getValue(HttpLogModifier.class);
                 return true;
             case "httpClientInstance":
                 clientInstance = value.getValue(HttpClient.class);
@@ -271,16 +275,17 @@ public Config(Config parent) {
         retryInterval = parent.retryInterval;
         retryCount = parent.retryCount;
         outlineVariablesAuto = parent.outlineVariablesAuto;
+        abortedStepsShouldPass = parent.abortedStepsShouldPass;
         logModifier = parent.logModifier;
     }
-        
+
     public void setCookies(ScriptValue cookies) {
         this.cookies = cookies;
-    }   
-    
+    }
+
     public void setClientClass(String clientClass) {
         this.clientClass = clientClass;
-    }    
+    }
 
     //==========================================================================
     //
@@ -354,8 +359,8 @@ public List<String> getNonProxyHosts() {
 
     public String getLocalAddress() {
         return localAddress;
-    }        
-    
+    }
+
     public ScriptValue getHeaders() {
         return headers;
     }
@@ -458,18 +463,22 @@ public void setRetryCount(int retryCount) {
 
     public boolean isOutlineVariablesAuto() {
         return outlineVariablesAuto;
-    } 
+    }
+
+    public boolean isAbortedStepsShouldPass() {
+        return abortedStepsShouldPass;
+    }
 
     public Target getDriverTarget() {
         return driverTarget;
     }
 
     public void setDriverTarget(Target driverTarget) {
         this.driverTarget = driverTarget;
-    }        
+    }
 
     public HttpLogModifier getLogModifier() {
         return logModifier;
-    }        
+    }
 
 }

karate-core/src/main/java/com/intuit/karate/core/ScenarioExecutionUnit.java

@@ -206,7 +206,13 @@ public StepResult execute(Step step) {
         }
         boolean hidden = step.isPrefixStar() && !step.isPrint() && !actions.context.getConfig().isShowAllSteps();
         if (stopped) {
-            StepResult sr = new StepResult(step, aborted ? Result.passed(0) : Result.skipped(), null, null, null);
+            Result result;
+            if (aborted && actions.context.getConfig().isAbortedStepsShouldPass()) {
+                result = Result.passed(0);
+            } else {
+                result = Result.skipped();
+            }
+            StepResult sr = new StepResult(step, result, null, null, null);
             sr.setHidden(hidden);
             return afterStep(sr);
         } else {

karate-core/src/test/java/com/intuit/karate/core/FeatureResultTest.java

@@ -82,15 +82,16 @@ public void testFailureMultiScenarioFeature() throws Exception {
     public void testAbortMultiScenarioFeature() throws Exception {        
         FeatureResult result = result("aborted.feature");
         assertEquals(0, result.getFailedCount());
-        assertEquals(3, result.getScenarioCount());
+        assertEquals(4, result.getScenarioCount());
         String contents = xml(result);
 
         // skip-pass and skip-fail both should have all steps as skipped
         // TODO: generate the expected content string, below code puts a hard dependency
         // with KarateJunitFormatter$TestCase.addStepAndResultListing()
         assertTrue(contents.contains("* karate.abort() .......................................................... passed"));
-        assertTrue(contents.contains("* assert a == 1 ........................................................... passed"));
-        assertTrue(contents.contains("* assert a == 2 ........................................................... passed"));
+        assertTrue(contents.contains("* assert a == 1 ........................................................... skipped"));
+        assertTrue(contents.contains("* assert a == 2 ........................................................... skipped"));
+        assertTrue(contents.contains("* assert a == 5 ........................................................... passed"));
 
         // noskip should have both steps as passed
         assertTrue(contents.contains("Then assert a != 3 ........................................................ passed"));

karate-core/src/test/java/com/intuit/karate/core/aborted.feature

@@ -14,3 +14,8 @@ Scenario: skip-fail
 Scenario: noskip
 Then assert a != 3
 And assert a != 4
+
+Scenario: skip-pass-config
+* configure abortedStepsShouldPass = true
+* karate.abort()
+* assert a == 5

karate-demo/src/test/java/demo/abort/abort.feature

@@ -3,6 +3,7 @@ Feature: abort should skip (but not fail) a test
 Scenario: you can conditionally exit a test
     but please use sparingly
 
+  * configure abortedStepsShouldPass = true
   * print 'before'
   * if (true) karate.abort()
   * print 'after'