Merge pull request #1825 from sharwell/fix-nre

Fix NullReferenceException in SA1623/SA1624

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs

@@ -32,11 +32,15 @@ public class SA1623UnitTests : CodeFixVerifier
         [InlineData("public", "int", "{ get; internal set; }", "Gets")]
         [InlineData("public", "int", "{ get; private set; }", "Gets")]
         [InlineData("public", "int", "{ get; }", "Gets")]
+        [InlineData("public", "int", "{ get; } = 0;", "Gets")]
+        [InlineData("public", "int", "=> 0;", "Gets")]
         [InlineData("public", "int", "{ set { } }", "Sets")]
         [InlineData("public", "int", "{ internal get { return 0; } set { } }", "Sets")]
         [InlineData("public", "int", "{ private get { return 0; } set { } }", "Sets")]
         [InlineData("public", "bool", "{ get; set; }", "Gets or sets a value indicating whether")]
         [InlineData("public", "bool", "{ get; }", "Gets a value indicating whether")]
+        [InlineData("public", "bool", "{ get; } = true;", "Gets a value indicating whether")]
+        [InlineData("public", "bool", "=> true;", "Gets a value indicating whether")]
         [InlineData("public", "bool", "{ get; private set; }", "Gets a value indicating whether")]
         [InlineData("public", "bool", "{ set { } }", "Sets a value indicating whether")]
         [InlineData("public", "bool", "{ private get { return false; } set { } }", "Sets a value indicating whether")]

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1624UnitTests.cs

@@ -77,6 +77,36 @@ public class TestClass
             await this.VerifyCSharpFixAsync(testCode, fixedTestCode).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Verifies that documentation that starts with the proper text for multiple accessors will not produce this
+        /// diagnostic when the property has an expression body.
+        /// </summary>
+        /// <param name="accessibility">The accessibility of the property.</param>
+        /// <param name="type">The type to use for the property.</param>
+        /// <param name="summaryPrefix">The prefix to use in the summary text.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Theory]
+        [InlineData("public", "int", "Gets or sets")]
+        [InlineData("public", "bool", "Gets or sets a value indicating whether")]
+        [InlineData("protected", "int", "Gets or sets")]
+        [InlineData("protected internal", "int", "Gets or sets")]
+        [InlineData("internal", "int", "Gets or sets")]
+        public async Task VerifyThatInvalidDocumentationWillReportDiagnosticForExpressionBodyAsync(string accessibility, string type, string summaryPrefix)
+        {
+            var testCode = $@"
+public class TestClass
+{{
+    /// <summary>
+    /// {summaryPrefix} the test property.
+    /// </summary>
+    {accessibility} {type} TestProperty =>
+        default({type});
+}}
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
         /// <summary>
         /// Verify that no diagnostic will be reported when a public and a private accessor are present within a property that is defined in a contained class of a private class.
         /// </summary>
@@ -109,6 +139,12 @@ public int TestProperty
             await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
+        /// <inheritdoc/>
+        protected override IEnumerable<string> GetDisabledDiagnostics()
+        {
+            yield return PropertySummaryDocumentationAnalyzer.SA1623Descriptor.Id;
+        }
+
         /// <inheritdoc/>
         protected override CodeFixProvider GetCSharpCodeFixProvider()
         {

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.Designer.cs

@@ -148,7 +148,7 @@
     <value>The property's documentation summary text must begin with: '{0}'</value>
   </data>
   <data name="SA1623Title" xml:space="preserve">
-    <value>Property summary documentation must match accessors.</value>
+    <value>Property summary documentation must match accessors</value>
   </data>
   <data name="SA1624Description" xml:space="preserve">
     <value>The documentation text within a C# property’s &lt;summary&gt; tag takes into account all of the accessors within the property, but one of the accessors has limited access.</value>
@@ -157,7 +157,7 @@
     <value>Because the property only contains a visible {0} accessor, the documentation summary text must begin with '{1}'.</value>
   </data>
   <data name="SA1624Title" xml:space="preserve">
-    <value>Property summary documentation must omit accessor with restricted access.</value>
+    <value>Property summary documentation must omit accessor with restricted access</value>
   </data>
   <data name="SA1626CodeFix" xml:space="preserve">
     <value>Convert to line comment</value>

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/DocumentationResources.resx

@@ -80,20 +80,24 @@ protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlN
         private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax syntax, Location diagnosticLocation, PropertyDeclarationSyntax propertyDeclaration, string startingTextGets, string startingTextSets, string startingTextGetsOrSets)
         {
             var diagnosticProperties = ImmutableDictionary.CreateBuilder<string, string>();
+            ArrowExpressionClauseSyntax expressionBody = propertyDeclaration.ExpressionBody;
             AccessorDeclarationSyntax getter = null;
             AccessorDeclarationSyntax setter = null;
 
-            foreach (var accessor in propertyDeclaration.AccessorList.Accessors)
+            if (propertyDeclaration.AccessorList != null)
             {
-                switch (accessor.Keyword.Kind())
+                foreach (var accessor in propertyDeclaration.AccessorList.Accessors)
                 {
-                case SyntaxKind.GetKeyword:
-                    getter = accessor;
-                    break;
+                    switch (accessor.Keyword.Kind())
+                    {
+                    case SyntaxKind.GetKeyword:
+                        getter = accessor;
+                        break;
 
-                case SyntaxKind.SetKeyword:
-                    setter = accessor;
-                    break;
+                    case SyntaxKind.SetKeyword:
+                        setter = accessor;
+                        break;
+                    }
                 }
             }
 
@@ -107,12 +111,13 @@ private static void AnalyzeSummaryElement(SyntaxNodeAnalysisContext context, Xml
             var textElement = summaryElement.Content.FirstOrDefault() as XmlTextSyntax;
             var text = textElement == null ? string.Empty : XmlCommentHelper.GetText(textElement, true).TrimStart();
 
-            if (getter != null)
+            if (getter != null || expressionBody != null)
             {
                 bool startsWithGetOrSet = text.StartsWith(startingTextGetsOrSets, StringComparison.Ordinal);
 
                 if (setter != null)
                 {
+                    // There is no way getter is null (can't have expression body and accessor list)
                     var getterAccessibility = getter.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
                     var setterAccessibility = setter.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
                     bool getterVisible;