Merge pull request #1864 from PowerShell/andschwa/pssa

andyleejordan · web-flow · commit c6b7b9147b8c · 2022-07-29T16:47:11.000-07:00
Use `HostInfo.BundledModulePath` to find PSScriptAnalyzer
diff --git a/src/PowerShellEditorServices/Hosting/HostStartupInfo.cs b/src/PowerShellEditorServices/Hosting/HostStartupInfo.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Management.Automation.Host;
 using System.Management.Automation.Runspaces;
 
@@ -92,7 +93,7 @@ public sealed class HostStartupInfo
         public string LogPath { get; }
 
         /// <summary>
-        /// The InitialSessionState will be inherited from the orginal PowerShell process. This will
+        /// The InitialSessionState will be inherited from the original PowerShell process. This will
         /// be used when creating runspaces so that we honor the same InitialSessionState.
         /// </summary>
         public InitialSessionState InitialSessionState { get; }
@@ -167,7 +168,15 @@ public HostStartupInfo(
             LogLevel = logLevel;
             ConsoleReplEnabled = consoleReplEnabled;
             UsesLegacyReadLine = usesLegacyReadLine;
-            BundledModulePath = bundledModulePath;
+
+            // Respect a user provided bundled module path.
+            BundledModulePath = Directory.Exists(bundledModulePath)
+                ? bundledModulePath
+                : Path.GetFullPath(Path.Combine(
+                    Path.GetDirectoryName(typeof(HostStartupInfo).Assembly.Location),
+                    "..",
+                    "..",
+                    ".."));
         }
 
         #endregion
diff --git a/src/PowerShellEditorServices/Services/Analysis/AnalysisService.cs b/src/PowerShellEditorServices/Services/Analysis/AnalysisService.cs
@@ -11,6 +11,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
+using Microsoft.PowerShell.EditorServices.Hosting;
 using Microsoft.PowerShell.EditorServices.Services.Analysis;
 using Microsoft.PowerShell.EditorServices.Services.Configuration;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
@@ -52,8 +53,7 @@ internal static string GetUniqueIdFromDiagnostic(Diagnostic diagnostic)
             .Append(':')
             .Append(end.Character);
 
-            string id = sb.ToString();
-            return id;
+            return sb.ToString();
         }
 
         /// <summary>
@@ -96,20 +96,16 @@ internal static string GetUniqueIdFromDiagnostic(Diagnostic diagnostic)
 
         private CancellationTokenSource _diagnosticsCancellationTokenSource;
 
+        private readonly string _pssaModulePath;
+
         private string _pssaSettingsFilePath;
 
-        /// <summary>
-        /// Construct a new AnalysisService.
-        /// </summary>
-        /// <param name="loggerFactory">Logger factory to create logger instances with.</param>
-        /// <param name="languageServer">The LSP language server for notifications.</param>
-        /// <param name="configurationService">The configuration service to query for configurations.</param>
-        /// <param name="workspaceService">The workspace service for file handling within a workspace.</param>
         public AnalysisService(
             ILoggerFactory loggerFactory,
             ILanguageServerFacade languageServer,
             ConfigurationService configurationService,
-            WorkspaceService workspaceService)
+            WorkspaceService workspaceService,
+            HostStartupInfo hostInfo)
         {
             _loggerFactory = loggerFactory;
             _logger = loggerFactory.CreateLogger<AnalysisService>();
@@ -119,6 +115,7 @@ public AnalysisService(
             _analysisDelayMillis = 750;
             _mostRecentCorrectionsByFile = new ConcurrentDictionary<ScriptFile, CorrectionTableEntry>();
             _analysisEngineLazy = new Lazy<PssaCmdletAnalysisEngine>(InstantiateAnalysisEngine);
+            _pssaModulePath = Path.Combine(hostInfo.BundledModulePath, "PSScriptAnalyzer");
             _pssaSettingsFilePath = null;
         }
 
@@ -202,7 +199,7 @@ public async Task<string> GetCommentHelpText(string functionText, string helpLoc
                 return null;
             }
 
-            Hashtable commentHelpSettings = AnalysisService.GetCommentHelpRuleSettings(helpLocation, forBlockComment);
+            Hashtable commentHelpSettings = GetCommentHelpRuleSettings(helpLocation, forBlockComment);
 
             ScriptFileMarker[] analysisResults = await AnalysisEngine.AnalyzeScriptAsync(functionText, commentHelpSettings).ConfigureAwait(false);
 
@@ -285,7 +282,7 @@ private void InitializeAnalysisEngineToCurrentSettings()
             _analysisEngineLazy = new Lazy<PssaCmdletAnalysisEngine>(() => RecreateAnalysisEngine(currentAnalysisEngine));
         }
 
