hudson.plugins.testlink

Class AbstractTestLinkBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.plugins.testlink.AbstractTestLinkBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

TestLinkBuilder

public class AbstractTestLinkBuilder
extends hudson.tasks.Builder

Contains basic logic for a Builder for TestLink plug-in. This class was created to reduce complexity and reduce the length of the code present in the Builder itself.

Since:

2.4

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
protected List<hudson.tasks.BuildStep>	afterIteratingAllTestCasesBuildSteps List of build steps that are executed after iterating all test cases.
protected List<hudson.tasks.BuildStep>	beforeIteratingAllTestCasesBuildSteps List of build steps that are executed before iterating all test cases.
protected String	buildName The name of the Build.
protected String	customFields Comma separated list of custom fields to download from TestLink.
protected ExecutionOrderComparator	executionOrderComparator Used to sort test cases marked as automated.
protected Boolean	failedTestsMarkBuildAsFailure If the plug-in should mark the Build in Jenkins as failure if it contains failed tests.
protected Boolean	failIfNoResults Fail the build if no test results are present.
protected Boolean	failOnNotRun Create failure if any of the tests are set as not-run
protected boolean	failure Flag to check if any failure happened.
protected List<hudson.tasks.BuildStep>	iterativeBuildSteps List of build steps that are executed for each test case.
protected String	platformName The platform name.
protected List<hudson.tasks.BuildStep>	singleBuildSteps List of build steps that are executed only once per job execution.
protected String	testLinkName The name of the TestLink installation.
protected String	testPlanCustomFields Comma separated list of test plan custom fields to download from TestLink.
protected String	testPlanName The name of the Test Plan.
protected String	testProjectName The name of the Test Project.
protected Boolean	transactional If this property is true, not more build steps are executed for this Build.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AbstractTestLinkBuilder(String testLinkName, String testProjectName, String testPlanName, String platformName, String buildName, String customFields, Boolean executionStatusNotRun, Boolean executionStatusPassed, Boolean executionStatusFailed, Boolean executionStatusBlocked, List<hudson.tasks.BuildStep> singleBuildSteps, List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps, List<hudson.tasks.BuildStep> iterativeBuildSteps, List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps, Boolean transactional, Boolean failedTestsMarkBuildAsFailure, Boolean failIfNoResults, Boolean failOnNotRun, List<ResultSeeker> resultSeekers) Deprecated.
AbstractTestLinkBuilder(String testLinkName, String testProjectName, String testPlanName, String platformName, String buildName, String customFields, List<hudson.tasks.BuildStep> singleBuildSteps, List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps, List<hudson.tasks.BuildStep> iterativeBuildSteps, List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps, Boolean transactional, Boolean failedTestsMarkBuildAsFailure, Boolean failIfNoResults, Boolean failOnNotRun, List<ResultSeeker> resultSeekers) Deprecated. to add test plan custom fields
AbstractTestLinkBuilder(String testLinkName, String testProjectName, String testPlanName, String platformName, String buildName, String customFields, String testPlanCustomFields, List<hudson.tasks.BuildStep> singleBuildSteps, List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps, List<hudson.tasks.BuildStep> iterativeBuildSteps, List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps, Boolean transactional, Boolean failedTestsMarkBuildAsFailure, Boolean failIfNoResults, Boolean failOnNotRun, List<ResultSeeker> resultSeekers) Create a AbstractTestLinkBuilder.

Method Summary

Modifier and Type	Method and Description
List<hudson.tasks.BuildStep>	getAfterIteratingAllTestCasesBuildSteps()
List<hudson.tasks.BuildStep>	getBeforeIteratingAllTestCasesBuildSteps()
String	getBuildName()
String	getCustomFields()
Boolean	getExecutionStatusBlocked() Deprecated.
Boolean	getExecutionStatusFailed() Deprecated.
Boolean	getExecutionStatusNotRun() Deprecated.
Boolean	getExecutionStatusPassed() Deprecated.
Boolean	getFailedTestsMarkBuildAsUnstable()
Boolean	getFailIfNoResults()
Boolean	getFailOnNotRun()
List<hudson.tasks.BuildStep>	getIterativeBuildSteps()
String	getPlatformName()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
List<ResultSeeker>	getResultSeekers()
List<hudson.tasks.BuildStep>	getSingleBuildSteps()
String	getTestLinkName()
String	getTestPlanCustomFields()
String	getTestPlanName()
String	getTestProjectName()
Boolean	getTransactional() Returns whether it is a transactional build or not.
void	setResultSeekers(List<ResultSeeker> resultSeekers)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

testLinkName

protected final String testLinkName

The name of the TestLink installation.

testProjectName

protected final String testProjectName

The name of the Test Project.

testPlanName

protected final String testPlanName

The name of the Test Plan.

buildName

protected String buildName

The name of the Build.

platformName

protected final String platformName

The platform name.

customFields

protected final String customFields

Comma separated list of custom fields to download from TestLink.

testPlanCustomFields

protected final String testPlanCustomFields

Comma separated list of test plan custom fields to download from TestLink.

singleBuildSteps

protected final List<hudson.tasks.BuildStep> singleBuildSteps

List of build steps that are executed only once per job execution.

beforeIteratingAllTestCasesBuildSteps

protected final List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps

List of build steps that are executed before iterating all test cases.

iterativeBuildSteps

protected final List<hudson.tasks.BuildStep> iterativeBuildSteps

List of build steps that are executed for each test case.

afterIteratingAllTestCasesBuildSteps

protected final List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps

List of build steps that are executed after iterating all test cases.

transactional

protected final Boolean transactional

If this property is true, not more build steps are executed for this Build.

failedTestsMarkBuildAsFailure

protected final Boolean failedTestsMarkBuildAsFailure

