Skip to content

Fix LiteralPath in Import-Csv to bind to Get-ChildItem output #8277

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
iSazonov merged 7 commits into from
Jan 9, 2019
Merged

Fix LiteralPath in Import-Csv to bind to Get-ChildItem output #8277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5f35649
Fix LiteralPath in Import-Csv to bind to Get-ChildItem output
iSazonov Nov 15, 2018
2eefba0
Remove ValueFromPipelineByPropertyName from Path parameter
iSazonov Nov 16, 2018
482446f
mklement0's change
iSazonov Nov 29, 2018
a3c14fc
Fix parameter set names
iSazonov Nov 29, 2018
dc73865
Fix parametersets in Export-Csv
iSazonov Dec 6, 2018
db3376f
Revert SetDelimiter()
iSazonov Dec 6, 2018
dc4a905
Add new tests
iSazonov Jan 9, 2019
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
27 changes: 18 additions & 9 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/CSVCommands.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ public override void
/// <summary>
/// Implements Import-Csv command.
/// </summary>
[Cmdlet(VerbsData.Import, "Csv", DefaultParameterSetName = "Delimiter", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=113341")]
[Cmdlet(VerbsData.Import, "Csv", DefaultParameterSetName = "DelimiterPath", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=113341")]
public sealed
class
ImportCsvCommand : PSCmdlet
Expand All @@ -519,14 +519,16 @@ public sealed
/// <summary>
/// Property that sets delimiter.
/// </summary>
[Parameter(Position = 1, ParameterSetName = "Delimiter")]
[Parameter(Position = 1, ParameterSetName = "DelimiterPath")]
[Parameter(Position = 1, ParameterSetName = "DelimiterLiteralPath")]
[ValidateNotNull]
public char Delimiter { get; set; }

/// <summary>
/// Mandatory file name to read from.
/// </summary>
[Parameter(Position = 0, ValueFromPipeline = true)]
[Parameter(Position = 0, ParameterSetName = "DelimiterPath", Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
[Parameter(Position = 0, ParameterSetName = "CulturePath", Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
[ValidateNotNullOrEmpty]
public string[] Path
{
Expand All @@ -548,7 +550,8 @@ public string[] Path
/// <summary>
/// The literal path of the mandatory file name to read from.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true)]
[Parameter(ParameterSetName = "DelimiterLiteralPath", Mandatory = true, ValueFromPipelineByPropertyName = true)]
[Parameter(ParameterSetName = "CultureLiteralPath", Mandatory = true, ValueFromPipelineByPropertyName = true)]
[ValidateNotNullOrEmpty]
[Alias("PSPath", "LP")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
Expand All @@ -571,7 +574,8 @@ public string[] LiteralPath
/// <summary>
/// Property that sets UseCulture parameter.
/// </summary>
[Parameter(ParameterSetName = "UseCulture", Mandatory = true)]
[Parameter(ParameterSetName = "CulturePath", Mandatory = true)]
[Parameter(ParameterSetName = "CultureLiteralPath", Mandatory = true)]
[ValidateNotNull]
public SwitchParameter UseCulture
{
Expand Down Expand Up @@ -664,7 +668,7 @@ protected override void ProcessRecord()
/// <summary>
/// Implements ConvertTo-Csv command.
/// </summary>
[Cmdlet(VerbsData.ConvertTo, "Csv", DefaultParameterSetName = "Delimiter",
[Cmdlet(VerbsData.ConvertTo, "Csv", DefaultParameterSetName = "DelimiterPath",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135203", RemotingCapability = RemotingCapability.None)]
[OutputType(typeof(string))]
public sealed class ConvertToCsvCommand : BaseCsvWritingCommand
Expand Down Expand Up @@ -754,7 +758,7 @@ public override void
/// <summary>
/// Implements ConvertFrom-Csv command.
/// </summary>
[Cmdlet(VerbsData.ConvertFrom, "Csv", DefaultParameterSetName = "Delimiter",
[Cmdlet(VerbsData.ConvertFrom, "Csv", DefaultParameterSetName = "DelimiterPath",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=135201", RemotingCapability = RemotingCapability.None)]
public sealed
class
Expand All @@ -765,15 +769,16 @@ public sealed
/// <summary>
/// Property that sets delimiter.
/// </summary>
[Parameter(Position = 1, ParameterSetName = "Delimiter")]
[Parameter(Position = 1, ParameterSetName = "DelimiterPath")]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
public char Delimiter { get; set; }

///<summary>
///Culture switch for csv conversion
///</summary>
[Parameter(ParameterSetName = "UseCulture", Mandatory = true)]
[Parameter(ParameterSetName = "CulturePath", Mandatory = true)]
[Parameter(ParameterSetName = "CultureLiteralPath", Mandatory = true)]
[ValidateNotNull]
[ValidateNotNullOrEmpty]
public SwitchParameter UseCulture { get; set; }
Expand Down Expand Up @@ -1702,6 +1707,8 @@ internal static char SetDelimiter(PSCmdlet Cmdlet, string ParameterSetName, char
switch (ParameterSetName)
{
case "Delimiter":
case "DelimiterPath":
case "DelimiterLiteralPath":
// if delimiter is not given, it should take , as value
if (Delimiter == '\0')
{
Expand All @@ -1710,6 +1717,8 @@ internal static char SetDelimiter(PSCmdlet Cmdlet, string ParameterSetName, char

break;
case "UseCulture":
case "CulturePath":
Copy link
Contributor

@mklement0 mklement0 Dec 6, 2018

Choose a reason for hiding this comment

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

If I understand this correctly, "UseCulture" should be added back in, because this method is used from the Export-Csv and ConvertTo-Csv cmdlets too, which still have the original parameter set names, Delimiter and UseCulture.

Copy link
Collaborator Author

@iSazonov iSazonov Dec 6, 2018

Choose a reason for hiding this comment

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

Fixed.

case "CultureLiteralPath":
if (UseCulture == true)
{
// ListSeparator is apparently always a character even though the property returns a string, checked via:
Expand Down
42 changes: 38 additions & 4 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Import-Csv.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,50 @@ Describe "Import-Csv Double Quote Delimiter" -Tags "CI" {
}


It "Should handle <name>" -TestCases @(
It "Should handle <name> and bind to LiteralPath from pipeline" -TestCases @(
@{ name = "quote with empty value" ; expectedHeader = "a1,H1,a3"; file = "EmptyValue.csv" ; content = $empyValueCsv ; delimiter = '"' }
@{ name = "quote with value" ; expectedHeader = "a1,a2,a3"; file = "WithValue.csv" ; content = $withValueCsv ; delimiter = '"' }
@{ name = "value enclosed in quote" ; expectedHeader = "a1,a2,a3"; file = "QuotedCharacter.csv" ; content = $quotedCharacterCsv ; delimiter = ',' }
){
param($expectedHeader, $file, $content, $delimiter)
Set-Content testdrive:/$file -Value $content
$returnObject = Import-Csv -Path testdrive:/$file -Delimiter $delimiter

$testPath = Join-Path $TestDrive $file
Set-Content $testPath -Value $content

$returnObject = Get-ChildItem -Path $testPath | Import-Csv -Delimiter $delimiter
$actualHeader = $returnObject[0].psobject.Properties.name -join ','
$actualHeader | Should -BeExactly $expectedHeader

$returnObject = $testPath | Import-Csv -Delimiter $delimiter
$actualHeader = $returnObject[0].psobject.Properties.name -join ','
$actualHeader | Should -BeExactly $expectedHeader

$returnObject = [pscustomobject]@{ LiteralPath = $testPath } | Import-Csv -Delimiter $delimiter
$actualHeader = $returnObject[0].psobject.Properties.name -join ','
$actualHeader | Should -BeExactly $expectedHeader
}

It "Should handle <name> and bind to Path from pipeline" -TestCases @(
@{ name = "quote with empty value" ; expectedHeader = "a1,H1,a3"; file = "EmptyValue.csv" ; content = $empyValueCsv ; delimiter = '"' }
@{ name = "quote with value" ; expectedHeader = "a1,a2,a3"; file = "WithValue.csv" ; content = $withValueCsv ; delimiter = '"' }
@{ name = "value enclosed in quote" ; expectedHeader = "a1,a2,a3"; file = "QuotedCharacter.csv" ; content = $quotedCharacterCsv ; delimiter = ',' }
){
param($expectedHeader, $file, $content, $delimiter)

$testPath = Join-Path $TestDrive $file
Set-Content $testPath -Value $content

$returnObject = Get-ChildItem -Path $testPath | Import-Csv -Delimiter $delimiter
$actualHeader = $returnObject[0].psobject.Properties.name -join ','
$actualHeader | Should -BeExactly $expectedHeader

$returnObject = $testPath | Import-Csv -Delimiter $delimiter
$actualHeader = $returnObject[0].psobject.Properties.name -join ','
$actualHeader | Should -BeExactly $expectedHeader

$returnObject = [pscustomobject]@{ Path = $testPath } | Import-Csv -Delimiter $delimiter
$actualHeader = $returnObject[0].psobject.Properties.name -join ','
$actualHeader | Should -Be $expectedHeader
$actualHeader | Should -BeExactly $expectedHeader
}
}

Expand Down