Merge pull request #717 from PowerShell/kapilmb/settings

Improve settings implementation

Author: Kapil Borle

CHANGELOG.MD

@@ -1,4 +1,19 @@
-## [1.10.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.10.0) - 2017-01-19
+## unreleased
+
+### Added
+- Built-in settings presets to specify settings from command line. Currently, PSSA ships with `PSGallery`, `CodeFormatting`, `DSC`, and other setting presets. All of them can be found in the `Settings/` directory in the module. To use them just pass them as an argument to the `Settings` parameters. For example, if you want to run rules that *powershellgallery* runs, then use the following command.
+```powershell
+PS> Invoke-ScriptAnalyzer -Path /path/to/your/module -Settings PSGallery
+```
+- Argument completion for built-in settings presets.
+- Argument completion for `IncludeRule` and `ExcludeRule` parameters.
+
+### Fixed
+
+### Changed
+    - Settings implementation to decouple it from engine.
+
+## [1.10.0](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.10.0) - 2017-01-19
 ### Added
 - Three rules to enable code formatting feature in vscode (#690)
     - [PSPlaceOpenBrace](https://github.com/PowerShell/PSScriptAnalyzer/blob/03a6e2b4ee24894bf574a8a8ce911d03680da607/RuleDocumentation/PlaceOpenBrace.md)

Engine/Commands/InvokeScriptAnalyzerCommand.cs

@@ -206,9 +206,9 @@ public SwitchParameter SaveDscDependency
         }
         private bool saveDscDependency;
 #endif // !PSV3
-#endregion Parameters
+        #endregion Parameters
 
-#region Overrides
+        #region Overrides
 
         /// <summary>
         /// Imports all known rules and loggers.
@@ -227,67 +227,74 @@ protected override void BeginProcessing()
                 Helper.Instance.SetPSVersionTable(psVersionTable);
             }
 
-            string[] rulePaths = Helper.ProcessCustomRulePaths(customRulePath,
-                this.SessionState, recurseCustomRulePath);
+            string[] rulePaths = Helper.ProcessCustomRulePaths(
+                customRulePath,
+                this.SessionState,
+                recurseCustomRulePath);
+
             if (IsFileParameterSet())
             {
                 ProcessPath();
             }
 
-            var settingFileHasErrors = false;
-            if (settings == null
-                && processedPaths != null
-                && processedPaths.Count == 1)
+            object settingsFound;
+            var settingsMode = PowerShell.ScriptAnalyzer.Settings.FindSettingsMode(
+                this.settings,
+                processedPaths == null || processedPaths.Count == 0 ? null : processedPaths[0],
+                out settingsFound);
+
+            switch (settingsMode)
             {
-                // add a directory separator character because if there is no trailing separator character, it will return the parent
-                var directory = processedPaths[0].TrimEnd(System.IO.Path.DirectorySeparatorChar);
-                if (File.Exists(directory))
-                {
-                    // if given path is a file, get its directory
-                    directory = System.IO.Path.GetDirectoryName(directory);
-                }
+                case SettingsMode.Auto:
+                    this.WriteVerbose(
+                        String.Format(
+                            CultureInfo.CurrentCulture,
+                            Strings.SettingsNotProvided,
+                            path));
+                    this.WriteVerbose(
+                        String.Format(
+                            CultureInfo.CurrentCulture,
+                            Strings.SettingsAutoDiscovered,
+                            (string)settingsFound));
+                    break;
 
-                this.WriteVerbose(
-                    String.Format(
-                        "Settings not provided. Will look for settings file in the given path {0}.",
-                        path));
-                var settingsFileAutoDiscovered = false;
-                if (Directory.Exists(directory))
-                {
-                    // if settings are not provided explicitly, look for it in the given path
-                    // check if pssasettings.psd1 exists
-                    var settingsFilename = "PSScriptAnalyzerSettings.psd1";
-                    var settingsFilepath = System.IO.Path.Combine(directory, settingsFilename);
-                    if (File.Exists(settingsFilepath))
-                    {
-                        settingsFileAutoDiscovered = true;
-                        this.WriteVerbose(
-                            String.Format(
-                                "Found {0} in {1}. Will use it to provide settings for this invocation.",
-                                settingsFilename,
-                                directory));
-                        settingFileHasErrors = !ScriptAnalyzer.Instance.ParseProfile(settingsFilepath, this.SessionState.Path, this);
-                    }
-                }
+                case SettingsMode.Preset:
+                case SettingsMode.File:
+                    this.WriteVerbose(
+                        String.Format(
+                            CultureInfo.CurrentCulture,
+                            Strings.SettingsUsingFile,
+                            (string)settingsFound));
+                    break;
 
-                if (!settingsFileAutoDiscovered)
-                {
+                case SettingsMode.Hashtable:
                     this.WriteVerbose(
                         String.Format(
-                            "Cannot find a settings file in the given path {0}.",
-                            path));
-                }
-            }
-            else
-            {
-                settingFileHasErrors = !ScriptAnalyzer.Instance.ParseProfile(this.settings, this.SessionState.Path, this);
+                            CultureInfo.CurrentCulture,
+                            Strings.SettingsUsingHashtable));
+                    break;
+
+                default: // case SettingsMode.None
+                    this.WriteVerbose(
+                        String.Format(
+                            CultureInfo.CurrentCulture,
+                            Strings.SettingsCannotFindFile));
+                    break;
             }
 
