Remote: Add remoteCacheable key to execution log

coeuvre · copybara-github · commit 0c07c2e6571d · 2021-06-08T00:17:17.000-07:00
Fixes #13495. Closes #13551. PiperOrigin-RevId: 378090621
diff --git a/src/main/java/com/google/devtools/build/lib/exec/SpawnLogContext.java b/src/main/java/com/google/devtools/build/lib/exec/SpawnLogContext.java
@@ -138,6 +138,7 @@ public void logSpawn(
       builder.setTimeoutMillis(timeout.toMillis());
     }
     builder.setCacheable(Spawns.mayBeCached(spawn));
+    builder.setRemoteCacheable(Spawns.mayBeCachedRemotely(spawn));
     builder.setExitCode(result.exitCode());
     builder.setRemoteCacheHit(result.isCacheHit());
     builder.setRunner(result.getRunnerName());
diff --git a/src/main/protobuf/spawn.proto b/src/main/protobuf/spawn.proto
@@ -123,4 +123,7 @@ message SpawnExec {
   // Its semantics varies greatly depending on the status field.
   // Dependable: if status is empty, exit_code is guaranteed to be zero.
   int32 exit_code = 15;
+
+  // Was the Spawn result allowed to be cached remotely.
+  bool remote_cacheable = 16;
 }
diff --git a/src/test/java/com/google/devtools/build/lib/exec/AbstractSpawnStrategyTest.java b/src/test/java/com/google/devtools/build/lib/exec/AbstractSpawnStrategyTest.java
@@ -360,6 +360,7 @@ public void testLogSpawn() throws Exception {
             .setExitCode(23)
             .setRemotable(true)
             .setCacheable(true)
+            .setRemoteCacheable(true)
             .setProgressMessage("my progress message")
             .setMnemonic("MyMnemonic")
             .setRunner("runner")
@@ -486,6 +487,7 @@ private static SpawnExec.Builder defaultSpawnExecBuilder(String cmd) {
         .setMnemonic("Mnemonic")
         .setRunner("runner")
         .setStatus("NON_ZERO_EXIT")
-        .setExitCode(23);
+        .setExitCode(23)
+        .setRemoteCacheable(true);
   }
 }
diff --git a/src/test/shell/bazel/bazel_execlog_test.sh b/src/test/shell/bazel/bazel_execlog_test.sh
@@ -188,4 +188,17 @@ EOF
   grep "listedOutputs" output.json || fail "log does not contain listed outputs"
 }
 
+function test_no_remote_cache() {
+  cat > BUILD <<'EOF'
+genrule(
+      name = "action",
+      outs = ["out.txt"],
+      cmd = "echo hello > $(location out.txt)",
+      tags = ["no-remote-cache"],
+)
+EOF
+  bazel build //:action --execution_log_json_file=output.json 2>&1 >> $TEST_log || fail "could not build"
+  grep "\"remoteCacheable\": false" output.json || fail "log does not contain valid remoteCacheable entry"
+}
+
 run_suite "execlog_tests"

Original file line number	Diff line number	Diff line change
`@@ -138,6 +138,7 @@ public void logSpawn(`
`138`	`138`	`builder.setTimeoutMillis(timeout.toMillis());`
`139`	`139`	`}`
`140`	`140`	`builder.setCacheable(Spawns.mayBeCached(spawn));`
	`141`	`+ builder.setRemoteCacheable(Spawns.mayBeCachedRemotely(spawn));`
`141`	`142`	`builder.setExitCode(result.exitCode());`
`142`	`143`	`builder.setRemoteCacheHit(result.isCacheHit());`
`143`	`144`	`builder.setRunner(result.getRunnerName());`
Original file line number	Diff line number	Diff line change
`@@ -123,4 +123,7 @@ message SpawnExec {`
`123`	`123`	`// Its semantics varies greatly depending on the status field.`
`124`	`124`	`// Dependable: if status is empty, exit_code is guaranteed to be zero.`
`125`	`125`	`int32 exit_code = 15;`
	`126`	`+`
	`127`	`+ // Was the Spawn result allowed to be cached remotely.`
	`128`	`+ bool remote_cacheable = 16;`
`126`	`129`	`}`