Merge pull request #3888 from bclothier/FixUnitTesting

Fix Heisenbug in unit test.

Author: retailcoder

Rubberduck.Core/App.cs

@@ -13,7 +13,6 @@
 using Rubberduck.Parsing.Inspections.Resources;
 using Rubberduck.Parsing.UIContext;
 using Rubberduck.UI.Command;
-using Rubberduck.VBEditor.ComManagement;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.VBEditor.Utility;
 using Rubberduck.VersionCheck;

Rubberduck.Core/UnitTesting/ProjectTestExtensions.cs

@@ -1,6 +1,7 @@
-using System.Runtime.InteropServices;
+using System;
+using System.Runtime.InteropServices;
 using System.Reflection;
-using System.IO;
+using Microsoft.Win32;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.UnitTesting
@@ -10,12 +11,27 @@ public static class ProjectTestExtensions
     {
         public static void EnsureReferenceToAddInLibrary(this IVBProject project)
         {
-            // FIXME should rely on the assembly containing the UnitTest components.
-            // Those are not necessarily the same.
-            var assembly = Assembly.GetEntryAssembly();
+            var libFolder = IntPtr.Size == 8 ? "win64" : "win32";
+            // TODO: This assumes the current assembly is same major/minor as the TLB!!!
+            var libVersion = Assembly.GetExecutingAssembly().GetName().Version;
+            const string libGuid = RubberduckGuid.RubberduckTypeLibGuid;
+            var pathKey = Registry.ClassesRoot.OpenSubKey($@"TypeLib\{{{libGuid}}}\{libVersion.Major}.{libVersion.Minor}\0\{libFolder}");
+            
+            var referencePath = pathKey?.GetValue(string.Empty, string.Empty) as string;
+            string name = null;
 
-            var name = assembly.GetName().Name.Replace('.', '_');
-            var referencePath = Path.ChangeExtension(assembly.Location, ".tlb");
+            if (!string.IsNullOrWhiteSpace(referencePath))
+            {
+                var tlbKey =
+                    Registry.ClassesRoot.OpenSubKey($@"TypeLib\{{{libGuid}}}\{libVersion.Major}.{libVersion.Minor}");
+
+                name = tlbKey?.GetValue(string.Empty, string.Empty) as string;
+            }
+            
+            if (string.IsNullOrWhiteSpace(referencePath) || string.IsNullOrWhiteSpace(name))
+            {
+                throw new InvalidOperationException("Cannot locate the tlb in the registry or the entry may be corrupted. Therefore early binding is not possible");
+            }
 
             using (var references = project.References)
             {

Rubberduck.Core/UnitTesting/TestEngine.cs

@@ -6,6 +6,7 @@
 using NLog;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI;
 using Rubberduck.UI.UnitTesting;
@@ -21,17 +22,41 @@ public class TestEngine : ITestEngine
         private readonly RubberduckParserState _state;
         private readonly IFakesFactory _fakesFactory;
         private readonly IVBETypeLibsAPI _typeLibApi;
+        private readonly IUiDispatcher _uiDispatcher;
 
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
-        public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesFactory fakesFactory, IVBETypeLibsAPI typeLibApi)
+        private bool _testRequested;
+        private IEnumerable<TestMethod> _tests;
+
+        public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesFactory fakesFactory, IVBETypeLibsAPI typeLibApi, IUiDispatcher uiDispatcher)
         {
             Debug.WriteLine("TestEngine created.");
             Model = model;
             _vbe = vbe;
             _state = state;
             _fakesFactory = fakesFactory;
             _typeLibApi = typeLibApi;
+            _uiDispatcher = uiDispatcher;
+
+            _state.StateChanged += StateChangedHandler;
+        }
+
+        private void StateChangedHandler(object sender, ParserStateEventArgs e)
+        {
+            if (_testRequested && (e.State == ParserState.Ready))
+            {
+                _testRequested = false;
+                _uiDispatcher.InvokeAsync(() =>
+                {
+                    RunInternal(_tests);
+                });
+            }
+
+            if (_testRequested && !e.IsError)
+            {
+                _testRequested = false;
+            }
         }
 
         public TestExplorerModel Model { get; }
@@ -51,11 +76,18 @@ public void Refresh()
 
         public void Run()
         {
+            _testRequested = true;
+            _tests = Model.LastRun;
+            // We will run the tests once parsing has completed
             Refresh();
-            Run(Model.LastRun);
         }
 
         public void Run(IEnumerable<TestMethod> tests)
+        {
+            _uiDispatcher.InvokeAsync(() => RunInternal(tests));
+        }
+
+        private void RunInternal(IEnumerable<TestMethod> tests)
         {
             var testMethods = tests as IList<TestMethod> ?? tests.ToList();
             if (!testMethods.Any())

Rubberduck.Core/UnitTesting/TestMethod.cs

@@ -8,7 +8,6 @@
 using Rubberduck.UI;
 using Rubberduck.UI.Controls;
 using Rubberduck.VBEditor;
-using Rubberduck.VBEditor.Application;
 using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 

Rubberduck.Parsing/VBA/RubberduckParserState.cs

@@ -51,6 +51,11 @@ public ParserStateEventArgs(ParserState state, CancellationToken token)
 
         public ParserState State { get; }
         public CancellationToken Token { get; }
+
+        public bool IsError => (State == ParserState.ResolverError ||
+                                State == ParserState.Error ||
+                                State == ParserState.UnexpectedError);
+
     }
 
     public class RubberduckStatusMessageEventArgs : EventArgs
@@ -535,10 +540,7 @@ public ParserState GetModuleState(QualifiedModuleName module)
 
         private readonly object _statusLockObject = new object(); 
         private ParserState _status;
-        public ParserState Status
-        {
-            get => _status;
-        }
+        public ParserState Status => _status;
 
         private void SetStatusWithCancellation(ParserState value, CancellationToken token)
         {
@@ -659,7 +661,7 @@ private IReadOnlyList<UnboundMemberDeclaration> AllUnresolvedMemberDeclarationsF
         }
 
         private readonly ConcurrentBag<SerializableProject> _builtInDeclarationTrees = new ConcurrentBag<SerializableProject>();
-        public IProducerConsumerCollection<SerializableProject> BuiltInDeclarationTrees { get { return _builtInDeclarationTrees; } }
+        public IProducerConsumerCollection<SerializableProject> BuiltInDeclarationTrees => _builtInDeclarationTrees;
 
         /// <summary>
         /// Gets a copy of the collected declarations, excluding the built-in ones.

RubberduckTests/Refactoring/MoveCloserToUsageTests.cs

@@ -887,13 +887,11 @@ Dim foo As Object
     foo.OtherProperty = 1626
 End Sub";
 
-            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(input, out var component);
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(input, out var component, referenceStdLibs: true);
+            
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
                 var messageBox = new Mock<IMessageBox>();
-                messageBox.Setup(m => m.Show(It.IsAny<string>(), It.IsAny<string>(),
-                                             It.IsAny<MessageBoxButtons>(), It.IsAny<MessageBoxIcon>()))
-                          .Returns(DialogResult.OK);
                 var refactoring = new MoveCloserToUsageRefactoring(vbe.Object, state, messageBox.Object);
                 refactoring.Refactor(state.AllUserDeclarations.First(d => d.DeclarationType == DeclarationType.Variable));
                 var rewriter = state.GetRewriter(component);