com.atlassian.bamboo.resultsummary.tests
Interface TestQuarantineManager

All Known Implementing Classes:

TestQuarantineManagerImpl

public interface TestQuarantineManager

Manager for manipulating all things test quarantine related

Field Summary

static String

QUARANTINE_TEST_KEY Deprecated. since 5.7 use TestQuarantineHelper instead

Method Summary

int	countCurrentlyQuarantinedTests(ImmutableChain chain) Returns the number of tests current qurantined for this plan
List<TestCase>	getCurrentlyQuarantinedTests(ImmutableChain chain) Get a list of TestCase of all the tests currently quarantined for a given plan
List<TestCase>	getCurrentlyQuarantinedTests(ImmutableJob job) Get a list of TestClass and TestCase names of all the tests currently quarantined for a given job In string form for use in the BuildContext custom config
List<TestCaseResult>	getQuarantinedTestsListForBuildResult(BuildResultsSummary buildResultsSummary) Returns List of TestCaseResult that are quarantined for a given build result.
List<TestCaseResult>	getQuarantinedTestsListForChainResult(ChainResultsSummary chainResultsSummary) Get a list of TestCase of all the tests quarantined for a given chain result
void	quarantineTest(long testId, com.atlassian.user.User user, Date date) Quarantines a given test
void	quarantineTest(long testId, com.atlassian.user.User user, Date date, Date expiryDate) Quarantines a given test until a specified date
void	unleashTest(long testId) Unleash a given test
void	unleashTestsWithExpiredQuarantine() Unleashes all tests with expired quarantine.

Field Detail

QUARANTINE_TEST_KEY

@Deprecated
static final String QUARANTINE_TEST_KEY

Deprecated. since 5.7 use TestQuarantineHelper instead

See Also:

Constant Field Values

Method Detail

quarantineTest

void quarantineTest(long testId,
                    @NotNull
                    com.atlassian.user.User user,
                    @NotNull
                    Date date)

Quarantines a given test

Parameters:

testId - - Id of the required test case

user - - @NotNull User quarantining test

date - - date of test quarantine

quarantineTest

void quarantineTest(long testId,
                    @NotNull
                    com.atlassian.user.User user,
                    @NotNull
                    Date date,
                    @Nullable
                    Date expiryDate)

Quarantines a given test until a specified date

Parameters:

testId - - Id of the required test case

user - - @NotNull User quarantining test

date - - date of test quarantine

expiryDate - - date of expiry for the quarantine, can be null for permanent quarantine

unleashTest

void unleashTest(long testId)

Unleash a given test

Parameters:

testId - - ID of required test case

getCurrentlyQuarantinedTests

@NotNull
List<TestCase> getCurrentlyQuarantinedTests(@NotNull
                                                    ImmutableJob job)

Get a list of TestClass and TestCase names of all the tests currently quarantined for a given job In string form for use in the BuildContext custom config

Parameters:

job - to get quarantined tests for

Returns:

A list of TestCase

getCurrentlyQuarantinedTests

@NotNull
List<TestCase> getCurrentlyQuarantinedTests(@NotNull
                                                    ImmutableChain chain)

Get a list of TestCase of all the tests currently quarantined for a given plan

Parameters:

chain - - the chain representing a plan to get quarantined tests for

Returns:

A list of TestCase

countCurrentlyQuarantinedTests

int countCurrentlyQuarantinedTests(ImmutableChain chain)

Returns the number of tests current qurantined for this plan

Parameters:

chain -

Returns:

getQuarantinedTestsListForChainResult

@Nullable
List<TestCaseResult> getQuarantinedTestsListForChainResult(@NotNull
                                                                    ChainResultsSummary chainResultsSummary)

Get a list of TestCase of all the tests quarantined for a given chain result

Parameters:

chainResultsSummary - - results summary of the build you need quarantined tests for

Returns:

a list of TestCase of all the tests quarantined for a chain result

getQuarantinedTestsListForBuildResult

@NotNull
List<TestCaseResult> getQuarantinedTestsListForBuildResult(@NotNull
                                                                   BuildResultsSummary buildResultsSummary)

Returns List of TestCaseResult that are quarantined for a given build result.

Parameters:

buildResultsSummary - - results summary of the build you need quarantined tests for

Returns:

List of TestCaseResult. Empty list if no quarantined tests

unleashTestsWithExpiredQuarantine

void unleashTestsWithExpiredQuarantine()

Unleashes all tests with expired quarantine.