Updated unit test framework

Author: sharwell

OpenStackNetAnalyzers/OpenStackNetAnalyzers.Test/Helpers/CodeFixVerifier.Helper.cs

@@ -5,37 +5,48 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
+using System.Threading.Tasks;
+using System.Collections.Immutable;
 
 namespace TestHelper
 {
     /// <summary>
-    /// Diagnostic Producer class with extra methods dealing with applying codefixes
+    /// Diagnostic Producer class with extra methods dealing with applying code fixes.
     /// All methods are static
     /// </summary>
     public abstract partial class CodeFixVerifier : DiagnosticVerifier
     {
         /// <summary>
-        /// Apply the inputted CodeAction to the inputted document.
-        /// Meant to be used to apply codefixes.
+        /// Apply the inputted <see cref="CodeAction"/> to the inputted document.
+        /// Meant to be used to apply code fixes.
         /// </summary>
-        /// <param name="document">The Document to apply the fix on</param>
-        /// <param name="codeAction">A CodeAction that will be applied to the Document.</param>
-        /// <returns>A Document with the changes from the CodeAction</returns>
-        private static Document ApplyFix(Document document, CodeAction codeAction)
+        /// <param name="document">The <see cref="Document"/> to apply the fix on</param>
+        /// <param name="codeAction">A <see cref="CodeAction"/> that will be applied to the
+        /// <paramref name="document"/>.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>
+        /// <returns>A <see cref="Document"/> with the changes from the <see cref="CodeAction"/>.</returns>
+        private static async Task<Document> ApplyFixAsync(Document document, CodeAction codeAction, CancellationToken cancellationToken)
         {
-            var operations = codeAction.GetOperationsAsync(CancellationToken.None).Result;
+            var operations = await codeAction.GetOperationsAsync(cancellationToken).ConfigureAwait(false);
             var solution = operations.OfType<ApplyChangesOperation>().Single().ChangedSolution;
             return solution.GetDocument(document.Id);
         }
 
         /// <summary>
-        /// Compare two collections of Diagnostics,and return a list of any new diagnostics that appear only in the second collection.
-        /// Note: Considers Diagnostics to be the same if they have the same Ids.  In the case of multiple diagnostics with the same Id in a row,
-        /// this method may not necessarily return the new one.
+        /// Compare two collections of <see cref="Diagnostic"/>s, and return a list of any new diagnostics that appear
+        /// only in the second collection.
+        /// <note type="note">
+        /// <para>Considers <see cref="Diagnostic"/> to be the same if they have the same <see cref="Diagnostic.Id"/>s.
+        /// In the case of multiple diagnostics with the same <see cref="Diagnostic.Id"/> in a row, this method may not
+        /// necessarily return the new one.</para>
+        /// </note>
         /// </summary>
-        /// <param name="diagnostics">The Diagnostics that existed in the code before the CodeFix was applied</param>
-        /// <param name="newDiagnostics">The Diagnostics that exist in the code after the CodeFix was applied</param>
-        /// <returns>A list of Diagnostics that only surfaced in the code after the CodeFix was applied</returns>
+        /// <param name="diagnostics">The <see cref="Diagnostic"/>s that existed in the code before the code fix was
+        /// applied.</param>
+        /// <param name="newDiagnostics">The <see cref="Diagnostic"/>s that exist in the code after the code fix was
+        /// applied.</param>
+        /// <returns>A list of <see cref="Diagnostic"/>s that only surfaced in the code after the code fix was
+        /// applied.</returns>
         private static IEnumerable<Diagnostic> GetNewDiagnostics(IEnumerable<Diagnostic> diagnostics, IEnumerable<Diagnostic> newDiagnostics)
         {
             var oldArray = diagnostics.OrderBy(d => d.Location.SourceSpan.Start).ToArray();
@@ -59,27 +70,29 @@ private static IEnumerable<Diagnostic> GetNewDiagnostics(IEnumerable<Diagnostic>
         }
 
         /// <summary>
-        /// Get the existing compiler diagnostics on the inputted document.
+        /// Get the existing compiler diagnostics on the input document.
         /// </summary>
-        /// <param name="document">The Document to run the compiler diagnostic analyzers on</param>
-        /// <returns>The compiler diagnostics that were found in the code</returns>
-        private static IEnumerable<Diagnostic> GetCompilerDiagnostics(Document document)
+        /// <param name="document">The <see cref="Document"/> to run the compiler diagnostic analyzers on.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>
+        /// <returns>The compiler diagnostics that were found in the code.</returns>
+        private static async Task<ImmutableArray<Diagnostic>> GetCompilerDiagnosticsAsync(Document document, CancellationToken cancellationToken)
         {
-            return document.GetSemanticModelAsync().Result.GetDiagnostics();
+            var semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false);
+            return semanticModel.GetDiagnostics(cancellationToken: cancellationToken);
         }
 
         /// <summary>
-        /// Given a document, turn it into a string based on the syntax root
+        /// Given a document, turn it into a string based on the syntax root.
         /// </summary>
-        /// <param name="document">The Document to be converted to a string</param>
-        /// <returns>A string containing the syntax of the Document after formatting</returns>
-        private static string GetStringFromDocument(Document document)
+        /// <param name="document">The <see cref="Document"/> to be converted to a string.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>
+        /// <returns>A string containing the syntax of the <see cref="Document"/> after formatting.</returns>
+        private static async Task<string> GetStringFromDocumentAsync(Document document, CancellationToken cancellationToken)
         {
-            var simplifiedDoc = Simplifier.ReduceAsync(document, Simplifier.Annotation).Result;
-            var root = simplifiedDoc.GetSyntaxRootAsync().Result;
-            root = Formatter.Format(root, Formatter.Annotation, simplifiedDoc.Project.Solution.Workspace);
-            return root.GetText().ToString();
+            var simplifiedDoc = await Simplifier.ReduceAsync(document, Simplifier.Annotation, cancellationToken: cancellationToken).ConfigureAwait(false);
+            var formatted = await Formatter.FormatAsync(simplifiedDoc, Formatter.Annotation, cancellationToken: cancellationToken);
+            var sourceText = await formatted.GetTextAsync(cancellationToken).ConfigureAwait(false);
+            return sourceText.ToString();
         }
     }
 }
-

OpenStackNetAnalyzers/OpenStackNetAnalyzers.Test/Helpers/DiagnosticResult.cs

@@ -30,7 +30,7 @@ public DiagnosticResultLocation(string path, int line, int column)
     }
 
     /// <summary>
-    /// Struct that stores information about a Diagnostic appearing in a source
+    /// Structure that stores information about a <see cref="Diagnostic"/> appearing in a source.
     /// </summary>
     public struct DiagnosticResult
     {
@@ -72,7 +72,7 @@ public string Path
         {
             get
             {
-                return this.Locations.Length > 0 ? this.Locations[0].Path : "";
+                return this.Locations.Length > 0 ? this.Locations[0].Path : string.Empty;
             }
         }