8000 Add tab completion for Export-Counter -FileFormat parameter by MiaRomero · Pull Request #3856 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Add tab completion for Export-Counter -FileFormat parameter #3856

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
merged 2 commits into from
Jun 25, 2017
Merged

Add tab completion for Export-Counter -FileFormat parameter #3856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af420ac
add tab completion for -FileFormat parameter
May 24, 2017
45a5520
update expected error for invalid -FileFormat test case
May 24, 2017
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
21 changes: 8 additions & 13 deletions src/Microsoft.PowerShell.Commands.Diagnostics/ExportCounterCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,13 @@ public string Path
ValueFromPi 10000 pelineByPropertyName = false,
HelpMessageBaseName = "GetEventResources")]
[ValidateNotNull]
[ValidateSet("blg", "csv", "tsv")]
Copy link
Member

Choose a reason for hiding this comment

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

Since we have tab completion now, should they be spelled out? CommaSeperatedValues, TabSeperatedValues and BinaryLog?

Copy link
Member

Choose a reason for hiding this comment

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

Had a chat with Jim. It is ok to keep them as is. Please open an issue on https://github.com/PowerShell/PowerShell-Docs/blob/staging/reference/5.1/Microsoft.PowerShell.Diagnostics/Export-Counter.md to explain what they mean.

Copy link
Member Author

Choose a reason for hiding this comment

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

The file types are explained in the 'Description' section of the documentation. Did you want them in the 'Parameter' section as well?

Copy link
Member

Choose a reason for hiding this comment

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

@MiaRomero Yes, please add them to the parameters section as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've opened issue MicrosoftDocs/PowerShell-Docs#1245 for this

public string FileFormat
{
get { return _format; }
set { _format = value; }
}
private string _format = "BLG";
private string _format = "blg";



Expand Down Expand Up @@ -180,9 +181,9 @@ protected override void BeginProcessing()
_resourceMgr = Microsoft.PowerShell.Commands.Diagnostics.Common.CommonUtilities.GetResourceManager();

//
// Validate the Format and CounterSamples arguments
// Set output format (log file type)
//
ValidateFormat();
SetOutputFormat();

if (Circular.IsPresent && _maxSize == 0)
{
Expand Down Expand Up @@ -311,26 +312,20 @@ protected override void ProcessRecord()
}
}

