Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix SA1649 warning #2173

Merged
merged 3 commits into from
Jul 4, 2024
Merged

Fix SA1649 warning #2173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9b9846
Fix warning sa1649
Zombach Jul 3, 2024
9296781
Merge branch 'App-vNext:main' into zombach/remive-warning-sa1649-cons…
Zombach Jul 3, 2024
503a5ef
Merge branch 'App-vNext:main' into zombach/remive-warning-sa1649-cons…
Zombach Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...ing/SerializingCacheProviderAsyncSpecs.cs → ...ing/AsyncSerializingCacheProviderSpecs.cs
View file
Open in desktop
File renamed without changes.
0 ...aker/ICircuitBreakerPolicyTResultSpecs.cs → ...aker/ICircuitBreakerTResultPolicySpecs.cs
View file
Open in desktop
File renamed without changes.
148 changes: 0 additions & 148 deletions ...ly.Specs/PolicyContextAndKeyAsyncSpecs.cs → test/Polly.Specs/PolicyKeyAsyncSpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,151 +202,3 @@ await retry.ExecuteAsync<int>(async _ =>
}
#endregion
}

public class PolicyTResultKeyAsyncSpecs
{
#region Configuration

[Fact]
public void Should_be_able_fluently_to_configure_the_policy_key()
{
var policy = Policy.HandleResult<int>(0).RetryAsync().WithPolicyKey(Guid.NewGuid().ToString());

policy.Should().BeAssignableTo<AsyncPolicy<int>>();
}

[Fact]
public void Should_be_able_fluently_to_configure_the_policy_key_via_interface()
{
IAsyncPolicy<int> policyAsInterface = Policy.HandleResult<int>(0).RetryAsync();
var policyAsInterfaceAfterWithPolicyKey = policyAsInterface.WithPolicyKey(Guid.NewGuid().ToString());

policyAsInterfaceAfterWithPolicyKey.Should().BeAssignableTo<IAsyncPolicy<int>>();
}

[Fact]
public void PolicyKey_property_should_be_the_fluently_configured_policy_key()
{
const string Key = "SomePolicyKey";

var policy = Policy.HandleResult(0).RetryAsync().WithPolicyKey(Key);

policy.PolicyKey.Should().Be(Key);
}

[Fact]
public void Should_not_be_able_to_configure_the_policy_key_explicitly_more_than_once()
{
var policy = Policy.HandleResult(0).RetryAsync();

Action configure = () => policy.WithPolicyKey(Guid.NewGuid().ToString());

configure.Should().NotThrow();

configure.Should().Throw<ArgumentException>().And.ParamName.Should().Be("policyKey");
}

[Fact]
public void Should_not_be_able_to_configure_the_policy_key_explicitly_more_than_once_via_interface()
{
IAsyncPolicy<int> policyAsInterface = Policy.HandleResult(0).RetryAsync();
Action configure = () => policyAsInterface.WithPolicyKey(Guid.NewGuid().ToString());

configure.Should().NotThrow();

configure.Should().Throw<ArgumentException>().And.ParamName.Should().Be("policyKey");
}

[Fact]
public void PolicyKey_property_should_be_non_null_or_empty_if_not_explicitly_configured()
{
var policy = Policy.HandleResult(0).RetryAsync();

policy.PolicyKey.Should().NotBeNullOrEmpty();
}

[Fact]
public void PolicyKey_property_should_start_with_policy_type_if_not_explicitly_configured()
{
var policy = Policy.HandleResult(0).RetryAsync();

policy.PolicyKey.Should().StartWith("AsyncRetry");
}

[Fact]
public void PolicyKey_property_should_be_unique_for_different_instances_if_not_explicitly_configured()
{
var policy1 = Policy.HandleResult(0).RetryAsync();
var policy2 = Policy.HandleResult(0).RetryAsync();

policy1.PolicyKey.Should().NotBe(policy2.PolicyKey);
}

[Fact]
public void PolicyKey_property_should_return_consistent_value_for_same_policy_instance_if_not_explicitly_configured()
{
var policy = Policy.HandleResult(0).RetryAsync();

var keyRetrievedFirst = policy.PolicyKey;
var keyRetrievedSecond = policy.PolicyKey;

keyRetrievedSecond.Should().Be(keyRetrievedFirst);
}

[Fact]
public void Should_not_be_able_to_configure_the_policy_key_explicitly_after_retrieving_default_value()
{
var policy = Policy.HandleResult(0).RetryAsync();

string retrieveKeyWhenNotExplicitlyConfigured = policy.PolicyKey;

Action configure = () => policy.WithPolicyKey(Guid.NewGuid().ToString());

configure.Should().Throw<ArgumentException>().And.ParamName.Should().Be("policyKey");
}

#endregion

#region PolicyKey and execution Context tests

[Fact]
public async Task Should_pass_PolicyKey_to_execution_context()
{
string policyKey = Guid.NewGuid().ToString();

string? policyKeySetOnExecutionContext = null;
Action<DelegateResult<ResultPrimitive>, int, Context> onRetry = (_, _, context) => { policyKeySetOnExecutionContext = context.PolicyKey; };
var retry = Policy.HandleResult(ResultPrimitive.Fault).RetryAsync(1, onRetry).WithPolicyKey(policyKey);

await retry.RaiseResultSequenceAsync(ResultPrimitive.Fault, ResultPrimitive.Good);

policyKeySetOnExecutionContext.Should().Be(policyKey);
}

[Fact]
public async Task Should_pass_OperationKey_to_execution_context()
{
string operationKey = "SomeKey";

string? operationKeySetOnContext = null;
Action<DelegateResult<ResultPrimitive>, int, Context> onRetry = (_, _, context) => { operationKeySetOnContext = context.OperationKey; };
var retry = Policy.HandleResult(ResultPrimitive.Fault).RetryAsync(1, onRetry);

bool firstExecution = true;
await retry.ExecuteAsync(async _ =>
{
await TaskHelper.EmptyTask;
if (firstExecution)
{
firstExecution = false;
return ResultPrimitive.Fault;
}

return ResultPrimitive.Good;
}, new Context(operationKey));

operationKeySetOnContext.Should().Be(operationKey);
}

#endregion
}
136 changes: 0 additions & 136 deletions test/Polly.Specs/PolicyContextAndKeySpecs.cs → test/Polly.Specs/PolicyKeySpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,139 +180,3 @@ public void Should_pass_OperationKey_to_execution_context_in_generic_execution_o
}
#endregion
}

