Package jetbrains.buildServer.agent.runner

Class SimpleProgramCommandLine

java.lang.Object

jetbrains.buildServer.agent.runner.SimpleProgramCommandLine

All Implemented Interfaces:

ProgramCommandLine

public class SimpleProgramCommandLine
extends java.lang.Object
implements ProgramCommandLine

Base implementation for ProgramCommandLine

• sets default working directory for process from BuildRunnerContext.getWorkingDirectory()
• sets default build process environment from build parameters BuildRunnerContext.getBuildParameters() => BuildParametersMap.getEnvironmentVariables()

See Also:

BuildServiceAdapter.createProgramCommandline(String, java.util.List)

Constructor Summary

Constructors

Constructor	Description
SimpleProgramCommandLine(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String workingDir, java.lang.String executablePath, java.util.List<java.lang.String> arguments)
SimpleProgramCommandLine(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String workingDir, java.lang.String executablePath, java.util.List<java.lang.String> arguments, java.lang.String argumentsLine)
SimpleProgramCommandLine(AgentRunningBuild build, java.lang.String executablePath, java.util.List<java.lang.String> arguments)	Deprecated. Use BuildServiceAdapter.createProgramCommandline(String, java.util.List)
SimpleProgramCommandLine(BuildRunnerContext runner, java.lang.String executablePath, java.util.List<java.lang.String> arguments)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getArguments()	All quotations are done property inside Java Runtime
java.lang.String	getCommandLineForLogging(PasswordReplacer passwordReplacer)
java.util.Map<java.lang.String,java.lang.String>	getEnvironment()
java.lang.String	getExecutablePath()	Returns either full pathrelative path to working dirsimply command name to be resolved by OS on the build agent to run
java.lang.String	getWorkingDirectory()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleProgramCommandLine

@Deprecated
public SimpleProgramCommandLine(@NotNull
                                AgentRunningBuild build,
                                @NotNull
                                java.lang.String executablePath,
                                @NotNull
                                java.util.List<java.lang.String> arguments)

Deprecated.

Use BuildServiceAdapter.createProgramCommandline(String, java.util.List)

Parameters:

build - build

executablePath - executable path

arguments - command arguments

SimpleProgramCommandLine

public SimpleProgramCommandLine(@NotNull
                                BuildRunnerContext runner,
                                @NotNull
                                java.lang.String executablePath,
                                @NotNull
                                java.util.List<java.lang.String> arguments)

SimpleProgramCommandLine

public SimpleProgramCommandLine(@NotNull
                                java.util.Map<java.lang.String,java.lang.String> env,
                                @NotNull
                                java.lang.String workingDir,
                                @NotNull
                                java.lang.String executablePath,
                                @NotNull
                                java.util.List<java.lang.String> arguments)

SimpleProgramCommandLine

public SimpleProgramCommandLine(@NotNull
                                java.util.Map<java.lang.String,java.lang.String> env,
                                @NotNull
                                java.lang.String workingDir,
                                @NotNull
                                java.lang.String executablePath,
                                @NotNull
                                java.util.List<java.lang.String> arguments,
                                @NotNull
                                java.lang.String argumentsLine)

Parameters:

env - environment variables

workingDir - working directory of the running build

executablePath - command line executable path

arguments - list of escaped arguments which will be passed into the process

argumentsLine - arguments string as these arguments are configured in build step. Used for logging, see getCommandLineForLogging(jetbrains.buildServer.util.PasswordReplacer)

Since:

2022.10

Method Detail

getExecutablePath

@NotNull
public java.lang.String getExecutablePath()
                                   throws RunBuildException

Description copied from interface: ProgramCommandLine

Returns either

• full path
• relative path to working dir
• simply command name to be resolved by OS on the build agent

to run

Specified by:

getExecutablePath in interface ProgramCommandLine

Returns:

file path to execute

Throws:

RunBuildException - on error in parameters or agent's machine environment

getWorkingDirectory

@NotNull
public java.lang.String getWorkingDirectory()

Specified by:

getWorkingDirectory in interface ProgramCommandLine

Returns:

executable working directory either relative on build checkout directory or absolute path

getArguments

@NotNull
public java.util.List<java.lang.String> getArguments()
                                              throws RunBuildException

Description copied from interface: ProgramCommandLine

All quotations are done property inside Java Runtime

Specified by:

getArguments in interface ProgramCommandLine

Returns:

arguments to be sent to process

Throws:

RunBuildException - on error in parameters or agent's machine environment

getCommandLineForLogging

public java.lang.String getCommandLineForLogging(PasswordReplacer passwordReplacer)
                                          throws RunBuildException

Specified by:

getCommandLineForLogging in interface ProgramCommandLine

Returns:

command line for logging, i.e. this line will be logged into build and agent logs. So the plugin should replace all passwords in this command line using provided password replacer.

Throws:

RunBuildException

getEnvironment

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getEnvironment()

Specified by:

getEnvironment in interface ProgramCommandLine

Returns:

map of all environment variables to be set for process