Merge pull request #3678 from bjornhellander/feature/global-using-alias-3

Update SA1121 and SA1404 to detect global using aliases, using GetImportScopes and compiling expression trees

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp10/Lightup/IImportScopeWrapperCSharp10UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp10.Lightup
+{
+    using StyleCop.Analyzers.Test.CSharp9.Lightup;
+
+    public partial class IImportScopeWrapperCSharp10UnitTests : IImportScopeWrapperCSharp9UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/Lightup/IImportScopeWrapperCSharp11UnitTests.cs

@@ -0,0 +1,85 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp11.Lightup
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis;
+    using Microsoft.CodeAnalysis.CSharp;
+    using Microsoft.CodeAnalysis.Text;
+    using StyleCop.Analyzers.Lightup;
+    using StyleCop.Analyzers.Test.CSharp10.Lightup;
+    using StyleCop.Analyzers.Test.Verifiers;
+    using Xunit;
+
+    public partial class IImportScopeWrapperCSharp11UnitTests : IImportScopeWrapperCSharp10UnitTests
+    {
+        [Theory]
+        [InlineData(1)]
+        [InlineData(2)]
+        public async Task TestCompatibleInstanceAsync(int numberOfAliasSymbols)
+        {
+            var obj = await CreateImportScopeAsync(numberOfAliasSymbols, CancellationToken.None).ConfigureAwait(false);
+            Assert.True(IImportScopeWrapper.IsInstance(obj));
+            var wrapper = IImportScopeWrapper.FromObject(obj);
+            Assert.Equal(obj.Aliases, wrapper.Aliases);
+        }
+
+        private static async Task<IImportScope> CreateImportScopeAsync(int numberOfAliasSymbols, CancellationToken cancellationToken)
+        {
+            var aliasDirectives = new List<string>(numberOfAliasSymbols);
+            for (var i = 0; i < numberOfAliasSymbols; i++)
+            {
+                aliasDirectives.Add($"global using Alias{i} = System.String;");
+            }
+
+            var source = string.Join(Environment.NewLine, aliasDirectives);
+            if (source.Length > 0)
+            {
+                source += Environment.NewLine;
+            }
+
+            source += @"
+namespace TestNamespace
+{
+    public class TestClass
+    {
+    }
+}
+";
+
+            var workspace = GenericAnalyzerTest.CreateWorkspace();
+            var projectId = ProjectId.CreateNewId();
+
+            var references = await GenericAnalyzerTest.ReferenceAssemblies
+                .ResolveAsync(LanguageNames.CSharp, cancellationToken).ConfigureAwait(false);
+
+            var solution = workspace.CurrentSolution
+                .AddProject(projectId, "TestProject", "TestProject", LanguageNames.CSharp)
+                .WithProjectCompilationOptions(projectId, new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
+                .WithProjectParseOptions(projectId, new CSharpParseOptions(LanguageVersionEx.CSharp11))
+                .AddMetadataReferences(projectId, references);
+
+            var documentId = DocumentId.CreateNewId(projectId);
+            solution = solution.AddDocument(documentId, "Test.cs", SourceText.From(source));
+
+            var project = solution.GetProject(projectId)!;
+            var compilation = (await project.GetCompilationAsync(cancellationToken).ConfigureAwait(false))!;
+            var syntaxTree = compilation.SyntaxTrees.Single();
+            var semanticModel = compilation.GetSemanticModel(syntaxTree);
+            var importScopes = semanticModel.GetImportScopes(syntaxTree.Length, cancellationToken);
+
+            var result = importScopes.FirstOrDefault(scope => scope.Aliases.Length == numberOfAliasSymbols);
+            if (result == null)
+            {
+                throw new InvalidOperationException("Could not create an import scope with the expected number of alias symbols.");
+            }
+
+            return result;
+        }
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1404CSharp11UnitTests.cs

@@ -3,9 +3,58 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using StyleCop.Analyzers.MaintainabilityRules;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
+
+    using static StyleCop.Analyzers.Test.Verifiers.StyleCopCodeFixVerifier<
+        StyleCop.Analyzers.MaintainabilityRules.SA1404CodeAnalysisSuppressionMustHaveJustification,
+        StyleCop.Analyzers.MaintainabilityRules.SA1404CodeFixProvider>;
 
     public partial class SA1404CSharp11UnitTests : SA1404CSharp10UnitTests
     {
+        // NOTE: This tests a fix for a c# 10 feature, but the Roslyn API used to solve it wasn't available in the version
+        // we use in the c# 10 test project, so the test was added here instead.
+        [Fact]
+        [WorkItem(3594, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3594")]
+        public async Task TestUsingNameChangeInGlobalUsingInAnotherFileAsync()
+        {
+            var testCode1 = @"
+global using MySuppressionAttribute = System.Diagnostics.CodeAnalysis.SuppressMessageAttribute;";
+
+            var testCode2 = @"
+public class Foo
+{
+    [[|MySuppression(null, null)|]]
+    public void Bar()
+    {
+
+    }
+}";
+
+            var fixedCode2 = @"
+public class Foo
+{
+    [MySuppression(null, null, Justification = """ + SA1404CodeAnalysisSuppressionMustHaveJustification.JustificationPlaceholder + @""")]
+    public void Bar()
+    {
+
+    }
+}";
+
+            await new CSharpTest()
+            {
+                TestSources = { testCode1, testCode2 },
+                FixedSources = { testCode1, fixedCode2 },
+                RemainingDiagnostics =
+                {
+                    Diagnostic().WithLocation("/0/Test1.cs", 4, 32),
+                },
+                NumberOfIncrementalIterations = 2,
+                NumberOfFixAllIterations = 2,
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/ReadabilityRules/SA1121CSharp11UnitTests.cs

@@ -3,9 +3,66 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.ReadabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
     using StyleCop.Analyzers.Test.CSharp10.ReadabilityRules;
+    using Xunit;
+
+    using static StyleCop.Analyzers.Test.Verifiers.StyleCopCodeFixVerifier<
+        StyleCop.Analyzers.ReadabilityRules.SA1121UseBuiltInTypeAlias,
+        StyleCop.Analyzers.ReadabilityRules.SA1121CodeFixProvider>;
 
     public partial class SA1121CSharp11UnitTests : SA1121CSharp10UnitTests
     {
+        // NOTE: This tests a fix for a c# 10 feature, but the Roslyn API used to solve it wasn't available in the version
+        // we use in the c# 10 test project, so the test was added here instead.
+        [Fact]
+        [WorkItem(3594, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3594")]
+        public async Task TestUsingNameChangeInGlobalUsingInAnotherFileAsync()
+        {
+            var source1 = @"
+global using MyDouble = System.Double;";
+
+            var oldSource2 = @"
+class TestClass
+{
+    private [|MyDouble|] x;
+}";
+
+            var newSource2 = @"
+class TestClass
+{
+    private double x;
+}";
+
+            await new CSharpTest()
+            {
+                TestSources = { source1, oldSource2 },
+                FixedSources = { source1, newSource2 },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        [WorkItem(3594, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3594")]
+        public async Task TestUsingNameChangeInGlobalUsingInSameFileAsync()
+        {
+            var source = @"global using MyDouble = System.Double;
+class TestClass
+{
+    private [|MyDouble|] x;
+}";
+
+            var newSource = @"global using MyDouble = System.Double;
+class TestClass
+{
+    private double x;
+}";
+
+            await new CSharpTest()
+            {
+                TestSources = { source },
+                FixedSources = { newSource },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp12/Lightup/IImportScopeWrapperCSharp12UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp12.Lightup
+{
+    using StyleCop.Analyzers.Test.CSharp11.Lightup;
+
+    public partial class IImportScopeWrapperCSharp12UnitTests : IImportScopeWrapperCSharp11UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp13/Lightup/IImportScopeWrapperCSharp13UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp13.Lightup
+{
+    using StyleCop.Analyzers.Test.CSharp12.Lightup;
+
+    public partial class IImportScopeWrapperCSharp13UnitTests : IImportScopeWrapperCSharp12UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/Lightup/IImportScopeWrapperCSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.Lightup
+{
+    using StyleCop.Analyzers.Test.Lightup;
+
+    public partial class IImportScopeWrapperCSharp7UnitTests : IImportScopeWrapperUnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp8/Lightup/IImportScopeWrapperCSharp8UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp8.Lightup
+{
+    using StyleCop.Analyzers.Test.CSharp7.Lightup;
+
+    public partial class IImportScopeWrapperCSharp8UnitTests : IImportScopeWrapperCSharp7UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp9/Lightup/IImportScopeWrapperCSharp9UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp9.Lightup
+{
+    using StyleCop.Analyzers.Test.CSharp8.Lightup;
+
+    public partial class IImportScopeWrapperCSharp9UnitTests : IImportScopeWrapperCSharp8UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test/Lightup/IImportScopeWrapperUnitTests.cs

@@ -0,0 +1,29 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.Lightup
+{
+    using System;
+    using StyleCop.Analyzers.Lightup;
+    using Xunit;
+
+    public class IImportScopeWrapperUnitTests
+    {
+        [Fact]
+        public void TestNull()
+        {
+            object? obj = null;
+            Assert.False(IImportScopeWrapper.IsInstance(obj!));
+            var wrapper = IImportScopeWrapper.FromObject(obj!);
+            Assert.Throws<NullReferenceException>(() => wrapper.Aliases);
+        }
+
+        [Fact]
+        public void TestIncompatibleInstance()
+        {
+            var obj = new object();
+            Assert.False(IImportScopeWrapper.IsInstance(obj));
+            Assert.Throws<InvalidCastException>(() => IImportScopeWrapper.FromObject(obj));
+        }
+    }
+}