Refactor MissingModuleManifest Rule

Moves the module manifest testing logic to a separate method in the Helper class. This will enable reuse of the functionality by other rules.

Author: Kapil Borle

Engine/Helper.cs

@@ -228,6 +228,58 @@ public bool IsDscResourceModule(string filePath)
 
             return false;
         }
+        
+        /// <summary>
+        /// Gets the module manifest
+        /// </summary>
+        /// <param name="filePath"></param>
+        /// <param name="errorRecord"></param>
+        /// <returns>Returns a object of type PSModuleInfo</returns>
+        public PSModuleInfo GetModuleManifest(string filePath, out IEnumerable<ErrorRecord> errorRecord)
+        {                        
+            errorRecord = null;
+            PSModuleInfo psModuleInfo = null;
+            Collection<PSObject> psObj = null;
+            var ps = System.Management.Automation.PowerShell.Create();
+            if (ps == null)
+            {
+                return null;
+            }
+            try
+            {                
+                ps.AddCommand("Test-ModuleManifest");
+                ps.AddParameter("Path", filePath);
+
+                // Suppress warnings emitted during the execution of Test-ModuleManifest
+                ps.AddParameter("WarningAction", ActionPreference.SilentlyContinue);
+                psObj = ps.Invoke();
+            }
+            catch { }
+            if (ps.HadErrors && ps.Streams != null && ps.Streams.Error != null)
+            {
+                var errorRecordArr = new ErrorRecord[ps.Streams.Error.Count];
+                ps.Streams.Error.CopyTo(errorRecordArr, 0);
+                errorRecord = errorRecordArr;
+            }
+            if (psObj != null && psObj.Any() && psObj[0] != null)
+            {
+                psModuleInfo = psObj[0].ImmediateBaseObject as PSModuleInfo;
+            }
+            ps.Dispose();                                       
+            return psModuleInfo;
+        }
+
+        /// <summary>
+        /// Checks if the error record is MissingMemberException
+        /// </summary>
+        /// <param name="errorRecord"></param>
+        /// <returns>Returns a boolean value indicating the presence of MissingMemberException</returns>
+        public bool IsMissingMemberException(ErrorRecord errorRecord)
+        {
+            return errorRecord.CategoryInfo != null
+                && errorRecord.CategoryInfo.Category == ErrorCategory.ResourceUnavailable
+                && string.Equals("MissingMemberException", errorRecord.CategoryInfo.Reason, StringComparison.OrdinalIgnoreCase);
+        }
 
         /// <summary>
         /// Get the list of exported function by analyzing the ast

Rules/MissingModuleManifestField.cs

@@ -38,41 +38,25 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
 
             if (String.Equals(System.IO.Path.GetExtension(fileName), ".psd1", StringComparison.OrdinalIgnoreCase))
             {
-                var ps = System.Management.Automation.PowerShell.Create();
-
-                try
-                {
-                    ps.AddCommand("Test-ModuleManifest");
-                    ps.AddParameter("Path", fileName);
-                    
-                    // Suppress warnings emitted during the execution of Test-ModuleManifest
-                    // ModuleManifest rule must catch any violations (warnings/errors) and generate DiagnosticRecord(s)
-                    ps.AddParameter("WarningAction", ActionPreference.SilentlyContinue);                    
-                    ps.Invoke();
-
-                } catch { }
-
-                if (ps != null && ps.HadErrors && ps.Streams != null && ps.Streams.Error != null)
+                IEnumerable<ErrorRecord> errorRecords;
+                var psModuleInfo = Helper.Instance.GetModuleManifest(fileName, out errorRecords);
+                if (errorRecords != null)
                 {
-                    foreach (var errorRecord in ps.Streams.Error)
+                    foreach (var errorRecord in errorRecords)
                     {
-                        if (errorRecord.CategoryInfo != null && errorRecord.CategoryInfo.Category == System.Management.Automation.ErrorCategory.ResourceUnavailable
-                            && String.Equals("MissingMemberException", errorRecord.CategoryInfo.Reason, StringComparison.OrdinalIgnoreCase))
+                        if (Helper.Instance.IsMissingMemberException(errorRecord))
                         {
                             System.Diagnostics.Debug.Assert(errorRecord.Exception != null && !String.IsNullOrWhiteSpace(errorRecord.Exception.Message), Strings.NullErrorMessage);
-
                             yield return
                                 new DiagnosticRecord(errorRecord.Exception.Message, ast.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
                         }
 
                     }
                 }
-
-                ps.Dispose();
             }
 
         }
-
+        
         /// <summary>
         /// GetName: Retrieves the name of this rule.
         /// </summary>