Introducing Busy state and SuspendParser action

Rubberduck.API/VBA/Parser.cs

@@ -4,6 +4,7 @@
 using System.Globalization;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Threading;
 using Rubberduck.Common;
 using Rubberduck.Parsing.PreProcessing;
 using Rubberduck.Parsing.Symbols.DeclarationLoaders;
@@ -60,15 +61,17 @@ public sealed class Parser : IParser, IDisposable
     {
         private RubberduckParserState _state;
         private AttributeParser _attributeParser;
-        private ParseCoordinator _parser;
+        private SynchronousParseCoordinator _parser;
         private IVBE _vbe;
         private IVBEEvents _vbeEvents;
         private readonly IUiDispatcher _dispatcher;
+        private readonly CancellationTokenSource _tokenSource;
 
         internal Parser()
         {
             UiContextProvider.Initialize();
             _dispatcher = new UiDispatcher(UiContextProvider.Instance());
+            _tokenSource = new CancellationTokenSource();
         }
 
         // vbe is the com coclass interface from the interop assembly.
@@ -137,22 +140,21 @@ internal Parser(object vbe) : this()
                 supertypeClearer
                 );
 
-            _parser = new ParseCoordinator(
+            _parser = new SynchronousParseCoordinator(
                 _state,
                 parsingStageService,
                 parsingCacheService,
                 projectManager,
                 parserStateManager
                 );
         }
-
+        
         /// <summary>
         /// Blocking call, for easier unit-test code
         /// </summary>
         public void Parse()
         {
-            // blocking call
-            _parser.Parse(new System.Threading.CancellationTokenSource());
+            _parser.Parse(_tokenSource);
         }
 
         /// <summary>
@@ -163,7 +165,7 @@ public void BeginParse()
             // non-blocking call
             _dispatcher.Invoke(() => _state.OnParseRequested(this));
         }
-
+        
         public delegate void OnStateChangedDelegate(ParserState ParserState);
         public event OnStateChangedDelegate OnStateChanged;
 

Rubberduck.Core/Rubberduck.Core.csproj

@@ -231,18 +231,9 @@
     <Reference Include="Antlr4.Runtime, Version=4.6.0.0, Culture=neutral, PublicKeyToken=09abb75b9ed49849, processorArchitecture=MSIL">
       <HintPath>..\packages\Antlr4.Runtime.4.6.4\lib\net45\Antlr4.Runtime.dll</HintPath>
     </Reference>
-    <Reference Include="Castle.Core, Version=4.0.0.0, Culture=neutral, PublicKeyToken=407dd0808d44fbdc, processorArchitecture=MSIL">
-      <HintPath>..\packages\Castle.Core.4.2.1\lib\net45\Castle.Core.dll</HintPath>
-    </Reference>
-    <Reference Include="Castle.Windsor, Version=4.0.0.0, Culture=neutral, PublicKeyToken=407dd0808d44fbdc, processorArchitecture=MSIL">
-      <HintPath>..\packages\Castle.Windsor.4.1.0\lib\net45\Castle.Windsor.dll</HintPath>
-    </Reference>
     <Reference Include="EasyHook, Version=2.7.6684.0, Culture=neutral, PublicKeyToken=4b580fca19d0b0c5, processorArchitecture=MSIL">
       <HintPath>..\packages\EasyHook.2.7.6684\lib\net40\EasyHook.dll</HintPath>
     </Reference>
-    <Reference Include="extensibility, Version=7.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
-      <EmbedInteropTypes>True</EmbedInteropTypes>
-    </Reference>
     <Reference Include="HtmlAgilityPack, Version=1.8.4.0, Culture=neutral, PublicKeyToken=bd319b19eaf3b43a, processorArchitecture=MSIL">
       <HintPath>..\packages\HtmlAgilityPack.1.8.4\lib\Net45\HtmlAgilityPack.dll</HintPath>
     </Reference>
@@ -262,26 +253,14 @@
     <Reference Include="PresentationCore" />
     <Reference Include="PresentationFramework" />
     <Reference Include="PresentationFramework.Aero" />
-    <Reference Include="ReachFramework" />
-    <Reference Include="stdole, Version=7.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
-      <EmbedInteropTypes>False</EmbedInteropTypes>
-    </Reference>
     <Reference Include="System" />
