Merge pull request #558 from PowerShell/development

Take development to master for version 1.6.0 release

Author: Kapil Borle

CHANGELOG.MD

@@ -1,14 +1,44 @@
+## Release v1.6.0
+
+### Engine
+- Add `SuggestedCorrections` property to `DiagnosticRecord`
+    - This property emits text that can rectify the violation which triggered the rule.
+    - The primary purpose of this feature is to enable quick-fix scenarios in editors (e.g. vscode)
+- Add "Name" as a positional parameter in Get-ScriptAnalyzerRule
+- Add a `SaveDscDependency` switch to allow `Invoke-ScriptAnalyzer` to download a DSC Resource module from PSGallery in the event of a `ModuleNotFoundDuringParse` parse error. This feature is available only for PSv5 and above.
+- Add `remove` verb to `UseShouldProcessForStateChangingFunctions` rule
+- Add a `ScriptPath` property to Diagnostic Record that returns the full path of the script
+- Add PSv4 (Windows Server 2012 R2) and PSv3 (Windows Server 2012) to build and test matrix on AppVeyor
+- Fix the parsing of `Settings` parameter value when a hashtable is given
+- Fix writing error record while running rule suppression
+- Fix rule suppression in DSC Configuration definitions
+- Fix build and tests on PSv4 and v3
+
+### Rules
+- Add suggested corrections feature to the following rules.
+    - `PSAvoidUsingCmdletAliases`
+    - `PSAvoidUsingPlainTextForPassword`
+    - `PSMisleadingBacktick`
+    - `PSUseToExportFieldsInManifest`
+    - `PSMissingModuleManifestField`
+- Fix extent of
+    - `PSUseSingularNoun`
+    - `PSUseApprovedVerb`
+    - `PSAvoidUsernameAndPasswordParams`
+- Fix a bug in `PSMissingModuleManifestField` rule caused by .psd1 files that do not contain Hashtable
+- Fix documentation of `PSAvoidUsingPlainTextForPassword`
+
 ## Release v1.5.0 (Mar. 30, 2016)
 
-#### Engine
+### Engine
 - Fixed an engine bug that prevented versioned script rule modules from being loaded
 - Fixed loading issues with custom rules that do not have comment-based help to describe the rule
 - Fixed a hang issue that appeared when using ScriptAnalyzer engine recursively with a large data set
 - Housekeeping: Fixed Appveyor config to use VS 2015 and WMF 5.0 RTM image
 - Community Fix: Updated the Initialize API to process the `-Settings` (formerly `-Profile`) parameter
 - Perf: Improved rule filtering based on severity before invoking the engine to create tasks (threads)
 
-#### Rules
+### Rules
 - Fixed `UseToExportFieldsInManifest` rule to improve perf and functionality
 - Fixed `AvoidNullOrEmptyHelpMessageAttribute` to use parsed values instead of ast extent
 - Fixed inconsistencies in severities of rules
@@ -81,7 +111,7 @@
 - Deprecate Internal Url rule based on community feedback, identified additional rules to handle hardcoded paths etc
 - Added localhost exceptions for HardCodedComputerName Rule
 - Update to Credential based rules to validate the presence of CredentialAttribute and PSCredential type
- 
+
 ###Documentation:
 - Rule & Cmdlet documentation updates – Cmdlet help file addition
 
@@ -174,9 +204,9 @@
 
 ##Released v1.0.0 on Apr.24, 2015
 ###Features:
-- Finalized three levels of Severity - Error/Warning/Information. 
+- Finalized three levels of Severity - Error/Warning/Information.
 - Improved PSScriptAnalyzer engine behavior: emits non-terminating errors (Ex: for failed ast parse) and continues rule application when running on multiple scripts.
-- Added wild card supports for rules in Invoke-ScriptAnalyzer and Get-ScriptAnalyzer. Eg. Invoke-ScriptAnalyzer -IncludeRule PSAvoid* will apply all rules starting with PSAvoid* in built in rule assemblies. 
+- Added wild card supports for rules in Invoke-ScriptAnalyzer and Get-ScriptAnalyzer. Eg. Invoke-ScriptAnalyzer -IncludeRule PSAvoid* will apply all rules starting with PSAvoid* in built in rule assemblies.
 - Added -Severity to Get-ScriptAnalyzerRules. Get-ScriptAnalyzer -Severity will filter rules based on the severity given.
 - Added Suppression functionality. Users are now able to specify suppression on certain parts of the scripts by specifying "SupressMessageAttribute" in the scripts. More details and documentations will be coming soon in blog posts. Also comes with this feature is the ability for users to display a list of suppressed messages.
 

Engine/Commands/GetScriptAnalyzerRuleCommand.cs

