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

Implement --remote_force_print_messages #15557

Closed
wants to merge 1 commit into from
Closed
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 @@ -61,6 +61,7 @@
import com.google.devtools.build.lib.remote.common.BulkTransferException;
import com.google.devtools.build.lib.remote.common.OperationObserver;
import com.google.devtools.build.lib.remote.options.RemoteOptions;
import com.google.devtools.build.lib.remote.options.RemoteOptions.ExecutionMessagePrintMode;
import com.google.devtools.build.lib.remote.util.Utils;
import com.google.devtools.build.lib.remote.util.Utils.InMemoryOutput;
import com.google.devtools.build.lib.sandbox.SandboxHelpers;
Expand Down Expand Up @@ -274,7 +275,13 @@ public SpawnResult exec(Spawn spawn, SpawnExecutionContext context)

FileOutErr outErr = context.getFileOutErr();
String message = result.getMessage();
if (!result.success() && !message.isEmpty()) {
boolean printMessage = (!result.success() &&
remoteOptions.remotePrintExecutionMessages == ExecutionMessagePrintMode.FAILURE ||
result.success() &&
remoteOptions.remotePrintExecutionMessages == ExecutionMessagePrintMode.SUCCESS ||
remoteOptions.remotePrintExecutionMessages == ExecutionMessagePrintMode.ALL)
&& !message.isEmpty();
if (printMessage) {
outErr.printErr(message + "\n");
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,19 @@ public RemoteOutputsStrategyConverter() {
help = "Maximum number of open files allowed during BEP artifact upload.")
public int maximumOpenFiles;

@Option(
name = "remote_print_execution_messages",
defaultValue = "failure",
converter = ExecutionMessagePrintMode.Converter.class,
category = "remote",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.TERMINAL_OUTPUT},
help =
"Choose when to print remote execution messages. Valid values are `failure`, "
+ "to print only on failures, `success` to print only on successes and "
+ "`all` to print always.")
public ExecutionMessagePrintMode remotePrintExecutionMessages;

// The below options are not configurable by users, only tests.
// This is part of the effort to reduce the overall number of flags.

Expand Down Expand Up @@ -643,4 +656,18 @@ private static FailureDetail createFailureDetail(String message, Code detailedCo
.setRemoteExecution(RemoteExecution.newBuilder().setCode(detailedCode))
.build();
}

/** An enum for specifying different modes for printing remote execution messages. */
public enum ExecutionMessagePrintMode {
FAILURE, // Print execution messages only on failure
SUCCESS, // Print execution messages only on success
ALL; // Print execution messages always

/** Converts to {@link ExecutionMessagePrintMode}. */
public static class Converter extends EnumConverter<ExecutionMessagePrintMode> {
public Converter() {
super(ExecutionMessagePrintMode.class, "execution message print mode");
}
}
}
}