commit 10cb390ce718bda9c2956a16c12d80aef5efd1cd
author mschaller <mschaller@google.com> Tue May 26 11:27:14 2020 -0700
committer Copybara-Service <copybara-worker@google.com> Tue May 26 11:28:54 2020 -0700
tree 8ae250b29f515bc5080c48bdcae28725b1ef6f9b
parent c45aaa91b64b3777ebe372ec3a37b20552747ed9

Encode RunCommand runfiles setup failures with FailureDetails

RELNOTES: None.
PiperOrigin-RevId: 313233026

src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java

diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java
index aab9fb1..54d6575 100644
--- a/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java
+++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java
@@ -76,7 +76,6 @@
 import com.google.devtools.build.lib.shell.ShellUtils;
 import com.google.devtools.build.lib.util.CommandDescriptionForm;
 import com.google.devtools.build.lib.util.CommandFailureUtils;
-import com.google.devtools.build.lib.util.ExitCode;
 import com.google.devtools.build.lib.util.FileType;
 import com.google.devtools.build.lib.util.InterruptedFailureDetails;
 import com.google.devtools.build.lib.util.OS;
@@ -377,10 +376,9 @@
         runfilesDir = ensureRunfilesBuilt(env, runfilesSupport,
             env.getSkyframeExecutor().getConfiguration(env.getReporter(),
                 targetToRun.getConfigurationKey()));
-      } catch (EnvironmentalExecException e) {
-        // TODO(138456686): Handle failures with higher resolution
-        env.getReporter().handle(Event.error("Error creating runfiles: " + e.getMessage()));
-        return BlazeCommandResult.exitCode(ExitCode.LOCAL_ENVIRONMENTAL_ERROR);
+      } catch (RunfilesException e) {
+        env.getReporter().handle(Event.error(e.getMessage()));
+        return BlazeCommandResult.failureDetail(e.createFailureDetail());
       }
     }
 
@@ -569,7 +567,7 @@
    */
   private static Path ensureRunfilesBuilt(
       CommandEnvironment env, RunfilesSupport runfilesSupport, BuildConfiguration configuration)
-      throws EnvironmentalExecException {
+      throws RunfilesException {
     Artifact manifest = Preconditions.checkNotNull(runfilesSupport.getRunfilesManifest());
     PathFragment runfilesDir = runfilesSupport.getRunfilesDirectoryExecPath();
     Path workingDir = env.getExecRoot().getRelative(runfilesDir);
@@ -589,7 +587,10 @@
           .getRelative(runfilesSupport.getWorkspaceName())
           .createDirectoryAndParents();
     } catch (IOException e) {
-      throw new EnvironmentalExecException(e);
+      throw new RunfilesException(
+          "Failed to create runfiles directories: " + e.getMessage(),
+          Code.RUNFILES_DIRECTORIES_CREATION_FAILURE,
+          e);
     }
 
     // When runfiles are not generated, getManifest() returns the
@@ -603,9 +604,18 @@
         manifest.getPath(),
         runfilesSupport.getRunfilesDirectory(),
         false);
-    helper.createSymlinksUsingCommand(
-        env.getExecRoot(), env.getBlazeWorkspace().getBinTools(),
-        /* shellEnvironment= */ ImmutableMap.of(), /* outErr= */ null);
+    try {
+      helper.createSymlinksUsingCommand(
+          env.getExecRoot(),
+          env.getBlazeWorkspace().getBinTools(),
+          /* shellEnvironment= */ ImmutableMap.of(),
+          /* outErr= */ null);
+    } catch (EnvironmentalExecException e) {
+      throw new RunfilesException(
+          "Failed to create runfiles symlinks: " + e.getMessage(),
+          Code.RUNFILES_SYMLINKS_CREATION_FAILURE,
+          e);
+    }
     return workingDir;
   }
 
@@ -807,4 +817,20 @@
         Joiner.on(", ").join(ImmutableSortedSet.copyOf(targetNamesToIncludeInErrorMessage)),
         truncateTargetNameList ? "[TRUNCATED]" : "");
   }
+
+  private static class RunfilesException extends Exception {
+    private final FailureDetails.RunCommand.Code detailedCode;
+
+    private RunfilesException(String message, Code detailedCode, Exception cause) {
+      super("Error creating runfiles: " + message, cause);
+      this.detailedCode = detailedCode;
+    }
+
+    private FailureDetail createFailureDetail() {
+      return FailureDetail.newBuilder()
+          .setMessage(getMessage())
+          .setRunCommand(FailureDetails.RunCommand.newBuilder().setCode(detailedCode))
+          .build();
+    }
+  }
 }

src/main/protobuf/failure_details.proto

diff --git a/src/main/protobuf/failure_details.proto b/src/main/protobuf/failure_details.proto
index 86bc0bd..58d3332 100644
--- a/src/main/protobuf/failure_details.proto
+++ b/src/main/protobuf/failure_details.proto
@@ -732,6 +732,8 @@
     COMMAND_LINE_EXPANSION_FAILURE = 10 [(metadata) = { exit_code: 36 }];
     NO_SHELL_SPECIFIED = 11 [(metadata) = { exit_code: 2 }];
     SCRIPT_WRITE_FAILURE = 12 [(metadata) = { exit_code: 6 }];
+    RUNFILES_DIRECTORIES_CREATION_FAILURE = 13 [(metadata) = { exit_code: 36 }];
+    RUNFILES_SYMLINKS_CREATION_FAILURE = 14 [(metadata) = { exit_code: 36 }];
   }
 
   Code code = 1;