-    <Reference Include="System.Configuration" />
     <Reference Include="System.Core" />
-    <Reference Include="System.Data" />
     <Reference Include="System.Drawing" />
     <Reference Include="System.IO.Compression" />
     <Reference Include="System.Net.Http" />
-    <Reference Include="System.Printing" />
-    <Reference Include="System.Runtime.Remoting" />
-    <Reference Include="System.Runtime.Serialization" />
-    <Reference Include="System.ServiceModel" />
-    <Reference Include="System.Transactions" />
     <Reference Include="System.ValueTuple, Version=4.0.2.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
       <HintPath>..\packages\System.ValueTuple.4.4.0\lib\netstandard1.0\System.ValueTuple.dll</HintPath>
     </Reference>
-    <Reference Include="System.Web" />
     <Reference Include="System.Windows.Forms" />
     <Reference Include="System.Windows.Interactivity, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <HintPath>..\packages\System.Windows.Interactivity.WPF.2.0.20525\lib\net40\System.Windows.Interactivity.dll</HintPath>
@@ -924,6 +903,9 @@
     <Folder Include="Properties\DataSources\" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="AutoComplete\AutoCompleteFunctionBlock.cs" />
+    <Compile Include="AutoComplete\AutoCompletePropertyBlock.cs" />
+    <Compile Include="AutoComplete\AutoCompleteSubBlock.cs" />
     <Content Include="EasyHook32.dll">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
@@ -942,9 +924,6 @@
     <Content Include="EasyLoad64.dll">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
-    <Compile Include="AutoComplete\AutoCompleteFunctionBlock.cs" />
-    <Compile Include="AutoComplete\AutoCompletePropertyBlock.cs" />
-    <Compile Include="AutoComplete\AutoCompleteSubBlock.cs" />
     <None Include="NLog.xsd">
       <SubType>Designer</SubType>
     </None>

Rubberduck.Core/UI/Command/RunAllTestsCommand.cs

@@ -31,11 +31,9 @@ public RunAllTestsCommand(IVBE vbe, RubberduckParserState state, ITestEngine eng
             _presenter = presenter;
         }
 
-        private static readonly ParserState[] AllowedRunStates = { ParserState.ResolvedDeclarations, ParserState.ResolvingReferences, ParserState.Ready };
-
         protected override bool EvaluateCanExecute(object parameter)
         {
-            return _vbe.IsInDesignMode && AllowedRunStates.Contains(_state.Status);
+            return _vbe.IsInDesignMode && _engine.AllowedRunStates.Contains(_state.Status);
         }
 
         protected override void OnExecute(object parameter)

Rubberduck.Core/UI/Inspections/InspectionResultsViewModel.cs

@@ -292,6 +292,11 @@ private void HandleStateChanged(object sender, ParserStateEventArgs e)
                 return;
             }
 
+            if (_state.Status == ParserState.Ready && e.OldState == ParserState.Busy)
+            {
+                return;
+            }
+
             if (_runInspectionsOnReparse || IsRefreshing)
             {
                 RefreshInspections(e.Token);

Rubberduck.Core/UnitTesting/ITestEngine.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.UnitTesting;
 using Rubberduck.VBEditor;
 
@@ -12,6 +13,7 @@ public interface ITestEngine
         void Run(IEnumerable<TestMethod> tests);
         void Refresh();
         event EventHandler TestCompleted;
+        ParserState[] AllowedRunStates { get; }
     }
 
     public class TestModuleEventArgs : EventArgs

Rubberduck.Core/UnitTesting/TestEngine.cs

@@ -24,6 +24,13 @@ public class TestEngine : ITestEngine
         private readonly IVBETypeLibsAPI _typeLibApi;
         private readonly IUiDispatcher _uiDispatcher;
 
+        public ParserState[] AllowedRunStates => new[]
+        {
+            ParserState.ResolvedDeclarations,
+            ParserState.ResolvingReferences, 
+            ParserState.Ready
+        };
+
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
         private bool _testRequested;
@@ -38,7 +45,7 @@ public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state
             _fakesFactory = fakesFactory;
             _typeLibApi = typeLibApi;
             _uiDispatcher = uiDispatcher;
-
+            
             _state.StateChanged += StateChangedHandler;
         }
 
