Merge pull request #1536 from peteri/FixForMissingXmlEncodingInFileHeaderLogic

Added logic to escape characters in XmlComments in the fixer.

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1634UnitTests.cs

@@ -263,6 +263,51 @@ namespace Bar
  * <summary>This is a test file.</summary>
  */
 
+namespace Bar
+{
+}
+";
+
+            var expectedDiagnostic = this.CSharpDiagnostic(FileHeaderAnalyzers.SA1634Descriptor).WithLocation(1, 1);
+            await this.VerifyCSharpDiagnosticAsync(testCode, expectedDiagnostic, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpDiagnosticAsync(fixedCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that a multi line file header containing characters that need xml escaping gets fixed correctly.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestFileHeaderWithMultiLineCommentAndFieldsNeedingXmlEscapingAsync()
+        {
+            this.multiLineSettings = @"
+{
+  ""settings"": {
+    ""documentationRules"": {
+      ""companyName"": ""Foo & Bar \""quote\"" Corp"",
+      ""copyrightText"": ""copyright (c) {companyName}. All rights reserved.\n\nLine #3""
+    }
+  }
+}
+";
+
+            var testCode = @"// <author>FooCorp</author>
+// <summary>Foo &amp; Bar Corp Bar Class</summary>
+ 
+namespace Bar
+{
+}
+";
+
+            var fixedCode = @"// <copyright file=""Test0.cs"" company=""Foo &amp; Bar &quot;quote&quot; Corp"">
+// copyright (c) Foo &amp; Bar ""quote"" Corp. All rights reserved.
+//
+// Line #3
+// </copyright>
+// <author>FooCorp</author>
+// <summary>Foo &amp; Bar Corp Bar Class</summary>
+ 
 namespace Bar
 {
 }

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/FileHeaderCodeFixProvider.cs

@@ -10,6 +10,7 @@ namespace StyleCop.Analyzers.DocumentationRules
     using System.Text;
     using System.Threading;
     using System.Threading.Tasks;
+    using System.Xml.Linq;
     using Microsoft.CodeAnalysis;
     using Microsoft.CodeAnalysis.CodeActions;
     using Microsoft.CodeAnalysis.CodeFixes;
@@ -352,9 +353,13 @@ private static SyntaxTriviaList CreateNewHeader(string prefixWithLeadingSpaces,
 
         private static string WrapInXmlComment(string prefixWithLeadingSpaces, string copyrightText, string filename, StyleCopSettings settings, string newLineText)
         {
+            string encodedFilename = new XAttribute("t", filename).ToString().Substring(2).Trim('"');
+            string encodedCompanyName = new XAttribute("t", settings.DocumentationRules.CompanyName).ToString().Substring(2).Trim('"');
+            string encodedCopyrightText = new XText(copyrightText).ToString();
+
             return
-                $"{prefixWithLeadingSpaces} <copyright file=\"{filename}\" company=\"{settings.DocumentationRules.CompanyName}\">" + newLineText
-                + copyrightText + newLineText
+                $"{prefixWithLeadingSpaces} <copyright file=\"{encodedFilename}\" company=\"{encodedCompanyName}\">" + newLineText
+                + encodedCopyrightText + newLineText
                 + prefixWithLeadingSpaces + " </copyright>";
         }