Merge pull request #2186 from pdelvo/settingsnre

Fixes that the settings system crashes on an empty or missing settings file

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/Settings/SettingsUnitTests.cs

@@ -152,6 +152,19 @@ public async Task VerifyInvalidJsonBehaviorAsync()
             Assert.Equal("Copyright (c) PlaceholderCompany. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
         }
 
+        [Fact]
+        public async Task VerifyEmptyOrMissingFileAsync()
+        {
+            var settings = string.Empty;
+            var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
+
+            var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
+
+            // The result is the same as the default settings.
+            Assert.Equal("PlaceholderCompany", styleCopSettings.DocumentationRules.CompanyName);
+            Assert.Equal("Copyright (c) PlaceholderCompany. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
+        }
+
         private static async Task<SyntaxTreeAnalysisContext> CreateAnalysisContextAsync(string stylecopJSON)
         {
             var projectId = ProjectId.CreateNewId();

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

@@ -58,6 +58,19 @@ public async Task TestInvalidSettingsAsync()
             await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
+        [Fact]
+        public async Task TestEmptySettingsAsync()
+        {
+            // The test infrastructure will not add a settings file to the compilation if GetSettings returns null or an empty string.
+            // This is why we set settings to a simple whitespace character.
+            this.settings = " ";
+
+            // This diagnostic is reported without a location
+            DiagnosticResult expected = this.CSharpDiagnostic();
+
+            await this.VerifyCSharpDiagnosticAsync(TestCode, expected, CancellationToken.None).ConfigureAwait(false);
+        }
+
         /// <inheritdoc/>
         protected override string GetSettings()
         {

StyleCop.Analyzers/StyleCop.Analyzers/Settings/SettingsHelper.cs

@@ -127,6 +127,12 @@ private static StyleCopSettings GetStyleCopSettings(SourceText text, Deserializa
             try
             {
                 var root = JsonConvert.DeserializeObject<SettingsFile>(text.ToString());
+
+                if (root == null)
+                {
+                    throw new JsonException($"Settings file was missing or empty.");
+                }
+
                 return root.Settings;
             }
             catch (JsonException) when (failureBehavior == DeserializationFailureBehavior.ReturnDefaultSettings)
@@ -160,6 +166,12 @@ private static StyleCopSettings GetStyleCopSettings(ImmutableArray<AdditionalTex
                     {
                         SourceText additionalTextContent = additionalFile.GetText(cancellationToken);
                         var root = JsonConvert.DeserializeObject<SettingsFile>(additionalTextContent.ToString());
+
+                        if (root == null)
+                        {
+                            throw new JsonException($"Settings file at '{Path.GetFileName(additionalFile.Path)}' was missing or empty.");
+                        }
+
                         return root.Settings;
                     }
                 }