@@ -88,67 +95,115 @@ public void Run(IEnumerable<TestMethod> tests)
         }
 
         private void RunInternal(IEnumerable<TestMethod> tests)
+        {
+            if (!AllowedRunStates.Contains(_state.Status))
+            {
+                return;
+            }
+
+            _state.OnSuspendParser(this, AllowedRunStates, () => RunWhileSuspended(tests));
+        }
+
+        private void RunWhileSuspended(IEnumerable<TestMethod> tests)
         {
             var testMethods = tests as IList<TestMethod> ?? tests.ToList();
             if (!testMethods.Any())
             {
                 return;
             }
 
-            var modules = testMethods.GroupBy(test => test.Declaration.QualifiedName.QualifiedModuleName);
-            foreach (var module in modules)
+            try
             {
-                var testInitialize = module.Key.FindTestInitializeMethods(_state).ToList();
-                var testCleanup = module.Key.FindTestCleanupMethods(_state).ToList();
+                var modules = testMethods.GroupBy(test => test.Declaration.QualifiedName.QualifiedModuleName);
+                foreach (var module in modules)
+                {
+                    var testInitialize = module.Key.FindTestInitializeMethods(_state).ToList();
+                    var testCleanup = module.Key.FindTestCleanupMethods(_state).ToList();
 
-                var capturedModule = module;
-                var moduleTestMethods = testMethods
-                    .Where(test => test.Declaration.QualifiedName.QualifiedModuleName.ProjectId == capturedModule.Key.ProjectId
-                                && test.Declaration.QualifiedName.QualifiedModuleName.ComponentName == capturedModule.Key.ComponentName);
+                    var capturedModule = module;
+                    var moduleTestMethods = testMethods
+                        .Where(test =>
+                        {
+                            var qmn = test.Declaration.QualifiedName.QualifiedModuleName;
 
-                var fakes = _fakesFactory.Create();
-                Run(module.Key.FindModuleInitializeMethods(_state));
-                foreach (var test in moduleTestMethods)
-                {
-                    // no need to run setup/teardown for ignored tests
-                    if (test.Declaration.Annotations.Any(a => a.AnnotationType == AnnotationType.IgnoreTest))
+                            return qmn.ProjectId == capturedModule.Key.ProjectId
+                                   && qmn.ComponentName == capturedModule.Key.ComponentName;
+                        });
+
+                    var fakes = _fakesFactory.Create();
+                    var initializeMethods = module.Key.FindModuleInitializeMethods(_state);
+                    try
                     {
-                        test.UpdateResult(TestOutcome.Ignored);
-                        OnTestCompleted();
+                        RunInternal(initializeMethods);
+                    }
+                    catch (COMException ex)
+                    {
+                        Logger.Error(ex,
+                            "Unexpected COM exception while initializing tests for module {0}. The module will be skipped.",
+                            module.Key.Name);
+                        foreach (var method in moduleTestMethods)
+                        {
+                            method.UpdateResult(TestOutcome.Unknown, AssertMessages.Assert_ComException);
+                        }
                         continue;
                     }
+                    foreach (var test in moduleTestMethods)
+                    {
+                        // no need to run setup/teardown for ignored tests
+                        if (test.Declaration.Annotations.Any(a => a.AnnotationType == AnnotationType.IgnoreTest))
+                        {
+                            test.UpdateResult(TestOutcome.Ignored);
+                            OnTestCompleted();
+                            continue;
+                        }
+
+                        var stopwatch = new Stopwatch();
+                        stopwatch.Start();
+
+                        try
+                        {
+                            fakes.StartTest();
+                            RunInternal(testInitialize);
+                            test.Run();
+                            RunInternal(testCleanup);
+                        }
+                        catch (COMException ex)
+                        {
+                            Logger.Error(ex, "Unexpected COM exception while running tests.");
+                            test.UpdateResult(TestOutcome.Inconclusive, AssertMessages.Assert_ComException);
+                        }
+                        finally
+                        {
+                            fakes.StopTest();
+                        }
+
+                        stopwatch.Stop();
+                        test.Result.SetDuration(stopwatch.ElapsedMilliseconds);
 
-                    var stopwatch = new Stopwatch();
-                    stopwatch.Start();
-
+                        OnTestCompleted();
+                        Model.AddExecutedTest(test);
+                    }
+                    var cleanupMethods = module.Key.FindModuleCleanupMethods(_state);
                     try
                     {
-                        fakes.StartTest();
-                        Run(testInitialize);
-                        test.Run();
-                        Run(testCleanup);
+                        RunInternal(cleanupMethods);
                     }
                     catch (COMException ex)
                     {
-                        Logger.Error(ex, "Unexpected COM exception while running tests.", test.Declaration?.QualifiedName);
-                        test.UpdateResult(TestOutcome.Inconclusive, AssertMessages.Assert_ComException);
-                    }
-                    finally
-                    {
-                        fakes.StopTest();
+                        Logger.Error(ex,
+                            "Unexpected COM exception while cleaning up tests for module {0}. Aborting any further unit tests",
+                            module.Key.Name);
+                        break;
                     }
-
-                    stopwatch.Stop();
-                    test.Result.SetDuration(stopwatch.ElapsedMilliseconds);
-
-                    OnTestCompleted();
-                    Model.AddExecutedTest(test);
                 }
-                Run(module.Key.FindModuleCleanupMethods(_state));
+            }
+            catch (Exception ex)
+            {
+                Logger.Error(ex, "Unexpected expection while running unit tests; unit tests will be aborted");
             }
         }
 
-        private void Run(IEnumerable<Declaration> members)
+        private void RunInternal(IEnumerable<Declaration> members)
         {
             var groupedMembers = members.GroupBy(m => m.ProjectId);
             foreach (var group in groupedMembers)

Rubberduck.Core/packages.config

@@ -2,8 +2,6 @@
 <packages>
   <package id="Antlr4.Runtime" version="4.6.4" targetFramework="net46" />
   <package id="AvalonEdit" version="5.0.4" targetFramework="net46" />
-  <package id="Castle.Core" version="4.2.1" targetFramework="net46" />
-  <package id="Castle.Windsor" version="4.1.0" targetFramework="net46" />
   <package id="EasyHook" version="2.7.6684" targetFramework="net46" />
   <package id="HtmlAgilityPack" version="1.8.4" targetFramework="net46" />
   <package id="NLog" version="4.5.4" targetFramework="net46" />

Rubberduck.Main/Rubberduck.Main.csproj

@@ -316,30 +316,17 @@
     <Reference Include="extensibility, Version=7.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
       <EmbedInteropTypes>True</EmbedInteropTypes>
     </Reference>
-    <Reference Include="Infralution.Localization.Wpf">
-      <HintPath>..\libs\Infralution.Localization.Wpf.dll</HintPath>
-    </Reference>
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="NLog, Version=4.0.0.0, Culture=neutral, PublicKeyToken=5120e14c03d0593c, processorArchitecture=MSIL">
       <HintPath>..\packages\NLog.4.5.4\lib\net45\NLog.dll</HintPath>
     </Reference>
     <Reference Include="PresentationCore" />
     <Reference Include="PresentationFramework" />
-    <Reference Include="stdole, Version=7.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
-      <EmbedInteropTypes>False</EmbedInteropTypes>
-    </Reference>
     <Reference Include="System" />
-    <Reference Include="System.Configuration" />
-    <Reference Include="System.Data" />
     <Reference Include="System.Drawing" />
     <Reference Include="System.IO.Compression" />
-    <Reference Include="System.Runtime.Remoting" />
-    <Reference Include="System.Runtime.Serialization" />
-    <Reference Include="System.ServiceModel" />
-    <Reference Include="System.Transactions" />
     <Reference Include="System.Windows.Forms" />
     <Reference Include="System.Xaml" />
-    <Reference Include="System.Xml" />
     <Reference Include="WindowsBase" />
   </ItemGroup>
   <ItemGroup>

Rubberduck.Parsing/Rubberduck.Parsing.csproj

@@ -354,6 +354,7 @@
     <Compile Include="VBA\BuiltInDeclarationLoader.cs" />
     <Compile Include="PreProcessing\TokensValue.cs" />
     <Compile Include="VBA\SupertypeClearer.cs" />
+    <Compile Include="VBA\SynchronousParseCoordinator.cs" />
     <Compile Include="VBA\SynchronousSupertypeClearer.cs" />
     <Compile Include="VBA\SupertypeClearerBase.cs" />
     <Compile Include="VBA\ISupertypeClearer.cs" />