jenkins.task

Class ExamTaskHelper

java.lang.Object

jenkins.task.ExamTaskHelper

public class ExamTaskHelper
extends Object

Helper class for all EXAM Tasks.

Author:

Thomas Reinicke

Constructor Summary

Constructors

Constructor and Description
ExamTaskHelper() Constructor for ExamTaskHelper.

Method Summary

Modifier and Type	Method and Description
void	copyArtifactsToTarget(TestConfiguration tc) copies all reports from the EXAM workspace to the target folder
String	getConfigurationPath(ExamTool examTool) Calculate and return the path to the configuration folder of EXAM
EnvVars	getEnv() get the environment variables
Node	getNode() returns the node the job is actual running
String	getPythonExePath(jenkins.plugins.shiningpanda.tools.PythonInstallation python) Resolves the given Python to the path on the target node
Run	getRun() get the Run
TaskListener	getTaskListener() get the TaskListener
ExamTool	getTool(ExamTool tool) returns the tool for EXAM on the actual running node
void	handleAdditionalArgs(String javaOpts, ArgumentListBuilder args, ExamPluginConfig examPluginConfig) handle and extend the run arguments
void	handleIOException(long startTime, IOException e, ExamTool[] installations) handles and logs the IOExcetion within the EXAM task
FilePath	prepareWorkspace(Task task, ArgumentListBuilder args) prepare some configurations and arguments to run EXAM
void	setEnv(EnvVars env)
void	setLauncher(Launcher launcher) get the TaskListener
void	setRun(Run run) get the TaskListener
void	setTaskListener(TaskListener taskListener) get the TaskListener
void	setWorkspace(FilePath workspace) get the TaskListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ExamTaskHelper

public ExamTaskHelper()

Constructor for ExamTaskHelper.

Method Detail

getEnv

public EnvVars getEnv()

get the environment variables

Returns:

EnvVars

setEnv

public void setEnv(EnvVars env)

getRun

public Run getRun()

get the Run

Returns:

Run

setRun

public void setRun(Run run)
            throws IOException,
                   InterruptedException

get the TaskListener

Parameters:

run - Run

Throws:

InterruptedException - InterruptedException

IOException - IOException

getTaskListener

public TaskListener getTaskListener()

get the TaskListener

Returns:

TaskListener

setTaskListener

public void setTaskListener(TaskListener taskListener)
                     throws IOException,
                            InterruptedException

get the TaskListener

Parameters:

taskListener - TaskListener

Throws:

InterruptedException - InterruptedException

IOException - IOException

setLauncher

public void setLauncher(Launcher launcher)

get the TaskListener

Parameters:

launcher - Launcher

setWorkspace

public void setWorkspace(FilePath workspace)

get the TaskListener

Parameters:

workspace - FilePath

getPythonExePath

public String getPythonExePath(jenkins.plugins.shiningpanda.tools.PythonInstallation python)
                        throws IOException,
                               InterruptedException

Resolves the given Python to the path on the target node

Parameters:

python - PythonInstallation

Returns:

String

Throws:

IOException - IOException

InterruptedException - InterruptedException

handleAdditionalArgs

public void handleAdditionalArgs(String javaOpts,
                                 ArgumentListBuilder args,
                                 ExamPluginConfig examPluginConfig)
                          throws AbortException

handle and extend the run arguments

Parameters:

args - run arguments

examPluginConfig - ExamPluginConfig

javaOpts - additional java options

Throws:

AbortException - AbortException

copyArtifactsToTarget

public void copyArtifactsToTarget(TestConfiguration tc)
                           throws IOException,
                                  InterruptedException

copies all reports from the EXAM workspace to the target folder

Parameters:

tc - TestConfiguration

Throws:

IOException - IOException

InterruptedException - InterruptedException

getConfigurationPath

public String getConfigurationPath(ExamTool examTool)
                            throws IOException,
                                   InterruptedException

Calculate and return the path to the configuration folder of EXAM

Parameters:

examTool - ExamTool

Returns:

String

Throws:

IOException - IOException

InterruptedException - InterruptedException

getNode

public Node getNode()
             throws AbortException

returns the node the job is actual running

Returns:

Node

Throws:

AbortException - AbortException

prepareWorkspace

public FilePath prepareWorkspace(@Nonnull
                                 Task task,
                                 ArgumentListBuilder args)
                          throws IOException,
                                 InterruptedException

prepare some configurations and arguments to run EXAM

Parameters:

task - Task

args - ArgumentListBuilder

Returns:

the path to EXAM runnable

Throws:

IOException - IOException

InterruptedException - InterruptedException

getTool

public ExamTool getTool(@Nullable
                        ExamTool tool)
                 throws IOException,
                        InterruptedException

returns the tool for EXAM on the actual running node

Parameters:

tool - ExamTool

Returns:

ExamTool

Throws:

IOException - IOException

InterruptedException - InterruptedException

handleIOException

public void handleIOException(long startTime,
                              IOException e,
                              ExamTool[] installations)
                       throws AbortException

handles and logs the IOExcetion within the EXAM task

Parameters:

startTime - long

e - IOException

installations - ExamTool[]

Throws:

AbortException - AbortException