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

Port CA2208: InstantiateArgumentExceptionsCorrectly #742

Merged
merged 5 commits into from
Dec 8, 2015
Merged

Port CA2208: InstantiateArgumentExceptionsCorrectly #742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7f2836b
Port CA2208: InstantiateArgumentExceptionsCorrectly
nguerrera Dec 7, 2015
54fc017
Port FxCop test cases for CA2208
nguerrera Dec 8, 2015
48a0fae
Add nameof coverage
nguerrera Dec 8, 2015
ebaff52
Respond to PR feedback
nguerrera Dec 8, 2015
b441a1c
Add missing FactAttribute and fix issues with the test
nguerrera Dec 8, 2015
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
19 changes: 0 additions & 19 deletions src/System.Runtime.Analyzers/CSharp/CSharpInstantiateArgumentExceptionsCorrectly.cs
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion src/System.Runtime.Analyzers/CSharp/System.Runtime.CSharp.Analyzers.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@
<Compile Include="CSharpNormalizeStringsToUppercase.Fixer.cs" />
<Compile Include="CSharpCallGCSuppressFinalizeCorrectly.cs" />
<Compile Include="CSharpCallGCSuppressFinalizeCorrectly.Fixer.cs" />
<Compile Include="CSharpInstantiateArgumentExceptionsCorrectly.cs" />
<Compile Include="CSharpInstantiateArgumentExceptionsCorrectly.Fixer.cs" />
</ItemGroup>
<ItemGroup>
Expand Down
182 changes: 153 additions & 29 deletions src/System.Runtime.Analyzers/Core/InstantiateArgumentExceptionsCorrectly.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,183 @@
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System.Collections.Immutable;
using System.Diagnostics;

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Semantics;

using Analyzer.Utilities;

