Add API Analyzer Assembly (#906)

* Start on API analyzers * Finish GuildAccessAnalyzer * Update build script (will this do?) * Correct slashes * Extrapolate DerivesFromModuleBase() to an extension method * Quick refactoring * Add doc file
2018-01-14 04:54:47 +01:00
parent 87124d3e39
commit f69ef2a8ca
14 changed files with 1074 additions and 1 deletions
--- a/test/Discord.Net.Tests/AnalyzerTests/GuildAccessTests.cs
+++ b/test/Discord.Net.Tests/AnalyzerTests/GuildAccessTests.cs
@@ -0,0 +1,111 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.Diagnostics;
+using Discord.Analyzers;
+using TestHelper;
+using Xunit;
+
+namespace Discord
+{
+    public partial class AnalyserTests
+    {
+        public class GuildAccessTests : DiagnosticVerifier
+        {
+            [Fact]
+            public void VerifyDiagnosticWhenLackingRequireContext()
+            {
+                string source = @"using System;
+using System.Threading.Tasks;
+using Discord.Commands;
+
+namespace Test
+{
+    public class TestModule : ModuleBase<ICommandContext>
+    {
+        [Command(""test"")]
+        public Task TestCmd() => ReplyAsync(Context.Guild.Name);
+    }
+}";
+                var expected = new DiagnosticResult()
+                {
+                    Id = "DNET0001",
+                    Locations = new[] { new DiagnosticResultLocation("Test0.cs", line: 10, column: 45) },
+                    Message = "Command method 'TestCmd' is accessing 'Context.Guild' but is not restricted to Guild contexts.",
+                    Severity = DiagnosticSeverity.Warning
+                };
+                VerifyCSharpDiagnostic(source, expected);
+            }
+
+            [Fact]
+            public void VerifyDiagnosticWhenWrongRequireContext()
+            {
+                string source = @"using System;
+using System.Threading.Tasks;
+using Discord.Commands;
+
+namespace Test
+{
+    public class TestModule : ModuleBase<ICommandContext>
+    {
+        [Command(""test""), RequireContext(ContextType.Group)]
+        public Task TestCmd() => ReplyAsync(Context.Guild.Name);
+    }
+}";
+                var expected = new DiagnosticResult()
+                {
+                    Id = "DNET0001",
+                    Locations = new[] { new DiagnosticResultLocation("Test0.cs", line: 10, column: 45) },
+                    Message = "Command method 'TestCmd' is accessing 'Context.Guild' but is not restricted to Guild contexts.",
+                    Severity = DiagnosticSeverity.Warning
+                };
+                VerifyCSharpDiagnostic(source, expected);
+            }
+
+            [Fact]
+            public void VerifyNoDiagnosticWhenRequireContextOnMethod()
+            {
+                string source = @"using System;
+using System.Threading.Tasks;
+using Discord.Commands;
+
+namespace Test
+{
+    public class TestModule : ModuleBase<ICommandContext>
+    {
+        [Command(""test""), RequireContext(ContextType.Guild)]
+        public Task TestCmd() => ReplyAsync(Context.Guild.Name);
+    }
+}";
+
+                VerifyCSharpDiagnostic(source, Array.Empty<DiagnosticResult>());
+            }
+
+            [Fact]
+            public void VerifyNoDiagnosticWhenRequireContextOnClass()
+            {
+                string source = @"using System;
+using System.Threading.Tasks;
+using Discord.Commands;
+
+namespace Test
+{
+    [RequireContext(ContextType.Guild)]
+    public class TestModule : ModuleBase<ICommandContext>
+    {
+        [Command(""test"")]
+        public Task TestCmd() => ReplyAsync(Context.Guild.Name);
+    }
+}";
+
+                VerifyCSharpDiagnostic(source, Array.Empty<DiagnosticResult>());
+            }
+
+            protected override DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer()
+                => new GuildAccessAnalyzer();
+        }
+    }
+}