com.compuware.jenkins.ted

Class TEDExecutionRunnerUtils

java.lang.Object

com.compuware.jenkins.ted.TEDExecutionRunnerUtils

public class TEDExecutionRunnerUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	TED_MINIMUM_CLI_VERSION
static String	TTT_CLI_200903

Constructor Summary

Constructors

Constructor and Description
TEDExecutionRunnerUtils()

Method Summary

Modifier and Type	Method and Description
static String	escapeForScript(String input) Returns an escaped version of the given input String for a Batch or Shell script.
static FilePath	getCLIScriptPath(Launcher launcher, TaskListener listener, String fileSeparator, String osScriptFile) Returns the path to the script to execute TED CLI
static FilePath	getCLIScriptPath(Launcher launcher, TaskListener listener, String fileSeparator, String osScriptFile, String minCLIRelease) Returns the path to the script to execute TED CLI
static String	getCLIVersion(Launcher launcher, String remoteFileSeparator) Returns the version of the TED CLI
static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	getLoginInformation(Item project, String credentialsId) Retrieves login information given a credential ID
static String	getTopaWorkbenchCLIPath(Launcher launcher) Returns the path of the Topaz Workbench CLI, as defined in the global Jenkins' System settings.
static boolean	isMinimumRelease(Launcher launcher, TaskListener listener, String remoteFileSeparator, String versionNumber) Returns if the TED CLI is greater or equal to the passed version.
static void	logJenkinsAndPluginVersion(TaskListener listener) Logs the Jenkins and TED Plugin versions

Methods inherited from class java.lang.Object

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

Field Detail

TTT_CLI_200903

public static final String TTT_CLI_200903

See Also:

Constant Field Values

TED_MINIMUM_CLI_VERSION

public static final String TED_MINIMUM_CLI_VERSION

See Also:

Constant Field Values

Constructor Detail

TEDExecutionRunnerUtils

public TEDExecutionRunnerUtils()

Method Detail

getLoginInformation

public static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getLoginInformation(Item project,
                                                                                                               String credentialsId)

Retrieves login information given a credential ID

Parameters:

project - the Jenkins project

credentialsId - The credendtial id for the user.

Returns:

a Jenkins credential with login information

getCLIScriptPath

public static FilePath getCLIScriptPath(Launcher launcher,
                                        TaskListener listener,
                                        String fileSeparator,
                                        String osScriptFile)
                                 throws IOException,
                                        InterruptedException

Returns the path to the script to execute TED CLI

Parameters:

launcher - An instance Launcher for launching the script.

listener - An instance of TaskListener for the task.

fileSeparator - The file separator for the system on which the script will run.

osScriptFile - The name of the operating system dependent script file to run.

Returns:

An instance of FilePath for the CLI directory

Throws:

IOException - If the CLI directory does not exist.

InterruptedException - If unable to get CLI directory.

getCLIScriptPath

public static FilePath getCLIScriptPath(Launcher launcher,
                                        TaskListener listener,
                                        String fileSeparator,
                                        String osScriptFile,
                                        String minCLIRelease)
                                 throws IOException,
                                        InterruptedException

Returns the path to the script to execute TED CLI

Parameters:

launcher - An instance Launcher for launching the script.

listener - An instance of TaskListener for the task.

fileSeparator - The file separator for the system on which the script will run.

osScriptFile - The name of the operating system dependent script file to run.

minCLIRelease - The minimum CLI release required to run the script.

Returns:

An instance of FilePath for the CLI directory

Throws:

IOException - If the CLI directory does not exist.

InterruptedException - If unable to get CLI directory.

getTopaWorkbenchCLIPath

public static String getTopaWorkbenchCLIPath(Launcher launcher)

Returns the path of the Topaz Workbench CLI, as defined in the global Jenkins' System settings.

Parameters:

launcher - An instance Launcher for launching the script.

Returns:

The path to The Topaz Workbench CLI

getCLIVersion

public static String getCLIVersion(Launcher launcher,
                                   String remoteFileSeparator)
                            throws IOException,
                                   InterruptedException

Returns the version of the TED CLI

Parameters:

launcher - The machine that the files will be checked out.

remoteFileSeparator - The remote file separator

Returns:

An instance of FilePath for the CLI directory

Throws:

IOException - If the CLI directory does not exist.

InterruptedException - If unable to get CLI directory.

logJenkinsAndPluginVersion

public static void logJenkinsAndPluginVersion(TaskListener listener)

Logs the Jenkins and TED Plugin versions

Parameters:

listener - An instance of TaskListener for the task.

isMinimumRelease

public static boolean isMinimumRelease(Launcher launcher,
                                       TaskListener listener,
                                       String remoteFileSeparator,
                                       String versionNumber)

Returns if the TED CLI is greater or equal to the passed version.

Parameters:

launcher - The machine that the files will be checked out.

listener - An instance of TaskListener for the task.

remoteFileSeparator - The remote file separator

versionNumber - The minimum TED CLI version number to check against.

Returns:

true if this node supports using the local configuration directory, otherwise false.

escapeForScript

public static String escapeForScript(String input)

Returns an escaped version of the given input String for a Batch or Shell script.

Parameters:

input - the String to escape

Returns:

the escaped String