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.

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

Use Operations instead of SyntaxNodes for analysis #177

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ public void Analyzer_is_not_triggered(string filename)

[Theory]
[InlineData("WithOutFileSystem.txt", 15, 28)]
[InlineData("StaticInvocation.txt", 15, 40)]
public void Analyzer_is_triggered(string filename, int diagnosticLine, int diagnosticColumn)
{
var source = ReadFile(filename);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ public class PathAnalyzerTests : CSharpDiagnosticAnalyzerTest<PathAnalyzer>
[InlineData("Valid.txt")]
[InlineData("UsingStaticFalsePositive.txt")]
[InlineData("UsingStaticLinqFalsePositive.txt")]
[InlineData("NonRelatedFieldFalsePositive.txt")]
public void Analyzer_is_not_triggered(string filename)
{
var source = ReadFile(filename);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace SomeNameSpace
{
const string path = "C:\\temp";

Directory.Remove(path);
Directory.Delete(path);
}
}
}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
namespace SomeNameSpace
{
public class NonRelatedFieldFalsePositive
{
private const string Path = "Some/Path/To/Something";

public string SomeMethod()
{
return Path.Replace('/', '_');
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,9 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp";

new ConfigurationBuilder().SetBasePath(_fileSystem.Directory.GetCurrentDirectory());
SetBasePath(_fileSystem.Directory.GetCurrentDirectory());
}

private void SetBasePath(string path) {}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,9 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp";

new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory());
SetBasePath(Directory.GetCurrentDirectory());
}

private void SetBasePath(string path) {}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,7 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

DirectoryInfo dirInfo = _fileSystem.DirectoryInfo.FromDirectoryName(filePath);
var dirInfo = _fileSystem.DirectoryInfo.New(filePath);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,7 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

DirectoryInfo dirInfo = new DirectoryInfo(filePath);
var dirInfo = new DirectoryInfo(filePath);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,7 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

FileInfo fileInf = _fileSystem.FileInfo.FromFileName(filePath);
var fileInf = _fileSystem.FileInfo.New(filePath);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,7 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

FileInfo fileInf = new FileInfo(filePath);
var fileInf = new FileInfo(filePath);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,13 +16,8 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

using (FileStream fstream = _fileSystem.FileStream.Create(filePath, FileMode.OpenOrCreate))
using (var fstream = _fileSystem.FileStream.New(filePath, FileMode.OpenOrCreate))
{
// преобразуем строку в байты
byte[] array = System.Text.Encoding.Default.GetBytes(text);
// запись массива байтов в файл
fstream.Write(array, 0, array.Length);
Console.WriteLine("Текст записан в файл");
}
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,14 +16,9 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

using (FileStream fstream = new FileStream(filePath, FileMode.OpenOrCreate))
{
// преобразуем строку в байты
byte[] array = System.Text.Encoding.Default.GetBytes(text);
// запись массива байтов в файл
fstream.Write(array, 0, array.Length);
Console.WriteLine("Текст записан в файл");
}
using (var fstream = new FileStream(filePath, FileMode.OpenOrCreate))
{
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,7 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

_fileSystem.Path.Exists(filePath);
_fileSystem.Path.GetFullPath(filePath);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.IO;
using System.IO.Abstractions;

namespace SomeNameSpace
Expand All @@ -15,7 +16,7 @@ namespace SomeNameSpace
{
const string filePath = "C:\\temp.txt";

Path.Exists(filePath);
Path.GetFullPath(filePath);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public override void Initialize(AnalysisContext context)

if (fileSystemContext.HasReference)
{
AnalyzeCompilation(compilationStartContext, fileSystemContext);
AnalyzeCompilation(compilationStartContext);
}
});
}
Expand All @@ -31,7 +31,5 @@ public override void Initialize(AnalysisContext context)
/// Analysis
/// </summary>
/// <param name="compilationStartContext"> Compilation Start Analysis Context </param>
/// <param name="fileSystemContext"> FileSystem Context </param>
protected abstract void AnalyzeCompilation(CompilationStartAnalysisContext compilationStartContext,
FileSystemContext fileSystemContext);
protected abstract void AnalyzeCompilation(CompilationStartAnalysisContext compilationStartContext);
}
Original file line number Diff line number Diff line change
@@ -1,117 +1,58 @@
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Operations;

namespace System.IO.Abstractions.Analyzers.Analyzers;

