Merge pull request #127 from bkoelman/fix-toplevel-statements

Fixed invalid warning on global namespace for compiler-generated top-level Program class

Author: bkoelman

coverage.bat

@@ -4,7 +4,7 @@ md coverage
 
 set configuration=Debug
 set opencover="%USERPROFILE%\.nuget\packages\OpenCover\4.7.1221\tools\OpenCover.Console.exe"
-set reportgenerator="%USERPROFILE%\.nuget\packages\ReportGenerator\4.8.12\tools\net47\ReportGenerator.exe"
+set reportgenerator="%USERPROFILE%\.nuget\packages\ReportGenerator\5.0.0\tools\net47\ReportGenerator.exe"
 set testrunner="%USERPROFILE%\.nuget\packages\xunit.runner.console\2.4.1\tools\net472\xunit.console.x86.exe"
 set target=".\src\CSharpGuidelinesAnalyzer\CSharpGuidelinesAnalyzer.Test\bin\%configuration%\net48\CSharpGuidelinesAnalyzer.Test.dll -noshadow"
 set filter="+[CSharpGuidelinesAnalyzer*]*  -[CSharpGuidelinesAnalyzer.Test*]*"

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer.Test/CSharpGuidelinesAnalyzer.Test.csproj

@@ -21,12 +21,12 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="FluentAssertions" Version="6.1.0" />
-    <PackageReference Include="JetBrains.Annotations" Version="2021.2.0" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.CodeAnalysis" Version="3.11.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
+    <PackageReference Include="FluentAssertions" Version="6.2.0" />
+    <PackageReference Include="JetBrains.Annotations" Version="2021.3.0" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.CodeAnalysis" Version="4.0.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
     <PackageReference Include="OpenCover" Version="4.7.1221" />
-    <PackageReference Include="ReportGenerator" Version="4.8.12" />
+    <PackageReference Include="ReportGenerator" Version="5.0.0" />
     <PackageReference Include="ResharperCodeContractNullability" Version="2.0.2" PrivateAssets="all" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.console" Version="2.4.1">

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer.Test/Specs/Maintainability/NamespaceShouldMatchAssemblyNameSpecs.cs

@@ -1,5 +1,6 @@
 using CSharpGuidelinesAnalyzer.Rules.Maintainability;
 using CSharpGuidelinesAnalyzer.Test.TestDataBuilders;
+using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
 using Xunit;
 
@@ -380,6 +381,44 @@ class [|C|]
                 "Type 'C' is declared in namespace 'WrongRoot.JetBrains.Annotations', which does not match with assembly name 'Company.ProductName'.");
         }
 
+        [Fact]
+        internal void When_top_level_program_it_must_be_skipped()
+        {
+            // Arrange
+            ParsedSourceCode source = new TypeSourceCodeBuilder()
+                .InAssemblyNamed("Some.Scope.Example")
+                .WithOutputKind(OutputKind.ConsoleApplication)
+                .InGlobalScope(@"
+                    System.Console.WriteLine("""");
+                ")
+                .Build();
+
+            // Act and assert
+            VerifyGuidelineDiagnostic(source);
+        }
+
+        [Fact]
+        internal void When_explicit_program_in_global_namespace_it_must_be_reported()
+        {
+            // Arrange
+            ParsedSourceCode source = new TypeSourceCodeBuilder()
+                .InAssemblyNamed("Some.Scope.Example")
+                .WithOutputKind(OutputKind.ConsoleApplication)
+                .InGlobalScope(@"
+                    static class [|Program|]
+                    {
+                        static void Main()
+                        {
+                            System.Console.WriteLine("""");
+                        }
+                    }
+                ")
+                .Build();
+
+            // Act and assert
+            VerifyGuidelineDiagnostic(source, "Type 'Program' is declared in global namespace, which does not match with assembly name 'Some.Scope.Example'.");
+        }
+
         protected override DiagnosticAnalyzer CreateAnalyzer()
         {
             return new NamespaceShouldMatchAssemblyNameAnalyzer();

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer.csproj

@@ -46,8 +46,8 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="JetBrains.Annotations" Version="2021.2.0" PrivateAssets="all" />
-    <PackageReference Include="JetBrains.ExternalAnnotations" Version="10.2.100" PrivateAssets="all" />
+    <PackageReference Include="JetBrains.Annotations" Version="2021.3.0" PrivateAssets="all" />
+    <PackageReference Include="JetBrains.ExternalAnnotations" Version="10.2.103" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CodeAnalysis" Version="2.6.0" PrivateAssets="all" />
     <PackageReference Include="ResharperCodeContractNullability" Version="2.0.2" PrivateAssets="all" />
   </ItemGroup>

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/Maintainability/NamespaceShouldMatchAssemblyNameAnalyzer.cs

@@ -12,6 +12,10 @@ namespace CSharpGuidelinesAnalyzer.Rules.Maintainability
     [DiagnosticAnalyzer(LanguageNames.CSharp)]
     public sealed class NamespaceShouldMatchAssemblyNameAnalyzer : DiagnosticAnalyzer
     {
+        // Copied from Microsoft.CodeAnalysis.WellKnownMemberNames, which provides these in later versions.
+        private const string TopLevelStatementsEntryPointTypeName = "Program";
+        private const string TopLevelStatementsEntryPointMethodName = "<Main>$";
+
         private const string Title = "Namespace should match with assembly name";
         private const string NamespaceMessageFormat = "Namespace '{0}' does not match with assembly name '{1}'.";
         private const string TypeInNamespaceMessageFormat = "Type '{0}' is declared in namespace '{1}', which does not match with assembly name '{2}'.";
@@ -94,12 +98,17 @@ private static void AnalyzeNamedType(SymbolAnalysisContext context)
         {
             var type = (INamedTypeSymbol)context.Symbol;
 
-            if (type.ContainingNamespace.IsGlobalNamespace && !type.IsSynthesized())
+            if (type.ContainingNamespace.IsGlobalNamespace && !type.IsSynthesized() && !IsTopLevelStatementsContainer(type))
             {
                 context.ReportDiagnostic(Diagnostic.Create(GlobalTypeRule, type.Locations[0], type.Name, type.ContainingAssembly.Name));
             }
         }
 
+        private static bool IsTopLevelStatementsContainer([NotNull] INamedTypeSymbol type)
+        {
+            return type.Name == TopLevelStatementsEntryPointTypeName && type.GetMembers(TopLevelStatementsEntryPointMethodName).Any();
+        }
+
         private sealed class TypesInNamespaceVisitor : SymbolVisitor
         {
             [ItemNotNull]