If the plug-in should mark the Build in Jenkins as failure if it contains failed tests.

failIfNoResults

protected final Boolean failIfNoResults

Fail the build if no test results are present.

failOnNotRun

protected final Boolean failOnNotRun

Create failure if any of the tests are set as not-run

executionOrderComparator

protected final ExecutionOrderComparator executionOrderComparator

Used to sort test cases marked as automated.

failure

protected boolean failure

Flag to check if any failure happened.

Constructor Detail

AbstractTestLinkBuilder

public AbstractTestLinkBuilder(String testLinkName,
                               String testProjectName,
                               String testPlanName,
                               String platformName,
                               String buildName,
                               String customFields,
                               String testPlanCustomFields,
                               List<hudson.tasks.BuildStep> singleBuildSteps,
                               List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps,
                               List<hudson.tasks.BuildStep> iterativeBuildSteps,
                               List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps,
                               Boolean transactional,
                               Boolean failedTestsMarkBuildAsFailure,
                               Boolean failIfNoResults,
                               Boolean failOnNotRun,
                               List<ResultSeeker> resultSeekers)

Create a AbstractTestLinkBuilder.

AbstractTestLinkBuilder

public AbstractTestLinkBuilder(String testLinkName,
                               String testProjectName,
                               String testPlanName,
                               String platformName,
                               String buildName,
                               String customFields,
                               List<hudson.tasks.BuildStep> singleBuildSteps,
                               List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps,
                               List<hudson.tasks.BuildStep> iterativeBuildSteps,
                               List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps,
                               Boolean transactional,
                               Boolean failedTestsMarkBuildAsFailure,
                               Boolean failIfNoResults,
                               Boolean failOnNotRun,
                               List<ResultSeeker> resultSeekers)

Deprecated. to add test plan custom fields

Create a AbstractTestLinkBuilder.

AbstractTestLinkBuilder

public AbstractTestLinkBuilder(String testLinkName,
                               String testProjectName,
                               String testPlanName,
                               String platformName,
                               String buildName,
                               String customFields,
                               Boolean executionStatusNotRun,
                               Boolean executionStatusPassed,
                               Boolean executionStatusFailed,
                               Boolean executionStatusBlocked,
                               List<hudson.tasks.BuildStep> singleBuildSteps,
                               List<hudson.tasks.BuildStep> beforeIteratingAllTestCasesBuildSteps,
                               List<hudson.tasks.BuildStep> iterativeBuildSteps,
                               List<hudson.tasks.BuildStep> afterIteratingAllTestCasesBuildSteps,
                               Boolean transactional,
                               Boolean failedTestsMarkBuildAsFailure,
                               Boolean failIfNoResults,
                               Boolean failOnNotRun,
                               List<ResultSeeker> resultSeekers)

Deprecated.

This constructor is bound to a stapler request. All parameters here are passed by Jenkins.

Parameters:

testLinkName - TestLink Installation name.

testProjectName - TestLink Test Project name.

testPlanName - TestLink Test Plan name.

platformName - TestLink Platform name.

buildName - TestLink Build name.

customFields - TestLink comma-separated list of Custom Fields.

singleBuildSteps - List of build steps to execute once for all automated test cases.

beforeIteratingAllTestCasesBuildSteps - Command executed before iterating all test cases.

iterativeBuildSteps - List of build steps to execute for each Automated Test Case.

afterIteratingAllTestCasesBuildSteps - Command executed after iterating all test cases.

transactional - Whether the build's execution is transactional or not.

failedTestsMarkBuildAsFailure - Whether failed tests mark the build as failure or not.

failIfNoResults - If true marks the build as FAILURE.

resultSeekers - List of result seekers.

Method Detail

getTestLinkName

public String getTestLinkName()

getTestProjectName

public String getTestProjectName()

getTestPlanName

public String getTestPlanName()

getPlatformName

public String getPlatformName()

getBuildName

public String getBuildName()

getCustomFields

public String getCustomFields()

getTestPlanCustomFields

public String getTestPlanCustomFields()

getExecutionStatusNotRun

public Boolean getExecutionStatusNotRun()

Deprecated.

getExecutionStatusPassed

public Boolean getExecutionStatusPassed()

Deprecated.

getExecutionStatusFailed

public Boolean getExecutionStatusFailed()

Deprecated.

getExecutionStatusBlocked

public Boolean getExecutionStatusBlocked()

Deprecated.

getSingleBuildSteps

public List<hudson.tasks.BuildStep> getSingleBuildSteps()

getBeforeIteratingAllTestCasesBuildSteps

public List<hudson.tasks.BuildStep> getBeforeIteratingAllTestCasesBuildSteps()

getIterativeBuildSteps

public List<hudson.tasks.BuildStep> getIterativeBuildSteps()

getAfterIteratingAllTestCasesBuildSteps

public List<hudson.tasks.BuildStep> getAfterIteratingAllTestCasesBuildSteps()

getTransactional

public Boolean getTransactional()

Returns whether it is a transactional build or not. A transactional build stops executing once a test fails. All tests must succeed or it won't finish its execution and will mark all remaining tests with Blocked status.

Returns:

If the build step should be transactional or not

getFailedTestsMarkBuildAsUnstable

public Boolean getFailedTestsMarkBuildAsUnstable()

Returns:

the failedTestsMarkBuildAsUnstable

getFailIfNoResults

public Boolean getFailIfNoResults()

Returns:

the failIfNoResults

getFailOnNotRun

public Boolean getFailOnNotRun()

Returns:

the failOnNotRun

getResultSeekers

public List<ResultSeeker> getResultSeekers()

Returns:

the resultSeekers

setResultSeekers

public void setResultSeekers(List<ResultSeeker> resultSeekers)

Parameters:

resultSeekers - the resultSeekers to set

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer