Merge pull request #2493 from codehackerr/develop

2499: Improve auto-screenshot on error in report
karatelabs · Feb 2, 2024 · ccd7ee9 · ccd7ee9
2 parents fcc1ad3 + 481cead
commit ccd7ee9
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 9 deletions.
diff --git a/karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java b/karate-core/src/main/java/com/intuit/karate/core/ScenarioRuntime.java
@@ -160,7 +160,7 @@ public String getEmbedFileName(ResourceType resourceType) {
         return scenario.getUniqueId() + "_" + System.currentTimeMillis() + (extension == null ? "" : "." + extension);
     }
 
-    public Embed saveToFileAndCreateEmbed(byte[] bytes, ResourceType resourceType) {
+    private Embed saveToFileAndCreateEmbed(byte[] bytes, ResourceType resourceType) {
         File file = new File(featureRuntime.suite.reportDir + File.separator + getEmbedFileName(resourceType));
         FileUtils.writeToFile(file, bytes);
         return new Embed(file, resourceType);
@@ -465,6 +465,12 @@ public StepResult execute(Step step) {
                 error = stepResult.getError();
                 logError(error.getMessage());
             }
+            if (engine.driver != null) {
+                engine.driver.onFailure(currentStepResult);
+            }
+            if (engine.robot != null) {
+                engine.robot.onFailure(currentStepResult);
+            }
         } else {
             boolean hidden = reportDisabled || (step.isPrefixStar() && !step.isPrint() && !engine.getConfig().isShowAllSteps());
             currentStepResult.setHidden(hidden);
@@ -484,14 +490,6 @@ public StepResult execute(Step step) {
                 stopped = true;
             }
         }
-        if (stepResult.isFailed()) {
-            if (engine.driver != null) {
-                engine.driver.onFailure(currentStepResult);
-            }
-            if (engine.robot != null) {
-                engine.robot.onFailure(currentStepResult);
-            }
-        }
         if (executed && !dryRun) {
             featureRuntime.suite.hooks.forEach(h -> h.afterStep(currentStepResult, this));
         }

diff --git a/karate-junit5/src/test/java/karate/SampleTest.java b/karate-junit5/src/test/java/karate/SampleTest.java
@@ -3,6 +3,11 @@
 import com.intuit.karate.junit5.Karate;
 
 class SampleTest {
+    @Karate.Test
+    // Uncomment @ignore on embed.feature for development verification
+    Karate testScreenshotIsEmbeddedOnTheCorrectStepOnFailure() {
+        return Karate.run("embed").relativeTo(getClass());
+    }
 
     @Karate.Test
     Karate testSample() {

diff --git a/karate-junit5/src/test/java/karate/embed.feature b/karate-junit5/src/test/java/karate/embed.feature
@@ -0,0 +1,22 @@
+Feature: browser automation demo
+
+  Background:
+    * configure driver = { type: 'chrome' }
+  @ignore
+  Scenario: try to login to github and then do a google search
+    Simulates step failure for testing embedded screenshots. Remove @ignore for developement
+
+    Given driver 'https://github.com/login'
+    And input('#login_field', 'YYY')
+    And input('#password', 'world')
+    When submit().click("input[name=commit]")
+    Then match html('.flash-error') contains 'Bad username or password.'
+
+    Given driver 'https://google.com'
+    # And click('{}Accept all')
+    And input("[name=q][name=q]", 'karate dsl')
+    When submit().click("input[name=btnI]")
+    Then waitForUrl('https://github.com/karatelabs/karate')
+
+   Scenario: Dummy not to fail build
+    * print 'dummy'