Add a switch to resolve dsc module dependency

Adds a switch named "ResolveDSCResourceDependency" to Invoke-ScriptAnalyzer (isa). If the switch is given, then isa with try to resolve the dependency, whenever parse error is thrown due to modulenotfound exception, through the ModuleDependencyHandler class. If the switch is not provided, isa will not try to resolve the dependency.

Author: Kapil Borle

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -188,6 +188,16 @@ public object Settings
 
         private bool stopProcessing;
 
+        /// <summary>
+        /// Resolve DSC resoure dependency
+        /// </summary>        
+        [Parameter(Mandatory = false)]
+        public SwitchParameter ResolveDSCResourceDependency
+        {
+            get { return resolveDSCResourceDependency; }
+            set { resolveDSCResourceDependency = value; }
+        }
+        private bool resolveDSCResourceDependency;
         #endregion Parameters
 
         #region Overrides
@@ -213,7 +223,8 @@ protected override void BeginProcessing()
                 this.excludeRule,
                 this.severity,
                 null == rulePaths ? true : this.includeDefaultRules,
-                this.suppressedOnly);
+                this.suppressedOnly,
+                resolveDSCResourceDependency: resolveDSCResourceDependency);
         }
 
         /// <summary>

Engine/ScriptAnalyzer.cs

@@ -105,7 +105,8 @@ internal void Initialize<TCmdlet>(
             string[] excludeRuleNames = null,
             string[] severity = null,
             bool includeDefaultRules = false,
-            bool suppressedOnly = false)
+            bool suppressedOnly = false,
+            bool resolveDSCResourceDependency = false)
             where TCmdlet : PSCmdlet, IOutputWriter
         {
             if (cmdlet == null)
@@ -122,7 +123,8 @@ internal void Initialize<TCmdlet>(
                 excludeRuleNames,
                 severity,
                 includeDefaultRules,
-                suppressedOnly);
+                suppressedOnly,
+                resolveDSCResourceDependency: resolveDSCResourceDependency);
         }
 
         /// <summary>
@@ -167,8 +169,11 @@ public void CleanUp()
             severity = null;
             includeRegexList = null;
             excludeRegexList = null;
-            suppressedOnly = false;            
-            moduleHandler.Dispose();
+            suppressedOnly = false;
+            if (moduleHandler != null)
+            {
+                moduleHandler.Dispose();
+            }
         }
 
         internal bool ParseProfile(object profileObject, PathIntrinsics path, IOutputWriter writer)
@@ -462,16 +467,17 @@ private bool ParseProfileString(string profile, PathIntrinsics path, IOutputWrit
         }
 
         private void Initialize(
-            IOutputWriter outputWriter, 
-            PathIntrinsics path, 
-            CommandInvocationIntrinsics invokeCommand, 
-            string[] customizedRulePath,            
+            IOutputWriter outputWriter,
+            PathIntrinsics path,
+            CommandInvocationIntrinsics invokeCommand,
+            string[] customizedRulePath,
             string[] includeRuleNames,
             string[] excludeRuleNames,
             string[] severity,
             bool includeDefaultRules = false,
             bool suppressedOnly = false,
-            string profile = null)
+            string profile = null,
+            bool resolveDSCResourceDependency = false)
         {
             if (outputWriter == null)
             {
@@ -481,8 +487,8 @@ private void Initialize(
             this.outputWriter = outputWriter;
 
             // TODO Create a runspace pool
-            runspace = RunspaceFactory.CreateRunspace();          
-            moduleHandler = new ModuleDependencyHandler(runspace);            
+            runspace = RunspaceFactory.CreateRunspace();
+            moduleHandler = resolveDSCResourceDependency ? new ModuleDependencyHandler(runspace) : null;
 
             #region Verifies rule extensions and loggers path
 
@@ -1318,8 +1324,8 @@ private IEnumerable<DiagnosticRecord> AnalyzeFile(string filePath)
                     // - OR
                     //  - swallow the these errors
 
-
-                    if (errors != null && errors.Length > 0)
+                    bool parseAgain = false;
+                    if (moduleHandler != null && errors != null && errors.Length > 0)
                     {
                         foreach (ParseError error in errors)
                         {
@@ -1329,6 +1335,8 @@ private IEnumerable<DiagnosticRecord> AnalyzeFile(string filePath)
                                 if (moduleName != null)
                                 {
                                     moduleHandler.SaveModule(moduleName);
+                                    // if successfully saved
+                                    parseAgain = true;
                                 }
                             }
                         }
@@ -1337,9 +1345,12 @@ private IEnumerable<DiagnosticRecord> AnalyzeFile(string filePath)
                     //try parsing again
                     //var oldDefault = Runspace.DefaultRunspace;
                     //Runspace.DefaultRunspace = moduleHandler.Runspace;
-                    scriptAst = Parser.ParseFile(filePath, out scriptTokens, out errors);
-                    //Runspace.DefaultRunspace = oldDefault;
+                    if (parseAgain)
+                    {
+                        scriptAst = Parser.ParseFile(filePath, out scriptTokens, out errors);
+                    }
 
+                    //Runspace.DefaultRunspace = oldDefault;
                     if (errors != null && errors.Length > 0)
                     {
                         foreach (ParseError error in errors)