Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Report error when PowerShell built-in modules are missing #16628

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.

Sign up for GitHub

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

Merged
daxian-dbw merged 12 commits into from
Jan 12, 2022
Merged

Report error when PowerShell built-in modules are missing #16628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
15c7249
Report error when PowerShell built-in modules are missing
daxian-dbw Dec 15, 2021
5529369
Fix a test failure
daxian-dbw Dec 15, 2021
c6af3c9
A little cleanup changes
daxian-dbw Dec 15, 2021
d7db8b3
Try not to assume the built-in moduels are only available under PSHOM…
daxian-dbw Dec 17, 2021
1eb9680
More changes and tests
daxian-dbw Dec 22, 2021
c32f182
Minor fix
daxian-dbw Dec 22, 2021
d22f34f
Fix the test. 'PersistentMemory' is not available on Windows Server, …
daxian-dbw Jan 3, 2022
831c6c0
Address Paul's feedback
daxian-dbw Jan 4, 2022
d23d611
Address Ilya's feedback
daxian-dbw Jan 5, 2022
a01a88d
Use 'PersistentMemory' for Win Client and 'RemoteDesktop' for Win Server
daxian-dbw Jan 6, 2022
8628521
Update comment
daxian-dbw Jan 6, 2022
0809a61
Update the test a bit
daxian-dbw Jan 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 23 additions & 32 deletions 55 src/System.Management.Automation/engine/CommandDiscovery.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,22 +376,16 @@ private static void VerifyRequiredSnapins(IEnumerable<PSSnapInSpecification> req

foreach (var requiresPSSnapIn in requiresPSSnapIns)
{
IEnumerable<PSSnapInInfo> loadedPSSnapIns = null;
loadedPSSnapIns = context.InitialSessionState.GetPSSnapIn(requiresPSSnapIn.Name);
if (loadedPSSnapIns == null || !loadedPSSnapIns.Any())
var loadedPSSnapIn = context.InitialSessionState.GetPSSnapIn(requiresPSSnapIn.Name);
if (loadedPSSnapIn is null)
{
if (requiresMissingPSSnapIns == null)
{
requiresMissingPSSnapIns = new Collection<string>();
}

requiresMissingPSSnapIns ??= new Collection<string>();
requiresMissingPSSnapIns.Add(BuildPSSnapInDisplayName(requiresPSSnapIn));
}
else
Comment thread
PaulHigin marked this conversation as resolved.
{
// the requires PSSnapin is loaded. now check the PSSnapin version
PSSnapInInfo loadedPSSnapIn = loadedPSSnapIns.First();
Diagnostics.Assert(loadedPSSnapIn.Version != null,
Dbg.Assert(loadedPSSnapIn.Version != null,
string.Format(
CultureInfo.InvariantCulture,
"Version is null for loaded PSSnapin {0}.", loadedPSSnapIn));
Expand All @@ -400,11 +394,7 @@ private static void VerifyRequiredSnapins(IEnumerable<PSSnapInSpecification> req
if (!AreInstalledRequiresVersionsCompatible(
requiresPSSnapIn.Version, loadedPSSnapIn.Version))
{
if (requiresMissingPSSnapIns == null)
{
requiresMissingPSSnapIns = new Collection<string>();
}

requiresMissingPSSnapIns ??= new Collection<string>();
requiresMissingPSSnapIns.Add(BuildPSSnapInDisplayName(requiresPSSnapIn));
}
}
Expand Down Expand Up @@ -1063,14 +1053,12 @@ private static CommandInfo TryModuleAutoDiscovery(string commandName,
return null;

CmdletInfo cmdletInfo = context.SessionState.InvokeCommand.GetCmdlet("Microsoft.PowerShell.Core\\Get-Module");
if ((commandOrigin == CommandOrigin.Internal) ||
((cmdletInfo != null) && (cmdletInfo.Visibility == SessionStateEntryVisibility.Public)))
if (commandOrigin == CommandOrigin.Internal || cmdletInfo?.Visibility == SessionStateEntryVisibility.Public)
{
// Search for a module with a matching command, as long as the user would have the ability to
// import the module.
cmdletInfo = context.SessionState.InvokeCommand.GetCmdlet("Microsoft.PowerShell.Core\\Import-Module");
if (((commandOrigin == CommandOrigin.Internal) ||
((cmdletInfo != null) && (cmdletInfo.Visibility == SessionStateEntryVisibility.Public))))
if (commandOrigin == CommandOrigin.Internal || cmdletInfo?.Visibility == SessionStateEntryVisibility.Public)
{
discoveryTracer.WriteLine("Executing non module-qualified search: {0}", commandName);
context.CommandDiscovery.RegisterLookupCommandInfoAction("ActiveModuleSearch", commandName);
Expand All @@ -1085,30 +1073,33 @@ private static CommandInfo TryModuleAutoDiscovery(string commandName,
{
// WinBlue:69141 - We need to get the full path here because the module path might be C:\Users\User1\DOCUME~1
// While the exportedCommands are cached, they are cached with the full path
string expandedModulePath = IO.Path.GetFullPath(modulePath);
string moduleShortName = System.IO.Path.GetFileNameWithoutExtension(expandedModulePath);
string expandedModulePath = Path.GetFullPath(modulePath);
string moduleShortName = Path.GetFileNameWithoutExtension(expandedModulePath);
var exportedCommands = AnalysisCache.GetExportedCommands(expandedModulePath, false, context);

if (exportedCommands == null) { continue; }

CommandTypes exportedCommandTypes;
// Skip if module only has class or other types and no commands.
if (exportedCommands.TryGetValue(commandName, out exportedCommandTypes))
if (exportedCommands.TryGetValue(commandName, out CommandTypes exportedCommandTypes))
{
Exception exception;
discoveryTracer.WriteLine("Found in module: {0}", expandedModulePath);
Collection<PSModuleInfo> matchingModule = AutoloadSpecifiedModule(expandedModulePath, context,
Collection<PSModuleInfo> matchingModule = AutoloadSpecifiedModule(
expandedModulePath,
context,
cmdletInfo != null ? cmdletInfo.Visibility : SessionStateEntryVisibility.Private,
out exception);
lastError = exception;
if ((matchingModule == null) || (matchingModule.Count == 0))
out lastError);

if (matchingModule is null || matchingModule.Count == 0)
{
string error = StringUtil.Format(DiscoveryExceptions.CouldNotAutoImportMatchingModule, commandName, moduleShortName);
CommandNotFoundException commandNotFound = new CommandNotFoundException(
string errorMessage = lastError is null
? StringUtil.Format(DiscoveryExceptions.CouldNotAutoImportMatchingModule, commandName, moduleShortName)
: StringUtil.Format(DiscoveryExceptions.CouldNotAutoImportMatchingModuleWithErrorMessage, commandName, moduleShortName, lastError.Message);

throw new CommandNotFoundException(
originalCommandName,
lastError,
"CouldNotAutoloadMatchingModule", error);
throw commandNotFound;
"CouldNotAutoloadMatchingModule",
errorMessage);
}

result = LookupCommandInfo(commandName, commandTypes, searchResolutionOptions, commandOrigin, context);
Expand Down
65 changes: 13 additions & 52 deletions 65 src/System.Management.Automation/engine/InitialSessionState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1663,11 +1663,6 @@ public InitialSessionState Clone()

ss.DisableFormatUpdates = this.DisableFormatUpdates;

foreach (var s in this.defaultSnapins)
{
ss.defaultSnapins.Add(s);
}

foreach (var s in ImportedSnapins)
{
ss.ImportedSnapins.Add(s.Key, s.Value);
Expand Down Expand Up @@ -3801,34 +3796,26 @@ public PSSnapInInfo ImportPSSnapIn(string name, out PSSnapInException warning)

// Now actually load the snapin...
PSSnapInInfo snapin = ImportPSSnapIn(newPSSnapIn, out warning);
if (snapin != null)
{
ImportedSnapins.Add(snapin.Name, snapin);
}

return snapin;
}

internal PSSnapInInfo ImportCorePSSnapIn()
{
// Load Microsoft.PowerShell.Core as a snapin
// Load Microsoft.PowerShell.Core as a snapin.
PSSnapInInfo coreSnapin = PSSnapInReader.ReadCoreEngineSnapIn();
this.defaultSnapins.Add(coreSnapin);
try
{
PSSnapInException warning;
this.ImportPSSnapIn(coreSnapin, out warning);
}
catch (PSSnapInException)
{
throw;
}

ImportPSSnapIn(coreSnapin, out _);
Comment thread
daxian-dbw marked this conversation as resolved.
return coreSnapin;
}

internal PSSnapInInfo ImportPSSnapIn(PSSnapInInfo psSnapInInfo, out PSSnapInException warning)
{
if (psSnapInInfo == null)
{
ArgumentNullException e = new ArgumentNullException(nameof(psSnapInInfo));
throw e;
}

// See if the snapin is already loaded. If has been then there will be an entry in the
// Assemblies list for it already...
bool reload = true;
Expand Down Expand Up @@ -3861,12 +3848,6 @@ internal PSSnapInInfo ImportPSSnapIn(PSSnapInInfo psSnapInInfo, out PSSnapInExce
Dictionary<string, List<SessionStateAliasEntry>> aliases = null;
Dictionary<string, SessionStateProviderEntry> providers = null;

if (psSnapInInfo == null)
{
ArgumentNullException e = new ArgumentNullException(nameof(psSnapInInfo));
throw e;
}

Assembly assembly = null;
string helpFile = null;

Expand Down Expand Up @@ -3985,37 +3966,18 @@ internal PSSnapInInfo ImportPSSnapIn(PSSnapInInfo psSnapInInfo, out PSSnapInExce
}
}

ImportedSnapins.Add(psSnapInInfo.Name, psSnapInInfo);
return psSnapInInfo;
}

internal List<PSSnapInInfo> GetPSSnapIn(string psSnapinName)
internal PSSnapInInfo GetPSSnapIn(string psSnapinName)
{
List<PSSnapInInfo> loadedSnapins = null;
foreach (var defaultSnapin in defaultSnapins)
{
if (defaultSnapin.Name.Equals(psSnapinName, StringComparison.OrdinalIgnoreCase))
{
if (loadedSnapins == null)
{
loadedSnapins = new List<PSSnapInInfo>();
}

loadedSnapins.Add(defaultSnapin);
}
}

PSSnapInInfo importedSnapin = null;
if (ImportedSnapins.TryGetValue(psSnapinName, out importedSnapin))
if (ImportedSnapins.TryGetValue(psSnapinName, out PSSnapInInfo importedSnapin))
{
if (loadedSnapins == null)
{
loadedSnapins = new List<PSSnapInInfo>();
}

loadedSnapins.Add(importedSnapin);
return importedSnapin;
}

return loadedSnapins;
return null;
}

[SuppressMessage("Microsoft.Reliability", "CA2001:AvoidCallingProblematicMethods", MessageId = "System.Reflection.Assembly.LoadFrom")]
Expand Down Expand Up @@ -4886,7 +4848,6 @@ internal static void RemoveAllDrivesForProvider(ProviderInfo pi, SessionStateInt

internal static readonly string CoreSnapin = "Microsoft.PowerShell.Core";
internal static readonly string CoreModule = "Microsoft.PowerShell.Core";
internal Collection<PSSnapInInfo> defaultSnapins = new Collection<PSSnapInInfo>();

// The list of engine modules to create warnings when you try to remove them
internal static readonly HashSet<string> EngineModules = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.