com.compuware.jenkins.totaltest

Class TotalTestRunnerUtils

java.lang.Object

com.compuware.jenkins.totaltest.TotalTestRunnerUtils

public class TotalTestRunnerUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TotalTestRunnerUtils.GetRemoteUTF8FileContents Returns a UTF8 string of the remote file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TTT_CLI_200401
static String	TTT_CLI_200501
static String	TTT_MINIMUM_CLI_VERSION
static String	TTT_NEW_EXTENSIONS_CLI_VERSION
static String	TTT_OUTPUTFOLDER_CLI_VERSION

Constructor Summary

Constructors

Constructor and Description
TotalTestRunnerUtils()

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 hudson.FilePath	getCLIScriptPath(hudson.Launcher launcher, hudson.model.TaskListener listener, String fileSeparator, String osScriptFile) Returns the path to the script to execute Total Test CLI
static hudson.FilePath	getCLIScriptPath(hudson.Launcher launcher, hudson.model.TaskListener listener, String fileSeparator, String osScriptFile, String minCLIRelease) Returns the path to the script to execute Total Test CLI
static String	getCLIVersion(hudson.Launcher launcher, String remoteFileSeparator) Returns the version of the Total Test CLI
static String	getHost(String hostPort) Gets the host name;
static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	getLoginInformation(hudson.model.Item project, String credentialsId) Retrieves login information given a credential ID
static String	getPort(String hostPort) Gets the port for the host connection.
static String	getTopaWorkbenchCLIPath(hudson.Launcher launcher) Returns the path of the Topaz Workbench CLI, as defined in the global Jenkins' System settings.
static boolean	isMinimumRelease(hudson.Launcher launcher, hudson.model.TaskListener listener, String remoteFileSeparator, String versionNumber) Returns if the Total Test CLI is greater or equal to the passed version.
static boolean	isSpecicalTestName(String testName) Checks if the specified test name is ALL_SCENARIOS or ALL_SUITES
static boolean	isTestNameList(String testSuiteEntry) Checks if the test suite entry is a list of test scenario/suite names.
static void	logJenkinsAndPluginVersion(hudson.model.TaskListener listener) Logs the Jenkins and Total Test Plugin versions
static boolean	usesDefaultOutputFolder(hudson.Launcher launcher, hudson.model.TaskListener listener, String remoteFileSeparator) Returns if the Total Test CLI will use the default Output folder
static boolean	usesNewFileExtensions(hudson.Launcher launcher, hudson.model.TaskListener listener, String remoteFileSeparator) Returns if the Total Test CLI will use the defulat Output folder
static void	validateHostPort(hudson.model.TaskListener listener, String hostPortValue) Validate that there is a host and port defined.

Methods inherited from class java.lang.Object

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

Field Detail

TTT_MINIMUM_CLI_VERSION

public static final String TTT_MINIMUM_CLI_VERSION

See Also:

Constant Field Values

TTT_NEW_EXTENSIONS_CLI_VERSION

public static final String TTT_NEW_EXTENSIONS_CLI_VERSION

See Also:

Constant Field Values

TTT_OUTPUTFOLDER_CLI_VERSION

public static final String TTT_OUTPUTFOLDER_CLI_VERSION

See Also:

Constant Field Values

TTT_CLI_200401

public static final String TTT_CLI_200401

See Also:

Constant Field Values

TTT_CLI_200501

public static final String TTT_CLI_200501

See Also:

Constant Field Values

Constructor Detail

TotalTestRunnerUtils

public TotalTestRunnerUtils()

Method Detail

getHost

public static String getHost(String hostPort)

Gets the host name;

Parameters:

hostPort - A string containing host:port.

Returns:

String the host name

getPort

public static String getPort(String hostPort)

Gets the port for the host connection.

Parameters:

hostPort - A string containing host:port.

Returns:

String the port

getLoginInformation

public static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getLoginInformation(hudson.model.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

validateHostPort

public static void validateHostPort(hudson.model.TaskListener listener,
                                    String hostPortValue)

Validate that there is a host and port defined.

Parameters:

listener - Task listener

hostPortValue - The host and port. Format(host:port)

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

isSpecicalTestName

public static boolean isSpecicalTestName(String testName)

Checks if the specified test name is ALL_SCENARIOS or ALL_SUITES

The check is case insensitive.

Parameters:

testName - The test name to check.

Returns:

true if either ALL_SCENARIOS or ALL_SUITES was specified, otherwise false.

isTestNameList

public static boolean isTestNameList(String testSuiteEntry)

Checks if the test suite entry is a list of test scenario/suite names.

Parameters:

testSuiteEntry - The test suite entry to check.

Returns:

true if the entry is a list, otherwise false

logJenkinsAndPluginVersion

public static void logJenkinsAndPluginVersion(hudson.model.TaskListener listener)

Logs the Jenkins and Total Test Plugin versions

Parameters:

listener - An instance of TaskListener for the task.

getTopaWorkbenchCLIPath

public static String getTopaWorkbenchCLIPath(hudson.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

getCLIScriptPath

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

Returns the path to the script to execute Total Test 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 hudson.FilePath getCLIScriptPath(hudson.Launcher launcher,
                                               hudson.model.TaskListener listener,
                                               String fileSeparator,
                                               String osScriptFile,
                                               String minCLIRelease)
                                        throws IOException,
                                               InterruptedException

Returns the path to the script to execute Total Test 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.

getCLIVersion

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

Returns the version of the Total Test 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.

usesDefaultOutputFolder

public static boolean usesDefaultOutputFolder(hudson.Launcher launcher,
                                              hudson.model.TaskListener listener,
                                              String remoteFileSeparator)

Returns if the Total Test CLI will use the default Output folder

Parameters:

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

listener - An instance of TaskListener for the task.

remoteFileSeparator - The remote file separator

Returns:

true if this uses the default folder

usesNewFileExtensions

public static boolean usesNewFileExtensions(hudson.Launcher launcher,
                                            hudson.model.TaskListener listener,
                                            String remoteFileSeparator)

Returns if the Total Test CLI will use the defulat Output folder

Parameters:

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

listener - An instance of TaskListener for the task.

remoteFileSeparator - The remote file separator

Returns:

true if this uses the default folder

isMinimumRelease

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

Returns if the Total Test 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 Total Test CLI version number to check against.

Returns:

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