namespace System.Runtime.Analyzers
{
{
/// <summary>
/// CA2208: Instantiate argument exceptions correctly
/// </summary>
public abstract class InstantiateArgumentExceptionsCorrectlyAnalyzer : DiagnosticAnalyzer
[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
public sealed class InstantiateArgumentExceptionsCorrectlyAnalyzer : DiagnosticAnalyzer
{
internal const string RuleId = "CA2208";
private const string HelpUri = "https://msdn.microsoft.com/en-us/library/ms182347.aspx";

private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(SystemRuntimeAnalyzersResources.InstantiateArgumentExceptionsCorrectlyTitle), SystemRuntimeAnalyzersResources.ResourceManager, typeof(SystemRuntimeAnalyzersResources));

private static readonly LocalizableString s_localizableMessageNoArguments = new LocalizableResourceString(nameof(SystemRuntimeAnalyzersResources.InstantiateArgumentExceptionsCorrectlyMessageNoArguments), SystemRuntimeAnalyzersResources.ResourceManager, typeof(SystemRuntimeAnalyzersResources));
private static readonly LocalizableString s_localizableMessageIncorrectMessage = new LocalizableResourceString(nameof(SystemRuntimeAnalyzersResources.InstantiateArgumentExceptionsCorrectlyMessageIncorrectMessage), SystemRuntimeAnalyzersResources.ResourceManager, typeof(SystemRuntimeAnalyzersResources));
private static readonly LocalizableString s_localizableMessageIncorrectParameterName = new LocalizableResourceString(nameof(SystemRuntimeAnalyzersResources.InstantiateArgumentExceptionsCorrectlyMessageIncorrectParameterName), SystemRuntimeAnalyzersResources.ResourceManager, typeof(SystemRuntimeAnalyzersResources));
private static readonly LocalizableString s_localizableDescription = new LocalizableResourceString(nameof(SystemRuntimeAnalyzersResources.InstantiateArgumentExceptionsCorrectlyDescription), SystemRuntimeAnalyzersResources.ResourceManager, typeof(SystemRuntimeAnalyzersResources));

internal static DiagnosticDescriptor NoArgumentsRule = new DiagnosticDescriptor(RuleId,
s_localizableTitle,
s_localizableMessageNoArguments,
DiagnosticCategory.Usage,
DiagnosticSeverity.Warning,
isEnabledByDefault: false,
description: s_localizableDescription,
helpLinkUri: null, // TODO: add MSDN url
customTags: WellKnownDiagnosticTags.Telemetry);
internal static DiagnosticDescriptor IncorrectMessageRule = new DiagnosticDescriptor(RuleId,
s_localizableTitle,
s_localizableMessageIncorrectMessage,
DiagnosticCategory.Usage,
DiagnosticSeverity.Warning,
isEnabledByDefault: false,
description: s_localizableDescription,
helpLinkUri: null, // TODO: add MSDN url
customTags: WellKnownDiagnosticTags.Telemetry);
internal static DiagnosticDescriptor IncorrectParameterNameRule = new DiagnosticDescriptor(RuleId,

internal static DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(RuleId,
s_localizableTitle,
s_localizableMessageIncorrectParameterName,
"{0}",
DiagnosticCategory.Usage,
DiagnosticSeverity.Warning,
isEnabledByDefault: false,
isEnabledByDefault: true,
description: s_localizableDescription,
helpLinkUri: null, // TODO: add MSDN url
helpLinkUri: HelpUri,
customTags: WellKnownDiagnosticTags.Telemetry);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(NoArgumentsRule, IncorrectMessageRule, IncorrectParameterNameRule);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Descriptor);

public override void Initialize(AnalysisContext analysisContext)
{

analysisContext.RegisterCompilationStartAction(
compilationContext =>
{
Compilation compilation = compilationContext.Compilation;
ITypeSymbol argumentExceptionType = compilation.GetTypeByMetadataName("System.ArgumentException");

if (argumentExceptionType == null)
{
return;
}

compilationContext.RegisterOperationBlockStartAction(
operationBlockStartContext =>
{
operationBlockStartContext.RegisterOperationAction(
operationContext => AnalyzeObjectCreation(
operationContext,
operationBlockStartContext.OwningSymbol,
argumentExceptionType),
OperationKind.ObjectCreationExpression);
});
});
}

private void AnalyzeObjectCreation(
OperationAnalysisContext context,
ISymbol owningSymbol,
ITypeSymbol argumentExceptionType)
{
var creation = (IObjectCreationExpression)context.Operation;
if (!creation.ResultType.Inherits(argumentExceptionType))
{
return;
}

if (creation.ConstructorArguments.Length == 0)
{
if (HasMessageOrParameterNameConstructor(creation.ResultType))
{
// Call the {0} constructor that contains a message and/ or paramName parameter
ReportDiagnostic(context, s_localizableMessageNoArguments, creation.ResultType);
}
}
else
{
foreach (var argument in creation.ConstructorArguments)
{
if (argument.Parameter.Type.SpecialType != SpecialType.System_String)
{
continue;
}

string value = argument.Value.ConstantValue as string;
if (value == null)
{
continue;
}

CheckArgument(owningSymbol, creation.ResultType, argument.Parameter, value, context);
}
}
}
private void CheckArgument(
ISymbol targetSymbol,
ITypeSymbol exceptionType,
IParameterSymbol parameter,
string stringArgument,
OperationAnalysisContext context)
{
bool matchesParameter = MatchesParameter(targetSymbol, stringArgument);
LocalizableString format = null;

if (IsMessage(parameter) && matchesParameter)
{
format = s_localizableMessageIncorrectMessage;
}
else if (IsParameterName(parameter) && !matchesParameter)
{
format = s_localizableMessageIncorrectParameterName;
}

if (format != null)
{
ReportDiagnostic(context, format, targetSymbol, stringArgument, parameter.Name, exceptionType);
}
}

private static void ReportDiagnostic(OperationAnalysisContext context, LocalizableString format, params object[] args)
{
context.ReportDiagnostic(
context.Operation.Syntax.CreateDiagnostic(
Descriptor,
string.Format(format.ToString(), args)));
}

private static bool IsMessage(IParameterSymbol parameter)
{
return parameter.Name == "message";
}

private static bool IsParameterName(IParameterSymbol parameter)
{
return parameter.Name == "paramName" || parameter.Name == "parameterName";
}

private static bool HasMessageOrParameterNameConstructor(ITypeSymbol type)
{
foreach (var member in type.GetMembers())
{
if (!member.IsConstructor())
{
continue;
}

foreach (var parameter in member.GetParameters())
{
if (parameter.Type.SpecialType == SpecialType.System_String
&& (IsMessage(parameter) || IsParameterName(parameter)))
{
return true;
}
}
}

return false;
}

private static bool MatchesParameter(ISymbol symbol, string stringArgumentValue)
{
foreach (var parameter in symbol.GetParameters())
{
if (parameter.Name == stringArgumentValue)
{
return true;
}
}

return false;
}
}
}
4 changes: 2 additions & 2 deletions src/System.Runtime.Analyzers/UnitTests/InstantiateArgumentExceptionsCorrectlyTests.Fixer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ public class InstantiateArgumentExceptionsCorrectlyFixerTests : CodeFixTestBase
{
protected override DiagnosticAnalyzer GetBasicDiagnosticAnalyzer()
{
return new BasicInstantiateArgumentExceptionsCorrectlyAnalyzer();
return new InstantiateArgumentExceptionsCorrectlyAnalyzer();
}

protected override DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer()
{
return new CSharpInstantiateArgumentExceptionsCorrectlyAnalyzer();
return new InstantiateArgumentExceptionsCorrectlyAnalyzer();
}

protected override CodeFixProvider GetBasicCodeFixProvider()
Expand Down
Loading