@@ -56,7 +56,7 @@ public SwitchParameter RecurseCustomRulePath
         /// <summary>
         /// Name: The name of a specific rule to list.
         /// </summary>
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, Position = 1)]
         [ValidateNotNullOrEmpty]
         [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
         public string[] Name

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -25,6 +25,7 @@
 using System.Threading.Tasks;
 using System.Collections.Concurrent;
 using System.Threading;
+using System.Management.Automation.Runspaces;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
 {
@@ -44,7 +45,7 @@ public class InvokeScriptAnalyzerCommand : PSCmdlet, IOutputWriter
         [Parameter(Position = 0,
             ParameterSetName = "File",
             Mandatory = true,
-            ValueFromPipeline = true, 
+            ValueFromPipeline = true,
             ValueFromPipelineByPropertyName = true)]
         [ValidateNotNull]
         [Alias("PSPath")]
@@ -188,9 +189,21 @@ public object Settings
 
         private bool stopProcessing;
 
-        #endregion Parameters
+#if !PSV3
+        /// <summary>
+        /// Resolve DSC resource dependency
+        /// </summary>
+        [Parameter(Mandatory = false)]
+        public SwitchParameter SaveDscDependency
+        {
+            get { return saveDscDependency; }
+            set { saveDscDependency = value; }
+        }
+        private bool saveDscDependency;
+#endif // !PSV3
+#endregion Parameters
 
-        #region Overrides
+#region Overrides
 
         /// <summary>
         /// Imports all known rules and loggers.
@@ -227,19 +240,23 @@ protected override void ProcessRecord()
                 return;
             }
 
-            if (String.Equals(this.ParameterSetName, "File", StringComparison.OrdinalIgnoreCase))
+#if !PSV3
+            // TODO Support dependency resolution for analyzing script definitions
+            if (saveDscDependency)
             {
-                // throws Item Not Found Exception                        
-                Collection<PathInfo> paths = this.SessionState.Path.GetResolvedPSPathFromPSPath(path);
-                foreach (PathInfo p in paths)
+                using (var rsp = RunspaceFactory.CreateRunspace())
                 {
-                    ProcessPathOrScriptDefinition(this.SessionState.Path.GetUnresolvedProviderPathFromPSPath(p.Path));
+                    rsp.Open();
+                    using (var moduleHandler = new ModuleDependencyHandler(rsp))
+                    {
+                        ScriptAnalyzer.Instance.ModuleHandler = moduleHandler;
+                        ProcessInput();
+                    }
                 }
+                return;
             }
-            else if (String.Equals(this.ParameterSetName, "ScriptDefinition", StringComparison.OrdinalIgnoreCase))
-            {
-                ProcessPathOrScriptDefinition(scriptDefinition);
-            }
+#endif
+            ProcessInput();
         }
 
         protected override void EndProcessing()
@@ -254,33 +271,41 @@ protected override void StopProcessing()
             base.StopProcessing();
         }
 
-        #endregion
-
-        #region Methods
+#endregion
 
-        private void ProcessPathOrScriptDefinition(string pathOrScriptDefinition)
+#region Methods
+        private void ProcessInput()
         {
             IEnumerable<DiagnosticRecord> diagnosticsList = Enumerable.Empty<DiagnosticRecord>();
-
             if (String.Equals(this.ParameterSetName, "File", StringComparison.OrdinalIgnoreCase))
             {
-                diagnosticsList = ScriptAnalyzer.Instance.AnalyzePath(pathOrScriptDefinition, this.recurse);
+                // throws Item Not Found Exception
+                Collection<PathInfo> paths = this.SessionState.Path.GetResolvedPSPathFromPSPath(path);
+                foreach (PathInfo p in paths)
+                {
+                    diagnosticsList = ScriptAnalyzer.Instance.AnalyzePath(
+                        this.SessionState.Path.GetUnresolvedProviderPathFromPSPath(p.Path),
+                        this.recurse);
+                    WriteToOutput(diagnosticsList);
+                }
             }
             else if (String.Equals(this.ParameterSetName, "ScriptDefinition", StringComparison.OrdinalIgnoreCase))
             {
-                diagnosticsList = ScriptAnalyzer.Instance.AnalyzeScriptDefinition(pathOrScriptDefinition);
+                diagnosticsList = ScriptAnalyzer.Instance.AnalyzeScriptDefinition(scriptDefinition);
+                WriteToOutput(diagnosticsList);
             }
+        }
 
-            //Output through loggers
+        private void WriteToOutput(IEnumerable<DiagnosticRecord> diagnosticRecords)
+        {
             foreach (ILogger logger in ScriptAnalyzer.Instance.Loggers)
             {
-                foreach (DiagnosticRecord diagnostic in diagnosticsList)
+                foreach (DiagnosticRecord diagnostic in diagnosticRecords)
                 {
                     logger.LogObject(diagnostic, this);
                 }
             }
         }
-
-        #endregion
+#endregion
     }
 }

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);
+            }
+        }
+
+    }
+}