Fixes CLI module and assembly loading microsoft#1361 microsoft#1362 (m…

…icrosoft#1363)
BernieWhite · Nov 27, 2022 · 1f878e9 · 1f878e9
1 parent 2ff19f5
commit 1f878e9
Show file tree

Hide file tree

Showing 13 changed files with 116 additions and 12 deletions.
diff --git a/docs/CHANGELOG-v2.md b/docs/CHANGELOG-v2.md
@@ -30,6 +30,14 @@ See [upgrade notes][1] for helpful information when upgrading from previous vers
 
 ## Unreleased
 
+What's changed since pre-release v2.7.0-B0016:
+
+- Bug fixes:
+  - Fixes CLI failed to load required assemblies by @BernieWhite.
+    [#1361](https://github.com/microsoft/PSRule/issues/1361)
+  - Fixes CLI ignores modules specified in `Include.Modules` by @BernieWhite.
+    [#1362](https://github.com/microsoft/PSRule/issues/1362)
+
 ## v2.7.0-B0016 (pre-release)
 
 What's changed since pre-release v2.7.0-B0006:

diff --git a/src/PSRule.Tool/ClientHelper.cs b/src/PSRule.Tool/ClientHelper.cs
@@ -15,8 +15,8 @@ internal sealed class ClientHelper
     {
         public static void RunAnalyze(AnalyzerOptions operationOptions, ClientContext clientContext, InvocationContext invocation)
         {
-            var option = GetOption();
             var host = new ClientHost(invocation, operationOptions.Verbose, operationOptions.Debug);
+            var option = GetOption(host);
             var inputPath = operationOptions.InputPath == null || operationOptions.InputPath.Length == 0 ?
                 new string[] { PSRuleOption.GetWorkingPath() } : operationOptions.InputPath;
 
@@ -40,8 +40,8 @@ public static void RunAnalyze(AnalyzerOptions operationOptions, ClientContext cl
 
         public static void RunRestore(RestoreOptions operationOptions, ClientContext clientContext, InvocationContext invocation)
         {
-            var option = GetOption();
             var host = new ClientHost(invocation, operationOptions.Verbose, operationOptions.Debug);
+            var option = GetOption(host);
             var requires = option.Requires.ToArray();
 
             using var pwsh = PowerShell.Create();
@@ -97,8 +97,9 @@ private static void InstallVersion(PowerShell pwsh, string name, string version)
             pwsh.Invoke();
         }
 
-        private static PSRuleOption GetOption()
+        private static PSRuleOption GetOption(ClientHost host)
         {
+            PSRuleOption.UseHostContext(host);
             var option = PSRuleOption.FromFileOrEmpty();
             option.Execution.InitialSessionState = Configuration.SessionState.Minimal;
             option.Input.Format = InputFormat.File;

diff --git a/src/PSRule.Tool/ClientHost.cs b/src/PSRule.Tool/ClientHost.cs
@@ -4,14 +4,15 @@
 using System.CommandLine;
 using System.CommandLine.Invocation;
 using System.CommandLine.IO;
+using System.IO;
 using System.Management.Automation;
 using PSRule.Pipeline;
 
 namespace PSRule.Tool
 {
     internal sealed class ClientHost : HostContext
     {
-        private InvocationContext _Invocation;
+        private readonly InvocationContext _Invocation;
         private readonly bool _Verbose;
         private readonly bool _Debug;
 
@@ -20,6 +21,8 @@ public ClientHost(InvocationContext invocation, bool verbose, bool debug)
             _Invocation = invocation;
             _Verbose = verbose;
             _Debug = debug;
+
+            Verbose($"Using working path: {Directory.GetCurrentDirectory()}");
         }
 
         public override ActionPreference GetPreferenceVariable(string variableName)

diff --git a/src/PSRule/Configuration/PSRuleOption.cs b/src/PSRule/Configuration/PSRuleOption.cs
@@ -11,6 +11,7 @@
 using System.Threading;
 using Newtonsoft.Json;
 using PSRule.Definitions.Baselines;
+using PSRule.Pipeline;
 using PSRule.Resources;
 using YamlDotNet.Serialization;
 using YamlDotNet.Serialization.NamingConventions;
@@ -395,6 +396,19 @@ public static void UseExecutionContext(EngineIntrinsics executionContext)
             _GetWorkingPath = () => executionContext.SessionState.Path.CurrentFileSystemLocation.Path;
         }
 
+        /// <summary>
+        /// Set working path from a command-line host environment.
+        /// </summary>
+        public static void UseHostContext(IHostContext hostContext)
+        {
+            if (hostContext == null)
+            {
+                _GetWorkingPath = () => Directory.GetCurrentDirectory();
+                return;
+            }
+            _GetWorkingPath = () => hostContext.GetWorkingPath();
+        }
+
         /// <summary>
         /// Configures PSRule to use the culture of the current thread at runtime.
         /// </summary>

diff --git a/src/PSRule/Definitions/IResultRecord.cs b/src/PSRule/Definitions/IResultRecord.cs
@@ -3,6 +3,9 @@
 
 namespace PSRule.Definitions
 {
+    /// <summary>
+    /// A base interface for a PSRule result record.
+    /// </summary>
     public interface IResultRecord
     {
     }

diff --git a/src/PSRule/Definitions/IRuleResultV2.cs b/src/PSRule/Definitions/IRuleResultV2.cs
@@ -44,6 +44,9 @@ public interface IRuleResultV2 : IResultRecord
         long Time { get; }
     }
 
+    /// <summary>
+    /// Detailed rule records for PSRule v2.
+    /// </summary>
     public interface IDetailedRuleResultV2 : IRuleResultV2
     {
         /// <summary>
@@ -61,8 +64,14 @@ public interface IDetailedRuleResultV2 : IRuleResultV2
         /// </summary>
         Hashtable Field { get; }
 
+        /// <summary>
+        /// The bound name of the target.
+        /// </summary>
         string TargetName { get; }
 
+        /// <summary>
+        /// The bound type of the target.
+        /// </summary>
         string TargetType { get; }
     }
 
@@ -92,8 +101,14 @@ public interface IResultReasonV2
         /// </summary>
         string FullPath { get; }
 
+        /// <summary>
+        /// The reason message.
+        /// </summary>
         string Message { get; }
 
+        /// <summary>
+        /// Return a formatted reason string.
+        /// </summary>
         string Format();
     }
 }
diff --git a/src/PSRule/Pipeline/CommandLineBuilder.cs b/src/PSRule/Pipeline/CommandLineBuilder.cs
@@ -27,6 +27,9 @@ public static IInvokePipelineBuilder Invoke(string[] module, PSRuleOption option
             for (var i = 0; i < module.Length; i++)
                 sourcePipeline.ModuleByName(module[i]);
 
+            for (var i = 0; option.Include.Module != null && i < option.Include.Module.Length; i++)
+                sourcePipeline.ModuleByName(option.Include.Module[i]);
+
             var source = sourcePipeline.Build();
             var pipeline = new InvokeRulePipelineBuilder(source, hostContext);
             pipeline.Configure(option);
@@ -49,6 +52,9 @@ public static IInvokePipelineBuilder Assert(string[] module, PSRuleOption option
             for (var i = 0; module != null && i < module.Length; i++)
                 sourcePipeline.ModuleByName(module[i]);
 
+            for (var i = 0; option.Include.Module != null && i < option.Include.Module.Length; i++)
+                sourcePipeline.ModuleByName(option.Include.Module[i]);
+
             var source = sourcePipeline.Build();
             var pipeline = new AssertPipelineBuilder(source, hostContext);
             pipeline.Configure(option);

diff --git a/src/PSRule/Pipeline/GetRulePipelineBuiler.cs b/src/PSRule/Pipeline/GetRulePipelineBuiler.cs
@@ -5,8 +5,14 @@
 
 namespace PSRule.Pipeline
 {
+    /// <summary>
+    /// A helper to build a get pipeline.
+    /// </summary>
     public interface IGetPipelineBuilder : IPipelineBuilder
     {
+        /// <summary>
+        /// Determines if the returned rules also include rule dependencies.
+        /// </summary>
         void IncludeDependencies();
     }
 
@@ -20,6 +26,7 @@ internal sealed class GetRulePipelineBuilder : PipelineBuilderBase, IGetPipeline
         internal GetRulePipelineBuilder(Source[] source, IHostContext hostContext)
             : base(source, hostContext) { }
 
+        /// <inheritdoc/>
         public override IPipelineBuilder Configure(PSRuleOption option)
         {
             if (option == null)
@@ -36,11 +43,14 @@ public override IPipelineBuilder Configure(PSRuleOption option)
 
             return this;
         }
+
+        /// <inheritdoc/>
         public void IncludeDependencies()
         {
             _IncludeDependencies = true;
         }
 
+        /// <inheritdoc/>
         public override IPipeline Build(IPipelineWriter writer = null)
         {
             return !RequireModules() || !RequireSources()

diff --git a/src/PSRule/Pipeline/GetTargetPipeline.cs b/src/PSRule/Pipeline/GetTargetPipeline.cs
@@ -7,8 +7,14 @@
 
 namespace PSRule.Pipeline
 {
+    /// <summary>
+    /// A helper to build a pipeline to return target objects.
+    /// </summary>
     public interface IGetTargetPipelineBuilder : IPipelineBuilder
     {
+        /// <summary>
+        /// Specifies a path for reading input objects from disk.
+        /// </summary>
         void InputPath(string[] path);
     }
 
@@ -25,6 +31,7 @@ internal GetTargetPipelineBuilder(Source[] source, IHostContext hostContext)
             _InputPath = null;
         }
 
+        /// <inheritdoc/>
         public override IPipelineBuilder Configure(PSRuleOption option)
         {
             if (option == null)
@@ -41,6 +48,7 @@ public override IPipelineBuilder Configure(PSRuleOption option)
             return this;
         }
 
+        /// <inheritdoc/>
         public void InputPath(string[] path)
         {
             if (path == null || path.Length == 0)
@@ -58,11 +66,13 @@ public void InputPath(string[] path)
             _InputPath = builder;
         }
 
+        /// <inheritdoc/>
         public override IPipeline Build(IPipelineWriter writer = null)
         {
             return new GetTargetPipeline(PrepareContext(null, null, null), PrepareReader(), writer ?? PrepareWriter());
         }
 
+        /// <inheritdoc/>
         protected override PipelineReader PrepareReader()
         {
             if (!string.IsNullOrEmpty(Option.Input.ObjectPath))

diff --git a/src/PSRule/Pipeline/HostContext.cs b/src/PSRule/Pipeline/HostContext.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System.IO;
 using System.Management.Automation;
 using PSRule.Definitions;
 
@@ -65,6 +66,11 @@ public interface IHostContext
         /// Determines if a destructive action such as overwriting a file should be processed.
         /// </summary>
         bool ShouldProcess(string target, string action);
+
+        /// <summary>
+        /// Get the current working path.
+        /// </summary>
+        string GetWorkingPath();
     }
 
     internal static class HostContextExtensions
@@ -186,6 +192,12 @@ public virtual void Record(IResultRecord record)
         {
 
         }
+
+        /// <inheritdoc/>
+        public virtual string GetWorkingPath()
+        {
+            return Directory.GetCurrentDirectory();
+        }
     }
 
     /// <summary>
@@ -273,5 +285,11 @@ public void Object(object sendToPipeline, bool enumerateCollection)
         {
             CmdletContext.WriteObject(sendToPipeline, enumerateCollection);
         }
+
+        /// <inheritdoc/>
+        public string GetWorkingPath()
+        {
+            return ExecutionContext.SessionState.Path.CurrentFileSystemLocation.Path;
+        }
     }
 }
diff --git a/src/PSRule/Pipeline/SourcePipeline.cs b/src/PSRule/Pipeline/SourcePipeline.cs
@@ -294,13 +294,14 @@ private static string[] SortModulePath(IEnumerable<string> values)
             return results;
         }
 
-        private static Source.ModuleInfo LoadManifest(string basePath)
+        private Source.ModuleInfo LoadManifest(string basePath)
         {
             var name = Path.GetFileName(Path.GetDirectoryName(basePath));
             var path = Path.Combine(basePath, GetManifestName(name));
             if (!File.Exists(path))
                 return null;
 
+            Log("Loading manifest for: {0}", basePath);
             using var reader = new StreamReader(path);
             var data = reader.ReadToEnd();
             var ast = System.Management.Automation.Language.Parser.ParseInput(data, out _, out _);
@@ -316,14 +317,32 @@ private static Source.ModuleInfo LoadManifest(string basePath)
             var projectUri = psData["ProjectUri"] as string;
             var prerelease = psData["Prerelease"] as string;
 
-            if (manifest["RequiredAssemblies"] is Array requiredAssemblies)
+            if (TryRequiredAssemblies(manifest["RequiredAssemblies"], out var requiredAssemblies))
             {
-                foreach (var a in requiredAssemblies.OfType<string>())
-                    Assembly.LoadFile(Path.Combine(basePath, a));
+                foreach (var a in requiredAssemblies)
+                {
+                    var assemblyPath = Path.Combine(basePath, a);
+                    Log("Loading assembly: {0}", assemblyPath);
+                    Assembly.LoadFile(assemblyPath);
+                }
             }
             return new Source.ModuleInfo(basePath, name, version, projectUri, guid, companyName, prerelease);
         }
 
+        private static bool TryRequiredAssemblies(object value, out IEnumerable<string> requiredAssemblies)
+        {
+            requiredAssemblies = null;
+            if (value == null) return false;
+
+            if (value is string s)
+                requiredAssemblies = new string[] { s };
+
+            if (value is Array array)
+                requiredAssemblies = array.OfType<string>().ToArray();
+
+            return requiredAssemblies != null;
+        }
+
         private static string GetManifestName(string name)
         {
             return string.Concat(name, ".psd1");

diff --git a/src/PSRule/Pipeline/TargetObject.cs b/src/PSRule/Pipeline/TargetObject.cs
@@ -63,7 +63,7 @@ internal TargetObject(PSObject o, TargetSourceCollection source)
         }
 
         internal TargetObject(PSObject o, string targetName = null, string targetType = null, string scope = null)
-            : this (o, null)
+            : this(o, null)
         {
             if (targetName != null)
                 TargetName = targetName;

diff --git a/tests/PSRule.Tests/SuppressionGroupTests.cs b/tests/PSRule.Tests/SuppressionGroupTests.cs
@@ -6,11 +6,8 @@
 using System.Linq;
 using System.Management.Automation;
 using PSRule.Configuration;
-using PSRule.Definitions;
-using PSRule.Definitions.SuppressionGroups;
 using PSRule.Host;
 using PSRule.Pipeline;
-using PSRule.Rules;
 using PSRule.Runtime;
 using Xunit;
 using Assert = Xunit.Assert;