com.ranorex.jenkinsranorexplugin

Class RanorexRunnerBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.ranorex.jenkinsranorexplugin.RanorexRunnerBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class RanorexRunnerBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RanorexRunnerBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
RanorexRunnerBuilder() When this builder is created in the project configuration step, the builder object will be created
RanorexRunnerBuilder(String rxTestSuiteFilePath, String rxRunConfiguration, String rxReportDirectory, String rxReportFile, String rxReportExtension, Boolean rxJUnitReport, Boolean rxZippedReport, String rxZippedReportDirectory, String rxZippedReportFile, Boolean rxTestRail, String rxTestRailUser, String rxTestRailPassword, String rxTestRailRID, String rxTestRailRunName, String rxGlobalParameter, String cmdLineArgs) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getCmdLineArgs()
RanorexRunnerBuilder.DescriptorImpl	getDescriptor()
String	getRxGlobalParameter()
Boolean	getRxJUnitReport()
String	getRxReportDirectory()
String	getRxReportExtension()
String	getRxReportFile()
String	getRxRunConfiguration()
Boolean	getRxTestRail()
String	getRxTestRailPassword()
String	getRxTestRailRID()
String	getRxTestRailRunName()
String	getRxTestRailUser()
String	getRxTestSuiteFilePath()
Boolean	getRxZippedReport()
String	getRxZippedReportDirectory()
String	getRxZippedReportFile()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Runs the step over the given build and reports the progress to the listener
void	setCmdLineArgs(String CmdLineArgs)
void	setRxGlobalParameter(String rxGlobalParameter)
void	setRxJUnitReport(Boolean rxJUnitReport)
void	setRxReportDirectory(String rxReportDirectory)
void	setRxReportExtension(String rxReportExtension)
void	setRxReportFile(String rxReportFile)
void	setRxRunConfiguration(String rxRunConfiguration)
void	setRxTestRail(Boolean rxTestRail)
void	setRxTestRailPassword(String rxTestRailPassword)
void	setRxTestRailRID(String rxTestRailRID)
void	setRxTestRailRunName(String rxTestRailRunName)
void	setRxTestRailUser(String rxTestRailUser)
void	setRxTestSuiteFilePath(String rxTestSuiteFilePath)
void	setRxZippedReport(Boolean rxZippedReport)
void	setRxZippedReportDirectory(String rxZippedReportDirectory)
void	setRxZippedReportFile(String rxZippedReportFile)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

RanorexRunnerBuilder

@DataBoundConstructor
public RanorexRunnerBuilder()

When this builder is created in the project configuration step, the builder object will be created

RanorexRunnerBuilder

@Deprecated
public RanorexRunnerBuilder(String rxTestSuiteFilePath,
                                         String rxRunConfiguration,
                                         String rxReportDirectory,
                                         String rxReportFile,
                                         String rxReportExtension,
                                         Boolean rxJUnitReport,
                                         Boolean rxZippedReport,
                                         String rxZippedReportDirectory,
                                         String rxZippedReportFile,
                                         Boolean rxTestRail,
                                         String rxTestRailUser,
                                         String rxTestRailPassword,
                                         String rxTestRailRID,
                                         String rxTestRailRunName,
                                         String rxGlobalParameter,
                                         String cmdLineArgs)

Deprecated.

When this builder is created in the project configuration step, the builder object will be created from the strings below

Parameters:

rxTestSuiteFilePath - The name/location of the Ranorex Test Suite / Ranorex Test Exe File

rxRunConfiguration - The Ranorex Run configuration which will be executed

rxReportDirectory - The directory where the Ranorex Report should be saved

rxReportFile - The name of the Ranorex Report

rxReportExtension - The extension of your Ranorex Report

rxJUnitReport - If true, a JUnit compatible Report will be saved

rxZippedReport - If true, the report will also be saved as RXZLOG

rxZippedReportDirectory - The directory where the Ranorex Zipped Report should be saved

rxZippedReportFile - The name of the zipped Ranorex Report

rxTestRail - True when test rail is used

rxTestRailUser - Username for connecting to TestRail

rxTestRailPassword - Password for connecting to TestRail

rxTestRailRID - TestRail RID

rxTestRailRunName - TestRail run name

rxGlobalParameter - Global test suite parameters

