Package io.jenkins.plugins.railflow

Class UploadParametersImpl

java.lang.Object

io.jenkins.plugins.railflow.UploadParametersImpl

All Implemented Interfaces:

UploadParameters, Serializable

public class UploadParametersImpl
extends Object
implements UploadParameters

Default implementation of UploadParameters.

Author:

Sergey Oplavin

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.jenkins.plugins.railflow.UploadParameters

UploadParameters.Builder

Constructor Summary

Constructors

Constructor	Description
UploadParametersImpl(String project, String testPath, ReportFormat reportFormat, SearchMode searchMode)

Method Summary

Modifier and Type	Method	Description
Optional<Map<String,Object>>	getCaseFields()	Gets the case fields.
Optional<Map<String,Integer>>	getCaseNameToIdMap()
Optional<String>	getCasePriority()	Gets the case priority.
Optional<String>	getCaseSearchField()	Gets the name of the case filed in TestRail which will be using for searching for existing test cases instead of test case title.
Optional<String>	getCaseType()	Gets the case type.
Optional<List<String>>	getConfigNames()
Optional<String>	getMilestonePath()	Gets the milestone path.
String	getProject()	Gets the project name.
ReportFormat	getReportFormat()	Gets the testreport format.
Optional<Map<String,Object>>	getResultFields()	Gets the result fields.
Optional<RunId>	getRunId()
SearchMode	getSearchMode()
Optional<List<String>>	getSmartTestFailureAssignment()
Optional<String>	getTagsFieldName()	Gets the tags field name.
Optional<String>	getTemplateName()	Gets the template name.
String	getTestPath()	Gets the test path.
Optional<String>	getTestPlan()	Gets the test plan.
Optional<String>	getTestRun()	Gets the test run.
Optional<UploadMode>	getUploadMode()
boolean	isClosePlan()	Checks if is close plan.
boolean	isCloseRun()	Checks if is close run.
boolean	isDisableGrouping()
boolean	isFullCaseNamesAllowed()	Checks if full case names allowed for test case names.
void	setCaseFields(Map<String,Object> caseFields)
void	setCaseNameToIdMap(Map<String,Integer> caseNameToIdMap)
void	setCasePriority(String casePriority)
void	setCaseSearchField(String caseSearchField)
void	setCaseType(String caseType)
void	setClosePlan(boolean closePlan)
void	setCloseRun(boolean closeRun)
void	setConfigNames(List<String> configNames)
void	setDisableGrouping(boolean disableGrouping)
void	setFullCaseNamesAllowed(boolean fullCaseNamesAllowed)
void	setMilestonePath(String milestonePath)
void	setResultFields(Map<String,Object> resultFields)
void	setRunId(RunId runId)
void	setSmartTestFailureAssignment(List<String> smartTestFailureAssignment)
void	setTagsFieldName(String tagsFieldName)
void	setTemplateName(String templateName)
void	setTestPlan(String testPlan)
void	setTestRun(String testRun)
void	setUploadMode(UploadMode uploadMode)

Methods inherited from class java.lang.Object

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

Constructor Details

UploadParametersImpl

public UploadParametersImpl(String project,
 String testPath,
 ReportFormat reportFormat,
 SearchMode searchMode)

Method Details

getProject

@NonNull
public String getProject()

Description copied from interface: UploadParameters

Gets the project name.

Specified by:

getProject in interface UploadParameters

Returns:

the project name

getTestPath

@NonNull
public String getTestPath()

Description copied from interface: UploadParameters

Gets the test path.

Specified by:

getTestPath in interface UploadParameters

Returns:

the test path

getReportFormat

@NonNull
public ReportFormat getReportFormat()

Description copied from interface: UploadParameters

Gets the testreport format.

Specified by:

getReportFormat in interface UploadParameters

Returns:

the testreport format

getSearchMode

public SearchMode getSearchMode()

Specified by:

getSearchMode in interface UploadParameters

Returns:

specifies the test case lookup algorithm.

getTestRun

public Optional<String> getTestRun()

Description copied from interface: UploadParameters

Gets the test run.

Specified by:

getTestRun in interface UploadParameters

Returns:

the test run

setTestRun

public void setTestRun(String testRun)

getTestPlan

public Optional<String> getTestPlan()

Description copied from interface: UploadParameters

Gets the test plan.

Specified by:

getTestPlan in interface UploadParameters

Returns:

the test plan

setTestPlan

public void setTestPlan(String testPlan)

getMilestonePath

public Optional<String> getMilestonePath()

Description copied from interface: UploadParameters

Gets the milestone path.

Specified by:

getMilestonePath in interface UploadParameters

Returns:

the milestone path

setMilestonePath

