Skip to content

Update AZC00002 to match method pair with required requestcontext and optional convenience method #6156

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

Merged
pshao25 merged 8 commits into from
Jun 13, 2023
Merged

Update AZC00002 to match method pair with required requestcontext and optional convenience method #6156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7de847e
Update AZC00002 to match method pair with required requestcontext and
pshao25 May 12, 2023
80cc9a1
Update
pshao25 May 15, 2023
076845d
Resolve comments
pshao25 May 16, 2023
14ae319
Resolve comments
pshao25 May 24, 2023
b176ba0
Update
pshao25 May 31, 2023
bc338fa
Update
pshao25 May 31, 2023
f988c29
Fix
pshao25 May 31, 2023
e817daf
Fix
pshao25 Jun 13, 2023
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
128 changes: 71 additions & 57 deletions src/dotnet/Azure.ClientSdk.Analyzers/Azure.ClientSdk.Analyzers.Tests/AZC0002Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace Azure.ClientSdk.Analyzers.Tests
public class AZC0002Tests
{
[Fact]
public async Task AZC0002ProducedForMethodsWithoutCancellationToken()
Copy link
Member

@m-nash m-nash May 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we have success cases for both cancellation token and request context being last where request context can be both required and optional but cancellation token cannot?

Copy link
Member Author

@pshao25 pshao25 May 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, AZC0002NotProducedForMethodsWithCancellationToken and AZC0002NotProducedForMethodsWithRequestContext

public async Task AZC0002ProducedForMethodsWithoutCancellationTokenOrRequestContext()
{
const string code = @"
using System.Threading.Tasks;
Expand All @@ -35,7 +35,7 @@ await Verifier.CreateAnalyzer(code)
}

[Fact]
public async Task AZC0002ProducedForMethodsWithNonOptionalCancellationToken()
public async Task AZC0002ProducedForMethodsWithWrongNameCancellationToken()
{
const string code = @"
using System.Threading;
Expand All @@ -45,12 +45,12 @@ namespace RandomNamespace
{
public class SomeClient
{
public virtual Task {|AZC0002:GetAsync|}(CancellationToken cancellationToken)
public virtual Task {|AZC0002:GetAsync|}(CancellationToken cancellation = default)
{
return null;
}

public virtual void {|AZC0002:Get|}(CancellationToken cancellationToken)
public virtual void {|AZC0002:Get|}(CancellationToken cancellation = default)
{
}
}
Expand All @@ -61,22 +61,23 @@ await Verifier.CreateAnalyzer(code)
}

[Fact]
public async Task AZC0002ProducedForMethodsWithWrongNameParameter()
public async Task AZC0002ProducedForMethodsWithWrongNameRequestContext()
{
const string code = @"
using Azure;
using System.Threading;
using System.Threading.Tasks;

namespace RandomNamespace
{
public class SomeClient
{
public virtual Task {|AZC0002:GetAsync|}(CancellationToken cancellation = default)
public virtual Task {|AZC0002:GetAsync|}(RequestContext cancellation = default)
{
return null;
}

public virtual void {|AZC0002:Get|}(CancellationToken cancellation = default)
public virtual void {|AZC0002:Get|}(RequestContext cancellation = default)
{
}
}
Expand All @@ -85,25 +86,24 @@ await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.RunAsync();
}

[Fact]
public async Task AZC0002ProducedForMethodsWhereRequestContextIsNotLast()
public async Task AZC0002ProducedForMethodsWithNonOptionalCancellationToken()
{
const string code = @"
using Azure;
using System.Threading;
using System.Threading.Tasks;

namespace RandomNamespace
{
public class SomeClient
{
public virtual Task {|AZC0002:GetAsync|}(RequestContext context = default, string text = default)
public virtual Task {|AZC0002:GetAsync|}(CancellationToken cancellationToken)
{
return null;
}

public virtual void {|AZC0002:Get|}(RequestContext context = default, string text = default)
public virtual void {|AZC0002:Get|}(CancellationToken cancellationToken)
{
}
}
Expand All @@ -112,44 +112,36 @@ await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.RunAsync();
}

[Fact]
public async Task AZC0002DoesntFireIfThereIsAnOverloadWithCancellationToken()
public async Task AZC0002ProducedForMethodsWhereRequestContextIsNotLast()
{
const string code = @"
using Azure;
using System.Threading;
using System.Threading.Tasks;

namespace RandomNamespace
{
public class SomeClient
{
public virtual Task GetAsync(string s)
{
return null;
}

public virtual void Get(string s)
{
}

public virtual Task GetAsync(string s, CancellationToken cancellationToken)
public virtual Task {|AZC0002:GetAsync|}(RequestContext context = default, string text = default)
{
return null;
}

public virtual void Get(string s, CancellationToken cancellationToken)
public virtual void {|AZC0002:Get|}(RequestContext context = default, string text = default)
{
}
}
}";
await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.RunAsync();
}
}

[Fact]
public async Task AZC0002DoesntFireIfThereIsAnOverloadWithRequestContext()
public async Task AZC0002ProducedForMethodsWhereCancellationTokenIsNotLast()
{
const string code = @"
using Azure;
Expand All @@ -160,91 +152,103 @@ namespace RandomNamespace
{
public class SomeClient
{
public virtual Task GetAsync(string s)
public virtual Task {|AZC0002:GetAsync|}(CancellationToken cancellationToken = default, string text = default)
{
return null;
}

public virtual void Get(string s)
public virtual void {|AZC0002:Get|}(CancellationToken cancellationToken = default, string text = default)
{
}
}
}";
await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.RunAsync();
}

public virtual Task GetAsync(string s, RequestContext context = default)
[Fact]
public async Task AZC0002NotProducedForMethodsWithCancellationToken()
{
const string code = @"
using System.Threading;
using System.Threading.Tasks;

namespace RandomNamespace
{
public class SomeClient
{
public virtual Task GetAsync(CancellationToken cancellationToken = default)
{
return null;
}

public virtual void Get(string s, RequestContext context = default)
public virtual void Get(CancellationToken cancellationToken = default)
{
}
}
}";
await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.RunAsync();
}

}
[Fact]
public async Task AZC0002ProducedWhenCancellationTokenOverloadsDontMatch()
public async Task AZC0002NotProducedForMethodsWithRequestContextAndCancellationToken()
{
const string code = @"
using Azure;
using System.Threading;
using System.Threading.Tasks;

namespace RandomNamespace
{
public class SomeClient
{
public virtual Task {|AZC0002:GetAsync|}(string s)
public virtual Task Get1Async(string s, CancellationToken cancellationToken = default)
{
return null;
}

public virtual void {|AZC0002:Get|}(string s)
public virtual void Get1(string s, CancellationToken cancellationToken = default)
{
}

public virtual Task {|AZC0002:GetAsync|}(CancellationToken cancellationToken)
public virtual Task Get1Async(string s, RequestContext context)
{
return null;
}

public virtual void {|AZC0002:Get|}(CancellationToken cancellationToken)
public virtual void Get1(string s, RequestContext context)
{
}
}
}";
await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.RunAsync();

public virtual Task Get2Async(CancellationToken cancellationToken = default)
{
return null;
}

[Fact]
public async Task AZC0002NotProducedForMethodsWithCancellationToken()
public virtual void Get2(CancellationToken cancellationToken = default)
{
const string code = @"
using System.Threading;
using System.Threading.Tasks;
}

namespace RandomNamespace
{
public class SomeClient
{
public virtual Task GetAsync(CancellationToken cancellationToken = default)
public virtual Task Get2Async(RequestContext context)
{
return null;
}

public virtual void Get(CancellationToken cancellationToken = default)
public virtual void Get2(RequestContext context)
{
}
}
}";
await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.WithDisabledDiagnostics("AZC0018")
.WithDisabledDiagnostics("AD0001")
.RunAsync();
}
}

[Fact]
public async Task AZC0002NotProducedForMethodsWithRequestContext()
{
Expand All @@ -265,10 +269,20 @@ public virtual Task GetAsync(RequestContext context = default)
public virtual void Get(RequestContext context = default)
{
}

public virtual Task Get2Async(RequestContext context)
{
return null;
}

public virtual void Get2(RequestContext context)
{
}
}
}";
await Verifier.CreateAnalyzer(code)
.WithDisabledDiagnostics("AZC0015")
.WithDisabledDiagnostics("AZC0018")
.RunAsync();
}
}
Expand Down
Loading