public class PolicyTResultKeySpecs
{
#region Configuration

[Fact]
public void Should_be_able_fluently_to_configure_the_policy_key()
{
var policy = Policy.HandleResult<int>(0).Retry().WithPolicyKey(Guid.NewGuid().ToString());

policy.Should().BeAssignableTo<Policy<int>>();
}

[Fact]
public void Should_be_able_fluently_to_configure_the_policy_key_via_interface()
{
ISyncPolicy<int> policyAsInterface = Policy.HandleResult<int>(0).Retry();
var policyAsInterfaceAfterWithPolicyKey = policyAsInterface.WithPolicyKey(Guid.NewGuid().ToString());

policyAsInterfaceAfterWithPolicyKey.Should().BeAssignableTo<ISyncPolicy<int>>();
}

[Fact]
public void PolicyKey_property_should_be_the_fluently_configured_policy_key()
{
const string Key = "SomePolicyKey";

var policy = Policy.HandleResult(0).Retry().WithPolicyKey(Key);

policy.PolicyKey.Should().Be(Key);
}

[Fact]
public void Should_not_be_able_to_configure_the_policy_key_explicitly_more_than_once()
{
var policy = Policy.HandleResult(0).Retry();

Action configure = () => policy.WithPolicyKey(Guid.NewGuid().ToString());

configure.Should().NotThrow();

configure.Should().Throw<ArgumentException>().And.ParamName.Should().Be("policyKey");
}

[Fact]
public void PolicyKey_property_should_be_non_null_or_empty_if_not_explicitly_configured()
{
var policy = Policy.HandleResult(0).Retry();

policy.PolicyKey.Should().NotBeNullOrEmpty();
}

[Fact]
public void PolicyKey_property_should_start_with_policy_type_if_not_explicitly_configured()
{
var policy = Policy.HandleResult(0).Retry();

policy.PolicyKey.Should().StartWith("Retry");
}

[Fact]
public void PolicyKey_property_should_be_unique_for_different_instances_if_not_explicitly_configured()
{
var policy1 = Policy.HandleResult(0).Retry();
var policy2 = Policy.HandleResult(0).Retry();

policy1.PolicyKey.Should().NotBe(policy2.PolicyKey);
}

[Fact]
public void PolicyKey_property_should_return_consistent_value_for_same_policy_instance_if_not_explicitly_configured()
{
var policy = Policy.HandleResult(0).Retry();

var keyRetrievedFirst = policy.PolicyKey;
var keyRetrievedSecond = policy.PolicyKey;

keyRetrievedSecond.Should().Be(keyRetrievedFirst);
}

[Fact]
public void Should_not_be_able_to_configure_the_policy_key_explicitly_after_retrieving_default_value()
{
var policy = Policy.HandleResult(0).Retry();

string retrieveKeyWhenNotExplicitlyConfigured = policy.PolicyKey;

Action configure = () => policy.WithPolicyKey(Guid.NewGuid().ToString());

configure.Should().Throw<ArgumentException>().And.ParamName.Should().Be("policyKey");
}

#endregion

#region PolicyKey and execution Context tests

[Fact]
public void Should_pass_PolicyKey_to_execution_context()
{
string policyKey = Guid.NewGuid().ToString();

string? policyKeySetOnExecutionContext = null;
Action<DelegateResult<ResultPrimitive>, int, Context> onRetry = (_, _, context) => { policyKeySetOnExecutionContext = context.PolicyKey; };
var retry = Policy.HandleResult(ResultPrimitive.Fault).Retry(1, onRetry).WithPolicyKey(policyKey);

retry.RaiseResultSequence(ResultPrimitive.Fault, ResultPrimitive.Good);

policyKeySetOnExecutionContext.Should().Be(policyKey);
}

[Fact]
public void Should_pass_OperationKey_to_execution_context()
{
string operationKey = "SomeKey";

string? operationKeySetOnContext = null;
Action<DelegateResult<ResultPrimitive>, int, Context> onRetry = (_, _, context) => { operationKeySetOnContext = context.OperationKey; };
var retry = Policy.HandleResult(ResultPrimitive.Fault).Retry(1, onRetry);

bool firstExecution = true;
retry.Execute(_ =>
{
if (firstExecution)
{
firstExecution = false;
return ResultPrimitive.Fault;
}

return ResultPrimitive.Good;
}, new Context(operationKey));

operationKeySetOnContext.Should().Be(operationKey);
}

#endregion
}
Loading