new setup hook working with build passing #1905

remaining - include the extra scenario in reports
documentation, and the support for multiple named setup scenarios in a feature

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

@@ -762,6 +762,7 @@ public Object setup() {
         Feature feature = engine.runtime.featureRuntime.feature;
         Scenario scenario = feature.getSetup();
         ScenarioRuntime sr = new ScenarioRuntime(engine.runtime.featureRuntime, scenario);
+        sr.setSkipBackground(true);
         sr.run();        
         return JsValue.fromJava(sr.engine.getAllVariablesAsMap());        
     }

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

@@ -31,6 +31,7 @@
 import java.util.function.Consumer;
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
+import org.slf4j.Logger;
 
 /**
  *
@@ -88,6 +89,7 @@ public boolean tryAdvance(Consumer<? super ScenarioRuntime> action) {
             }
         }
         if (currentScenario.isDynamic()) {
+            Logger logger = FeatureRuntime.logger;
             if (expressionValue == null) {
                 String expression = currentScenario.getDynamicExpression();
                 dynamicRuntime = new ScenarioRuntime(featureRuntime, currentScenario);
@@ -103,6 +105,7 @@ public boolean tryAdvance(Consumer<? super ScenarioRuntime> action) {
                     }
                 } catch (Exception e) {
                     String message = "dynamic expression evaluation failed: " + expression;
+                    logger.error("{} - {}", currentScenario, message);
                     dynamicRuntime.result.addFakeStepResult(message, e);
                     currentScenario = null;
                     action.accept(dynamicRuntime);
@@ -120,6 +123,7 @@ public boolean tryAdvance(Consumer<? super ScenarioRuntime> action) {
                     rowValue = dynamicRuntime.engine.executeFunction(expressionValue, rowIndex);
                 } catch (Exception e) {
                     String message = "dynamic function expression evaluation failed at index " + rowIndex + ": " + e.getMessage();
+                    logger.error("{} - {}", currentScenario, message);
                     dynamicRuntime.result.addFakeStepResult(message, e);
                     currentScenario = null;
                     action.accept(dynamicRuntime);

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

@@ -60,7 +60,8 @@ public class ScenarioRuntime implements Runnable {
     public final boolean dryRun;
     public final LogAppender logAppender;
 
-    public boolean ignoringFailureSteps;
+    private boolean skipBackground; 
+    private boolean ignoringFailureSteps;
 
     public ScenarioRuntime(FeatureRuntime featureRuntime, Scenario scenario) {
         logger = new Logger();
@@ -127,10 +128,6 @@ public boolean isFailed() {
         return error != null || result.isFailed();
     }
 
-    public boolean isIgnoringFailureSteps() {
-        return ignoringFailureSteps;
-    }
-
     public Step getCurrentStep() {
         return currentStep;
     }
@@ -139,6 +136,10 @@ public boolean isStopped() {
         return stopped;
     }
 
+    public void setSkipBackground(boolean skipBackground) {
+        this.skipBackground = skipBackground;
+    }    
+
     public String getEmbedFileName(ResourceType resourceType) {
         String extension = resourceType == null ? null : resourceType.getExtension();
         return scenario.getUniqueId() + "_" + System.currentTimeMillis() + (extension == null ? "" : "." + extension);
@@ -338,8 +339,8 @@ private static boolean isSelectedForExecution(FeatureRuntime fr, Scenario scenar
 
     //==========================================================================
     //
-    public void beforeRun() {
-        steps = scenario.getStepsIncludingBackground();
+    public void beforeRun() {        
+        steps = skipBackground ? scenario.getSteps() : scenario.getStepsIncludingBackground();
         ScenarioEngine.set(engine);
         engine.init();
         result.setExecutorName(Thread.currentThread().getName());
@@ -449,7 +450,7 @@ public StepResult execute(Step step) {
         if (currentStepResult.isErrorIgnored()) {
             engine.setFailedReason(null);
         }
-        if (!engine.isIgnoringStepErrors() && isIgnoringFailureSteps()) {
+        if (!engine.isIgnoringStepErrors() && ignoringFailureSteps) {
             if (engine.getConfig().isContinueAfterContinueOnStepFailure()) {
                 // continue execution and reset failed reason for engine to null
                 engine.setFailedReason(null);

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

@@ -36,6 +36,7 @@ public class Tag {
     public static final String IGNORE = "ignore";
     public static final String ENV = "env";
     public static final String ENVNOT = "envnot";
+    public static final String SETUP = "setup";
 
     private final int line;
     private final String text;

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

@@ -135,6 +135,9 @@ public boolean evaluate(String tagSelector, String karateEnv) {
         if (StringUtils.containsIgnoreCase(tags, Tag.IGNORE)) {
             return false;
         }
+        if (tagValues.containsKey(Tag.SETUP)) {
+            return false;
+        }
         Values envValues = valuesFor(Tag.ENV);
         if (envValues.isPresent) {
             if (karateEnv == null) {

karate-core/src/test/java/com/intuit/karate/core/jsread/js-read-2.feature

@@ -1,29 +1,19 @@
 Feature:
 
-Background:
-    * def anotherVariable = 'hello'
+@setup
+Scenario:
     * def data = [{ name: 'one' }, { name: 'two' }]
 
 Scenario Outline:
     * match name == "#present"
-    * match anotherVariable == "hello"
 
 Examples:
-    | data |
+    | karate.setup().data |
 
 Scenario Outline:
     * match name == "#present"
-    * match anotherVariable == "hello"
-
-Examples:
-    | name |
-    | test |
-
-Scenario Outline:
-    * match name == "#present"
-    * match anotherVariable == "hello"
     * def params = { 'foo': 'bar' }
     * call read('js-read-called-2.feature') params
 
 Examples:
-    | data |
+    | karate.setup().data |

karate-core/src/test/java/com/intuit/karate/core/jsread/js-read-3.feature

@@ -1,44 +1,12 @@
 Feature:
 
-Background:
-    * def anotherVariable = 'hello'
+@setup
+Scenario:
     * def x = read('js-read-3.json')
     * def data = x.thirderror
-    * def backgroundVar =
-    """
-        {"foo": '#(data)' }
-    """
 
 Scenario Outline:
-    * match backgroundVar == { "foo": "#(data)" }
-    * match id == "#present"
-    * match anotherVariable == "hello"
+    * match id == '#number'
 
 Examples:
-    | data |
-
-Scenario Outline:
-    * def param =
-    """
-        { bar: '#(backgroundVar)'}
-    """
-    * match param == { bar: '#(backgroundVar)'}
-    * match id == "#present"
-    * match anotherVariable == "hello"
-
-Examples:
-    | data |
-
-
-Scenario Outline:
-    * def params =
-    """
-        { backgroundVar: '#(backgroundVar)'}
-    """
-    * print params
-    * match id == "#present"
-    * match anotherVariable == "hello"
-    * call read('js-read-called-2.feature') params
-
-Examples:
-    | data |
+    | karate.setup().data |

karate-core/src/test/java/com/intuit/karate/core/jsread/js-read-called-2.feature

@@ -1,10 +1,7 @@
 Feature:
 
 Background:
-    #* call read('js-read-3.json')
     * call read('../utils-reuse-common.feature')
 
 Scenario:
-    * print 'arg: ' + __arg
-    * match __arg == "#present"
-    * match __arg == "#notnull"
+    * match __arg == { foo: 'bar' }

karate-core/src/test/java/com/intuit/karate/core/outline-background.feature

@@ -1,21 +1,15 @@
 Feature:
 
-Background:
-    * def foo = 'hello'
-    * def fun = function(){ return 'bar' }
-    * configure driver = { type: "noopdriver" }
-    * driver 'http://google.com'
-    * table data
-        | name  | extra        |
-        | 'one' |              |
-        | 'two' | configSource |
+@setup
+Scenario:
+* table data
+    | name  | extra        |
+    | 'one' |              |
+    | 'two' | configSource |
 
 Scenario Outline:
-    * assert name == 'one' || name == 'two'
-    * assert name == 'two' ? extra == 'normal' : true
-    * match foo == "hello"
-    * match fun() == 'bar'
-    * click("#testing.usage.driver.method")
+* assert name == 'one' || name == 'two'
+* assert name == 'two' ? extra == 'normal' : true
 
 Examples:
-    | data |
+| karate.setup().data |

karate-core/src/test/java/com/intuit/karate/core/outline-config-js.feature

@@ -1,10 +1,11 @@
-Feature: function from global config
+Feature:
 
-Background:
- * def data = [ { name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' } ]
+@setup
+Scenario:
+ * def data = [{ name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' }]
 
 Scenario Outline:
 * print 'name:', name
 
   Examples:
-| data |
+| karate.setup().data |

karate-core/src/test/java/com/intuit/karate/core/outline-dynamic.feature

@@ -1,7 +1,11 @@
 Feature:
 
-@ignore @setup
+Background:
+* print 'in background', __num
+
+@setup
 Scenario:
+* print 'in setup'
 * def data = [{a:1}, {a:2}]
 
 Scenario Outline:

karate-core/src/test/java/com/intuit/karate/core/outline-generator.feature

@@ -1,11 +1,12 @@
 Feature:
 
-Background:
+@setup
+Scenario:
 * def generator = function(i){ if (i == 5) return null; return { name: 'cat' + i, age: i } }
 
 Scenario Outline:
 * match __num == age
 * match __row.name == 'cat' + age
 
 Examples:
-| generator |
+| karate.setup().generator |

karate-core/src/test/java/com/intuit/karate/core/parallel/parallel-csv.feature

@@ -1,26 +1,25 @@
 Feature:
 
-Background:
-* def isNot = function(x) { return function(row) { return row.id != x } }
-* callonce read('call-once-from-feature.feature')
+@setup
+Scenario:
+* def data = read('data.csv')
+* def exclude = x => data.filter(y => y.id != x)
+* def include = x => data.filter(y => y.id == x)
 
 Scenario Outline:
-* call read('called.feature')
 * assert id != '0'
 
 Examples:
-| karate.filter(read('data.csv'), isNot('0')) |
+| karate.setup().data.filter(x => x.id != '0') |
 
 Scenario Outline:
-* call read('called.feature')
 * assert id != '1'
 
 Examples:
-| karate.filter(read('data.csv'), isNot('1')) |
+| karate.setup().exclude('1') |
 
 Scenario Outline:
-* call read('called.feature')
-* assert id != '2'
+* assert id == '2'
 
 Examples:
-| karate.filter(read('data.csv'), isNot('2')) |
+| karate.setup().include('2') |

karate-core/src/test/java/com/intuit/karate/core/parallel/parallel-outline-1.feature

@@ -1,10 +1,8 @@
-@trigger-by-tag
 Feature:
 
 Background:
  # background http builder should work even for a dynamic scenario outline
- * url serverUrl
- * def data = [ { name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' } ]
+ * url serverUrl 
  # java object that comes from a callSingle in the config
  * def HelloBg = HelloConfigSingle
  * callonce read('call-once-from-feature.feature')
@@ -23,6 +21,10 @@ Background:
     }
   """
 
+@setup
+Scenario:
+* def data = [ { name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' } ]
+
 Scenario Outline:
  * call read('called.feature')
  * match functionFromKarateBase() == 'fromKarateBase'
@@ -31,13 +33,12 @@ Scenario Outline:
  * status 200
  * match response == { message: 'from feature' }
 
-
  * match HelloBg.sayHello('world') == 'hello world'
  * match HelloOnce.sayHello('world') == 'hello world'
  * match sayHello('world') == 'hello world'
 
  Examples:
-  | data |
+  | karate.setup().data |
 
 Scenario Outline: validating background http context set in background will be shared in shared scope, with dynamic scenario outline
  * call read('called.feature')
@@ -51,4 +52,4 @@ Scenario Outline: validating background http context set in background will be s
  * match sayHello('world') == 'hello world'
 
  Examples:
-  | data |
+  | karate.setup().data |

karate-core/src/test/java/com/intuit/karate/core/parallel/parallel-outline-2.feature

@@ -1,10 +1,11 @@
 Feature:
 
-Background:
-  * def data = [ { name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' } ]
+@setup
+Scenario:
+  * def data = [{ name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' }]
 
 Scenario Outline:
   * match functionFromKarateBase() == 'fromKarateBase'
 
 Examples:
-  | data |
+  | karate.setup().data |

karate-core/src/test/java/com/intuit/karate/core/parasimple/parallel-outline-simple.feature

@@ -1,8 +1,11 @@
 Feature:
 
 Background:
- * def data = [{ name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' }]
- * call read('headers.feature')
+* call read('headers.feature')
+
+@setup
+Scenario:
+ * def data = [{ name: 'value1' }, { name: 'value2' }, { name: 'value3' }, { name: 'value4' }] 
 
 Scenario Outline:
  * url 'http://localhost:' + karate.properties['server.port']
@@ -12,5 +15,5 @@ Scenario Outline:
  * match response == { message: 'from feature' }
 
  Examples:
-  | data |
+  | karate.setup().data |