commit fc040ce6eec07e3b2722ba94b504272be5ace202
author ulfjack <ulfjack@google.com> Mon Jul 24 10:42:20 2017 +0200
committer Jakob Buchgraber <buchgr@google.com> Mon Jul 24 13:18:49 2017 +0200
tree a036de458fc51af993efa8e3be9255e369b1a2e4
parent b8205c89767f5cdcc639d72fe36c243a1742001c

SpawnResult: allow signaling catastrophic errors, and compute detail message

PiperOrigin-RevId: 162906926

src/main/java/com/google/devtools/build/lib/exec/SpawnResult.java

diff --git a/src/main/java/com/google/devtools/build/lib/exec/SpawnResult.java b/src/main/java/com/google/devtools/build/lib/exec/SpawnResult.java
index 30e8c84..b3a0383 100644
--- a/src/main/java/com/google/devtools/build/lib/exec/SpawnResult.java
+++ b/src/main/java/com/google/devtools/build/lib/exec/SpawnResult.java
@@ -16,6 +16,8 @@
 import com.google.common.base.Preconditions;
 import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
 import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
+import com.google.devtools.build.lib.shell.TerminationStatus;
+import java.util.Locale;
 import javax.annotation.Nullable;
 
 /**
@@ -125,6 +127,8 @@
    */
   boolean setupSuccess();
 
+  boolean isCatastrophe();
+
   /** The status of the attempted Spawn execution. */
   Status status();
 
@@ -146,6 +150,9 @@
   /** Whether the spawn result was a cache hit. */
   boolean isCacheHit();
 
+  String getDetailMessage(
+      String messagePrefix, String message, boolean catastrophe, boolean forciblyRunRemotely);
+
   /**
    * Basic implementation of {@link SpawnResult}.
    */
@@ -171,6 +178,11 @@
     }
 
     @Override
+    public boolean isCatastrophe() {
+      return false;
+    }
+
+    @Override
     public int exitCode() {
       return exitCode;
     }
@@ -194,6 +206,34 @@
     public boolean isCacheHit() {
       return cacheHit;
     }
+
+    @Override
+    public String getDetailMessage(
+        String messagePrefix, String message, boolean catastrophe, boolean forciblyRunRemotely) {
+      TerminationStatus status = new TerminationStatus(
+          exitCode(), status() == Status.TIMEOUT);
+      String reason = " (" + status.toShortString() + ")"; // e.g " (Exit 1)"
+      String explanation = status.exited() ? "" : ": " + message;
+
+      if (!status().isConsideredUserError()) {
+        String errorDetail = status().name().toLowerCase(Locale.US)
+            .replace('_', ' ');
+        explanation += ". Note: Remote connection/protocol failed with: " + errorDetail;
+      }
+      if (status() == Status.TIMEOUT) {
+        explanation +=
+            String.format(
+                " (failed due to timeout after %.2f seconds.)",
+                getWallTimeMillis() / 1000.0f);
+      } else if (status() == Status.OUT_OF_MEMORY) {
+        explanation += " (Remote action was terminated due to Out of Memory.)";
+      }
+      if (status() != Status.TIMEOUT && forciblyRunRemotely) {
+        explanation += " Action tagged as local was forcibly run remotely and failed - it's "
+            + "possible that the action simply doesn't work remotely";
+      }
+      return messagePrefix + " failed" + reason + explanation;
+    }
   }
 
   /**