/// <inheritdoc />
public abstract class BaseFileSystemNodeAnalyzer : BaseFileSystemAnalyzer
{
/// <inheritdoc />
protected override void AnalyzeCompilation(CompilationStartAnalysisContext compilationStartContext,
FileSystemContext fileSystemContext)
protected override void AnalyzeCompilation(CompilationStartAnalysisContext compilationStartContext)
{
if (DoesNotUsedSystemIo())
{
return;
}

compilationStartContext.RegisterSyntaxNodeAction(syntaxContext =>
compilationStartContext.RegisterOperationAction(operationContext =>
{
var invocation = (InvocationExpressionSyntax) syntaxContext.Node;
var invocationOperation = (IInvocationOperation) operationContext.Operation;

if (IsStaticInvocationStartWith(invocation) && !IsInvocationFromAbstractions(syntaxContext, invocation))
if (IsFileSystemType(invocationOperation.TargetMethod.ContainingType, GetFileSystemTypeSymbol(compilationStartContext.Compilation)))
{
Analyze(syntaxContext, invocation);
Analyze(operationContext, invocationOperation);
}
},
SyntaxKind.InvocationExpression);
OperationKind.Invocation);

compilationStartContext.RegisterSyntaxNodeAction(syntaxContext =>
compilationStartContext.RegisterOperationAction(operationContext =>
{
var creationExpressionSyntax = (ObjectCreationExpressionSyntax) syntaxContext.Node;
var typeInfo = syntaxContext.SemanticModel.GetTypeInfo(creationExpressionSyntax);
var objectCreationOperation = (IObjectCreationOperation) operationContext.Operation;

if (IsTypesEquals(typeInfo))
if (IsFileSystemType(objectCreationOperation.Type, GetFileSystemTypeSymbol(compilationStartContext.Compilation)))
{
Analyze(syntaxContext, creationExpressionSyntax);
Analyze(operationContext, objectCreationOperation);
}
},
SyntaxKind.ObjectCreationExpression);
OperationKind.ObjectCreation);
}

protected abstract void Analyze(SyntaxNodeAnalysisContext context, ExpressionSyntax invocation);
protected abstract void Analyze(OperationAnalysisContext context, IOperation operation);

protected abstract Type GetFileSystemType();

private bool DoesNotUsedSystemIo()
{
var systemIoNamespace = typeof(Path).Namespace;

return systemIoNamespace != null
&& !systemIoNamespace.Equals(GetFileSystemType()
.Namespace);
}
private INamedTypeSymbol GetFileSystemTypeSymbol(Compilation compilation) => compilation.GetTypeByMetadataName(GetFileSystemType().FullName);

private bool IsTypesEquals(TypeInfo typeInfo)
private static bool IsFileSystemType(ITypeSymbol typeSymbol, INamedTypeSymbol fileSystemType)
{
if (typeInfo.Type is null)
if (typeSymbol is null)
{
return false;
}

var namespaceSymbol = typeInfo.Type.ContainingNamespace;
var fileSystemType = GetFileSystemType();

return typeInfo.Type.Name.Equals(fileSystemType.Name, StringComparison.Ordinal)
&& (namespaceSymbol.IsGlobalNamespace || namespaceSymbol.ToString() == fileSystemType.Namespace);
}

private bool IsStaticInvocationStartWith(InvocationExpressionSyntax invocation) => invocation.IsKind(SyntaxKind.InvocationExpression)
&& invocation.Expression.NormalizeWhitespace()
.ToFullString()
.StartsWith(GetFileSystemType()
.Name
+ ".", StringComparison.Ordinal);

private static bool IsInvocationFromAbstractions(SyntaxNodeAnalysisContext context, InvocationExpressionSyntax invocation) =>
(invocation?.Expression as MemberAccessExpressionSyntax)?.Expression is ExpressionSyntax invokedMember
&& IsSymbolFromAbstractions(context.SemanticModel.GetSymbolInfo(invokedMember));

private static bool IsSymbolFromAbstractions(SymbolInfo symbolInfo)
{
if (symbolInfo.Symbol is ISymbol symbol)
{
return IsSymbolFromAbstractions(symbol);
}

return symbolInfo.CandidateSymbols.Length > 0 && symbolInfo.CandidateSymbols.All(IsSymbolFromAbstractions);
return typeSymbol.Equals(fileSystemType, SymbolEqualityComparer.Default);
}

private static bool IsSymbolFromAbstractions(ISymbol symbol)
protected static bool IsFirstConstructorParameterOfType<T>(OperationAnalysisContext context, IOperation operation)
{
var namespaceSymbol = symbol switch
{
IPropertySymbol propertySymbol => propertySymbol.Type.ContainingNamespace,
IFieldSymbol fieldSymbol => fieldSymbol.Type.ContainingNamespace,
IMethodSymbol methodSymbol => methodSymbol.ContainingNamespace,
var _ => null
};

return namespaceSymbol is
{
IsGlobalNamespace: false
}
&& namespaceSymbol.ToString()
.StartsWith(Constants.FileSystemNameSpace, StringComparison.Ordinal);
var parameterTypeSymbol = context.Compilation.GetTypeByMetadataName(typeof(T).FullName);
return (operation as IObjectCreationOperation)?.Arguments.FirstOrDefault()?.Parameter?.Type?.Equals(parameterTypeSymbol, SymbolEqualityComparer.Default) ?? false;
}

protected static bool IsFirstConstructorParameterOfType<T>(SyntaxNodeAnalysisContext context, ExpressionSyntax syntax) =>
(syntax as ObjectCreationExpressionSyntax)?.ArgumentList?.Arguments.FirstOrDefault() is ArgumentSyntax firstArgument
&& (context.SemanticModel.GetSymbolInfo(firstArgument.Expression)
.Symbol as ILocalSymbol)?.Type is ITypeSymbol argumentType
&& argumentType.ContainingNamespace.Name == typeof(T).Namespace
&& argumentType.Name == typeof(T).Name;
}
Loading