Skip to content

Fix class searcher to ignore hidden properties #7188

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 5 commits into from
Jun 29, 2018
Merged

Fix class searcher to ignore hidden properties #7188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab77d6b
Fix class searcher to ignore hidden properties
SteveL-MSFT Jun 26, 2018
7803705
address Bruce's feedback
SteveL-MSFT Jun 26, 2018
598c31f
address Dongbo's feedback
SteveL-MSFT Jun 27, 2018
d4806d2
added test
SteveL-MSFT Jun 28, 2018
8f569fc
address Aditya's feedback
SteveL-MSFT Jun 28, 2018
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
3 changes: 1 addition & 2 deletions src/System.Management.Automation/engine/PSClassSearcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,7 @@ private PSClassInfo ConvertToClassInfo(PSModuleInfo module, ScriptBlockAst ast,

foreach (var member in statement.Members)
{
PropertyMemberAst propAst = member as PropertyMemberAst;
if (propAst != null)
if (member is PropertyMemberAst propAst && !propAst.PropertyAttributes.HasFlag(PropertyAttributes.Hidden))
{
Dbg.Assert(propAst.Name != null, "PropName cannot be null");
Dbg.Assert(propAst.PropertyType != null, "PropertyType cannot be null");
Expand Down
24 changes: 24 additions & 0 deletions test/powershell/engine/Help/HelpSystem.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,14 @@ Describe "Get-Help should find pattern help files" -Tags "CI" {
Remove-Item $helpFilePath2 -Force -ErrorAction SilentlyContinue
}

BeforeEach {
$currentPSModulePath = $env:PSModulePath
}

AfterEach {
$env:PSModulePath = $currentPSModulePath
}

$testcases = @(
@{command = {Get-Help about_testCas?1}; testname = "test ? pattern"; result = "about_test1"}
@{command = {Get-Help about_testCase.?}; testname = "test ? pattern with dot"; result = "about_test2"}
Expand All @@ -309,6 +317,22 @@ Describe "Get-Help should find pattern help files" -Tags "CI" {
)
$command.Invoke() | Should -Be $result
}

It "Get-Help should fail expectedly searching for class help with hidden members" {
$testModule = @'
class foo
{
hidden static $monthNames = @('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun','Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec')
}
'@
$modulesFolder = Join-Path $TestDrive "Modules"
Copy link
Member

@adityapatwardhan adityapatwardhan Jun 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use -AdditionalChildPath instead of two Join-Path

Copy link
Member Author

@SteveL-MSFT SteveL-MSFT Jun 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$modulesFolder and $modulePath are used independently

$modulePath = Join-Path $modulesFolder "TestModule"
New-Item -ItemType Directory -Path $modulePath -Force > $null
Set-Content -Path (Join-Path $modulePath "TestModule.psm1") -Value $testModule
$env:PSModulePath += [System.IO.Path]::PathSeparator + $modulesFolder

{ Get-Help -Category Class -Name foo -ErrorAction Stop } | Should -Throw -ErrorId "HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand"
}
}

Describe "Get-Help should find pattern alias" -Tags "CI" {
Expand Down