Interface TestQuarantineManager
- All Known Implementing Classes:
TestQuarantineManagerImpl
public interface TestQuarantineManager
Manager for manipulating all things test quarantine related
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of tests current qurantined for this plangetCurrentlyQuarantinedTests
(@NotNull ImmutableChain chain) Get a list ofTestCase
of all the tests currently quarantined for a given plangetCurrentlyQuarantinedTests
(@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@NotNull List<TestCaseResult>
getQuarantinedTestsListForBuildResult
(@NotNull BuildResultsSummary buildResultsSummary) ReturnsList
ofTestCaseResult
that are quarantined for a given build result.@Nullable List<TestCaseResult>
getQuarantinedTestsListForChainResult
(@NotNull ChainResultsSummary chainResultsSummary) Get a list ofTestCase
of all the tests quarantined for a given chain resultvoid
quarantineTest
(long testId, @NotNull com.atlassian.user.User user, @NotNull Date date) Quarantines a given testvoid
quarantineTest
(long testId, @NotNull com.atlassian.user.User user, @NotNull Date date, @Nullable Date expiryDate) Quarantines a given test until a specified datedefault void
unleashTest
(long testId) Unleash a given testvoid
unleashTest
(long testId, @Nullable com.atlassian.user.User user) Unleash a given testvoid
Deprecated.since 9.5
-
Field Details
-
QUARANTINE_TEST_KEY
Deprecated.since 5.7 useTestQuarantineHelper
instead- See Also:
-
-
Method Details
-
quarantineTest
void quarantineTest(long testId, @NotNull @NotNull com.atlassian.user.User user, @NotNull @NotNull Date date) Quarantines a given test- Parameters:
testId
- - Id of the required test caseuser
- - User quarantining testdate
- - date of test quarantine
-
quarantineTest
void quarantineTest(long testId, @NotNull @NotNull com.atlassian.user.User user, @NotNull @NotNull Date date, @Nullable @Nullable Date expiryDate) Quarantines a given test until a specified date- Parameters:
testId
- - Id of the required test caseuser
- - User quarantining testdate
- - date of test quarantineexpiryDate
- - date of expiry for the quarantine, can be null for permanent quarantine
-
unleashTest
default void unleashTest(long testId) Unleash a given test- Parameters:
testId
- - ID of required test case
-
unleashTest
void unleashTest(long testId, @Nullable @Nullable com.atlassian.user.User user) Unleash a given test- Parameters:
testId
- - ID of required test caseuser
- - user who unleashed test
-
getCurrentlyQuarantinedTests
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 @NotNull List<TestCase> getCurrentlyQuarantinedTests(@NotNull @NotNull ImmutableChain chain) Get a list ofTestCase
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
Returns the number of tests current qurantined for this plan- Parameters:
chain
-- Returns:
-
getQuarantinedTestsListForChainResult
@Nullable @Nullable List<TestCaseResult> getQuarantinedTestsListForChainResult(@NotNull @NotNull ChainResultsSummary chainResultsSummary) Get a list ofTestCase
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 @NotNull List<TestCaseResult> getQuarantinedTestsListForBuildResult(@NotNull @NotNull BuildResultsSummary buildResultsSummary) ReturnsList
ofTestCaseResult
that are quarantined for a given build result.- Parameters:
buildResultsSummary
- - results summary of the build you need quarantined tests for- Returns:
List
ofTestCaseResult
. Empty list if no quarantined tests
-
unleashTestsWithExpiredQuarantine
Deprecated.since 9.5Unleashes all tests with expired quarantine.
-
TestQuarantineHelper
instead