Add suggested corrections to allow violation fixes

Engine/Generic/CorrectionExtent.cs

@@ -0,0 +1,144 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Management.Automation.Language;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
+{
+    public class CorrectionExtent
+    {
+        public int EndColumnNumber
+        {
+            get
+            {
+                return endColumnNumber;
+            }
+        }
+
+        public int EndLineNumber
+        {
+            get
+            {
+                return endLineNumber;
+            }
+        }
+
+        public string File
+        {
+            get
+            {
+                return file;
+            }
+        }
+
+        public int StartColumnNumber
+        {
+            get
+            {
+                return startColumnNumber;
+            }
+        }
+
+        public int StartLineNumber
+        {
+            get
+            {
+                return startLineNumber;
+            }
+        }
+
+        public string Text
+        {
+            get
+            {
+                return text;
+            }
+        }
+
+        public string Description
+        {
+            get
+            {
+                return description;
+            }
+        }
+
+        private string file;
+        private int startLineNumber;
+        private int endLineNumber;
+        private int startColumnNumber;
+        private int endColumnNumber;
+        private string text;
+        private string description;
+
+        public CorrectionExtent(
+            int startLineNumber, 
+            int endLineNumber, 
+            int startColumnNumber, 
+            int endColumnNumber, 
+            string text, 
+            string file) 
+            : this(
+                  startLineNumber, 
+                  endLineNumber,
+                  startColumnNumber,
+                  endColumnNumber,
+                  text,
+                  file,
+                  null)
+        {
+        }
+
+        public CorrectionExtent(
+            int startLineNumber, 
+            int endLineNumber, 
+            int startColumnNumber, 
+            int endColumnNumber, 
+            string text, 
+            string file,
+            string description)
+        {
+            this.startLineNumber = startLineNumber;
+            this.endLineNumber = endLineNumber;
+            this.startColumnNumber = startColumnNumber;
+            this.endColumnNumber = endColumnNumber;
+            this.file = file;
+            this.text = text;
+            this.description = description;
+            ThrowIfInvalidArguments();
+        }
+
+
+
+        private void ThrowIfInvalidArguments()
+        {
+            ThrowIfNull<string>(file, "filename");
+            ThrowIfNull<string>(text, "text");
+            ThrowIfDecreasing(startLineNumber, endLineNumber, "start line number cannot be less than end line number");            
+            if (startLineNumber == endLineNumber)
+            {
+                ThrowIfDecreasing(StartColumnNumber, endColumnNumber, "start column number cannot be less than end column number for a one line extent");
+            }
+        }
+
+        private void ThrowIfDecreasing(int start, int end, string message)
+        {
+            if (start > end)
+            {
+                throw new ArgumentException(message);
+            }
+        }
+
+        private void ThrowIfNull<T>(T arg, string argName)
+        {
+            if (arg == null)
+            {
+                throw new ArgumentNullException(argName);
+            }
+        }
+
+    }
+}

Engine/Generic/DiagnosticRecord.cs

@@ -10,6 +10,7 @@
 // THE SOFTWARE.
 //
 
+using System.Collections.Generic;
 using System.Management.Automation.Language;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
@@ -26,6 +27,7 @@ public class DiagnosticRecord
         private DiagnosticSeverity severity;
         private string scriptName;
         private string ruleSuppressionId;
+        private List<CorrectionExtent> suggestedCorrections;
 
         /// <summary>
         /// Represents a string from the rule about why this diagnostic was created.
@@ -91,30 +93,41 @@ public string RuleSuppressionID
             set { ruleSuppressionId = value; }
         }
 
+        /// <summary>
+        /// Returns suggested correction
+        /// return value can be null
+        /// </summary>
+        public IEnumerable<CorrectionExtent> SuggestedCorrections
+        {
+            get { return suggestedCorrections;  }            
+        }
+
         /// <summary>
         /// DiagnosticRecord: The constructor for DiagnosticRecord class.
         /// </summary>
         public DiagnosticRecord()
         {
 
         }
-
+        
         /// <summary>
-        /// DiagnosticRecord: The constructor for DiagnosticRecord class.
+        /// DiagnosticRecord: The constructor for DiagnosticRecord class that takes in suggestedCorrection
         /// </summary>
         /// <param name="message">A string about why this diagnostic was created</param>
         /// <param name="extent">The place in the script this diagnostic refers to</param>
         /// <param name="ruleName">The name of the rule that created this diagnostic</param>
         /// <param name="severity">The severity of this diagnostic</param>
         /// <param name="scriptName">The name of the script file being analyzed</param>
