[Docs] Mocking of ResiliencePipelineProvider (#1662)

App-vNext · Sep 29, 2023 · 2e82960 · 2e82960
1 parent 305e0c3
commit 2e82960
Show file tree

Hide file tree

Showing 3 changed files with 140 additions and 1 deletion.
diff --git a/docs/advanced/testing.md b/docs/advanced/testing.md
@@ -61,3 +61,75 @@ ResiliencePipelineDescriptor descriptor = pipeline.GetPipelineDescriptor();
 // ...
 ```
 <!-- endSnippet -->
+
+## Mocking `ResiliencePipelineProvider<TKey>`
+
+Consider the following code that might resemble a part of your project:
+
+<!-- snippet: testing-resilience-pipeline-provider-usage -->
+```cs
+// Represents an arbitrary API that needs resilience support
+public class MyApi
+{
+    private readonly ResiliencePipeline _pipeline;
+
+    // The value of pipelineProvider is injected via dependency injection
+    public MyApi(ResiliencePipelineProvider<string> pipelineProvider)
+    {
+        _pipeline = pipelineProvider.GetPipeline("my-pipeline");
+    }
+
+    public async Task ExecuteAsync(CancellationToken cancellationToken)
+    {
+        await _pipeline.ExecuteAsync(
+            static async token =>
+            {
+                // Add your code here
+            },
+            cancellationToken);
+    }
+}
+
+// Extensions to incorporate MyApi into dependency injection
+public static class MyApiExtensions
+{
+    public static IServiceCollection AddMyApi(this IServiceCollection services)
+    {
+        return services
+            .AddResiliencePipeline("my-pipeline", builder =>
+            {
+                builder.AddRetry(new RetryStrategyOptions
+                {
+                    MaxRetryAttempts = 4
+                });
+            })
+            .AddSingleton<MyApi>();
+    }
+}
+```
+<!-- endSnippet -->
+
+In the example above:
+
+- The `MyApi` class is introduced, representing part of your application that requires resilience support.
+- The `AddMyApi` extension method is also defined, which integrates `MyApi` into dependency injection (DI) and sets up the resilience pipeline it uses.
+
+For unit tests, if you want to assess the behavior of `ExecuteAsync`, it might not be practical to rely on the entire pipeline, especially since it could slow down tests during failure scenario evaluations. Instead, it's recommended to mock the `ResiliencePipelineProvider<string>` and return an empty pipeline:
+
+<!-- snippet: testing-resilience-pipeline-provider-mocking -->
+```cs
+ResiliencePipelineProvider<string> pipelineProvider = Substitute.For<ResiliencePipelineProvider<string>>();
+
+// Mock the pipeline provider to return an empty pipeline for testing
+pipelineProvider
+    .GetPipeline("my-pipeline")
+    .Returns(ResiliencePipeline.Empty);
+
+// Use the mocked pipeline provider in your code
+var api = new MyApi(pipelineProvider);
+
+// You can now test the api
+```
+<!-- endSnippet -->
+
+This example leverages the [`NSubstitute`](https://github.com/nsubstitute/NSubstitute) library to mock the pipeline provider.
diff --git a/src/Snippets/Docs/Testing.cs b/src/Snippets/Docs/Testing.cs
@@ -1,4 +1,7 @@
-using Polly.Retry;
+using Microsoft.Extensions.DependencyInjection;
+using NSubstitute;
+using Polly.Registry;
+using Polly.Retry;
 using Polly.Testing;
 using Polly.Timeout;
 using Xunit;
@@ -58,4 +61,66 @@ public static void GetPipelineDescriptorGeneric()
 
         #endregion
     }
+
+    public static void PipelineProviderProviderMocking()
+    {
+        #region testing-resilience-pipeline-provider-mocking
+
+        ResiliencePipelineProvider<string> pipelineProvider = Substitute.For<ResiliencePipelineProvider<string>>();
+
+        // Mock the pipeline provider to return an empty pipeline for testing
+        pipelineProvider
+            .GetPipeline("my-pipeline")
+            .Returns(ResiliencePipeline.Empty);
+
+        // Use the mocked pipeline provider in your code
+        var api = new MyApi(pipelineProvider);
+
+        // You can now test the api
+
+        #endregion
+    }
+}
+
+#region testing-resilience-pipeline-provider-usage
+
+// Represents an arbitrary API that needs resilience support
+public class MyApi
+{
+    private readonly ResiliencePipeline _pipeline;
+
+    // The value of pipelineProvider is injected via dependency injection
+    public MyApi(ResiliencePipelineProvider<string> pipelineProvider)
+    {
+        _pipeline = pipelineProvider.GetPipeline("my-pipeline");
+    }
+
+    public async Task ExecuteAsync(CancellationToken cancellationToken)
+    {
+        await _pipeline.ExecuteAsync(
+            static async token =>
+            {
+                // Add your code here
+            },
+            cancellationToken);
+    }
+}
+
+// Extensions to incorporate MyApi into dependency injection
+public static class MyApiExtensions
+{
+    public static IServiceCollection AddMyApi(this IServiceCollection services)
+    {
+        return services
+            .AddResiliencePipeline("my-pipeline", builder =>
+            {
+                builder.AddRetry(new RetryStrategyOptions
+                {
+                    MaxRetryAttempts = 4
+                });
+            })
+            .AddSingleton<MyApi>();
+    }
 }
+
+#endregion
diff --git a/src/Snippets/Snippets.csproj b/src/Snippets/Snippets.csproj
@@ -9,6 +9,7 @@
     <GenerateDocumentationFile>false</GenerateDocumentationFile>
     <IsPackable>false</IsPackable>
     <NoWarn>$(NoWarn);SA1123;SA1515;CA2000;CA2007;CA1303;IDE0021;IDE0017;IDE0060;CS1998;CA1064;S3257;IDE0028;CA1031;CA1848</NoWarn>
+    <NoWarn>$(NoWarn);RS0016;SA1402;SA1600;RS0037;CA1062;SA1204</NoWarn>
     <RootNamespace>Snippets</RootNamespace>
     <EnablePackageValidation>false</EnablePackageValidation>
   </PropertyGroup>
@@ -23,6 +24,7 @@
     <ProjectReference Include="..\Polly.RateLimiting\Polly.RateLimiting.csproj" />
     <ProjectReference Include="..\Polly.Testing\Polly.Testing.csproj" />
     <ProjectReference Include="..\Polly\Polly.csproj" />
+    <PackageReference Include="NSubstitute" />
 
     <Using Include="Polly" />
   </ItemGroup>