Improve Polly coverage (#2505)

Extend coverage for unit tests and mutations with low-hanging fruit parameter validation and redundant code.

Author: martincostello

src/Polly/Bulkhead/AsyncBulkheadPolicy.cs

@@ -19,7 +19,7 @@ internal AsyncBulkheadPolicy(
         Func<Context, Task> onBulkheadRejectedAsync)
     {
         _maxQueueingActions = maxQueueingActions;
-        _onBulkheadRejectedAsync = onBulkheadRejectedAsync ?? throw new ArgumentNullException(nameof(onBulkheadRejectedAsync));
+        _onBulkheadRejectedAsync = onBulkheadRejectedAsync;
 
         (_maxParallelizationSemaphore, _maxQueuedActionsSemaphore) = BulkheadSemaphoreFactory.CreateBulkheadSemaphores(maxParallelization, maxQueueingActions);
     }
@@ -87,7 +87,7 @@ internal AsyncBulkheadPolicy(
         Func<Context, Task> onBulkheadRejectedAsync)
     {
         _maxQueueingActions = maxQueueingActions;
-        _onBulkheadRejectedAsync = onBulkheadRejectedAsync ?? throw new ArgumentNullException(nameof(onBulkheadRejectedAsync));
+        _onBulkheadRejectedAsync = onBulkheadRejectedAsync;
 
         (_maxParallelizationSemaphore, _maxQueuedActionsSemaphore) = BulkheadSemaphoreFactory.CreateBulkheadSemaphores(maxParallelization, maxQueueingActions);
     }

src/Polly/Bulkhead/BulkheadPolicy.cs

@@ -19,7 +19,7 @@ internal BulkheadPolicy(
         Action<Context> onBulkheadRejected)
     {
         _maxQueueingActions = maxQueueingActions;
-        _onBulkheadRejected = onBulkheadRejected ?? throw new ArgumentNullException(nameof(onBulkheadRejected));
+        _onBulkheadRejected = onBulkheadRejected;
 
         (_maxParallelizationSemaphore, _maxQueuedActionsSemaphore) = BulkheadSemaphoreFactory.CreateBulkheadSemaphores(maxParallelization, maxQueueingActions);
     }
@@ -85,7 +85,7 @@ internal BulkheadPolicy(
         Action<Context> onBulkheadRejected)
     {
         _maxQueueingActions = maxQueueingActions;
-        _onBulkheadRejected = onBulkheadRejected ?? throw new ArgumentNullException(nameof(onBulkheadRejected));
+        _onBulkheadRejected = onBulkheadRejected;
 
         (_maxParallelizationSemaphore, _maxQueuedActionsSemaphore) = BulkheadSemaphoreFactory.CreateBulkheadSemaphores(maxParallelization, maxQueueingActions);
     }

src/Polly/Fallback/AsyncFallbackPolicy.cs

@@ -9,12 +9,14 @@ public class AsyncFallbackPolicy : AsyncPolicy, IFallbackPolicy
     private readonly Func<Exception, Context, Task> _onFallbackAsync;
     private readonly Func<Exception, Context, CancellationToken, Task> _fallbackAction;
 
-    internal AsyncFallbackPolicy(PolicyBuilder policyBuilder, Func<Exception, Context, Task> onFallbackAsync,
+    internal AsyncFallbackPolicy(
+        PolicyBuilder policyBuilder,
+        Func<Exception, Context, Task> onFallbackAsync,
         Func<Exception, Context, CancellationToken, Task> fallbackAction)
        : base(policyBuilder)
     {
-        _onFallbackAsync = onFallbackAsync ?? throw new ArgumentNullException(nameof(onFallbackAsync));
-        _fallbackAction = fallbackAction ?? throw new ArgumentNullException(nameof(fallbackAction));
+        _onFallbackAsync = onFallbackAsync;
+        _fallbackAction = fallbackAction;
     }
 
     /// <inheritdoc/>
@@ -65,8 +67,8 @@ internal AsyncFallbackPolicy(
         Func<DelegateResult<TResult>, Context, CancellationToken, Task<TResult>> fallbackAction)
         : base(policyBuilder)
     {
-        _onFallbackAsync = onFallbackAsync ?? throw new ArgumentNullException(nameof(onFallbackAsync));
-        _fallbackAction = fallbackAction ?? throw new ArgumentNullException(nameof(fallbackAction));
+        _onFallbackAsync = onFallbackAsync;
+        _fallbackAction = fallbackAction;
     }
 
     /// <inheritdoc/>

src/Polly/Fallback/FallbackPolicy.cs

@@ -15,14 +15,14 @@ internal FallbackPolicy(
         Action<Exception, Context, CancellationToken> fallbackAction)
         : base(policyBuilder)
     {
-        _onFallback = onFallback ?? throw new ArgumentNullException(nameof(onFallback));
-        _fallbackAction = fallbackAction ?? throw new ArgumentNullException(nameof(fallbackAction));
+        _onFallback = onFallback;
+        _fallbackAction = fallbackAction;
     }
 
     /// <inheritdoc/>
     [DebuggerStepThrough]
     protected override void Implementation(Action<Context, CancellationToken> action, Context context, CancellationToken cancellationToken) =>
-        FallbackEngine.Implementation<EmptyStruct>(
+        FallbackEngine.Implementation(
             (ctx, token) =>
             {
                 action(ctx, token);
@@ -62,8 +62,8 @@ internal FallbackPolicy(
         Func<DelegateResult<TResult>, Context, CancellationToken, TResult> fallbackAction)
         : base(policyBuilder)
     {
-        _onFallback = onFallback ?? throw new ArgumentNullException(nameof(onFallback));
-        _fallbackAction = fallbackAction ?? throw new ArgumentNullException(nameof(fallbackAction));
+        _onFallback = onFallback;
+        _fallbackAction = fallbackAction;
     }
 
     /// <inheritdoc/>

src/Polly/Polly.csproj

@@ -5,7 +5,7 @@
     <AssemblyTitle>Polly</AssemblyTitle>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <ProjectType>Library</ProjectType>
-    <MutationScore>70</MutationScore>
+    <MutationScore>80</MutationScore>
     <IncludePollyUsings>true</IncludePollyUsings>
     <!-- We do not plan on enabling nullable annotations for Polly -->
     <NoWarn>$(NoWarn);RS0037</NoWarn>

src/Polly/RateLimit/AsyncRateLimitPolicy.cs

@@ -9,7 +9,7 @@ public class AsyncRateLimitPolicy : AsyncPolicy, IRateLimitPolicy
     private readonly IRateLimiter _rateLimiter;
 
     internal AsyncRateLimitPolicy(IRateLimiter rateLimiter) =>
-        _rateLimiter = rateLimiter ?? throw new ArgumentNullException(nameof(rateLimiter));
+        _rateLimiter = rateLimiter;
 
     /// <inheritdoc/>
     [DebuggerStepThrough]
@@ -47,7 +47,7 @@ internal AsyncRateLimitPolicy(
         IRateLimiter rateLimiter,
         Func<TimeSpan, Context, TResult>? retryAfterFactory)
     {
-        _rateLimiter = rateLimiter ?? throw new ArgumentNullException(nameof(rateLimiter));
+        _rateLimiter = rateLimiter;
         _retryAfterFactory = retryAfterFactory;
     }
 

src/Polly/RateLimit/LockFreeTokenBucketRateLimiter.cs

@@ -33,11 +33,6 @@ public LockFreeTokenBucketRateLimiter(TimeSpan onePer, long bucketCapacity)
             throw new ArgumentOutOfRangeException(nameof(onePer), onePer, $"The {nameof(LockFreeTokenBucketRateLimiter)} must specify a positive TimeSpan for how often an execution is permitted.");
         }
 
-        if (bucketCapacity <= 0)
-        {
-            throw new ArgumentOutOfRangeException(nameof(bucketCapacity), bucketCapacity, $"{nameof(bucketCapacity)} must be greater than or equal to 1.");
-        }
-
         _addTokenTickInterval = onePer.Ticks;
         _bucketCapacity = bucketCapacity;
 
@@ -82,6 +77,7 @@ public LockFreeTokenBucketRateLimiter(TimeSpan onePer, long bucketCapacity)
             long tokensToAdd = Math.Min(_bucketCapacity, tokensMissedAdding);
 
             // Work out when tokens would next be due to be added, if we add these tokens.
+            // stryker disable once all : no means to test this
             long newAddNextTokenAtTicks = currentAddNextTokenAtTicks + (tokensToAdd * _addTokenTickInterval);
 
             // But if we were way overdue refilling the bucket (there was inactivity for a while), that value would be out-of-date: the next time we add tokens must be at least addTokenTickInterval from now.

src/Polly/RateLimit/RateLimitPolicy.cs

@@ -9,7 +9,7 @@ public class RateLimitPolicy : Policy, IRateLimitPolicy
     private readonly IRateLimiter _rateLimiter;
 
     internal RateLimitPolicy(IRateLimiter rateLimiter) =>
-        _rateLimiter = rateLimiter ?? throw new ArgumentNullException(nameof(rateLimiter));
+        _rateLimiter = rateLimiter;
 
     /// <inheritdoc/>
     [DebuggerStepThrough]
@@ -37,7 +37,7 @@ internal RateLimitPolicy(
         IRateLimiter rateLimiter,
         Func<TimeSpan, Context, TResult>? retryAfterFactory)
     {
-        _rateLimiter = rateLimiter ?? throw new ArgumentNullException(nameof(rateLimiter));
+        _rateLimiter = rateLimiter;
         _retryAfterFactory = retryAfterFactory;
     }
 

src/Polly/Registry/PolicyRegistry.cs

@@ -25,8 +25,13 @@ public PolicyRegistry()
     /// <remarks>This internal constructor exists solely to facilitate testing of the GetEnumerator() methods, which allow us to support collection initialisation syntax.</remarks>
     /// </summary>
     /// <param name="registry">a dictionary containing keys and policies used for testing.</param>
-    internal PolicyRegistry(IDictionary<string, IsPolicy> registry) =>
-        _registry = registry ?? throw new ArgumentNullException(nameof(registry));
+    internal PolicyRegistry(IDictionary<string, IsPolicy> registry)
+    {
+#pragma warning disable S3236 // Remove this argument from the method call; it hides the caller information.
+        Debug.Assert(registry != null, "This constructor is for testing only, and should not be called with a null registry.");
+#pragma warning restore S3236 // Remove this argument from the method call; it hides the caller information.
+        _registry = registry;
+    }
 
     private ConcurrentDictionary<string, IsPolicy> ThrowIfNotConcurrentImplementation()
     {

src/Polly/Retry/AsyncRetryPolicy.cs

@@ -21,7 +21,7 @@ internal AsyncRetryPolicy(
         _permittedRetryCount = permittedRetryCount;
         _sleepDurationsEnumerable = sleepDurationsEnumerable;
         _sleepDurationProvider = sleepDurationProvider;
-        _onRetryAsync = onRetryAsync ?? throw new ArgumentNullException(nameof(onRetryAsync));
+        _onRetryAsync = onRetryAsync;
     }
 
     /// <inheritdoc/>
@@ -78,7 +78,7 @@ internal AsyncRetryPolicy(
         _permittedRetryCount = permittedRetryCount;
         _sleepDurationsEnumerable = sleepDurationsEnumerable;
         _sleepDurationProvider = sleepDurationProvider;
-        _onRetryAsync = onRetryAsync ?? throw new ArgumentNullException(nameof(onRetryAsync));
+        _onRetryAsync = onRetryAsync;
     }
 
     /// <inheritdoc/>