Convert SA1412 (Store Files as UTF-8) to the new test helpers

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1503UnitTests.cs

@@ -6,6 +6,7 @@ namespace StyleCop.Analyzers.Test.LayoutRules
     using System.Collections.Generic;
     using System.Threading;
     using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Text;
     using StyleCop.Analyzers.LayoutRules;
     using TestHelper;
     using Xunit;
@@ -522,7 +523,7 @@ public void Bar(int i)
                 await test.RunAsync(CancellationToken.None).ConfigureAwait(false);
 
                 // Test again with the fixedCode as the test code
-                test.TestSources[0] = (test.TestSources[0].filename, fixedCode);
+                test.TestSources[0] = (test.TestSources[0].filename, SourceText.From(fixedCode));
                 await test.RunAsync(CancellationToken.None).ConfigureAwait(false);
             }
         }

StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/FileMayOnlyContainTestBase`2.cs

@@ -333,7 +333,11 @@ protected static Task VerifyCSharpFixAsync(string source, string testSettings, D
                 Settings = testSettings,
             };
 
-            test.FixedSources.AddRange(fixedSources);
+            foreach (var fixedSource in fixedSources)
+            {
+                test.FixedSources.Add(fixedSource);
+            }
+
             test.ExpectedDiagnostics.AddRange(expected);
             return test.RunAsync(cancellationToken);
         }

StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402ForNonBlockDeclarationUnitTestsBase.cs

@@ -47,7 +47,11 @@ protected static Task VerifyCSharpFixAsync(string source, string testSettings, D
                 Settings = testSettings,
             };
 
-            test.FixedSources.AddRange(fixedSources);
+            foreach (var fixedSource in fixedSources)
+            {
+                test.FixedSources.Add(fixedSource);
+            }
+
             test.ExpectedDiagnostics.AddRange(expected);
             return test.RunAsync(cancellationToken);
         }

StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1412UnitTests.cs

@@ -4,25 +4,18 @@
 namespace StyleCop.Analyzers.Test.MaintainabilityRules
 {
     using System.Collections.Generic;
-    using System.Collections.Immutable;
-    using System.Linq;
     using System.Text;
     using System.Threading;
     using System.Threading.Tasks;
-    using Microsoft.CodeAnalysis;
-    using Microsoft.CodeAnalysis.CodeActions;
     using Microsoft.CodeAnalysis.CodeFixes;
-    using Microsoft.CodeAnalysis.Diagnostics;
     using Microsoft.CodeAnalysis.Text;
-    using StyleCop.Analyzers.MaintainabilityRules;
-    using StyleCop.Analyzers.Test.Helpers;
-    using TestHelper;
     using Xunit;
+    using static StyleCop.Analyzers.Test.Verifiers.StyleCopCodeFixVerifier<
+        StyleCop.Analyzers.MaintainabilityRules.SA1412StoreFilesAsUtf8,
+        StyleCop.Analyzers.MaintainabilityRules.SA1412CodeFixProvider>;
 
-    public class SA1412UnitTests : CodeFixVerifier
+    public class SA1412UnitTests
     {
-        private Encoding fileEncoding;
-
         public static IEnumerable<object[]> NonUtf8Encodings
         {
             get
@@ -40,77 +33,33 @@ public static IEnumerable<object[]> NonUtf8Encodings
         [MemberData(nameof(NonUtf8Encodings))]
         public async Task TestFileWithWrongEncodingAsync(int codepage)
         {
-            string testCode = "class TypeName { }";
-
-            this.fileEncoding = Encoding.GetEncoding(codepage);
+            var testCode = SourceText.From("class TypeName { }", Encoding.GetEncoding(codepage));
+            var fixedCode = SourceText.From(testCode.ToString(), Encoding.UTF8);
 
-            var expected = this.CSharpDiagnostic().WithLocation(1, 1);
+            var expected = Diagnostic().WithLocation(1, 1);
 
-            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+            await new CSharpTest
+            {
+                TestSources = { testCode },
+                ExpectedDiagnostics = { expected },
+                FixedSources = { fixedCode },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         [Fact]
         public async Task TestFileWithUtf8EncodingWithoutBOMAsync()
         {
-            string testCode = "class TypeName { }";
-
-            this.fileEncoding = new UTF8Encoding(false);
-
-            var expected = this.CSharpDiagnostic().WithLocation(1, 1);
-
-            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
-        }
-
-        [Theory]
-        [MemberData(nameof(NonUtf8Encodings))]
-        public async Task TestCodeFixAsync(int codepage)
-        {
-            string testCode = "class TypeName { }";
-
-            this.fileEncoding = Encoding.GetEncoding(codepage);
-
-            // Create a project using the specified encoding
-            Project project = this.CreateProject(new[] { testCode });
-            Project oldProject = project;
-
-            Workspace workspace = project.Solution.Workspace;
-
-            var codeFixer = this.GetCSharpCodeFixProvider();
-
-            var document = project.Documents.First();
-
-            // Create a diagnostic for the document to fix
-            var properties = ImmutableDictionary<string, string>.Empty.SetItem(SA1412StoreFilesAsUtf8.EncodingProperty, this.fileEncoding.WebName);
-            var diagnostic = Diagnostic.Create(
-                this.GetCSharpDiagnosticAnalyzers().First().SupportedDiagnostics.First(),
-                Location.Create(await document.GetSyntaxTreeAsync().ConfigureAwait(false), TextSpan.FromBounds(0, 0)),
-                properties);
-
-            await codeFixer.RegisterCodeFixesAsync(
-                new CodeFixContext(
-                    document,
-                    diagnostic,
-                    (ca, d) =>
-                    {
-                        var operation = ca.GetOperationsAsync(CancellationToken.None).ConfigureAwait(false).GetAwaiter().GetResult()[0];
-
-                        operation.Apply(workspace, CancellationToken.None);
-                    },
-                    CancellationToken.None)).ConfigureAwait(false);
+            var testCode = SourceText.From("class TypeName { }", new UTF8Encoding(false));
+            var fixedCode = SourceText.From(testCode.ToString(), Encoding.UTF8);
 
-            // project should now have the "fixed document" in it.
-            // Because of limitations in Roslyn the fixed document should
-            // have a different DocumentId then the broken document
-            project = workspace.CurrentSolution.Projects.First();
+            var expected = Diagnostic().WithLocation(1, 1);
 
-            Assert.Equal(1, project.DocumentIds.Count);
-
-            SourceText sourceText = await project.Documents.First().GetTextAsync().ConfigureAwait(false);
-
-            Assert.Equal(testCode, sourceText.ToString());
-
-            Assert.Equal(Encoding.UTF8, sourceText.Encoding);
-            Assert.NotEqual(oldProject.DocumentIds[0], project.DocumentIds[0]);
+            await new CSharpTest
+            {
+                TestSources = { testCode },
+                ExpectedDiagnostics = { expected },
+                FixedSources = { fixedCode },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         [Theory]
@@ -121,175 +70,56 @@ public async Task TestFixAllAsync(int codepage)
             await this.TestFixAllExecuterAsync(codepage, FixAllScope.Solution).ConfigureAwait(false);
         }
 
-        protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
-        {
-            yield return new SA1412StoreFilesAsUtf8();
-        }
-
-        protected override CodeFixProvider GetCSharpCodeFixProvider()
-        {
-            return new SA1412CodeFixProvider();
-        }
-
-        protected override Project CreateProjectImpl(string[] sources, string language, string[] filenames)
+        [Fact]
+        public async Task TestFixAllWithMultipleEncodingsAsync()
         {
-            string fileNamePrefix = "Test";
-            string fileExt = "cs";
-
-            var projectId = ProjectId.CreateNewId(debugName: "TestProject");
-            var solution = this.CreateSolution(projectId, language);
-
-            int count = 0;
-            for (int i = 0; i < sources.Length; i++)
+            await new CSharpTest
             {
-                string source = sources[i];
-                var newFileName = filenames?[i] ?? fileNamePrefix + count + "." + fileExt;
-                var documentId = DocumentId.CreateNewId(projectId, debugName: newFileName);
-                solution = solution.AddDocument(documentId, newFileName, SourceText.From(source, encoding: this.fileEncoding));
-                count++;
-            }
-
-            return solution.GetProject(projectId);
+                TestSources =
+                {
+                    SourceText.From("class Foo { }", Encoding.Unicode),
+                    SourceText.From("class Bar { }", Encoding.Unicode),
+                    SourceText.From("class FooBar { }", Encoding.UTF7),
+                },
+                ExpectedDiagnostics =
+                {
+                    Diagnostic().WithLocation("Test0.cs", 1, 1),
+                    Diagnostic().WithLocation("Test1.cs", 1, 1),
+                    Diagnostic().WithLocation("Test2.cs", 1, 1),
+                },
+                FixedSources =
+                {
+                    SourceText.From("class Foo { }", Encoding.UTF8),
+                    SourceText.From("class Bar { }", Encoding.UTF8),
+                    SourceText.From("class FooBar { }", Encoding.UTF8),
+                },
+                NumberOfFixAllIterations = 2,
+                NumberOfFixAllInDocumentIterations = 3,
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         private async Task TestFixAllExecuterAsync(int codepage, FixAllScope scope)
         {
-            string[] testCode = new[] { "class Foo { }", "class Bar { }" };
-
-            this.fileEncoding = Encoding.GetEncoding(codepage);
-
-            // Create a project using the specified encoding
-            Project project = this.CreateProject(testCode);
-            Project oldProject = project;
-
-            Workspace workspace = project.Solution.Workspace;
-
-            var codeFixer = this.GetCSharpCodeFixProvider();
-            var fixAllProvider = codeFixer.GetFixAllProvider();
-            var diagnostics = new List<Diagnostic>();
-            var descriptor = this.GetCSharpDiagnosticAnalyzers().First().SupportedDiagnostics.First();
-            foreach (var document in project.Documents)
-            {
-                // Create a diagnostic for the document to fix
-                var properties = ImmutableDictionary<string, string>.Empty.SetItem(SA1412StoreFilesAsUtf8.EncodingProperty, (await document.GetTextAsync().ConfigureAwait(false)).Encoding.WebName);
-                var diagnostic = Diagnostic.Create(
-                    descriptor,
-                    Location.Create(await document.GetSyntaxTreeAsync().ConfigureAwait(false), TextSpan.FromBounds(0, 0)),
-                    properties);
-                diagnostics.Add(diagnostic);
-            }
-
-            FixAllContext fixAllContext = new FixAllContext(
-                project.Documents.First(),
-                codeFixer,
-                scope,
-                nameof(SA1412CodeFixProvider) + "." + this.fileEncoding.WebName,
-                new[] { SA1412StoreFilesAsUtf8.DiagnosticId },
-                TestDiagnosticProvider.Create(diagnostics.ToImmutableArray()),
-                CancellationToken.None);
-
-            CodeAction codeAction = await fixAllProvider.GetFixAsync(fixAllContext).ConfigureAwait(false);
-            var operation = codeAction.GetOperationsAsync(CancellationToken.None).ConfigureAwait(false).GetAwaiter().GetResult()[0];
-
-            operation.Apply(workspace, CancellationToken.None);
-
-            // project should now have the "fixed document" in it.
-            // Because of limitations in roslyn the fixed document should
-            // have a different DocumentId then the broken document
-            project = workspace.CurrentSolution.Projects.First();
-
-            Assert.Equal(2, project.DocumentIds.Count);
-
-            for (int i = 0; i < project.DocumentIds.Count; i++)
-            {
-                DocumentId documentId = project.DocumentIds[i];
-                SourceText sourceText = await project.GetDocument(documentId).GetTextAsync().ConfigureAwait(false);
-
-                Assert.Equal(testCode[i], sourceText.ToString());
-
-                Assert.Equal(Encoding.UTF8, sourceText.Encoding);
-                Assert.NotEqual(oldProject.DocumentIds[i], project.DocumentIds[i]);
-            }
-        }
-
-        [Theory]
-        [InlineData(FixAllScope.Solution)]
-        [InlineData(FixAllScope.Project)]
-        private async Task TestFixAllWithMultipleEncodingsAsync(FixAllScope scope)
-        {
-            string[] testCode = new[] { "class Foo { }", "class Bar { }" };
-
-            this.fileEncoding = Encoding.Unicode;
-
-            // Create a project using the specified encoding
-            Project project = this.CreateProject(testCode);
-
-            project = project.AddDocument("Test2.cs", SourceText.From("class FooBar { }", Encoding.UTF7)).Project;
-
-            Project oldProject = project;
-
-            Workspace workspace = project.Solution.Workspace;
-
-            var codeFixer = this.GetCSharpCodeFixProvider();
-            var fixAllProvider = codeFixer.GetFixAllProvider();
-            var diagnostics = new List<Diagnostic>();
-            var descriptor = this.GetCSharpDiagnosticAnalyzers().First().SupportedDiagnostics.First();
-            foreach (var document in project.Documents)
+            await new CSharpTest
             {
-                // Create a diagnostic for the document to fix
-                var properties = ImmutableDictionary<string, string>.Empty.SetItem(SA1412StoreFilesAsUtf8.EncodingProperty, (await document.GetTextAsync().ConfigureAwait(false)).Encoding.WebName);
-                var diagnostic = Diagnostic.Create(
-                    descriptor,
-                    Location.Create(await document.GetSyntaxTreeAsync().ConfigureAwait(false), TextSpan.FromBounds(0, 0)),
-                    properties);
-                diagnostics.Add(diagnostic);
-            }
-
-            FixAllContext fixAllContext = new FixAllContext(
-                project.Documents.First(),
-                codeFixer,
-                scope,
-                nameof(SA1412CodeFixProvider) + "." + this.fileEncoding.WebName,
-                new[] { SA1412StoreFilesAsUtf8.DiagnosticId },
-                TestDiagnosticProvider.Create(diagnostics.ToImmutableArray()),
-                CancellationToken.None);
-
-            CodeAction codeAction = await fixAllProvider.GetFixAsync(fixAllContext).ConfigureAwait(false);
-            var operation = codeAction.GetOperationsAsync(CancellationToken.None).ConfigureAwait(false).GetAwaiter().GetResult()[0];
-
-            operation.Apply(workspace, CancellationToken.None);
-
-            // project should now have the "fixed document" in it.
-            // Because of limitations in Roslyn the fixed document should
-            // have a different DocumentId then the broken document
-            project = workspace.CurrentSolution.Projects.First();
-
-            Assert.Equal(3, project.DocumentIds.Count);
-
-            // The order of the document ids is now different from the order before.
-            for (int i = 1; i < 3; i++)
-            {
-                DocumentId documentId = project.DocumentIds[i];
-                SourceText sourceText = await project.GetDocument(documentId).GetTextAsync().ConfigureAwait(false);
-
-                Assert.Equal(testCode[i - 1], sourceText.ToString());
-
-                Assert.Equal(Encoding.UTF8, sourceText.Encoding);
-                Assert.NotEqual(oldProject.DocumentIds[i - 1], project.DocumentIds[i]);
-            }
-
-            // Check that Test2.cs was not changed
-            DocumentId otherDocumentId = project.DocumentIds[0];
-            var otherDocument = project.GetDocument(otherDocumentId);
-
-            Assert.Equal("Test2.cs", otherDocument.Name);
-
-            SourceText otherDocumentText = await otherDocument.GetTextAsync().ConfigureAwait(false);
-
-            Assert.Equal("class FooBar { }", otherDocumentText.ToString());
-
-            Assert.Equal(Encoding.UTF7, otherDocumentText.Encoding);
-            Assert.Equal(oldProject.DocumentIds[2], project.DocumentIds[0]);
+                TestSources =
+                {
+                    SourceText.From("class Foo { }", Encoding.GetEncoding(codepage)),
+                    SourceText.From("class Bar { }", Encoding.GetEncoding(codepage)),
+                },
+                ExpectedDiagnostics =
+                {
+                    Diagnostic().WithLocation("Test0.cs", 1, 1),
+                    Diagnostic().WithLocation("Test1.cs", 1, 1),
+                },
+                FixedSources =
+                {
+                    SourceText.From("class Foo { }", Encoding.UTF8),
+                    SourceText.From("class Bar { }", Encoding.UTF8),
+                },
+                NumberOfFixAllIterations = 1,
+                NumberOfFixAllInDocumentIterations = 2,
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
     }
 }