// ValidateFormat() helper.
// Validates Format argument: only "BLG", "TSV" and "CSV" are valid strings (case-insensitive)
// Determines Log File Type based on FileFormat parameter
//
private void ValidateFormat()
private void SetOutputFormat()
{
switch (_format.ToLowerInvariant())
{
case "blg":
_outputFormat = PdhLogFileType.PDH_LOG_TYPE_BINARY;
break;
case "csv":
_outputFormat = PdhLogFileType.PDH_LOG_TYPE_CSV;
break;
case "tsv":
_outputFormat = PdhLogFileType.PDH_LOG_TYPE_TSV;
break;
default:
string msg = string.Format(CultureInfo.InvariantCulture, _resourceMgr.GetString("CounterInvalidFormat"), _format);
Exception exc = new Exception(msg);
ThrowTerminatingError(new ErrorRecord(exc, "CounterInvalidFormat", ErrorCategory.InvalidArgument, null));
default: // By default file format is blg
_outputFormat = PdhLogFileType.PDH_LOG_TYPE_BINARY;
break;
}
}
Expand Down
3 changes: 0 additions & 3 deletions src/Microsoft.PowerShell.Commands.Diagnostics/resources/GetEventResources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,6 @@ The defined template is following:
<data name="IncorrectEventVersion" xml:space="preserve">
<value>Event cannot be written because the specified version {0} for event {1} is not defined for the provider {2}. Please correct the version and try again.</value>
</data>
<data name="CounterInvalidFormat" xml:space="preserve">
<value>The {0} format type is not a valid format for a counter file. Possible values for the Format parameter are .blg, .csv, or .tsv.</value>
</data>
<data name="Counter32FileLimit" xml:space="preserve">
<value>You cannot import more than 32 .blg counter log files in each command.</value>
</data>
Expand Down
1 change: 0 additions & 1 deletion src/Microsoft.PowerShell.Commands.Diagnostics/resources/GetEventResources.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ CounterExportSampleNotInInitialSet=The {0} performance counter cannot be exporte
CounterPathTranslationFailed=The default values for this command failed. Error: {0:x8}.
CounterContinuousOrMaxSamples=The Continuous parameter and the MaxSamples parameter cannot be used in the same command.
CounterSampleDataInvalid=The data in one of the performance counter samples is not valid. View the Status property for each PerformanceCounterSample object to make sure it contains valid data.
CounterInvalidFormat=The {0} format type is not a valid format for a counter file. Possible values for the Format parameter are .blg, .csv, or .tsv.
CounterCircularNoMaxSize=The Circular parameter will be ignored unless the MaxSize parameter is also specified.
ExportCtrWin7Required=This cmdlet can be run only on Microsoft Windows 7 and above.
FileOpenFailed=Unable to open the {0} file for writing.
Expand Down
30 changes: 22 additions & 8 deletions test/powershell/Host/TabCompletion/TabCompletion.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ Describe "TabCompletion" -Tags CI {
It 'Should complete format-table hashtable' {
$res = TabExpansion2 -inputScript 'Get-ChildItem | Format-Table @{ ' -cursorColumn 'Get-ChildItem | Format-Table @{ '.Length
$res.CompletionMatches.Count | Should Be 5
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Label', 'Width', 'Alignment', 'Expression', 'FormatString' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' ' | Should Be 'Alignment Expression FormatString Label Width'
}


Expand All @@ -46,37 +47,43 @@ Describe "TabCompletion" -Tags CI {
param($cmd)
$res = TabExpansion2 -inputScript "Get-ChildItem | $cmd -GroupBy @{ " -cursorColumn "Get-ChildItem | $cmd -GroupBy @{ ".Length
$res.CompletionMatches.Count | Should Be 3
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Label', 'Expression', 'FormatString' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' ' | Should Be 'Expression FormatString Label'
}

It 'Should complete format-list hashtable' {
$res = TabExpansion2 -inputScript 'Get-ChildItem | Format-List @{ ' -cursorColumn 'Get-ChildItem | Format-List @{ '.Length
$res.CompletionMatches.Count | Should Be 3
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Label', 'Expression', 'FormatString' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' ' | Should Be 'Expression FormatString Label'
}

It 'Should complete format-wide hashtable' {
$res = TabExpansion2 -inputScript 'Get-ChildItem | Format-Wide @{ ' -cursorColumn 'Get-ChildItem | Format-Wide @{ '.Length
$res.CompletionMatches.Count | Should Be 2
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Expression', 'FormatString' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' ' | Should Be 'Expression FormatString'
}

It 'Should complete format-custom hashtable' {
$res = TabExpansion2 -inputScript 'Get-ChildItem | Format-Custom @{ ' -cursorColumn 'Get-ChildItem | Format-Custom @{ '.Length
$res.CompletionMatches.Count | Should Be 2
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Expression', 'Depth' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' ' | Should Be 'Depth Expression'
}

It 'Should complete Select-Object hashtable' {
$res = TabExpansion2 -inputScript 'Get-ChildItem | Select-Object @{ ' -cursorColumn 'Get-ChildItem | Select-Object @{ '.Length
$res.CompletionMatches.Count | Should Be 2
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Name', 'Expression' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' '| Should Be 'Expression Name'
}

It 'Should complete Sort-Object hashtable' {
$res = TabExpansion2 -inputScript 'Get-ChildItem | Sort-Object @{ ' -cursorColumn 'Get-ChildItem | Sort-Object @{ '.Length
$res.CompletionMatches.Count | Should Be 3
$res.CompletionMatches.Foreach{$_.CompletionText -in 'Expression', 'Ascending', 'Descending' | Should Be $true}
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' '| Should Be 'Ascending Descending Expression'
}

It 'Should complete New-Object hashtable' {
Expand All @@ -87,7 +94,7 @@ Describe "TabCompletion" -Tags CI {
}
$res = TabExpansion2 -inputScript 'New-Object -TypeName X -Property @{ ' -cursorColumn 'New-Object -TypeName X -Property @{ '.Length
$res.CompletionMatches.Count | Should Be 3
$res.CompletionMatches.Foreach{$_.CompletionText -in 'A', 'B', 'C' | Should Be $true}
$res.CompletionMatches.CompletionText -join ' ' | Should Be 'A B C'
}

It 'Should complete "Get-Process -Id " with Id and name in tooltip' {
Expand All @@ -103,4 +110,11 @@ Describe "TabCompletion" -Tags CI {
$res = TabExpansion2 -inputScript 'using nam' -cursorColumn 'using nam'.Length
$res.CompletionMatches[0].CompletionText | Should be 'namespace'
}

It 'Should complete "Export-Counter -FileFormat" with available output formats'-Skip:(!$IsWindows) {
$res = TabExpansion2 -inputScript 'Export-Counter -FileFormat ' -cursorColumn 'Export-Counter -FileFormat '.Length
$res.CompletionMatches.Count | Should Be 3
$completionText = $res.CompletionMatches.CompletionText | Sort-Object
$completionText -join ' '| Should Be 'blg csv tsv'
}
}
5 changes: 0 additions & 5 deletions test/powershell/Modules/Microsoft.PowerShell.Diagnostics/Export-Counter.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,6 @@ Describe "Feature tests for Export-Counter cmdlet" -Tags "Feature" {
Parameters = "-MaxSize -2"
ExpectedErrorId = "CannotConvertArgumentNoMessage,Microsoft.PowerShell.Commands.ExportCounterCommand"
}
@{
Name = "Fails when given invalid file format"
FileFormat = "dat"
ExpectedErrorId = "CounterInvalidFormat,Microsoft.PowerShell.Commands.ExportCounterCommand"
}
)

foreach ($testCase in $testCases)
Expand Down
0