Document RetryBaseAttribute/RetryAttribute introduced in MSTest 3.8 #44635
+9
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-policy-service
bot
added
dotnet-fundamentals/svc
community-contribution
Evangelink
reviewed
Jan 31, 2025
Comment on lines
356
to
365
| ### `RetryBaseAttribute` | ||
|
|
||
| The `RetryBaseAttribute` was introduced in MSTest 3.8. It's an abstract attribute that encapsulates a retry logic to be used when a test fails or timeouts. Implementors of this attribute must implement `ExecuteAsync` method which takes `RetryContext` as a parameter. Whenever a test times out or fails and an implementation of `RetryBaseAttribute` is present on the test method, MSTest will call `ExecuteAsync` of the attribute. | ||
|
|
||
| > [!NOTE] | ||
| > `RetryBaseAttribute.ExecuteAsync` is currently marked as experimental API. | ||
| > | ||
| > [!NOTE] | ||
| > MSTest provides a built-in implementation of `RetryBaseAttribute`, named `RetryAttribute`. | ||
| > The built-in `RetryAttribute` allows to control the maximum number of retry attempts, time delay between retries, and a delay backoff type which is either constant or exponential. You can check out the implementation of `RetryAttribute` on [GitHub](https://github.com/microsoft/testfx/blob/27e0f3da163f3cd651e34395c8759772012b55f9/src/TestFramework/TestFramework/Attributes/TestMethod/RetryAttribute.cs) to have better understanding of how to implement your own custom `RetryBaseAttribute`. |
There was a problem hiding this comment.
I would probably do the opposite and describe here RetryAttribute that is what is useful to end users. We can mention RetryBaseAttribute in a note saying that it allows for user-provided attributes or we could just not mention it here and add a new documentation page about MSTest extensibility.
There was a problem hiding this comment.
@Evangelink Does it look better now?
There was a problem hiding this comment.
@Evangelink Which note? About experimental? That one is already dropped
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes microsoft/testfx#4689
cc @Evangelink
Internal previews