-            if (settingFileHasErrors)
+            if (settingsMode != SettingsMode.None)
             {
-                this.WriteWarning("Cannot parse settings. Will abort the invocation.");
-                stopProcessing = true;
-                return;
+                try
+                {
+                    var settingsObj = new Settings(settingsFound);
+                    ScriptAnalyzer.Instance.UpdateSettings(settingsObj);
+                }
+                catch
+                {
+                        this.WriteWarning(String.Format(CultureInfo.CurrentCulture, Strings.SettingsNotParsable));
+                        stopProcessing = true;
+                        return;
+                }
             }
 
             ScriptAnalyzer.Instance.Initialize(
@@ -323,7 +330,8 @@ protected override void ProcessRecord()
                         ScriptAnalyzer.Instance.ModuleHandler = moduleHandler;
                         this.WriteVerbose(
                             String.Format(
-                                "Temporary module location: {0}",
+                                CultureInfo.CurrentCulture,
+                                Strings.ModuleDepHandlerTempLocation,
                                 moduleHandler.TempModulePath));
                         ProcessInput();
                     }
@@ -346,9 +354,10 @@ protected override void StopProcessing()
             base.StopProcessing();
         }
 
-#endregion
+        #endregion
+
+        #region Private Methods
 
-#region Methods
         private void ProcessInput()
         {
             IEnumerable<DiagnosticRecord> diagnosticsList = Enumerable.Empty<DiagnosticRecord>();
@@ -392,6 +401,7 @@ private bool IsFileParameterSet()
         {
             return String.Equals(this.ParameterSetName, "File", StringComparison.OrdinalIgnoreCase);
         }
-#endregion
+
+        #endregion // Private Methods
     }
-}
+}

Engine/Generic/CorrectionExtent.cs

@@ -1,4 +1,16 @@
-using System;
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;

Engine/Helper.cs

@@ -21,6 +21,7 @@
 using Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic;
 using System.Management.Automation.Runspaces;
 using System.Collections;
+using System.Reflection;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer
 {

Engine/PSScriptAnalyzer.psm1

@@ -18,7 +18,7 @@ else
 {
     if ($PSVersionTable.PSVersion -lt [Version]'5.0') {
         $binaryModuleRoot = Join-Path -Path $PSModuleRoot -ChildPath 'PSv3'
-    }    
+    }
 }
 
 $binaryModulePath = Join-Path -Path $binaryModuleRoot -ChildPath 'Microsoft.Windows.PowerShell.ScriptAnalyzer.dll'
@@ -27,4 +27,27 @@ $binaryModule = Import-Module -Name $binaryModulePath -PassThru
 # When the module is unloaded, remove the nested binary module that was loaded with it
 $PSModule.OnRemove = {
     Remove-Module -ModuleInfo $binaryModule
+}
+
+if (Get-Command Register-ArgumentCompleter -ErrorAction Ignore)
+{
+    Register-ArgumentCompleter -CommandName 'Invoke-ScriptAnalyzer' -ParameterName 'Settings' -ScriptBlock {
+        param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParmeter)
+
+        [Microsoft.Windows.PowerShell.ScriptAnalyzer.Settings]::GetSettingPresets() | `
+            Where-Object {$_ -like "$wordToComplete*"} | `
+            ForEach-Object { New-Object System.Management.Automation.CompletionResult $_ }
+    }
+
+    Function RuleNameCompleter
+    {
+        param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParmeter)
+
+        Get-ScriptAnalyzerRule *$wordToComplete* | `
+            ForEach-Object { New-Object System.Management.Automation.CompletionResult $_.RuleName }
+    }
+
+    Register-ArgumentCompleter -CommandName 'Invoke-ScriptAnalyzer' -ParameterName 'IncludeRule' -ScriptBlock $Function:RuleNameCompleter
+    Register-ArgumentCompleter -CommandName 'Invoke-ScriptAnalyzer' -ParameterName 'ExcludeRule' -ScriptBlock $Function:RuleNameCompleter
+    Register-ArgumentCompleter -CommandName 'Get-ScriptAnalyzerRule' -ParameterName 'Name' -ScriptBlock $Function:RuleNameCompleter
 }

Engine/ScriptAnalyzer.cs

@@ -198,6 +198,30 @@ public void CleanUp()
             suppressedOnly = false;
         }
 
+        /// <summary>
+        /// Update includerules, excluderules, severity and rule arguments.
+        /// </summary>
+        /// <param name="settings">An object of type Settings</param>
+        public void UpdateSettings(Settings settings)
+        {
+            if (settings == null)
+            {
+                throw new ArgumentNullException(nameof(settings));
+            }
+
+            this.severity = (!settings.Severities.Any()) ? null : settings.Severities.ToArray();
+            this.includeRule = (!settings.IncludeRules.Any()) ? null : settings.IncludeRules.ToArray();
+            this.excludeRule = (!settings.ExcludeRules.Any()) ? null : settings.ExcludeRules.ToArray();
+            if (settings.RuleArguments != null)
+            {
+                Helper.Instance.SetRuleArguments(
+                    settings.RuleArguments.ToDictionary(
+                        kvp => kvp.Key,
+                        kvp => kvp.Value as object,
+                        StringComparer.OrdinalIgnoreCase));
+            }
+        }
+
         internal bool ParseProfile(object profileObject, PathIntrinsics path, IOutputWriter writer)
         {
             // profile was not given

Engine/ScriptAnalyzerEngine.csproj

@@ -74,6 +74,7 @@
     <Compile Include="Generic\ConfigurableRule.cs" />
     <Compile Include="Generic\ModuleDependencyHandler.cs" />
     <Compile Include="Generic\CorrectionExtent.cs" />
+    <Compile Include="Settings.cs" />
     <Compile Include="Generic\SuppressedRecord.cs" />
     <Compile Include="Generic\DiagnosticRecord.cs" />
     <Compile Include="Generic\ExternalRule.cs" />