Refactored the VS add-in

visual_studio/NativeClientVSAddIn/UnitTests/TestUtilities.cs

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 namespace UnitTests
 {
   using System;
   using System.Collections.Generic;
   using System.IO;
   using System.Linq;
@@ skipping 18 matching lines @@
     /// Uniquename of the NaCl project in BlankValidSolution.
     /// </summary>
     public const string BlankNaClProjectUniqueName = @"NaClProject\NaClProject.vcxproj";
 
     /// <summary>
     /// Uniquename of the non-NaCl project in BlankValidSolution.
     /// </summary>
     public const string NotNaClProjectUniqueName = @"NotNaCl\NotNaCl.csproj";
 
     /// <summary>
+    /// A generic boolean statement to be used with RetryWithTimeout.
+    /// </summary>
+    /// <returns>True if the statement is true, false if false.</returns>
+    public delegate bool RetryStatement();
+
+    /// <summary>
     /// This starts an instance of Visual Studio and get its DTE object.
     /// </summary>
     /// <returns>DTE of the started instance.</returns>
     public static DTE2 StartVisualStudioInstance()
     {
       // Set up filter to handle threading events and automatically retry calls
       // to dte which fail because dte is busy.
       ComMessageFilter.Register();
 
       Type visualStudioType = Type.GetTypeFromProgID("VisualStudio.DTE.10.0");
@@ skipping 78 matching lines @@
         if (dte.Solution != null)
         {
           dte.Solution.Close();
         }
       }
 
       return newSolution;
     }
 
     /// <summary>
-    /// Ensures that the add-in is configured to load on start. If it isn't then some tests may
-    /// unexpectedly fail, this check helps catch that problem early.
-    /// </summary>
-    /// <param name="dte">The main Visual Studio interface.</param>
-    /// <param name="addInName">The name of the add-in to check if loaded.</param>
-    public static void AssertAddinLoaded(DTE2 dte, string addInName)
-    {
-      bool found = false;
-      foreach (AddIn addin in dte.AddIns)
-      {
-        if (addin.Connected && addInName.Equals(addin.Name))
-        {
-          found = true;
-          break;
-        }
-      }
-
-      Assert.IsTrue(found, "Add-in is not configured to load on start.");
-    }
-
-    /// <summary>
     /// This returns the text contained in the given output window pane.
     /// </summary>
     /// <param name="pane">Pane to get text from.</param>
     /// <returns>Text in the window.</returns>
     public static string GetPaneText(OutputWindowPane pane)
     {
       TextSelection selection = pane.TextDocument.Selection;
       selection.StartOfDocument(false);
       selection.EndOfDocument(true);
       return selection.Text;
@@ skipping 210 matching lines @@
       string message = string.Format(
           "{0} was null or empty. Page: {1}, Configuration: {2}",
           propertyName,
           pageName,
           configuration.ConfigurationName);
 
       Assert.IsFalse(string.IsNullOrEmpty(propertyValue), message);
     }
 
     /// <summary>
+    /// Ensures that the add-in is configured to load on start. If it isn't then some tests may
+    /// unexpectedly fail, this check helps catch that problem early.
+    /// </summary>
+    /// <param name="dte">The main Visual Studio interface.</param>
+    /// <param name="addInName">The name of the add-in to check if loaded.</param>
+    public static void AssertAddinLoaded(DTE2 dte, string addInName)
+    {
+      bool found = false;
+      foreach (AddIn addin in dte.AddIns)
+      {
+        if (addin.Connected && addInName.Equals(addin.Name))
+        {
+          found = true;
+          break;
+        }
+      }
+
+      Assert.IsTrue(found, "Add-in is not configured to load on start.");
+    }
+
+    /// <summary>
+    /// Will retry the given statement up to maxRetry times while pausing between each try for
+    /// the given interval.
+    /// </summary>
+    /// <param name="test">Generic boolean statement.</param>
+    /// <param name="interval">Amount of time to wait between each retry.</param>
+    /// <param name="maxRetry">Maximum number of retries.</param>
+    /// <param name="message">Message to print on failure.</param>
+    public static void AssertTrueWithTimeout(
+        RetryStatement test, TimeSpan interval, int maxRetry, string message)
+    {
+      for (int tryCount = 0; tryCount <= maxRetry; tryCount++)
+      {
+        if (test.Invoke())
+        {
+          return;
+        }
+
+        System.Threading.Thread.Sleep(interval);
+      }
+
+      throw new Exception(string.Format("Statement timed out. {0}", message));
+    }
+
+    /// <summary>
     /// Extends the string class to allow checking if a string contains another string
     /// allowing a comparison type (such as case-insensitivity).
     /// </summary>
     /// <param name="source">Base string to search.</param>
     /// <param name="toCheck">String to check if contained within base string.</param>
     /// <param name="comparison">Comparison type.</param>
     /// <returns>True if toCheck is contained in source.</returns>
     public static bool Contains(this string source, string toCheck, StringComparison comparison)
     {
       return source.IndexOf(toCheck, comparison) != -1;
@@ skipping 26 matching lines @@
       }
 
       foreach (DirectoryInfo subdir in dir.GetDirectories())
       {
         string path = Path.Combine(dest, subdir.Name);
         CopyDirectory(subdir.FullName, path);
       }
     }
   }
 }