cmdLineArgs - Additional CMD line arguments

Method Detail

getRxTestSuiteFilePath

@CheckForNull
public String getRxTestSuiteFilePath()

getRxRunConfiguration

@CheckForNull
public String getRxRunConfiguration()

getRxReportDirectory

@CheckForNull
public String getRxReportDirectory()

getRxReportFile

@CheckForNull
public String getRxReportFile()

getRxReportExtension

@CheckForNull
public String getRxReportExtension()

getRxJUnitReport

@CheckForNull
public Boolean getRxJUnitReport()

getRxZippedReport

@CheckForNull
public Boolean getRxZippedReport()

getRxZippedReportDirectory

@CheckForNull
public String getRxZippedReportDirectory()

getRxZippedReportFile

@CheckForNull
public String getRxZippedReportFile()

getRxTestRail

@CheckForNull
public Boolean getRxTestRail()

getRxTestRailUser

@CheckForNull
public String getRxTestRailUser()

getRxTestRailPassword

@CheckForNull
public String getRxTestRailPassword()

getRxTestRailRID

@CheckForNull
public String getRxTestRailRID()

getRxTestRailRunName

@CheckForNull
public String getRxTestRailRunName()

getRxGlobalParameter

@CheckForNull
public String getRxGlobalParameter()

getCmdLineArgs

@CheckForNull
public String getCmdLineArgs()

setRxTestSuiteFilePath

@DataBoundSetter
public void setRxTestSuiteFilePath(@CheckForNull
                                                     String rxTestSuiteFilePath)

setRxRunConfiguration

@DataBoundSetter
public void setRxRunConfiguration(@CheckForNull
                                                    String rxRunConfiguration)

setRxReportDirectory

@DataBoundSetter
public void setRxReportDirectory(@CheckForNull
                                                   String rxReportDirectory)

setRxReportFile

@DataBoundSetter
public void setRxReportFile(@CheckForNull
                                              String rxReportFile)

setRxReportExtension

@DataBoundSetter
public void setRxReportExtension(@CheckForNull
                                                   String rxReportExtension)

setRxJUnitReport

@DataBoundSetter
public void setRxJUnitReport(@CheckForNull
                                               Boolean rxJUnitReport)

setRxZippedReport

@DataBoundSetter
public void setRxZippedReport(Boolean rxZippedReport)

setRxZippedReportDirectory

@DataBoundSetter
public void setRxZippedReportDirectory(@CheckForNull
                                                         String rxZippedReportDirectory)

setRxZippedReportFile

@DataBoundSetter
public void setRxZippedReportFile(@CheckForNull
                                                    String rxZippedReportFile)

setRxTestRail

@DataBoundSetter
public void setRxTestRail(Boolean rxTestRail)

setRxTestRailUser

@DataBoundSetter
public void setRxTestRailUser(@CheckForNull
                                                String rxTestRailUser)

setRxTestRailPassword

@DataBoundSetter
public void setRxTestRailPassword(@CheckForNull
                                                    String rxTestRailPassword)

setRxTestRailRID

@DataBoundSetter
public void setRxTestRailRID(@CheckForNull
                                               String rxTestRailRID)

setRxTestRailRunName

@DataBoundSetter
public void setRxTestRailRunName(@CheckForNull
                                                   String rxTestRailRunName)

setRxGlobalParameter

@DataBoundSetter
public void setRxGlobalParameter(@CheckForNull
                                                   String rxGlobalParameter)

setCmdLineArgs

@DataBoundSetter
public void setCmdLineArgs(@CheckForNull
                                             String CmdLineArgs)

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> run,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Runs the step over the given build and reports the progress to the listener

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Parameters:

run - Run instance

workspace - Current workspace

launcher - Starts a process

listener - Receives events that happen during a build

Throws:

IOException - - If the build is interrupted by the user (in an attempt to abort the build.) Normally the BuildStep implementations may simply forward the exception it got from its lower-level functions.

InterruptedException - - If the implementation wants to abort the processing when an IOException happens, it can simply propagate the exception to the caller. This will cause the build to fail, with the default error message. Implementations are encouraged to catch IOException on its own to provide a better error message, if it can do so, so that users have better understanding on why it failed.

getDescriptor

public RanorexRunnerBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder