blob: 091e0df0e8615b098caa93b363a0d0ec87651a1f [file] [log] [blame]
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.exec;
import static com.google.common.base.Preconditions.checkArgument;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.devtools.build.lib.actions.Action;
import com.google.devtools.build.lib.actions.ActionExecutionException;
import com.google.devtools.build.lib.actions.ExecException;
import com.google.devtools.build.lib.actions.Spawn;
import com.google.devtools.build.lib.actions.SpawnResult;
import com.google.devtools.build.lib.actions.SpawnResult.Status;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.util.ExitCode;
/**
* A specialization of {@link ExecException} that indicates something went wrong when trying to
* execute a {@link Spawn}.
*/
public class SpawnExecException extends ExecException {
protected final SpawnResult result;
protected final boolean forciblyRunRemotely;
public SpawnExecException(String message, SpawnResult result, boolean forciblyRunRemotely) {
super(message, result.isCatastrophe());
checkArgument(
!Status.SUCCESS.equals(result.status()),
"Can't create exception with successful spawn result.");
this.result = Preconditions.checkNotNull(result);
this.forciblyRunRemotely = forciblyRunRemotely;
}
@VisibleForTesting
public SpawnExecException(
String message, SpawnResult result, boolean forciblyRunRemotely, boolean catastrophe) {
super(message, catastrophe);
this.result = Preconditions.checkNotNull(result);
this.forciblyRunRemotely = forciblyRunRemotely;
}
/** Returns the spawn result. */
public SpawnResult getSpawnResult() {
return result;
}
public boolean hasTimedOut() {
return getSpawnResult().status() == Status.TIMEOUT;
}
@Override
public ActionExecutionException toActionExecutionException(
String messagePrefix, boolean verboseFailures, Action action) {
if (messagePrefix == null) {
messagePrefix = action.describe();
}
String message =
result.getDetailMessage(
messagePrefix, getMessage(), verboseFailures, isCatastrophic(), forciblyRunRemotely);
return new ActionExecutionException(
message, this, action, isCatastrophic(), getDetailedExitCode());
}
/** Return exit code depending on the spawn result. */
private DetailedExitCode getDetailedExitCode() {
if (result.status().isConsideredUserError()) {
return null;
}
return DetailedExitCode.justExitCode(ExitCode.REMOTE_ERROR);
}
}