Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[6.4.0] Add the remote_require_cached flag #19075

Merged
merged 1 commit into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,22 @@ public SpawnResult exec(Spawn spawn, SpawnExecutionContext context)
return execLocallyAndUploadOrFail(action, spawn, context, uploadLocalResults, e);
}

if (remoteOptions.remoteRequireCached) {
return new SpawnResult.Builder()
.setStatus(SpawnResult.Status.EXECUTION_DENIED)
.setExitCode(1)
.setFailureMessage(
"Action must be cached due to --experimental_remote_require_cached but it is not")
.setFailureDetail(
FailureDetail.newBuilder()
.setSpawn(
FailureDetails.Spawn.newBuilder()
.setCode(FailureDetails.Spawn.Code.EXECUTION_DENIED))
.build())
.setRunnerName("remote")
.build();
}

AtomicBoolean useCachedResult = new AtomicBoolean(acceptCachedResult);
AtomicBoolean forceUploadInput = new AtomicBoolean(false);
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,18 @@ public String getTypeDescription() {
help = "Whether to accept remotely cached action results.")
public boolean remoteAcceptCached;

@Option(
name = "experimental_remote_require_cached",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.REMOTE,
effectTags = {OptionEffectTag.UNKNOWN},
help =
"If set to true, enforce that all actions that can run remotely are cached, or else "
+ "fail the build. This is useful to troubleshoot non-determinism issues as it "
+ "allows checking whether actions that should be cached are actually cached "
+ "without spuriously injecting new results into the cache.")
public boolean remoteRequireCached;

@Option(
name = "remote_local_fallback",
defaultValue = "false",
Expand Down
30 changes: 30 additions & 0 deletions src/test/shell/bazel/remote/remote_execution_test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -1253,6 +1253,36 @@ EOF
expect_not_log "1 local"
}

function test_require_cached() {
mkdir -p a
cat > a/BUILD <<'EOF'
genrule(
name = "foo",
srcs = ["foo.in"],
outs = ["foo.out"],
cmd = "cp \"$<\" \"$@\"",
)
EOF

echo "input 1" >a/foo.in
bazel build \
--remote_executor=grpc://localhost:${worker_port} \
//a:foo >& $TEST_log || fail "Failed to build //a:foo"

expect_log "1 remote"

echo "input 2" >a/foo.in
if bazel build \
--remote_executor=grpc://localhost:${worker_port} \
--experimental_remote_require_cached \
//a:foo >& $TEST_log; then
fail "Build of //a:foo succeeded but it should have failed"
fi

expect_log "Action must be cached due to --experimental_remote_require_cached but it is not"
expect_not_log "remote cache hit"
}

function test_nobuild_runfile_links() {
mkdir data && echo "hello" > data/hello && echo "world" > data/world
cat > WORKSPACE <<EOF
Expand Down