Merge pull request #2426 from sharwell/sa0002-test

Add a test for SA0002 when deserialization throws JsonParseException

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpecialRules/SA0002UnitTests.cs

@@ -3,15 +3,23 @@
 
 namespace StyleCop.Analyzers.Test.SpecialRules
 {
+    extern alias system;
+
+    using System;
     using System.Collections.Generic;
+    using System.Collections.Immutable;
     using System.Threading;
     using System.Threading.Tasks;
     using Analyzers.Settings;
     using Analyzers.SpecialRules;
+    using Microsoft.CodeAnalysis;
     using Microsoft.CodeAnalysis.Diagnostics;
+    using Microsoft.CodeAnalysis.Text;
     using TestHelper;
     using Xunit;
 
+    using ExcludeFromCodeCoverageAttribute = system::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute;
+
     /// <summary>
     /// Unit tests for <see cref="SA0002InvalidSettingsFile"/>.
     /// </summary>
@@ -60,7 +68,7 @@ public async Task TestInvalidSettingsAsync()
         }
 
         [Fact]
-        public async Task TestInvalidSettingValueAsync()
+        public async Task TestInvalidSettingStringValueAsync()
         {
             this.settings = @"
 {
@@ -78,6 +86,176 @@ public async Task TestInvalidSettingValueAsync()
             await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        public async Task TestInvalidSettingStringArrayElementValueAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""namingRules"": {
+      ""allowedHungarianPrefixes"": [ 3 ]
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingBooleanValueAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""documentationRules"": {
+      ""xmlHeader"": 3
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingIntegerValueAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""indentation"": {
+      ""tabSize"": ""3""
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingEnumValueNotStringAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""documentationRules"": {
+      ""fileNamingConvention"": 3
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingArrayElementEnumValueNotStringAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""maintainabilityRules"": {
+      ""topLevelTypes"": [ 3 ]
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingArrayElementEnumValueNotRecognizedAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""maintainabilityRules"": {
+      ""topLevelTypes"": [ ""Some incorrect value"" ]
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingArrayAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""namingRules"": {
+      ""allowedHungarianPrefixes"": ""ah""
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingObjectAsync()
+        {
+            this.settings = @"
+{
+  ""settings"": {
+    ""namingRules"": true
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        public async Task TestInvalidSettingSyntaxAsync()
+        {
+            // Missing the ':' between "companyName" and "name"
+            this.settings = @"
+{
+  ""settings"": {
+    ""documentationRules"": {
+      ""companyName"" ""name""
+    }
+  }
+}
+";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
         [Fact]
         public async Task TestEmptySettingsAsync()
         {
@@ -91,6 +269,21 @@ public async Task TestEmptySettingsAsync()
             await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        public void TestUnexpectedExceptionNotCaught()
+        {
+            var analysisContext = new AnalysisContextMissingOptions();
+            var analyzer = new SA0002InvalidSettingsFile();
+            analyzer.Initialize(analysisContext);
+            Assert.NotNull(analysisContext.CompilationAction);
+
+            var additionalFiles = ImmutableArray.Create<AdditionalText>(new InvalidAdditionalText());
+            Assert.Null(additionalFiles[0].Path);
+            Assert.Null(additionalFiles[0].GetText(CancellationToken.None));
+            var context = new CompilationAnalysisContext(compilation: null, options: new AnalyzerOptions(additionalFiles), reportDiagnostic: null, isSupportedDiagnostic: null, cancellationToken: CancellationToken.None);
+            Assert.Throws<NullReferenceException>(() => analysisContext.CompilationAction(context));
+        }
+
         /// <inheritdoc/>
         protected override string GetSettings()
         {
@@ -102,5 +295,73 @@ protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers(
         {
             yield return new SA0002InvalidSettingsFile();
         }
+
+        private class InvalidAdditionalText : AdditionalText
+        {
+            public override string Path => null;
+
+            public override SourceText GetText(CancellationToken cancellationToken) => null;
+        }
+
+        /// <summary>
+        /// This analysis context is used for testing the specific case where an exception occurs while evaluating the
+        /// stylecop.json settings file, but it is not one of the JSON deserialization exceptions caused by this
+        /// library's code.
+        /// </summary>
+        private class AnalysisContextMissingOptions : AnalysisContext
+        {
+            public Action<CompilationAnalysisContext> CompilationAction
+            {
+                get;
+                private set;
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterCodeBlockAction(Action<CodeBlockAnalysisContext> action)
+            {
+                throw new NotImplementedException();
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterCodeBlockStartAction<TLanguageKindEnum>(Action<CodeBlockStartAnalysisContext<TLanguageKindEnum>> action)
+            {
+                throw new NotImplementedException();
+            }
+
+            public override void RegisterCompilationAction(Action<CompilationAnalysisContext> action)
+            {
+                this.CompilationAction = action;
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterCompilationStartAction(Action<CompilationStartAnalysisContext> action)
+            {
+                throw new NotImplementedException();
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterSemanticModelAction(Action<SemanticModelAnalysisContext> action)
+            {
+                throw new NotImplementedException();
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterSymbolAction(Action<SymbolAnalysisContext> action, ImmutableArray<SymbolKind> symbolKinds)
+            {
+                throw new NotImplementedException();
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterSyntaxNodeAction<TLanguageKindEnum>(Action<SyntaxNodeAnalysisContext> action, ImmutableArray<TLanguageKindEnum> syntaxKinds)
+            {
+                throw new NotImplementedException();
+            }
+
+            [ExcludeFromCodeCoverage]
+            public override void RegisterSyntaxTreeAction(Action<SyntaxTreeAnalysisContext> action)
+            {
+                throw new NotImplementedException();
+            }
+        }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test/StyleCop.Analyzers.Test.csproj

@@ -64,7 +64,9 @@
       <HintPath>..\..\packages\Microsoft.CodeAnalysis.Workspaces.Common.1.2.1\lib\net45\Microsoft.CodeAnalysis.Workspaces.Desktop.dll</HintPath>
       <Private>True</Private>
     </Reference>
-    <Reference Include="System" />
+    <Reference Include="System">
+      <Aliases>global,system</Aliases>
+    </Reference>
     <Reference Include="System.Collections.Immutable, Version=1.1.37.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
       <HintPath>..\..\packages\System.Collections.Immutable.1.1.37\lib\dotnet\System.Collections.Immutable.dll</HintPath>
       <Private>True</Private>