-        private PssaCmdletAnalysisEngine InstantiateAnalysisEngine()
+        internal PssaCmdletAnalysisEngine InstantiateAnalysisEngine()
         {
             PssaCmdletAnalysisEngine.Builder pssaCmdletEngineBuilder = new(_loggerFactory);
 
@@ -302,7 +299,7 @@ private PssaCmdletAnalysisEngine InstantiateAnalysisEngine()
                 pssaCmdletEngineBuilder.WithIncludedRules(s_defaultRules);
             }
 
-            return pssaCmdletEngineBuilder.Build();
+            return pssaCmdletEngineBuilder.Build(_pssaModulePath);
         }
 
         private PssaCmdletAnalysisEngine RecreateAnalysisEngine(PssaCmdletAnalysisEngine oldAnalysisEngine)
@@ -320,15 +317,15 @@ private PssaCmdletAnalysisEngine RecreateAnalysisEngine(PssaCmdletAnalysisEngine
 
         private bool TryFindSettingsFile(out string settingsFilePath)
         {
-            string configuredPath = _configurationService.CurrentSettings.ScriptAnalysis.SettingsPath;
+            string configuredPath = _configurationService?.CurrentSettings.ScriptAnalysis.SettingsPath;
 
             if (string.IsNullOrEmpty(configuredPath))
             {
                 settingsFilePath = null;
                 return false;
             }
 
-            settingsFilePath = _workspaceService.ResolveWorkspacePath(configuredPath);
+            settingsFilePath = _workspaceService?.ResolveWorkspacePath(configuredPath);
 
             if (settingsFilePath == null
                 || !File.Exists(settingsFilePath))
diff --git a/src/PowerShellEditorServices/Services/Analysis/PssaCmdletAnalysisEngine.cs b/src/PowerShellEditorServices/Services/Analysis/PssaCmdletAnalysisEngine.cs
@@ -5,7 +5,6 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
-using System.IO;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
@@ -67,35 +66,27 @@ public Builder WithIncludedRules(string[] rules)
             /// If PSScriptAnalyzer cannot be found, this will return null.
             /// </summary>
             /// <returns>A newly configured PssaCmdletAnalysisEngine, or null if PSScriptAnalyzer cannot be found.</returns>
-            public PssaCmdletAnalysisEngine Build()
+            public PssaCmdletAnalysisEngine Build(string pssaModulePath)
             {
                 // RunspacePool takes care of queuing commands for us so we do not
                 // need to worry about executing concurrent commands
                 ILogger logger = _loggerFactory.CreateLogger<PssaCmdletAnalysisEngine>();
                 try
                 {
-                    RunspacePool pssaRunspacePool = CreatePssaRunspacePool();
-
-                    PssaCmdletAnalysisEngine cmdletAnalysisEngine = _settingsParameter is not null
-                        ? new PssaCmdletAnalysisEngine(logger, pssaRunspacePool, _settingsParameter)
-                        : new PssaCmdletAnalysisEngine(logger, pssaRunspacePool, _rules);
-
+                    logger.LogDebug("Creating PSScriptAnalyzer runspace with module at: '{Path}'", pssaModulePath);
+                    RunspacePool pssaRunspacePool = CreatePssaRunspacePool(pssaModulePath);
+                    PssaCmdletAnalysisEngine cmdletAnalysisEngine = new(logger, pssaRunspacePool, _settingsParameter ?? _rules);
                     cmdletAnalysisEngine.LogAvailablePssaFeatures();
                     return cmdletAnalysisEngine;
                 }
-                catch (FileNotFoundException e)
+                catch (Exception ex)
                 {
-                    logger.LogError(e, $"Unable to find PSScriptAnalyzer. Disabling script analysis. PSModulePath: '{Environment.GetEnvironmentVariable("PSModulePath")}'");
+                    logger.LogError(ex, "Unable to load PSScriptAnalyzer, disabling script analysis!");
                     return null;
                 }
             }
         }
 
-        // This is a default that can be overriden at runtime by the user or tests.
-        // TODO: Deduplicate this logic with PsesInternalHost.
-        private static readonly string s_pssaModulePath = Path.GetFullPath(Path.Combine(
-            Path.GetDirectoryName(typeof(PssaCmdletAnalysisEngine).Assembly.Location), "..", "..", "..", "PSScriptAnalyzer"));
-
         /// <summary>
         /// The indentation to add when the logger lists errors.
         /// </summary>
@@ -365,7 +356,7 @@ private IEnumerable<string> GetPSScriptAnalyzerRules()
         /// This looks for the latest version of PSScriptAnalyzer on the path and loads that.
         /// </summary>
         /// <returns>A runspace pool with PSScriptAnalyzer loaded for running script analysis tasks.</returns>
-        private static RunspacePool CreatePssaRunspacePool()
+        private static RunspacePool CreatePssaRunspacePool(string pssaModulePath)
         {
             using PowerShell pwsh = PowerShell.Create(RunspaceMode.NewRunspace);
 
@@ -375,10 +366,7 @@ private static RunspacePool CreatePssaRunspacePool()
             // We intentionally use `CreateDefault2()` as it loads `Microsoft.PowerShell.Core`
             // only, which is a more minimal and therefore safer state.
             InitialSessionState sessionState = InitialSessionState.CreateDefault2();
-
-            sessionState.ImportPSModulesFromPath(s_pssaModulePath);
-            // pwsh.ImportModule(s_pssaModulePath);
-            // sessionState.ImportPSModule(new[] { pssaModuleInfo.ModuleBase });
+            sessionState.ImportPSModulesFromPath(pssaModulePath);
 
             RunspacePool runspacePool = RunspaceFactory.CreateRunspacePool(sessionState);
 
diff --git a/src/PowerShellEditorServices/Services/PowerShell/Host/PsesInternalHost.cs b/src/PowerShellEditorServices/Services/PowerShell/Host/PsesInternalHost.cs
@@ -32,12 +32,6 @@ namespace Microsoft.PowerShell.EditorServices.Services.PowerShell.Host
     internal class PsesInternalHost : PSHost, IHostSupportsInteractiveSession, IRunspaceContext, IInternalPowerShellExecutionService
     {
         private const string DefaultPrompt = "> ";
-        // This is a default that can be overriden at runtime by the user or tests.
-        private static string s_bundledModulePath = Path.GetFullPath(Path.Combine(
-            Path.GetDirectoryName(typeof(PsesInternalHost).Assembly.Location), "..", "..", ".."));
-
-        private static string CommandsModulePath => Path.GetFullPath(Path.Combine(
-            s_bundledModulePath, "PowerShellEditorServices", "Commands", "PowerShellEditorServices.Commands.psd1"));
 
         private static readonly PropertyInfo s_scriptDebuggerTriggerObjectProperty;
 
@@ -115,14 +109,6 @@ public PsesInternalHost(
             _logger = loggerFactory.CreateLogger<PsesInternalHost>();
             _languageServer = languageServer;
             _hostInfo = hostInfo;
-
-            // Respect a user provided bundled module path.
-            if (Directory.Exists(hostInfo.BundledModulePath))
-            {
-                _logger.LogTrace($"Using new bundled module path: {hostInfo.BundledModulePath}");
-                s_bundledModulePath = hostInfo.BundledModulePath;
-            }
-
             _readLineProvider = new ReadLineProvider(loggerFactory);
             _taskQueue = new BlockingConcurrentDeque<ISynchronousTask>();
             _psFrameStack = new Stack<PowerShellContextFrame>();
@@ -1012,7 +998,13 @@ private static PowerShell CreatePowerShellForRunspace(Runspace runspace)
                 pwsh.SetCorrectExecutionPolicy(_logger);
             }
 
-            pwsh.ImportModule(CommandsModulePath);
+            string commandsModulePath = Path.Combine(
+                _hostInfo.BundledModulePath,
+                "PowerShellEditorServices",
+                "Commands",
+                "PowerShellEditorServices.Commands.psd1");
+
+            pwsh.ImportModule(commandsModulePath);
 
             if (hostStartupInfo.AdditionalModules?.Count > 0)
             {
@@ -1311,7 +1303,7 @@ internal bool TryLoadPSReadLine(PowerShell pwsh, EngineIntrinsics engineIntrinsi
             psrlReadLine = null;
             try
             {
-                PSReadLineProxy psrlProxy = PSReadLineProxy.LoadAndCreate(_loggerFactory, s_bundledModulePath, pwsh);
+                PSReadLineProxy psrlProxy = PSReadLineProxy.LoadAndCreate(_loggerFactory, _hostInfo.BundledModulePath, pwsh);
                 psrlReadLine = new PsrlReadLine(psrlProxy, this, engineIntrinsics, ReadKey, OnPowerShellIdle);
                 return true;
             }
diff --git a/test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs b/test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs
@@ -15,10 +15,12 @@
 using Microsoft.PowerShell.EditorServices.Services.DebugAdapter;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
+using Microsoft.PowerShell.EditorServices.Test;
 using Microsoft.PowerShell.EditorServices.Test.Shared;
 using Microsoft.PowerShell.EditorServices.Utility;
 using Xunit;
-namespace Microsoft.PowerShell.EditorServices.Test.Debugging
+
+namespace PowerShellEditorServices.Test.Debugging
 {
     [Trait("Category", "DebugService")]
     public class DebugServiceTests : IDisposable
diff --git a/test/PowerShellEditorServices.Test/Extensions/ExtensionCommandTests.cs b/test/PowerShellEditorServices.Test/Extensions/ExtensionCommandTests.cs
@@ -13,10 +13,11 @@
 using Microsoft.PowerShell.EditorServices.Services.Extension;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
+using Microsoft.PowerShell.EditorServices.Test;
 using Microsoft.PowerShell.EditorServices.Test.Shared;
 using Xunit;
 
-namespace Microsoft.PowerShell.EditorServices.Test.Extensions
+namespace PowerShellEditorServices.Test.Extensions
 {
     [Trait("Category", "Extensions")]
     public class ExtensionCommandTests : IDisposable
@@ -59,7 +60,7 @@ public async Task CanRegisterAndInvokeCommandWithCmdletName()
                 BufferRange.None);
 
             EditorCommand commandAdded = null;
-            extensionCommandService.CommandAdded += (object _, EditorCommand command) => commandAdded = command;
+            extensionCommandService.CommandAdded += (_, command) => commandAdded = command;
 
             const string commandName = "test.function";
             const string commandDisplayName = "Function extension";
@@ -95,7 +96,7 @@ public async Task CanRegisterAndInvokeCommandWithScriptBlock()
                 BufferRange.None);
 
             EditorCommand commandAdded = null;
-            extensionCommandService.CommandAdded += (object _, EditorCommand command) => commandAdded = command;
+            extensionCommandService.CommandAdded += (_, command) => commandAdded = command;
 
             const string commandName = "test.scriptblock";
             const string commandDisplayName = "ScriptBlock extension";
@@ -126,7 +127,7 @@ await psesHost.ExecutePSCommandAsync(
         public async Task CanUpdateRegisteredCommand()
         {
             EditorCommand updatedCommand = null;
-            extensionCommandService.CommandUpdated += (object _, EditorCommand command) => updatedCommand = command;
+            extensionCommandService.CommandUpdated += (_, command) => updatedCommand = command;
 
             const string commandName = "test.function";
             const string commandDisplayName = "Updated function extension";
@@ -160,7 +161,7 @@ public async Task CanUnregisterCommand()
             const string commandDisplayName = "ScriptBlock extension";
 
             EditorCommand removedCommand = null;
-            extensionCommandService.CommandRemoved += (object _, EditorCommand command) => removedCommand = command;
+            extensionCommandService.CommandRemoved += (_, command) => removedCommand = command;
 
             // Add the command and wait for the add event
             await psesHost.ExecutePSCommandAsync(
diff --git a/test/PowerShellEditorServices.Test/Language/CompletionHandlerTests.cs b/test/PowerShellEditorServices.Test/Language/CompletionHandlerTests.cs
@@ -11,13 +11,14 @@
 using Microsoft.PowerShell.EditorServices.Services;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Host;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
+using Microsoft.PowerShell.EditorServices.Test;
 using Microsoft.PowerShell.EditorServices.Test.Shared;
 using Microsoft.PowerShell.EditorServices.Test.Shared.Completion;
 using Microsoft.PowerShell.EditorServices.Utility;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using Xunit;
 
-namespace Microsoft.PowerShell.EditorServices.Test.Language
+namespace PowerShellEditorServices.Test.Language
 {
     [Trait("Category", "Completions")]
     public class CompletionHandlerTests : IDisposable
diff --git a/test/PowerShellEditorServices.Test/Language/SemanticTokenTest.cs b/test/PowerShellEditorServices.Test/Language/SemanticTokenTest.cs
@@ -5,13 +5,13 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Management.Automation.Language;
-using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using Microsoft.PowerShell.EditorServices.Handlers;
+using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using OmniSharp.Extensions.LanguageServer.Protocol;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using Xunit;
 
-namespace Microsoft.PowerShell.EditorServices.Test.Language
+namespace PowerShellEditorServices.Test.Language
 {
     public class SemanticTokenTest
     {
diff --git a/test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs b/test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs
@@ -14,6 +14,7 @@
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Utility;
 using Microsoft.PowerShell.EditorServices.Services.Symbols;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
+using Microsoft.PowerShell.EditorServices.Test;
 using Microsoft.PowerShell.EditorServices.Test.Shared;
 using Microsoft.PowerShell.EditorServices.Test.Shared.Definition;
 using Microsoft.PowerShell.EditorServices.Test.Shared.Occurrences;
@@ -23,7 +24,7 @@
 using Microsoft.PowerShell.EditorServices.Test.Shared.Symbols;
 using Xunit;
 
-namespace Microsoft.PowerShell.EditorServices.Test.Language
+namespace PowerShellEditorServices.Test.Language
 {
     [Trait("Category", "Symbols")]
     public class SymbolsServiceTests : IDisposable
diff --git a/test/PowerShellEditorServices.Test/Language/TokenOperationsTests.cs b/test/PowerShellEditorServices.Test/Language/TokenOperationsTests.cs
@@ -8,7 +8,7 @@
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using Xunit;
 
-namespace Microsoft.PowerShell.EditorServices.Test.Language
+namespace PowerShellEditorServices.Test.Language
 {
     public class TokenOperationsTests
     {
diff --git a/test/PowerShellEditorServices.Test/Services/Symbols/AstOperationsTests.cs b/test/PowerShellEditorServices.Test/Services/Symbols/AstOperationsTests.cs
@@ -8,7 +8,7 @@
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using Xunit;
 
-namespace Microsoft.PowerShell.EditorServices.Test.Services.Symbols
+namespace PowerShellEditorServices.Test.Services.Symbols
 {
     [Trait("Category", "AstOperations")]
     public class AstOperationsTests
diff --git a/test/PowerShellEditorServices.Test/Services/Symbols/PSScriptAnalyzerTests.cs b/test/PowerShellEditorServices.Test/Services/Symbols/PSScriptAnalyzerTests.cs
diff --git a/test/PowerShellEditorServices.Test/Session/PathEscapingTests.cs b/test/PowerShellEditorServices.Test/Session/PathEscapingTests.cs
diff --git a/test/PowerShellEditorServices.Test/Session/PsesInternalHostTests.cs b/test/PowerShellEditorServices.Test/Session/PsesInternalHostTests.cs
diff --git a/test/PowerShellEditorServices.Test/Session/ScriptFileTests.cs b/test/PowerShellEditorServices.Test/Session/ScriptFileTests.cs
diff --git a/test/PowerShellEditorServices.Test/Session/WorkspaceTests.cs b/test/PowerShellEditorServices.Test/Session/WorkspaceTests.cs

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`using OmniSharp.Extensions.LanguageServer.Protocol.Models;`
`9`	`9`	`using Xunit;`
`10`	`10`
`11`		`-namespace Microsoft.PowerShell.EditorServices.Test.Language`
	`11`	`+namespace PowerShellEditorServices.Test.Language`
`12`	`12`	`{`
`13`	`13`	`public class TokenOperationsTests`
`14`	`14`	`{`