defined first spec for testing

akkadotnet · Dec 27, 2023 · 2d4ab20 · 2d4ab20
1 parent 7701c67
commit 2d4ab20
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 12 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,7 +1,7 @@
 <Project>
     <PropertyGroup>
         <Copyright>Copyright © 2023 Your Company</Copyright>
-        <NoWarn>$(NoWarn);CS1591</NoWarn>
+        <NoWarn>$(NoWarn);CS1591;NU1701;CA1707;</NoWarn>
         <VersionPrefix>1.0.0</VersionPrefix>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     </PropertyGroup>

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -10,6 +10,8 @@
 
   <!-- Testing Utilities -->
   <ItemGroup>
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeFix.Testing.XUnit" Version="1.1.1" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.XUnit" Version="1.1.1" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
     <PackageVersion Include="xunit" Version="2.5.0" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.5.0" />

diff --git a/src/Akka.Analyzers.Tests/Akka.Analyzers.Tests.csproj b/src/Akka.Analyzers.Tests/Akka.Analyzers.Tests.csproj
@@ -21,6 +21,15 @@
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
         <PackageReference Include="FluentAssertions"/>
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.XUnit" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Akka.Analyzers\Akka.Analyzers.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="true" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Akka.Analyzers\Akka.Analyzers.csproj" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Akka.Analyzers.Tests/Analyzers/AK1000/MustNotUseNewKeywordOnActorSpecs.cs b/src/Akka.Analyzers.Tests/Analyzers/AK1000/MustNotUseNewKeywordOnActorSpecs.cs
@@ -0,0 +1,64 @@
+// -----------------------------------------------------------------------
+//  <copyright file="MustNotUseNewKeywordOnActorSpecs.cs" company="Akka.NET Project">
+//      Copyright (C) 2015-2023 .NET Petabridge, LLC
+//  </copyright>
+// -----------------------------------------------------------------------
+
+using Microsoft.CodeAnalysis.CSharp.Testing;
+using Microsoft.CodeAnalysis.Testing;
+using Microsoft.CodeAnalysis.Testing.Verifiers;
+
+namespace Akka.Analyzers.Tests.Analyzers.AK1000;
+
+public class AkkaActorInstantiationAnalyzerTests
+{
+    [Fact]
+    public async Task Analyzer_Should_Not_Report_Diagnostic_For_Valid_Usage()
+    {
+        var testCode = @"
+using Akka.Actor;
+
+class MyActor : ActorBase { }
+
+class Test
+{
+    void Method()
+    {
+        ActorSystem sys = ActorSystem.Create(""MySys"");
+        Props props = Props.Create(() => new MyActor());
+        IActorRef realActorInstance = sys.ActorOf(props);
+    }
+}";
+        await new CSharpAnalyzerTest<MustNotUseNewKeywordOnActorsAnalyzer, XUnitVerifier>
+        {
+            TestCode = testCode,
+        }.RunAsync().ConfigureAwait(true);
+    }
+
+    [Fact]
+    public async Task Analyzer_Should_Report_Diagnostic_For_Invalid_Usage()
+    {
+        var testCode = @"
+using Akka.Actor;
+
+class MyActor : ActorBase { }
+
+class Test
+{
+    void Method()
+    {
+        MyActor actorInstance = new MyActor();
+    }
+}";
+
+        await new CSharpAnalyzerTest<MustNotUseNewKeywordOnActorsAnalyzer, XUnitVerifier>
+        {
+            TestCode = testCode,
+            ExpectedDiagnostics =
+            {
+                // The diagnostic expected to be raised by the analyzer
+                DiagnosticResult.CompilerError("AkkaActorInstantiation").WithSpan(10, 31, 10, 45).WithArguments("MyActor"),
+            },
+        }.RunAsync().ConfigureAwait(false);
+    }
+}
diff --git a/src/Akka.Analyzers.Tests/UnitTest1.cs b/src/Akka.Analyzers.Tests/UnitTest1.cs
diff --git a/...rs/AK1000/MustNotUseNewKeywordOnActors.cs → ...0/MustNotUseNewKeywordOnActorsAnalyzer.cs b/...rs/AK1000/MustNotUseNewKeywordOnActors.cs → ...0/MustNotUseNewKeywordOnActorsAnalyzer.cs
@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------
-//  <copyright file="MustNotUseNewKeywordOnActors.cs" company="Akka.NET Project">
+//  <copyright file="MustNotUseNewKeywordOnActorsAnalyzer.cs" company="Akka.NET Project">
 //      Copyright (C) 2015-2023 .NET Petabridge, LLC
 //  </copyright>
 // -----------------------------------------------------------------------
@@ -12,7 +12,7 @@
 namespace Akka.Analyzers;
 
 [DiagnosticAnalyzer(LanguageNames.CSharp)]
-public class MustNotUseNewKeywordOnActors() : AkkaDiagnosticAnalyzer(RuleDescriptors.Ak1000DoNotNewActors)
+public class MustNotUseNewKeywordOnActorsAnalyzer() : AkkaDiagnosticAnalyzer(RuleDescriptors.Ak1000DoNotNewActors)
 {
     public override void AnalyzeCompilation(CompilationStartAnalysisContext context, AkkaContext akkaContext)
     {

diff --git a/src/Akka.Analyzers/Properties/Friends.cs b/src/Akka.Analyzers/Properties/Friends.cs
@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Akka.Analyzers.Tests")]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		using System.Runtime.CompilerServices;

		[assembly: InternalsVisibleTo("Akka.Analyzers.Tests")]