-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into mtomka/fix-unstable-test
- Loading branch information
Showing
14 changed files
with
278 additions
and
5 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| namespace Polly.Testing; | ||
|
|
||
| /// <summary> | ||
| /// Describes the pipeline of a resilience strategy. | ||
| /// </summary> | ||
| /// <param name="Strategies">The strategies the pipeline is composed of.</param> | ||
| /// <param name="HasTelemetry">Gets a value indicating whether the pipeline has telemetry enabled.</param> | ||
| /// <param name="IsReloadable">Gets a value indicating whether the resilience strategy is reloadable.</param> | ||
| public record class InnerStrategiesDescriptor(IReadOnlyList<ResilienceStrategyDescriptor> Strategies, bool HasTelemetry, bool IsReloadable); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFrameworks>netstandard2.0</TargetFrameworks> | ||
| <AssemblyTitle>Polly.Testing</AssemblyTitle> | ||
| <RootNamespace>Polly.Testing</RootNamespace> | ||
| <Nullable>enable</Nullable> | ||
| <GenerateDocumentationFile>true</GenerateDocumentationFile> | ||
| <ProjectType>Library</ProjectType> | ||
| <MutationScore>100</MutationScore> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\Polly.Core\Polly.Core.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # About Polly.Testing | ||
|
|
||
| This package exposes APIs and utilities that can be used to assert on the composition of resilience strategies. | ||
|
|
||
| ``` csharp | ||
| // Build your resilience strategy. | ||
| ResilienceStrategy strategy = new ResilienceStrategyBuilder() | ||
| .AddRetry(new RetryStrategyOptions | ||
| { | ||
| RetryCount = 4 | ||
| }) | ||
| .AddTimeout(TimeSpan.FromSeconds(1)) | ||
| .ConfigureTelemetry(NullLoggerFactory.Instance) | ||
| .Build(); | ||
|
|
||
| // Retrieve inner strategies. | ||
| InnerStrategiesDescriptor descriptor = strategy.GetInnerStrategies(); | ||
|
|
||
| // Assert the composition. | ||
| Assert.True(descriptor.HasTelemetry); | ||
| Assert.Equal(2, descriptor.Strategies.Count); | ||
|
|
||
| var retryOptions = Assert.IsType<RetryStrategyOptions>(descriptor.Strategies[0]); | ||
| Assert.Equal(4, retryOptions.RetryCount); | ||
|
|
||
| var timeoutOptions = Assert.IsType<TimeoutStrategyOptions>(descriptor.Strategies[0]); | ||
| Assert.Equal(TimeSpan.FromSeconds(1), timeoutOptions.Timeout); | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| namespace Polly.Testing; | ||
|
|
||
| /// <summary> | ||
| /// This class provides additional information about a <see cref="ResilienceStrategy"/>. | ||
| /// </summary> | ||
| /// <param name="Options">The options used by the resilience strategy, if any.</param> | ||
| /// <param name="StrategyType">The type of the strategy.</param> | ||
| public record ResilienceStrategyDescriptor(ResilienceStrategyOptions? Options, Type StrategyType) | ||
| { | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| using Polly.Utils; | ||
|
|
||
| namespace Polly.Testing; | ||
|
|
||
| /// <summary> | ||
| /// The test-related extensions for <see cref="ResilienceStrategy"/> and <see cref="ResilienceStrategy{TResult}"/>. | ||
| /// </summary> | ||
| public static class ResilienceStrategyExtensions | ||
| { | ||
| private const string TelemetryResilienceStrategy = "Polly.Extensions.Telemetry.TelemetryResilienceStrategy"; | ||
|
|
||
| /// <summary> | ||
| /// Gets the inner strategies the <paramref name="strategy"/> is composed of. | ||
| /// </summary> | ||
| /// <typeparam name="TResult">The type of result.</typeparam> | ||
| /// <param name="strategy">The strategy instance.</param> | ||
| /// <returns>A list of inner strategies.</returns> | ||
| /// <exception cref="ArgumentNullException">Thrown when <paramref name="strategy"/> is <see langword="null"/>.</exception> | ||
| public static InnerStrategiesDescriptor GetInnerStrategies<TResult>(this ResilienceStrategy<TResult> strategy) | ||
| { | ||
| Guard.NotNull(strategy); | ||
|
|
||
| return strategy.Strategy.GetInnerStrategies(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the inner strategies the <paramref name="strategy"/> is composed of. | ||
| /// </summary> | ||
| /// <param name="strategy">The strategy instance.</param> | ||
| /// <returns>A list of inner strategies.</returns> | ||
| /// <exception cref="ArgumentNullException">Thrown when <paramref name="strategy"/> is <see langword="null"/>.</exception> | ||
| public static InnerStrategiesDescriptor GetInnerStrategies(this ResilienceStrategy strategy) | ||
| { | ||
| Guard.NotNull(strategy); | ||
|
|
||
| var strategies = new List<ResilienceStrategy>(); | ||
| strategy.ExpandStrategies(strategies); | ||
|
|
||
| var innerStrategies = strategies.Select(s => new ResilienceStrategyDescriptor(s.Options, s.GetType())).ToList(); | ||
|
|
||
| return new InnerStrategiesDescriptor( | ||
| innerStrategies.Where(s => !ShouldSkip(s.StrategyType)).ToList().AsReadOnly(), | ||
| HasTelemetry: innerStrategies.Exists(s => s.StrategyType.FullName == TelemetryResilienceStrategy), | ||
| IsReloadable: innerStrategies.Exists(s => s.StrategyType == typeof(ReloadableResilienceStrategy))); | ||
| } | ||
|
|
||
| private static bool ShouldSkip(Type type) => type == typeof(ReloadableResilienceStrategy) || type.FullName == TelemetryResilienceStrategy; | ||
|
|
||
| private static void ExpandStrategies(this ResilienceStrategy strategy, List<ResilienceStrategy> strategies) | ||
| { | ||
| if (strategy is ResilienceStrategyPipeline pipeline) | ||
| { | ||
| foreach (var inner in pipeline.Strategies) | ||
| { | ||
| inner.ExpandStrategies(strategies); | ||
| } | ||
| } | ||
| else if (strategy is ReloadableResilienceStrategy reloadable) | ||
| { | ||
| strategies.Add(reloadable); | ||
| ExpandStrategies(reloadable.Strategy, strategies); | ||
| } | ||
| else | ||
| { | ||
| strategies.Add(strategy); | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>net7.0;net6.0</TargetFrameworks> | ||
| <TargetFrameworks Condition="$([MSBuild]::IsOSPlatform('Windows'))">$(TargetFrameworks);net481</TargetFrameworks> | ||
| <ProjectType>Test</ProjectType> | ||
| <Nullable>enable</Nullable> | ||
| <Threshold>100</Threshold> | ||
| <NoWarn>$(NoWarn);SA1600;SA1204</NoWarn> | ||
| <Include>[Polly.Testing]*</Include> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\Polly.Extensions\Polly.Extensions.csproj" /> | ||
| <ProjectReference Include="..\..\src\Polly.RateLimiting\Polly.RateLimiting.csproj" /> | ||
| <ProjectReference Include="..\..\src\Polly.Testing\Polly.Testing.csproj" /> | ||
| </ItemGroup> | ||
| </Project> |
102 changes: 102 additions & 0 deletions
102
test/Polly.Testing.Tests/ResilienceStrategyExtensionsTests.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| using System; | ||
| using FluentAssertions; | ||
| using Microsoft.Extensions.Logging.Abstractions; | ||
| using Polly.CircuitBreaker; | ||
| using Polly.Fallback; | ||
| using Polly.Hedging; | ||
| using Polly.RateLimiting; | ||
| using Polly.Registry; | ||
| using Polly.Retry; | ||
| using Polly.Timeout; | ||
|
|
||
| namespace Polly.Testing.Tests; | ||
|
|
||
| public class ResilienceStrategyExtensionsTests | ||
| { | ||
| [Fact] | ||
| public void GetInnerStrategies_Ok() | ||
| { | ||
| // arrange | ||
| var strategy = new ResilienceStrategyBuilder<string>() | ||
| .AddFallback(new() | ||
| { | ||
| FallbackAction = _ => Outcome.FromResultAsTask("dummy"), | ||
| }) | ||
| .AddRetry(new()) | ||
| .AddAdvancedCircuitBreaker(new()) | ||
| .AddTimeout(TimeSpan.FromSeconds(1)) | ||
| .AddHedging(new()) | ||
| .AddConcurrencyLimiter(10) | ||
| .AddStrategy(new CustomStrategy()) | ||
| .ConfigureTelemetry(NullLoggerFactory.Instance) | ||
| .Build(); | ||
|
|
||
| // act | ||
| var descriptor = strategy.GetInnerStrategies(); | ||
|
|
||
| // assert | ||
| descriptor.HasTelemetry.Should().BeTrue(); | ||
| descriptor.IsReloadable.Should().BeFalse(); | ||
| descriptor.Strategies.Should().HaveCount(7); | ||
| descriptor.Strategies[0].Options.Should().BeOfType<FallbackStrategyOptions<string>>(); | ||
| descriptor.Strategies[1].Options.Should().BeOfType<RetryStrategyOptions<string>>(); | ||
| descriptor.Strategies[2].Options.Should().BeOfType<AdvancedCircuitBreakerStrategyOptions<string>>(); | ||
| descriptor.Strategies[3].Options.Should().BeOfType<TimeoutStrategyOptions>(); | ||
| descriptor.Strategies[3].Options | ||
| .Should() | ||
| .BeOfType<TimeoutStrategyOptions>().Subject.Timeout | ||
| .Should().Be(TimeSpan.FromSeconds(1)); | ||
|
|
||
| descriptor.Strategies[4].Options.Should().BeOfType<HedgingStrategyOptions<string>>(); | ||
| descriptor.Strategies[5].Options.Should().BeOfType<RateLimiterStrategyOptions>(); | ||
| descriptor.Strategies[6].StrategyType.Should().Be(typeof(CustomStrategy)); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void GetInnerStrategies_SingleStrategy_Ok() | ||
| { | ||
| // arrange | ||
| var strategy = new ResilienceStrategyBuilder<string>() | ||
| .AddTimeout(TimeSpan.FromSeconds(1)) | ||
| .Build(); | ||
|
|
||
| // act | ||
| var descriptor = strategy.GetInnerStrategies(); | ||
|
|
||
| // assert | ||
| descriptor.HasTelemetry.Should().BeFalse(); | ||
| descriptor.IsReloadable.Should().BeFalse(); | ||
| descriptor.Strategies.Should().HaveCount(1); | ||
| descriptor.Strategies[0].Options.Should().BeOfType<TimeoutStrategyOptions>(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void GetInnerStrategies_Reloadable_Ok() | ||
| { | ||
| // arrange | ||
| var strategy = new ResilienceStrategyRegistry<string>().GetOrAddStrategy("dummy", (builder, context) => | ||
| { | ||
| context.EnableReloads(() => () => CancellationToken.None); | ||
| builder | ||
| .AddConcurrencyLimiter(10) | ||
| .AddStrategy(new CustomStrategy()); | ||
| }); | ||
|
|
||
| // act | ||
| var descriptor = strategy.GetInnerStrategies(); | ||
|
|
||
| // assert | ||
| descriptor.HasTelemetry.Should().BeFalse(); | ||
| descriptor.IsReloadable.Should().BeTrue(); | ||
| descriptor.Strategies.Should().HaveCount(2); | ||
| descriptor.Strategies[0].Options.Should().BeOfType<RateLimiterStrategyOptions>(); | ||
| descriptor.Strategies[1].StrategyType.Should().Be(typeof(CustomStrategy)); | ||
| } | ||
|
|
||
| private sealed class CustomStrategy : ResilienceStrategy | ||
| { | ||
| protected override ValueTask<Outcome<TResult>> ExecuteCoreAsync<TResult, TState>(Func<ResilienceContext, TState, ValueTask<Outcome<TResult>>> callback, ResilienceContext context, TState state) | ||
| => throw new NotSupportedException(); | ||
| } | ||
| } |