Skip to content

Get/Add-Content throws improved error when targeting a container #7823

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 4 commits into from
Sep 28, 2018
Merged

Get/Add-Content throws improved error when targeting a container #7823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc54f0a
Get/Add-Content throws improved error when targeting a container
kvprasoon Sep 19, 2018
d307909
CodeFactor Fix
kvprasoon Sep 19, 2018
c4f326b
Review comments changes
kvprasoon Sep 20, 2018
25f70d5
Error message changes as per review comments,
kvprasoon Sep 21, 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
16 changes: 16 additions & 0 deletions src/System.Management.Automation/namespaces/FileSystemProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6366,6 +6366,14 @@ public IContentReader GetContentReader(string path)

try
{
if (Directory.Exists(path))
{
string errMsg = StringUtil.Format(SessionStateStrings.GetContainerContentException, path);
ErrorRecord error = new ErrorRecord(new InvalidOperationException(errMsg), "GetContainerContentException", ErrorCategory.InvalidOperation, null);
WriteError(error);
return stream;
}

// Users can't both read as bytes, and specify a delimiter
if (delimiterSpecified)
{
Expand Down Expand Up @@ -6514,6 +6522,14 @@ public IContentWriter GetContentWriter(string path)

try
{
if (Directory.Exists(path))
{
string errMsg = StringUtil.Format(SessionStateStrings.WriteContainerContentException, path);
ErrorRecord error = new ErrorRecord(new InvalidOperationException(errMsg), "WriteContainerContentException", ErrorCategory.InvalidOperation, null);
WriteError(error);
return stream;
}

stream = new FileSystemContentReaderWriter(path, streamName, filemode, FileAccess.Write, FileShare.Write, encoding, usingByteEncoding, false, this, false, suppressNewline);
}
catch (PathTooLongException pathTooLong)
Expand Down
6 changes: 6 additions & 0 deletions src/System.Management.Automation/resources/SessionStateStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,12 @@
<data name="GetContentWriterDynamicParametersProviderException" xml:space="preserve">
<value>The dynamic parameters for the GetContentWriter operation cannot be retrieved for the '{0}' provider for path '{1}'. {2}</value>
</data>
<data name="GetContainerContentException" xml:space="preserve">
<value>Unable to get content because it is a directory: '{0}'. Please use 'Get-ChildItem' instead.</value>
</data>
<data name="WriteContainerContentException" xml:space="preserve">
<value>Unable to write content because it is a directory: '{0}'.</value>
</data>
<data name="LocationUndoStackIsEmpty" xml:space="preserve">
<value>There is no location history left to navigate backwards.</value>
</data>
Expand Down
4 changes: 4 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Management/Add-Content.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Describe "Add-Content cmdlet tests" -Tags "CI" {
{ Add-Content -Path $() -Value "ShouldNotWorkBecausePathIsInvalid" -ErrorAction Stop } | Should -Throw -ErrorId "ParameterArgumentValidationErrorNullNotAllowed,Microsoft.PowerShell.Commands.AddContentCommand"
}

It "Should throw an error on a directory" {
{ Add-Content -Path . -Value "WriteContainerContentException" -ErrorAction Stop } | Should -Throw -ErrorId "WriteContainerContentException,Microsoft.PowerShell.Commands.AddContentCommand"
}

#[BugId(BugDatabase.WindowsOutOfBandReleases, 906022)]
It "should throw 'NotSupportedException' when you add-content to an unsupported provider" -Skip:($IsLinux -Or $IsMacOS) {
{ Add-Content -Path HKLM:\\software\\microsoft -Value "ShouldNotWorkBecausePathIsUnsupported" -ErrorAction Stop } | Should -Throw -ErrorId "NotSupported,Microsoft.PowerShell.Commands.AddContentCommand"
Expand Down
4 changes: 2 additions & 2 deletions test/powershell/Modules/Microsoft.PowerShell.Management/Get-Content.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Describe "Get-Content" -Tags "CI" {
Remove-Item -Path $testPath2 -Force
}

It "Should throw an error on a directory " {
It "Should throw an error on a directory" {
{ Get-Content . -ErrorAction Stop } |
Should -Throw -ErrorId "GetContentReaderUnauthorizedAccessError,Microsoft.PowerShell.Commands.GetContentCommand"
Should -Throw -ErrorId "GetContainerContentException,Microsoft.PowerShell.Commands.GetContentCommand"
}

It "Should return an Object when listing only a single line and the correct information from a file" {
Expand Down