com.facebook.buck.shell

Class WorkerShellStep

java.lang.Object

com.facebook.buck.shell.WorkerShellStep

All Implemented Interfaces:

Step

public class WorkerShellStep
extends Object
implements Step

Constructor Summary

Constructors

Constructor and Description
WorkerShellStep(BuildTarget buildTarget, Optional<WorkerJobParams> cmdParams, Optional<WorkerJobParams> bashParams, Optional<WorkerJobParams> cmdExeParams, WorkerProcessPoolFactory factory) Creates new shell step that uses worker process to delegate work.

Method Summary

Modifier and Type	Method and Description
StepExecutionResult	execute(ExecutionContext context)
String	getDescription(ExecutionContext context)
protected com.google.common.collect.ImmutableMap<String,String>	getEnvironmentVariables() Returns the environment variables to use when expanding the job arguments that get sent to the process.
String	getShortName()
WorkerJobParams	getWorkerJobParamsToUse(Platform platform)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerShellStep

public WorkerShellStep(BuildTarget buildTarget,
                       Optional<WorkerJobParams> cmdParams,
                       Optional<WorkerJobParams> bashParams,
                       Optional<WorkerJobParams> cmdExeParams,
                       WorkerProcessPoolFactory factory)

Creates new shell step that uses worker process to delegate work. If platform-specific params are present they are used in favor of universal params.

Parameters:

cmdParams - Universal, platform independent params, something that would work for both Linux/macOS and Windows platforms.

bashParams - Used in Linux/macOS environment, specifies the arguments that are passed into bash shell.

cmdExeParams - Used in Windows environment, specifies the arguments that are passed into cmd.exe (Windows shell).

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException,
                                   InterruptedException

Specified by:

execute in interface Step

Throws:

IOException

InterruptedException

getWorkerJobParamsToUse

public WorkerJobParams getWorkerJobParamsToUse(Platform platform)

getEnvironmentVariables

protected com.google.common.collect.ImmutableMap<String,String> getEnvironmentVariables()

Returns the environment variables to use when expanding the job arguments that get sent to the process.

By default, this method returns an empty map.

getShortName

public String getShortName()

Specified by:

getShortName in interface Step

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getDescription

public final String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step