Fix #153: Script Analyzer is not returning markers

This change fixes an issue in 0.4.1 where Script Analyzer analysis markers
are not being returned by the AnalysisService.  This issue was caused by a
new optional parameter to the ScriptAnalyzer.Initialize method called
'includeDefaultRules' which was introduced in 1.3.0.  Since this parameter
has a default value of 'false', the default Script Analyzer rules were not
being loaded or applied in analysis runs.

Author: daviwil

src/PowerShellEditorServices/Analysis/AnalysisService.cs

@@ -3,8 +3,10 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.PowerShell.EditorServices.Utility;
 using Microsoft.Windows.PowerShell.ScriptAnalyzer;
 using System;
+using System.IO;
 using System.Linq;
 using System.Management.Automation.Runspaces;
 using System.Threading;
@@ -47,17 +49,30 @@ public class AnalysisService : IDisposable
         /// </summary>
         public AnalysisService()
         {
-            this.analysisRunspace = RunspaceFactory.CreateRunspace(InitialSessionState.CreateDefault2());
-            this.analysisRunspace.ApartmentState = ApartmentState.STA;
-            this.analysisRunspace.ThreadOptions = PSThreadOptions.ReuseThread;
-            this.analysisRunspace.Open();
+            try
+            {
+                // Attempt to create a ScriptAnalyzer instance first
+                // just in case the assembly can't be found and we
+                // can skip creating an extra runspace.
+                this.scriptAnalyzer = new ScriptAnalyzer();
+
+                this.analysisRunspace = RunspaceFactory.CreateRunspace(InitialSessionState.CreateDefault2());
+                this.analysisRunspace.ApartmentState = ApartmentState.STA;
+                this.analysisRunspace.ThreadOptions = PSThreadOptions.ReuseThread;
+                this.analysisRunspace.Open();
 
-            this.scriptAnalyzer = new ScriptAnalyzer();
-            this.scriptAnalyzer.Initialize(
-                this.analysisRunspace,
-                new AnalysisOutputWriter(),
-                null,
-                IncludedRules);
+                this.scriptAnalyzer.Initialize(
+                    this.analysisRunspace,
+                    new AnalysisOutputWriter(),
+                    includeRuleNames: IncludedRules,
+                    includeDefaultRules: true);
+            }
+            catch (FileNotFoundException)
+            {
+                Logger.Write(
+                    LogLevel.Warning,
+                    "Script Analyzer binaries not found, AnalysisService will be disabled.");
+            }
         }
 
         #endregion
@@ -72,7 +87,7 @@ public AnalysisService()
         /// <returns>An array of ScriptFileMarkers containing semantic analysis results.</returns>
         public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
         {
-            if (file.IsAnalysisEnabled)
+            if (this.scriptAnalyzer != null && file.IsAnalysisEnabled)
             {
                 // TODO: This is a temporary fix until we can change how
                 // ScriptAnalyzer invokes their async tasks.

test/PowerShellEditorServices.Test.Host/LanguageServerTests.cs

@@ -65,6 +65,22 @@ await this.WaitForEvent(
                 string.IsNullOrEmpty(diagnostics.Diagnostics[0].Message));
         }
 
+        [Fact]
+        public async Task ServiceReturnsSemanticMarkers()
+        {
+            // Send the 'didOpen' event
+            await this.SendOpenFileEvent("TestFiles\\SimpleSemanticError.ps1", false);
+
+            // Wait for the diagnostic event
+            PublishDiagnosticsNotification diagnostics = 
+                await this.WaitForEvent(
+                    PublishDiagnosticsNotification.Type);
+
+            // Was there a semantic error?
+            Assert.NotEqual(0, diagnostics.Diagnostics.Length);
+            Assert.Contains("unapproved", diagnostics.Diagnostics[0].Message);
+        }
+
         [Fact]
         public async Task ServiceCompletesFunctionName()
         {

test/PowerShellEditorServices.Test.Host/PowerShellEditorServices.Test.Host.csproj

@@ -83,6 +83,9 @@
     <None Include="TestFiles\MultiLineReplace.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="TestFiles\SimpleSemanticError.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="TestFiles\SimpleSyntaxError.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

test/PowerShellEditorServices.Test.Host/TestFiles/SimpleSemanticError.ps1

@@ -0,0 +1,3 @@
+function Do-Work {
+	# This should trigger the PSUseApprovedVerbs rule
+}