mirror of
https://github.com/PowerShell/PowerShell
synced 2026-06-08 12:12:50 +00:00
Steve Lee
3b70f7689b
- The original change to remove extra padding didn't take into account alignment. Fix logic to accommodate left, center, and right alignment in the table format and also add tests. - Fix ImplicitRemoting test that validates formatting to use same instance due to formatting changes in this PR - Only use loopback to same powershell instance for formatting test as the other tests implicitly expect Windows PowerShell.
350 lines
11 KiB
PowerShell
350 lines
11 KiB
PowerShell
# Copyright (c) Microsoft Corporation. All rights reserved.
|
|
# Licensed under the MIT License.
|
|
Describe "Format-Table" -Tags "CI" {
|
|
It "Should call format table on piped input without error" {
|
|
{ Get-Date | Format-Table } | Should Not Throw
|
|
|
|
{ Get-Date | ft } | Should Not Throw
|
|
}
|
|
|
|
It "Should return a format object data type" {
|
|
$val = (Get-Date | Format-Table | gm )
|
|
|
|
$val2 = (Get-Date | Format-Table | gm )
|
|
|
|
$val.TypeName | Should Match "Microsoft.Powershell.Commands.Internal.Format"
|
|
|
|
$val2.TypeName | Should Match "Microsoft.Powershell.Commands.Internal.Format"
|
|
}
|
|
|
|
It "Should be able to be called with optional parameters" {
|
|
$v1 = (Get-Date | Format-Table *)
|
|
$v2 = (Get-Date | Format-Table -Property Hour)
|
|
$v3 = (Get-Date | Format-Table -GroupBy Hour)
|
|
|
|
$v12 = (Get-Date | ft *)
|
|
$v22 = (Get-Date | ft -Property Hour)
|
|
$v32 = (Get-Date | ft -GroupBy Hour)
|
|
|
|
}
|
|
}
|
|
|
|
Describe "Format-Table DRT Unit Tests" -Tags "CI" {
|
|
It "Format-Table with not existing table with force should throw PipelineStoppedException"{
|
|
$obj = New-Object -typename PSObject
|
|
try
|
|
{
|
|
$obj | Format-Table -view bar -force -EA Stop
|
|
Throw "Execution OK"
|
|
}
|
|
catch
|
|
{
|
|
$_.CategoryInfo | Should Match "PipelineStoppedException"
|
|
$_.FullyQualifiedErrorId | Should be "FormatViewNotFound,Microsoft.PowerShell.Commands.FormatTableCommand"
|
|
}
|
|
}
|
|
|
|
It "Format-Table with array should work" {
|
|
$al = (0..255)
|
|
$info = @{}
|
|
$info.array = $al
|
|
$result = $info|Format-Table|Out-String
|
|
$result | Should Match "array\s+{0, 1, 2, 3...}"
|
|
}
|
|
|
|
It "Format-Table with Negative Count should work" {
|
|
$FormatEnumerationLimit = -1
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{1, 2}"
|
|
}
|
|
|
|
# Pending on issue#888
|
|
It "Format-Table with Zero Count should work" -Pending {
|
|
$FormatEnumerationLimit = 0
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{...}"
|
|
}
|
|
|
|
It "Format-Table with Less Count should work" {
|
|
$FormatEnumerationLimit = 1
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{1...}"
|
|
}
|
|
|
|
It "Format-Table with More Count should work" {
|
|
$FormatEnumerationLimit = 10
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{1, 2}"
|
|
}
|
|
|
|
It "Format-Table with Equal Count should work" {
|
|
$FormatEnumerationLimit = 2
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{1, 2}"
|
|
}
|
|
|
|
# Pending on issue#888
|
|
It "Format-Table with Bogus Count should throw Exception" -Pending {
|
|
$FormatEnumerationLimit = "abc"
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{1, 2}"
|
|
}
|
|
|
|
# Pending on issue#888
|
|
It "Format-Table with Var Deleted should throw Exception" -Pending {
|
|
$FormatEnumerationLimit = 2
|
|
Remove-Variable FormatEnumerationLimit
|
|
$result = Format-Table -inputobject @{'test'= 1, 2}
|
|
$resultStr = $result|Out-String
|
|
$resultStr | Should Match "test\s+{1, 2}"
|
|
}
|
|
|
|
It "Format-Table with new line should work" {
|
|
$info = @{}
|
|
$info.name = "1\n2"
|
|
$result = $info|Format-Table|Out-String
|
|
$result | Should Match "name\s+1.+2"
|
|
}
|
|
|
|
It "Format-Table with ExposeBug920454 should work" {
|
|
$IP1 = [System.Net.IPAddress]::Parse("1.1.1.1")
|
|
$IP2 = [System.Net.IPAddress]::Parse("4fde:0000:0000:0002:0022:f376:255.59.171.63")
|
|
$IPs = New-Object System.Collections.ArrayList
|
|
$IPs.Add($IP1)
|
|
$IPs.Add($IP2)
|
|
$info = @{}
|
|
$info.test = $IPs
|
|
$result = $info|Format-Table|Out-String
|
|
$result | Should Match "test\s+{1.1.1.1, 4fde::2:22:f376:ff3b:ab3f}"
|
|
}
|
|
|
|
It "Format-Table with Autosize should work" {
|
|
$IP1 = [PSCustomObject]@{'name'='Bob';'size'=1234;'booleanValue'=$true;}
|
|
$IP2 = [PSCustomObject]@{'name'='Jim';'size'=5678;'booleanValue'=$false;}
|
|
$IPs = New-Object System.Collections.ArrayList
|
|
$IPs.Add($IP1)
|
|
$IPs.Add($IP2)
|
|
$result = $IPs|Format-Table -Autosize|Out-String
|
|
$result | Should Match "name size booleanValue"
|
|
$result | Should Match "---- ---- ------------"
|
|
$result | Should Match "Bob\s+1234\s+True"
|
|
$result | Should Match "Jim\s+5678\s+False"
|
|
}
|
|
|
|
It "Format-Table with '<testName>' should return `$null" -TestCases @(
|
|
@{ testName = "empty array"; testObject = @{} },
|
|
@{ testName = "null" ; testObject = $null }
|
|
) {
|
|
param ($testObject)
|
|
$result = $testObject | Format-Table -Property "foo","bar" | Out-String
|
|
$result | Should BeNullOrEmpty
|
|
}
|
|
|
|
It "Format-Table with '<testName>' string and -Force should output table with requested properties" -TestCases @(
|
|
@{ testName = "single line"; testString = "single line string" },
|
|
@{ testName = "multi line" ; testString = "line1`nline2" },
|
|
@{ testName = "array" ; testString = "line1","line2" }
|
|
) {
|
|
param ($testString)
|
|
$result = $testString | Format-Table -Property "foo","bar" -Force | Out-String
|
|
$result.Replace(" ","").Replace([Environment]::NewLine,"") | Should BeExactly "foobar------"
|
|
}
|
|
|
|
It "Format-Table with complex object for End-To-End should work" {
|
|
Add-Type -TypeDefinition "public enum MyDayOfWeek{Sun,Mon,Tue,Wed,Thu,Fri,Sat}"
|
|
$eto = New-Object MyDayOfWeek
|
|
$info = @{}
|
|
$info.intArray = 1,2,3,4
|
|
$info.arrayList = "string1","string2"
|
|
$info.enumerable = [MyDayOfWeek]$eto
|
|
$info.enumerableTestObject = $eto
|
|
$result = $info|Format-Table|Out-String
|
|
$result | Should Match "intArray\s+{1, 2, 3, 4}"
|
|
$result | Should Match "arrayList\s+{string1, string2}"
|
|
$result | Should Match "enumerable\s+Sun"
|
|
$result | Should Match "enumerableTestObject\s+Sun"
|
|
}
|
|
|
|
It "Format-Table with Expand Enumerable should work" {
|
|
$obj1 = "x 0","y 0"
|
|
$obj2 = "x 1","y 1"
|
|
$objs = New-Object System.Collections.ArrayList
|
|
$objs.Add($obj1)
|
|
$objs.Add($obj2)
|
|
$mo = [PSCustomObject]@{name = "this is name";sub = $objs}
|
|
$result1 = $mo|Format-Table -Expand CoreOnly|Out-String
|
|
$result1 | Should Match "name\s+sub"
|
|
$result1 | Should Match "this is name"
|
|
|
|
$result2 = $mo|Format-Table -Expand EnumOnly|Out-String
|
|
$result2 | Should Match "name\s+sub"
|
|
$result2 | Should Match "this is name\s+{x 0 y 0, x 1 y 1}"
|
|
|
|
$result3 = $mo|Format-Table -Expand Both|Out-String
|
|
$result3 | Should Match "name\s+sub"
|
|
$result3 | Should Match "this is name\s+{x 0 y 0, x 1 y 1}"
|
|
}
|
|
|
|
It "Format-Table should not add trailing whitespace to the header" {
|
|
$out = "hello" | Format-Table -Property foo -Force | Out-String
|
|
$out.Replace([System.Environment]::NewLine, "") | Should BeExactly "foo---"
|
|
}
|
|
|
|
It "Format-Table should not add trailing whitespace to rows" {
|
|
$out = [pscustomobject]@{a=1;b=2} | Format-Table -HideTableHeaders | Out-String
|
|
$out.Replace([System.Environment]::NewLine, "") | Should BeExactly "1 2"
|
|
}
|
|
|
|
It "Format-Table should have correct alignment" {
|
|
$ps1xml = @"
|
|
<Configuration>
|
|
<ViewDefinitions>
|
|
<View>
|
|
<Name>Test.Format</Name>
|
|
<ViewSelectedBy>
|
|
<TypeName>Test.Format</TypeName>
|
|
</ViewSelectedBy>
|
|
<TableControl>
|
|
<TableHeaders>
|
|
<TableColumnHeader>
|
|
<Label>Left</Label>
|
|
<Alignment>left</Alignment>
|
|
</TableColumnHeader>
|
|
<TableColumnHeader>
|
|
<Label>Center</Label>
|
|
<Alignment>center</Alignment>
|
|
</TableColumnHeader>
|
|
<TableColumnHeader>
|
|
<Label>Right</Label>
|
|
<Alignment>right</Alignment>
|
|
</TableColumnHeader>
|
|
</TableHeaders>
|
|
<TableRowEntries>
|
|
<TableRowEntry>
|
|
<TableColumnItems>
|
|
<TableColumnItem>
|
|
<PropertyName>Left</PropertyName>
|
|
</TableColumnItem>
|
|
<TableColumnItem>
|
|
<PropertyName>Center</PropertyName>
|
|
</TableColumnItem>
|
|
<TableColumnItem>
|
|
<PropertyName>Right</PropertyName>
|
|
</TableColumnItem>
|
|
</TableColumnItems>
|
|
</TableRowEntry>
|
|
</TableRowEntries>
|
|
</TableControl>
|
|
</View>
|
|
</ViewDefinitions>
|
|
</Configuration>
|
|
"@
|
|
|
|
$ps1xmlPath = Join-Path -Path $TestDrive -ChildPath "test.format.ps1xml"
|
|
Set-Content -Path $ps1xmlPath -Value $ps1xml
|
|
# run in own runspace so not affect global sessionstate
|
|
$ps = [powershell]::Create()
|
|
$ps.AddScript( {
|
|
param($ps1xmlPath)
|
|
Update-FormatData -AppendPath $ps1xmlPath
|
|
$a = [PSCustomObject]@{Left=1;Center=2;Right=3}
|
|
$a.PSObject.TypeNames.Insert(0,"Test.Format")
|
|
$a | Out-String
|
|
} ).AddArgument($ps1xmlPath) | Out-Null
|
|
$output = $ps.Invoke()
|
|
|
|
$expectedTable = @"
|
|
|
|
Left Center Right
|
|
---- ------ -----
|
|
1 2 3
|
|
|
|
|
|
|
|
"@
|
|
$output.Replace("`n","").Replace("`r","") | Should BeExactly $expectedTable.Replace("`n","").Replace("`r","")
|
|
}
|
|
|
|
It "Format-Table should not have trailing whitespace if there is truncation: <view>" -TestCases @(
|
|
# `u{2B758} is a double-byte Japanese character
|
|
@{view="Test.Format.Left" ; object=[pscustomobject]@{Left="123`u{2B758}"} ; expected="Left----1..." },
|
|
@{view="Test.Format.Center"; object=[pscustomobject]@{Center="12345`u{2B758}"}; expected="Center------123..."}
|
|
) {
|
|
param($view, $object, $expected)
|
|
|
|
$ps1xml = @"
|
|
<Configuration>
|
|
<ViewDefinitions>
|
|
<View>
|
|
<Name>Test.Format.Left</Name>
|
|
<ViewSelectedBy>
|
|
<TypeName>Test.Format</TypeName>
|
|
</ViewSelectedBy>
|
|
<TableControl>
|
|
<TableHeaders>
|
|
<TableColumnHeader>
|
|
<Label>Left</Label>
|
|
<Alignment>left</Alignment>
|
|
<Width>4</Width>
|
|
</TableColumnHeader>
|
|
</TableHeaders>
|
|
<TableRowEntries>
|
|
<TableRowEntry>
|
|
<TableColumnItems>
|
|
<TableColumnItem>
|
|
<PropertyName>Left</PropertyName>
|
|
</TableColumnItem>
|
|
</TableColumnItems>
|
|
</TableRowEntry>
|
|
</TableRowEntries>
|
|
</TableControl>
|
|
</View>
|
|
<View>
|
|
<Name>Test.Format.Center</Name>
|
|
<ViewSelectedBy>
|
|
<TypeName>Test.Format</TypeName>
|
|
</ViewSelectedBy>
|
|
<TableControl>
|
|
<TableHeaders>
|
|
<TableColumnHeader>
|
|
<Label>Center</Label>
|
|
<Alignment>center</Alignment>
|
|
<Width>6</Width>
|
|
</TableColumnHeader>
|
|
</TableHeaders>
|
|
<TableRowEntries>
|
|
<TableRowEntry>
|
|
<TableColumnItems>
|
|
<TableColumnItem>
|
|
<PropertyName>Center</PropertyName>
|
|
</TableColumnItem>
|
|
</TableColumnItems>
|
|
</TableRowEntry>
|
|
</TableRowEntries>
|
|
</TableControl>
|
|
</View>
|
|
</ViewDefinitions>
|
|
</Configuration>
|
|
"@
|
|
|
|
$ps1xmlPath = Join-Path -Path $TestDrive -ChildPath "test.format.ps1xml"
|
|
Set-Content -Path $ps1xmlPath -Value $ps1xml
|
|
# run in own runspace so not affect global sessionstate
|
|
$ps = [powershell]::Create()
|
|
$ps.AddScript( {
|
|
param($ps1xmlPath,$view,$object)
|
|
Update-FormatData -AppendPath $ps1xmlPath
|
|
$object.PSObject.TypeNames.Insert(0,"Test.Format")
|
|
$object | Format-Table -View $view | Out-String
|
|
} ).AddArgument($ps1xmlPath).AddArgument($view).AddArgument($object) | Out-Null
|
|
$output = $ps.Invoke()
|
|
$output.Replace("`n","").Replace("`r","") | Should BeExactly $expected
|
|
}
|
|
}
|