-
Notifications
You must be signed in to change notification settings - Fork 401
Added PSUseFullyQualifiedCmdletNames rule with fix capabilities #2122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
genXdev
wants to merge
8
commits into
PowerShell:main
Choose a base branch
from
genXdev:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e73df6d
Added UseFullyQualifiedCmdletNames rule
genXdev dc90c53
Missing Strings.resx
genXdev 71cbf21
Added UseFullyQualifiedCmdletNames rule
genXdev 63e9bf5
Update Rules/UseFullyQualifiedCmdletNames.cs
genXdev 26dfa4e
Update Rules/UseFullyQualifiedCmdletNames.cs
genXdev 69a2690
Added UseFullyQualifiedCmdletNames rule
genXdev 971f02b
Added Docs and Test for UseFullyQualifiedCmdletNames rule
genXdev 33fad88
Also added 'IgnoredModules' parameter and updated tests and docs acco…
genXdev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,251 @@ | ||||||||||||||||||||||||||||
| //--------------------------------------------------------------------------------- | ||||||||||||||||||||||||||||
| // Copyright (c) Microsoft Corporation. | ||||||||||||||||||||||||||||
| // The MIT License (MIT) | ||||||||||||||||||||||||||||
| // | ||||||||||||||||||||||||||||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||||||||||||||||||||||||||||
| // of this software and associated documentation files (the "Software"), to deal | ||||||||||||||||||||||||||||
| // in the Software without restriction, including without limitation the rights | ||||||||||||||||||||||||||||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||||||||||||||||||||||||||||
| // copies of the Software, and to permit persons to whom the Software is | ||||||||||||||||||||||||||||
| // furnished to do so, subject to the following conditions: | ||||||||||||||||||||||||||||
| // | ||||||||||||||||||||||||||||
| // The above copyright notice and this permission notice shall be included in all | ||||||||||||||||||||||||||||
| // copies or substantial portions of the Software. | ||||||||||||||||||||||||||||
| // | ||||||||||||||||||||||||||||
| // 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.Collections.Concurrent; | ||||||||||||||||||||||||||||
| using System.Collections.ObjectModel; | ||||||||||||||||||||||||||||
| using System.Linq; | ||||||||||||||||||||||||||||
| using System.Management.Automation; | ||||||||||||||||||||||||||||
| using System.Management.Automation.Language; | ||||||||||||||||||||||||||||
| using Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic; | ||||||||||||||||||||||||||||
| #if !CORECLR | ||||||||||||||||||||||||||||
| using System.ComponentModel.Composition; | ||||||||||||||||||||||||||||
| #endif | ||||||||||||||||||||||||||||
| using System.Globalization; | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| /// <summary> | ||||||||||||||||||||||||||||
| /// UseFullyQualifiedCmdletNames: Checks if cmdlet and function invocations use fully qualified module names. | ||||||||||||||||||||||||||||
| /// </summary> | ||||||||||||||||||||||||||||
| #if !CORECLR | ||||||||||||||||||||||||||||
| [Export(typeof(IScriptRule))] | ||||||||||||||||||||||||||||
| #endif | ||||||||||||||||||||||||||||
| public class UseFullyQualifiedCmdletNames : ConfigurableRule | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| private ConcurrentDictionary<string, string> resolutionCache = new ConcurrentDictionary<string, string>(StringComparer.OrdinalIgnoreCase); | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| internal const string AnalyzerName = "Microsoft.Windows.PowerShell.ScriptAnalyzer"; | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| /// <summary> | ||||||||||||||||||||||||||||
| /// Modules to ignore when applying this rule. | ||||||||||||||||||||||||||||
| /// Commands from these modules will not be expanded to their fully qualified names. | ||||||||||||||||||||||||||||
| /// Default is empty array (no modules ignored - all cmdlets are processed). | ||||||||||||||||||||||||||||
| /// </summary> | ||||||||||||||||||||||||||||
| [ConfigurableRuleProperty(defaultValue: new string[] { })] | ||||||||||||||||||||||||||||
| public string[] IgnoredModules { get; protected set; } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| /// <summary> | ||||||||||||||||||||||||||||
| /// Analyzes the given ast to find cmdlet invocations that are not fully qualified. | ||||||||||||||||||||||||||||
| /// </summary> | ||||||||||||||||||||||||||||
| /// <param name="ast">The script's ast</param> | ||||||||||||||||||||||||||||
| /// <param name="fileName">The script's file name</param> | ||||||||||||||||||||||||||||
| /// <returns>The diagnostic results of this rule</returns> | ||||||||||||||||||||||||||||
| public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| if (ast == null) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| throw new ArgumentNullException(nameof(ast)); | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| var commandAsts = ast.FindAll(testAst => testAst is CommandAst, true).Cast<CommandAst>(); | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| foreach (var commandAst in commandAsts) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| var commandName = commandAst.GetCommandName(); | ||||||||||||||||||||||||||||
| if (string.IsNullOrWhiteSpace(commandName) || commandName.Contains("\\")) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| if (!resolutionCache.TryGetValue(commandName, out string fullyQualifiedName)) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| var resolvedCommand = ResolveCommand(commandName); | ||||||||||||||||||||||||||||
| if (resolvedCommand == null) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| // Cache null results to avoid repeated lookups | ||||||||||||||||||||||||||||
| resolutionCache[commandName] = null; | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| if (resolvedCommand.CommandType != CommandTypes.Cmdlet && | ||||||||||||||||||||||||||||
| resolvedCommand.CommandType != CommandTypes.Function && | ||||||||||||||||||||||||||||
| resolvedCommand.CommandType != CommandTypes.Alias) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| // Cache null results for non-cmdlet/function/alias commands | ||||||||||||||||||||||||||||
| resolutionCache[commandName] = null; | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| string moduleName = resolvedCommand.ModuleName; | ||||||||||||||||||||||||||||
| string actualCmdletName = resolvedCommand.Name; | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| if (resolvedCommand is AliasInfo aliasInfo) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| if (aliasInfo.ResolvedCommand == null) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| resolutionCache[commandName] = null; | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| actualCmdletName = aliasInfo.ResolvedCommand.Name; | ||||||||||||||||||||||||||||
| moduleName = aliasInfo.ResolvedCommand.ModuleName; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| if (string.IsNullOrEmpty(moduleName) || string.IsNullOrEmpty(actualCmdletName)) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| resolutionCache[commandName] = null; | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| // Check if the module is in the ignored list | ||||||||||||||||||||||||||||
| if (IgnoredModules != null && IgnoredModules.Contains(moduleName, StringComparer.OrdinalIgnoreCase)) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| // Cache null for ignored modules to avoid re-checking | ||||||||||||||||||||||||||||
| resolutionCache[commandName] = null; | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| fullyQualifiedName = $"{moduleName}\\{actualCmdletName}"; | ||||||||||||||||||||||||||||
| resolutionCache[commandName] = fullyQualifiedName; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| else | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| // If we have a cached result but it's null/empty, it means we should skip this command | ||||||||||||||||||||||||||||
| if (string.IsNullOrEmpty(fullyQualifiedName)) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| // Re-check ignored modules for cached results (in case IgnoredModules was changed) | ||||||||||||||||||||||||||||
| var moduleName = fullyQualifiedName.Split('\\')[0]; | ||||||||||||||||||||||||||||
| if (IgnoredModules != null && IgnoredModules.Contains(moduleName, StringComparer.OrdinalIgnoreCase)) | ||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||
| continue; | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| var extent = commandAst.CommandElements[0].Extent; | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| bool isAlias = commandName != fullyQualifiedName.Split('\\')[1]; | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
| bool isAlias = commandName != fullyQualifiedName.Split('\\')[1]; | |
| else | |
| { | |
| // Extract actualCmdletName from the cached fullyQualifiedName | |
| int idx = fullyQualifiedName.IndexOf('\\'); | |
| actualCmdletName = (idx >= 0 && idx < fullyQualifiedName.Length - 1) | |
| ? fullyQualifiedName.Substring(idx + 1) | |
| : fullyQualifiedName; | |
| } | |
| var extent = commandAst.CommandElements[0].Extent; | |
| bool isAlias = commandName != actualCmdletName; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The logic for determining if a command is an alias is incorrect. This will incorrectly identify unqualified cmdlets as aliases when the command name matches the actual cmdlet name. Consider checking the resolved command type instead:
bool isAlias = resolvedCommand.CommandType == CommandTypes.Alias;There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not following..