-        public DiagnosticRecord(string message, IScriptExtent extent, string ruleName, DiagnosticSeverity severity, string scriptName, string ruleId = null)
+        /// <param name="suggestedCorrections">The correction suggested by the rule to replace the extent text</param>
+        public DiagnosticRecord(string message, IScriptExtent extent, string ruleName, DiagnosticSeverity severity, string scriptName, string ruleId = null, List<CorrectionExtent> suggestedCorrections = null)
         {
-            Message  = string.IsNullOrEmpty(message)  ? string.Empty : message;
+            Message = string.IsNullOrEmpty(message) ? string.Empty : message;
             RuleName = string.IsNullOrEmpty(ruleName) ? string.Empty : ruleName;
-            Extent   = extent;
+            Extent = extent;
             Severity = severity;
             ScriptName = string.IsNullOrEmpty(scriptName) ? string.Empty : scriptName;
             ruleSuppressionId = ruleId;
+            this.suggestedCorrections = suggestedCorrections;
         }
     }
 

Engine/Helper.cs

@@ -19,6 +19,7 @@
 using System.Management.Automation.Language;
 using System.Globalization;
 using Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic;
+using System.Management.Automation.Runspaces;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer
 {
@@ -104,14 +105,14 @@ internal set
         private string[] functionScopes = new string[] { "global:", "local:", "script:", "private:"};
 
         private string[] variableScopes = new string[] { "global:", "local:", "script:", "private:", "variable:", ":"};
-
         #endregion
 
         /// <summary>
         /// Initializes the Helper class.
         /// </summary>
         private Helper()
         {
+
         }
 
         /// <summary>
@@ -229,6 +230,61 @@ 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();
+            try
+            {
+                ps.AddCommand("Test-ModuleManifest");
+                ps.AddParameter("Path", filePath);
+                ps.AddParameter("WarningAction", ActionPreference.SilentlyContinue);
+                psObj = ps.Invoke();
+            }
+            catch (CmdletInvocationException e)
+            {
+                // Invoking Test-ModuleManifest on a module manifest that doesn't have all the valid keys
+                // throws a NullReferenceException. This is probably a bug in Test-ModuleManifest and hence
+                // we consume it to allow execution of the of this method.
+                if (e.InnerException == null || e.InnerException.GetType() != typeof(System.NullReferenceException))
+                {
+                    throw;
+                }
+            }
+            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 static bool IsMissingManifestMemberException(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
@@ -1317,8 +1373,7 @@ public static string[] ProcessCustomRulePaths(string[] rulePaths, SessionState s
 
         }
 
-
-        #endregion
+        #endregion Methods
     }
 
 

Engine/ScriptAnalyzerEngine.csproj

@@ -34,23 +34,23 @@
     <RootNamespace>Microsoft.Windows.PowerShell.ScriptAnalyzer</RootNamespace>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'PSV3 Debug|AnyCPU'">
-     <DebugSymbols>true</DebugSymbols>
-     <OutputPath>bin\PSV3 Debug\</OutputPath>
-     <DefineConstants>TRACE;DEBUG;PSV3</DefineConstants>
-     <DebugType>full</DebugType>
-     <PlatformTarget>AnyCPU</PlatformTarget>
-     <ErrorReport>prompt</ErrorReport>
-     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
-   </PropertyGroup>
-   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'PSV3 Release|AnyCPU'">
-     <OutputPath>bin\PSV3 Release\</OutputPath>
-     <DefineConstants>TRACE;PSV3</DefineConstants>
-     <Optimize>true</Optimize>
-     <DebugType>pdbonly</DebugType>
-     <PlatformTarget>AnyCPU</PlatformTarget>
-     <ErrorReport>prompt</ErrorReport>
-     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
-    </PropertyGroup>
+    <DebugSymbols>true</DebugSymbols>
+    <OutputPath>bin\PSV3 Debug\</OutputPath>
+    <DefineConstants>TRACE;DEBUG;PSV3</DefineConstants>
+    <DebugType>full</DebugType>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'PSV3 Release|AnyCPU'">
+    <OutputPath>bin\PSV3 Release\</OutputPath>
+    <DefineConstants>TRACE;PSV3</DefineConstants>
+    <Optimize>true</Optimize>
+    <DebugType>pdbonly</DebugType>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
   <ItemGroup>
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="System" />
@@ -70,6 +70,7 @@
     <Compile Include="Commands\InvokeScriptAnalyzerCommand.cs" />
     <Compile Include="Generic\AvoidCmdletGeneric.cs" />
     <Compile Include="Generic\AvoidParameterGeneric.cs" />
+    <Compile Include="Generic\CorrectionExtent.cs" />
     <Compile Include="Generic\SuppressedRecord.cs" />
     <Compile Include="Generic\DiagnosticRecord.cs" />
     <Compile Include="Generic\ExternalRule.cs" />
@@ -101,7 +102,7 @@
     <Compile Include="VariableAnalysisBase.cs" />
   </ItemGroup>
   <ItemGroup>
-	<None Include="PSScriptAnalyzer.psm1" />
+    <None Include="PSScriptAnalyzer.psm1" />
     <None Include="PSScriptAnalyzer.psd1" />
     <None Include="ScriptAnalyzer.format.ps1xml" />
     <None Include="ScriptAnalyzer.types.ps1xml" />