Наработки по фиксеру FileServiceInterfaceInjectionCodeFix

inyutin-maxim · inyutin-maxim · commit 442dd5374918 · 2019-02-20T01:48:33.000+03:00
diff --git a/Roslyn.Testing/Analyzer/CSharpDiagnosticAnalyzerTest.cs b/Roslyn.Testing/Analyzer/CSharpDiagnosticAnalyzerTest.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.Linq;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
 using Roslyn.Testing.Model;
@@ -24,7 +25,7 @@ protected CSharpDiagnosticAnalyzerTest()
 
 		protected virtual IEnumerable<MetadataReference> GetAdditionalReferences()
 		{
-			return null;
+			return Enumerable.Empty<MetadataReference>();
 		}
 
 		/// <summary>
diff --git a/Roslyn.Testing/CodeFix/CSharpCodeFixProviderTest.cs b/Roslyn.Testing/CodeFix/CSharpCodeFixProviderTest.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Generic;
+using System.Linq;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CodeFixes;
 using Microsoft.CodeAnalysis.Diagnostics;
@@ -13,14 +14,20 @@ public abstract class CSharpCodeFixProviderTest<TDiagnosticAnalyzer, TCodeFixPro
 	{
 	#region To be implemented by Test classes
 
+		/// <inheritdoc />
+		public override string Filepath => _codeFixProvider.GetType().Name;
+
+		/// <inheritdoc />
+		public override string PathToTestData => "./TestData/CodeFix/";
+
 		protected virtual IEnumerable<MetadataReference> GetAdditionalReferences()
 		{
-			return null;
+			return Enumerable.Empty<MetadataReference>();
 		}
 
 	#endregion
 
-		private readonly CodeFixProvider _codeFixProvider;
+		private readonly TCodeFixProvider _codeFixProvider;
 
 		private readonly TDiagnosticAnalyzer _diagnosticAnalyzer;
 
diff --git a/System.IO.Abstractions.Analyzers.Tests/CodeFixes/FileServiceInterfaceInjectionCodeFixTests.cs b/System.IO.Abstractions.Analyzers.Tests/CodeFixes/FileServiceInterfaceInjectionCodeFixTests.cs
@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+using System.IO.Abstractions.Analyzers.Analyzers;
+using System.IO.Abstractions.Analyzers.CodeFixes;
+using Microsoft.CodeAnalysis;
+using Roslyn.Testing.CodeFix;
+using Xunit;
+
+namespace System.IO.Abstractions.Analyzers.Tests.CodeFixes
+{
+	public class FileServiceInterfaceInjectionCodeFixTests :
+		CSharpCodeFixProviderTest<FileServiceInterfaceInjectionAnalyzer, FileServiceInterfaceInjectionCodeFix>
+	{
+		[Theory]
+		[InlineData("BeforeFix.txt", "AfterFix.txt")]
+		public void CodeFix(string sourceBefore, string sourceAfter)
+		{
+			var sourceBeforeFix = ReadFile(sourceBefore);
+			var sourceAfterFix = ReadFile(sourceAfter);
+			VerifyFix(sourceBeforeFix, sourceAfterFix, 0, true);
+		}
+
+		protected override IEnumerable<MetadataReference> GetAdditionalReferences() => new[]
+		{
+			MetadataReference.CreateFromFile(typeof(IFileSystem).Assembly.Location)
+		};
+	}
+}
diff --git a/System.IO.Abstractions.Analyzers.Tests/System.IO.Abstractions.Analyzers.Tests.csproj b/System.IO.Abstractions.Analyzers.Tests/System.IO.Abstractions.Analyzers.Tests.csproj
@@ -8,7 +8,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
-		<PackageReference Include="xunit" Version="2.4.0" />
+		<PackageReference Include="xunit" Version="2.4.1" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
 	</ItemGroup>
 
diff --git a/System.IO.Abstractions.Analyzers.Tests/TestData/CodeFix/FileServiceInterfaceInjectionCodeFix/AfterFix.txt b/System.IO.Abstractions.Analyzers.Tests/TestData/CodeFix/FileServiceInterfaceInjectionCodeFix/AfterFix.txt
@@ -0,0 +1,24 @@
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem(IFileSystem fileSystem)
+		{
+			_fileSystem = fileSystem;
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			if (File.Exists(filePath))
+			{
+				File.Delete(filePath);
+			}
+		}
+	}
+}
diff --git a/System.IO.Abstractions.Analyzers.Tests/TestData/CodeFix/FileServiceInterfaceInjectionCodeFix/BeforeFix.txt b/System.IO.Abstractions.Analyzers.Tests/TestData/CodeFix/FileServiceInterfaceInjectionCodeFix/BeforeFix.txt
@@ -0,0 +1,21 @@
+using System.IO;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		public WithOutFileSystem()
+		{
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			if (File.Exists(filePath))
+			{
+				File.Delete(filePath);
+			}
+		}
+	}
+}
diff --git a/System.IO.Abstractions.Analyzers/CodeActions/FileServiceInterfaceInjectionCodeAction.cs b/System.IO.Abstractions.Analyzers/CodeActions/FileServiceInterfaceInjectionCodeAction.cs
@@ -0,0 +1,73 @@
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CodeActions;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Editing;
+using Microsoft.CodeAnalysis.Formatting;
+using Microsoft.CodeAnalysis.Simplification;
+using SF = Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
+
+namespace System.IO.Abstractions.Analyzers.CodeActions
+{
+	/// <inheritdoc />
+	public class FileServiceInterfaceInjectionCodeAction : CodeAction
+	{
+		private readonly ConstructorDeclarationSyntax _constructor;
+
+		private readonly Document _document;
+
+		public FileServiceInterfaceInjectionCodeAction(string title, Document document, ConstructorDeclarationSyntax constructor)
+		{
+			_constructor = constructor;
+			_document = document;
+			Title = title;
+		}
+
+		public override string Title { get; }
+
+		public override string EquivalenceKey => Title;
+
+		protected override async Task<Document> GetChangedDocumentAsync(CancellationToken cancellationToken)
+		{
+			var editor = await DocumentEditor.CreateAsync(_document, cancellationToken).ConfigureAwait(false);
+
+			var parameter = SF.Parameter(SF.Identifier("fileSystem"))
+				.WithType(SF.ParseTypeName(nameof(IFileSystem)))
+				.WithAdditionalAnnotations(Formatter.Annotation, Simplifier.Annotation)
+				.NormalizeWhitespace();
+
+			if (!(_constructor.Parent is ClassDeclarationSyntax classDeclarationSyntax))
+			{
+				editor.AddParameter(_constructor, parameter);
+
+				return editor.GetChangedDocument();
+			}
+
+			var fileSystem = classDeclarationSyntax.Members
+				.OfType<FieldDeclarationSyntax>()
+				.FirstOrDefault(x => x.NormalizeWhitespace().ToFullString().Equals(nameof(IFileSystem)));
+
+			if (fileSystem != null)
+			{
+				return editor.GetChangedDocument();
+			}
+
+			var fileSystemPropertyDeclaration = SF.FieldDeclaration(SF.VariableDeclaration(SF.IdentifierName(nameof(IFileSystem)))
+					.WithVariables(SF.SingletonSeparatedList(SF.VariableDeclarator(SF.Identifier("_fileSystem")))))
+				.WithModifiers(SF.TokenList(SF.Token(SyntaxKind.PrivateKeyword),
+					SF.Token(SyntaxKind.ReadOnlyKeyword)));
+
+			editor.InsertMembers(classDeclarationSyntax,
+				0,
+				new SyntaxNode[]
+					{ fileSystemPropertyDeclaration });
+
+			editor.AddParameter(_constructor, parameter);
+
+			return editor.GetChangedDocument();
+		}
+	}
+}
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileServiceInterfaceInjectionCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileServiceInterfaceInjectionCodeFix.cs
@@ -0,0 +1,34 @@
+using System.Collections.Immutable;
+using System.Composition;
+using System.IO.Abstractions.Analyzers.Analyzers;
+using System.IO.Abstractions.Analyzers.CodeActions;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CodeFixes;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+
+namespace System.IO.Abstractions.Analyzers.CodeFixes
+{
+	[Shared]
+	[ExportCodeFixProvider(LanguageNames.CSharp)]
+	public class FileServiceInterfaceInjectionCodeFix : CodeFixProvider
+	{
+		private const string Title = "Use System.IO.Abstractions";
+
+		public sealed override ImmutableArray<string> FixableDiagnosticIds { get; } =
+			ImmutableArray.Create(FileServiceInterfaceInjectionAnalyzer.DiagnosticId);
+
+		public sealed override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
+
+		public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
+		{
+			var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
+			var constructorDeclarationSyntax = root.FindNode(context.Span).FirstAncestorOrSelf<ConstructorDeclarationSyntax>();
+
+			context.RegisterCodeFix(new FileServiceInterfaceInjectionCodeAction(Title,
+					context.Document,
+					constructorDeclarationSyntax),
+				context.Diagnostics);
+		}
+	}
+}
diff --git a/System.IO.Abstractions.Analyzers/System.IO.Abstractions.Analyzers.csproj b/System.IO.Abstractions.Analyzers/System.IO.Abstractions.Analyzers.csproj
@@ -9,6 +9,8 @@
 		<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="2.6.3" />
 		<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="2.10.0" PrivateAssets="all" />
 		<PackageReference Update="NETStandard.Library" PrivateAssets="all" />
+		<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="2.10.0" />
+		<PackageReference Include="Roslyn.Diagnostics.Analyzers" Version="2.6.3" />
 		<PackageReference Include="System.ComponentModel.Composition" Version="4.5.0" />
 		<PackageReference Include="System.IO.Abstractions" Version="3.0.10" />
 	</ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System.Collections.Generic;`
	`2`	`+using System.Linq;`
`2`	`3`	`using Microsoft.CodeAnalysis;`
`3`	`4`	`using Microsoft.CodeAnalysis.Diagnostics;`
`4`	`5`	`using Roslyn.Testing.Model;`
`@@ -24,7 +25,7 @@ protected CSharpDiagnosticAnalyzerTest()`
`24`	`25`
`25`	`26`	`protected virtual IEnumerable<MetadataReference> GetAdditionalReferences()`
`26`	`27`	`{`
`27`		`- return null;`
	`28`	`+ return Enumerable.Empty<MetadataReference>();`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`/// <summary>`