Change CommandInfo lookup for commands in the form module\cmdletName

[liamjpeters]

PR Summary

When the CommandInfoCache is used to lookup some fully qualified commands (by way of Get-Command), a nested module name is returned.

PR changes CommandInfoCache when a CommandInfo is looked up for a command in the form module\cmdletName. It passes this module name hint along to Get-Command to allow correct resolution.

With the MicrosoftTeams module installed, as an example, running:

Get-Command -Name 'MicrosoftTeams\Get-CsOnlineLisCivicAddress'

Reports the commands module as Microsoft.Teams.ConfigAPI.Cmdlets.

Instead running:

Get-Command -Name 'Get-CsOnlineLisCivicAddress' -Module 'MicrosoftTeams'

Correctly reports the module as MicrosoftTeams.

Also happens for Az.resources\Get-AzRoleEligibilitySchedule

Fixes #2123
Fixes #2023

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Change is not breaking
• Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
• Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

[andyleejordan]

Perfect, thanks so much! Weird, seems like there may be a bug in Get-Command itself because that behavior is changing between the module-qualified command name, and passing the module name as a separate parameter. Maybe a sorting issue, we don't know. This is a good workaround given your tests.

[andyleejordan]

@liamjpeters can you rebase this so the PR checks trigger and I can merge it? Thanks!

[liamjpeters]

My Git-Fu is not strong @andyleejordan 😅 Did I do it?

[andyleejordan]

You did it! CI Tests are running now 😄

[liamjpeters]

If only it had succeeded. Drat.

The offending test that failed on the mac build runner:

PSScriptAnalyzer/Tests/Rules/UseCorrectCasing.tests.ps1

Lines 77 to 85 in ea70855

	It "Does not throw when correcting certain cmdlets (issue 1516)" {
	$scriptDefinition = 'Get-Content;Test-Path;Get-ChildItem;Get-Content;Test-Path;Get-ChildItem'
	$settings = @{ 'Rules' = @{ 'PSUseCorrectCasing' = @{ 'Enable' = $true; CheckCommands = $true; CheckKeywords = $true; CheckOperators = $true } } }
	{
	1..100 |
	ForEach-Object { $null = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -Settings $settings -ErrorAction Stop }
	} |
	Should -Not -Throw
	}

I don't have a mac to try it on, but the failure looks like the runspace safety issue with the command info cache - an old discussion and summary in issue #1867.

I've run the test in a loop and managed to get it to fail once with the same error on my Windows machine after about 20 mins of running. I've managed the same on the master branch just now:

I'm not sure how to check whether this PR makes this issue more prevalent or if it's the same as it has been and just got unlucky with the CI run.

[andyleejordan]

That seems like it's a flaky test, I'm rerunning the CI.