public void setMilestonePath(String milestonePath)

getCaseFields

public Optional<Map<String,Object>> getCaseFields()

Description copied from interface: UploadParameters

Gets the case fields.

Specified by:

getCaseFields in interface UploadParameters

Returns:

the case fields

setCaseFields

public void setCaseFields(Map<String,Object> caseFields)

getResultFields

public Optional<Map<String,Object>> getResultFields()

Description copied from interface: UploadParameters

Gets the result fields.

Specified by:

getResultFields in interface UploadParameters

Returns:

the result fields

setResultFields

public void setResultFields(Map<String,Object> resultFields)

getConfigNames

public Optional<List<String>> getConfigNames()

Specified by:

getConfigNames in interface UploadParameters

Returns:

string list containing configuration names (paths)

setConfigNames

public void setConfigNames(List<String> configNames)

isCloseRun

public boolean isCloseRun()

Description copied from interface: UploadParameters

Checks if is close run.

Specified by:

isCloseRun in interface UploadParameters

Returns:

true, if is close run.

setCloseRun

public void setCloseRun(boolean closeRun)

isClosePlan

public boolean isClosePlan()

Description copied from interface: UploadParameters

Checks if is close plan.

Specified by:

isClosePlan in interface UploadParameters

Returns:

true, if is close plan.

setClosePlan

public void setClosePlan(boolean closePlan)

getCaseNameToIdMap

public Optional<Map<String,Integer>> getCaseNameToIdMap()

Specified by:

getCaseNameToIdMap in interface UploadParameters

Returns:

string containing mappings between test name and test case ID in TestRail.

setCaseNameToIdMap

public void setCaseNameToIdMap(Map<String,Integer> caseNameToIdMap)

isDisableGrouping

public boolean isDisableGrouping()

Specified by:

isDisableGrouping in interface UploadParameters

Returns:

flag indicates whether or not sub section creation (grouping) is disabled. true - creation of subsections is disabled so all test cases will be uploaded into one section defined by test path parameter, false - creation of subsection is enabled, so one or more subsection will be created.

setDisableGrouping

public void setDisableGrouping(boolean disableGrouping)

getTemplateName

public Optional<String> getTemplateName()

Description copied from interface: UploadParameters

Gets the template name.

Specified by:

getTemplateName in interface UploadParameters

Returns:

the template name

setTemplateName

public void setTemplateName(String templateName)

getCaseType

public Optional<String> getCaseType()

Description copied from interface: UploadParameters

Gets the case type.

Specified by:

getCaseType in interface UploadParameters

Returns:

the case type

setCaseType

public void setCaseType(String caseType)

getCasePriority

public Optional<String> getCasePriority()

Description copied from interface: UploadParameters

Gets the case priority.

Specified by:

getCasePriority in interface UploadParameters

Returns:

the case priority

setCasePriority

public void setCasePriority(String casePriority)

getRunId

public Optional<RunId> getRunId()

Specified by:

getRunId in interface UploadParameters

Returns:

the ID of the TestRail Run to update or 0.

setRunId

public void setRunId(RunId runId)

getSmartTestFailureAssignment

public Optional<List<String>> getSmartTestFailureAssignment()

Specified by:

getSmartTestFailureAssignment in interface UploadParameters

Returns:

string list of user email addresses.

setSmartTestFailureAssignment

public void setSmartTestFailureAssignment(List<String> smartTestFailureAssignment)

getUploadMode

public Optional<UploadMode> getUploadMode()

Specified by:

getUploadMode in interface UploadParameters

Returns:

specifies test cases upload mode.

setUploadMode

public void setUploadMode(UploadMode uploadMode)

getCaseSearchField

public Optional<String> getCaseSearchField()

Description copied from interface: UploadParameters

Gets the name of the case filed in TestRail which will be using for searching for existing test cases instead of test case title.

Specified by:

getCaseSearchField in interface UploadParameters

Returns:

the name of a case field.

setCaseSearchField

public void setCaseSearchField(String caseSearchField)

isFullCaseNamesAllowed

public boolean isFullCaseNamesAllowed()

Description copied from interface: UploadParameters

Checks if full case names allowed for test case names.

Specified by:

isFullCaseNamesAllowed in interface UploadParameters

Returns:

true, if full case names allowed.

setFullCaseNamesAllowed

public void setFullCaseNamesAllowed(boolean fullCaseNamesAllowed)

getTagsFieldName

public Optional<String> getTagsFieldName()

Description copied from interface: UploadParameters

Gets the tags field name.

Specified by:

getTagsFieldName in interface UploadParameters

Returns:

the tags field name.

setTagsFieldName

public void setTagsFieldName(String tagsFieldName)