com.piketec.jenkins.plugins.tpt

Class Utils

java.lang.Object

com.piketec.jenkins.plugins.tpt.Utils

public class Utils
extends Object

Collection of some utility methods and constants

Author:

jkuhnert, PikeTec GmbH

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static File	getAbsolutePath(File workspaceDir, File path) Builds a absolute path from the workspace directory and the given path.
static String	getGeneratedReportDir(JenkinsConfiguration ec) Creates a String with a path to create for the report dir.
static String	getGeneratedTestDataDir(JenkinsConfiguration ec) Creates a String with a path to create for the test data dir.
static com.piketec.tpt.api.TptApi	getTptApi(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, TptLogger logger, hudson.FilePath[] exePaths, int tptPort, String tptBindingName, long startupWaitTime) Conects to the Tpt Api through a registry.
static File	getTptPluginRootDir()
static File	getWorkspaceDir(hudson.FilePath workspace, TptLogger logger) Creates a File (workspace) with a FilePath.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

getWorkspaceDir

public static File getWorkspaceDir(hudson.FilePath workspace,
                                   TptLogger logger)
                            throws InterruptedException

Creates a File (workspace) with a FilePath.

Parameters:

workspace - The workspace of the jenkisn job

logger - To print some messages

Returns:

The worksapce as a native Java file.

Throws:

InterruptedException - If the current Job is cancelled

getGeneratedTestDataDir

public static String getGeneratedTestDataDir(JenkinsConfiguration ec)

Creates a String with a path to create for the test data dir. This will be relative to the build workspace

Parameters:

ec - through the jenkins configuration we get the name and the configuration of the file. Used to create an unique path.

Returns:

a String with the folders for the test data dir.

getGeneratedReportDir

public static String getGeneratedReportDir(JenkinsConfiguration ec)

Creates a String with a path to create for the report dir. This will be relative to the build workspace

Parameters:

ec - through the jenkins configuration we get the name and the configuration of the file. Used to create an unique path.

Returns:

a String with the folders for the report dir.

getTptPluginRootDir

public static File getTptPluginRootDir()
                                throws IOException

Returns:

the rootdir from the "piketec-tpt" plugin, used for knowing where to get html files, json or some data stored there.

Throws:

IOException - If no Jenkins isntance could be found

getTptApi

public static com.piketec.tpt.api.TptApi getTptApi(hudson.model.AbstractBuild<?,?> build,
                                                   hudson.Launcher launcher,
                                                   TptLogger logger,
                                                   hudson.FilePath[] exePaths,
                                                   int tptPort,
                                                   String tptBindingName,
                                                   long startupWaitTime)
                                            throws InterruptedException

Conects to the Tpt Api through a registry. It looks for a host with the channel from the launcher. Then it creates a registry with the host and the port, and finally it binds the registry with the TptApi through the tpt binding name.

Parameters:

build - The current Jenkins build

launcher - The launcher

logger - The logger to displax messages

exePaths - The paths to TPT executables

tptPort - the TPTRMI port

tptBindingName - the TPT RMI binding name

startupWaitTime - The wait time to start up TPT

Returns:

Tpt Api that allows accessing tpt through the api.

Throws:

InterruptedException - If the Job is cancelled

getAbsolutePath

public static File getAbsolutePath(File workspaceDir,
                                   File path)

Builds a absolute path from the workspace directory and the given path.

• If both are null, the current working directory will returned - hopefully it is inside the workspace.
• If the workspace is null, the path will returned.
• If the path is null, the workspace will returned.
• If the path is absolute, the path will returned.
• If the path is relative, the path will append to the workspace and returned.

Parameters:

workspaceDir - Current workspace for the build.

path - Relative or absolute path.

Returns:

A absolute path, but it can be a nonexisting file system object or not a directory.