com.facebook.buck.shell

Class ShellStep

java.lang.Object

com.facebook.buck.shell.ShellStep

All Implemented Interfaces:

Step

Direct Known Subclasses:

AaptStep, AbstractGenruleStep, AidlStep, BashStep, CGoCompileStep, CGoGenerateImportStep, CsharpLibraryCompile, DCompileStep, DefaultShellStep, DxStep, GenerateCodeCoverageReportStep, GoAssembleStep, GoCompileStep, GoLinkStep, GoListStep, GoPackStep, GoTestCoverStep, GoTestMainStep, HalideCompilerStep, InstrumentationStep, JUnitStep, LibtoolStep, MachoScrubContentSectionsStep, NdkBuildStep, OcamlCCompileStep, OcamlDepToolStep, OcamlLexStep, OcamlLinkStep, OcamlMLCompileStep, OcamlNativePluginStep, OcamlYaccStep, PexStep, ProGuardObfuscateStep, ReDexStep, ScalacStep, StripStep, ZipalignStep

public abstract class ShellStep
extends Object
implements Step

Field Summary

Fields

Modifier and Type	Field and Description
protected Path	workingDirectory If specified, working directory will be different from build cell root.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShellStep(AbsPath workingDirectory)
protected	ShellStep(Path workingDirectory)

Method Summary

Modifier and Type	Method and Description
protected void	addOptions(com.google.common.collect.ImmutableSet.Builder<ProcessExecutor.Option> options)
StepExecutionResult	execute(ExecutionContext context)
String	getDescription(ExecutionContext context)
long	getDuration()
com.google.common.collect.ImmutableMap<String,String>	getEnvironmentVariables(ExecutionContext context) Returns the environment variables to include when running this ShellStep.
protected int	getExitCodeFromResult(ExecutionContext context, ProcessExecutor.Result result)
com.google.common.collect.ImmutableList<String>	getShellCommand(ExecutionContext context) This method is idempotent.
protected com.google.common.collect.ImmutableList<String>	getShellCommandArgsForDescription(ExecutionContext context)
protected abstract com.google.common.collect.ImmutableList<String>	getShellCommandInternal(ExecutionContext context) Implementations of this method should not have any observable side-effects.
String	getStderr()
protected Optional<String>	getStdin(ExecutionContext context)
String	getStdout()
protected Optional<Long>	getTimeout()
protected Optional<java.util.function.Consumer<Process>>	getTimeoutHandler(ExecutionContext context)
protected boolean	shouldPrintStderr(Verbosity verbosity)
protected boolean	shouldPrintStdout(Verbosity verbosity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.step.Step

getShortName

Field Detail

workingDirectory

protected final Path workingDirectory

If specified, working directory will be different from build cell root. This should be relative to the build cell root.

Constructor Detail

ShellStep

protected ShellStep(Path workingDirectory)

ShellStep

protected ShellStep(AbsPath workingDirectory)

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws InterruptedException,
                                   IOException

Specified by:

execute in interface Step

Throws:

InterruptedException

IOException

getExitCodeFromResult

protected int getExitCodeFromResult(ExecutionContext context,
                                    ProcessExecutor.Result result)

Returns:

the exit code interpreted from the result.

addOptions

protected void addOptions(com.google.common.collect.ImmutableSet.Builder<ProcessExecutor.Option> options)

getDuration

public long getDuration()

getShellCommand

public final com.google.common.collect.ImmutableList<String> getShellCommand(ExecutionContext context)

This method is idempotent.

Returns:

the shell command arguments

getShellCommandArgsForDescription

protected com.google.common.collect.ImmutableList<String> getShellCommandArgsForDescription(ExecutionContext context)

getStdin

protected Optional<String> getStdin(ExecutionContext context)
                             throws InterruptedException,
                                    IOException

Throws:

InterruptedException

IOException

getShellCommandInternal

protected abstract com.google.common.collect.ImmutableList<String> getShellCommandInternal(ExecutionContext context)

Implementations of this method should not have any observable side-effects.

getDescription

public final String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step

getEnvironmentVariables

public com.google.common.collect.ImmutableMap<String,String> getEnvironmentVariables(ExecutionContext context)

Returns the environment variables to include when running this ShellStep.

By default, this method returns an empty map.

Parameters:

context - that may be useful when determining environment variables to include.

shouldPrintStdout

protected boolean shouldPrintStdout(Verbosity verbosity)

Parameters:

verbosity - is provided in case that affects what should be printed.

Returns:

whether the stdout of the shell command, when executed, should be printed to the stderr of the specified ExecutionContext. If false, stdout will only be printed on error and only if verbosity is set to standard information.

getStdout

public final String getStdout()

Returns:

the stdout of this ShellCommand or throws an exception if the stdout was not recorded

shouldPrintStderr

protected boolean shouldPrintStderr(Verbosity verbosity)

Returns:

whether the stderr of the shell command, when executed, should be printed to the stderr of the specified ExecutionContext. If false, stderr will only be printed on error and only if verbosity is set to standard information.

getStderr

public final String getStderr()

Returns:

the stderr of this ShellCommand or throws an exception if the stderr was not recorded

getTimeout

protected Optional<Long> getTimeout()

Returns:

an optional timeout to apply to the step.

getTimeoutHandler

protected Optional<java.util.function.Consumer<Process>> getTimeoutHandler(ExecutionContext context)

Returns:

an optional timeout handler Function to do something before the process is killed.