Skip to content

Test-Path: Return $false when given an empty or $null -Path/-LiteralPath value #8080

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 15 commits into from
Nov 21, 2018
Merged

Test-Path: Return $false when given an empty or $null -Path/-LiteralPath value #8080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1313095
Add empty / null path handling to Test-Path
vexx32 Oct 19, 2018
7d5735a
Update tests to fail correctly under the sole remaining erroring cond…
vexx32 Oct 19, 2018
2f41783
Use quick-exit code paths instead of lengthy if/else
vexx32 Oct 19, 2018
44417f5
Add non-terminating errors for null input
vexx32 Oct 25, 2018
63e1b8f
Reformat test file for readability
vexx32 Oct 25, 2018
d793658
Use more descriptive error ID
vexx32 Oct 25, 2018
794e78b
Add Tests for new behaviour
vexx32 Oct 25, 2018
cae5294
Remove unnecessary blank line per StyleCop
vexx32 Oct 25, 2018
60810ca
Add new tests
vexx32 Oct 30, 2018
e731fab
Clarify it name
vexx32 Oct 30, 2018
2008e51
Fix endless loop caused by change of error type in tests
vexx32 Oct 30, 2018
28cc91f
Fix FullyQualifiedErrorID
vexx32 Oct 31, 2018
0be7bf1
Consolidate ErrorIDs to match
vexx32 Oct 31, 2018
890fcb1
Add .resx file for TestPath
vexx32 Nov 16, 2018
cddfb79
Use resource file for error string
vexx32 Nov 16, 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
38 changes: 37 additions & 1 deletion src/Microsoft.PowerShell.Commands.Management/commands/management/PingPathCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Management.Automation;
using Dbg = System.Management.Automation;

Expand Down Expand Up @@ -41,6 +42,9 @@ public class TestPathCommand : CoreCommandWithCredentialsBase
/// </summary>
[Parameter(Position = 0, ParameterSetName = "Path",
Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
[AllowNull]
[AllowEmptyCollection]
[AllowEmptyString]
public string[] Path
{
get { return _paths; }
Expand All @@ -53,6 +57,9 @@ public string[] Path
[Parameter(ParameterSetName = "LiteralPath",
Mandatory = true, ValueFromPipeline = false, ValueFromPipelineByPropertyName = true)]
[Alias("PSPath", "LP")]
[AllowNull]
[AllowEmptyCollection]
[AllowEmptyString]
public string[] LiteralPath
{
get { return _paths; }
Expand Down Expand Up @@ -124,7 +131,7 @@ internal override object GetDynamicParameters(CmdletProviderContext context)

if (this.PathType == TestPathType.Any && !IsValid)
{
if (Path != null && Path.Length > 0)
if (Path != null && Path.Length > 0 && Path[0] != null)
{
result = InvokeProvider.Item.ItemExistsDynamicParameters(Path[0], context);
}
Expand All @@ -133,6 +140,7 @@ internal override object GetDynamicParameters(CmdletProviderContext context)
result = InvokeProvider.Item.ItemExistsDynamicParameters(".", context);
}
}

return result;
} // GetDynamicParameters

Expand All @@ -154,12 +162,39 @@ internal override object GetDynamicParameters(CmdletProviderContext context)
/// </summary>
protected override void ProcessRecord()
{
if (_paths == null || _paths.Length == 0)
{
WriteError(new ErrorRecord(
new ArgumentNullException(TestPathResources.PathIsNullOrEmptyCollection),
"NullPathNotPermitted",
ErrorCategory.InvalidArgument,
Path));

return;
}

CmdletProviderContext currentContext = CmdletProviderContext;

foreach (string path in _paths)
{
bool result = false;

if (path == null)
{
WriteError(new ErrorRecord(
new ArgumentNullException(TestPathResources.PathIsNullOrEmptyCollection),
"NullPathNotPermitted",
ErrorCategory.InvalidArgument,
Path));
continue;
}

if (string.IsNullOrWhiteSpace(path))
{
WriteObject(result);
continue;
}

try
{
if (IsValid)
Expand All @@ -184,6 +219,7 @@ protected override void ProcessRecord()
}
}
}

// Any of the known exceptions means the path does not exist.
catch (PSNotSupportedException)
{
Expand Down
123 changes: 123 additions & 0 deletions src/Microsoft.PowerShell.Commands.Management/resources/TestPathResources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema

Version 2.0

The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.

Example:

... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>

There are any number of "resheader" rows that contain simple
name/value pairs.

Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.

The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:

Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.

mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="https://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="PathIsNullOrEmptyCollection" xml:space="preserve">
<value>The provided Path argument was null or an empty collection.</value>
</data>
</root>
8 changes: 4 additions & 4 deletions test/powershell/Language/Scripting/ErrorPosition.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ for ($null[0];
'@
$for_pipeline_initializer_script = @'
$test = 1
for (Test-Path $null;
for (Test-Path $null -ErrorAction Stop;
$test -gt 1;) { }
'@
$for_expression_condition_script = @'
Expand All @@ -27,7 +27,7 @@ for (;$null[0];)
'@
$for_pipeline_condition_script = @'
$test = 1
for (;Test-Path $null;)
for (;Test-Path $null -ErrorAction Stop;)
{ }
'@
$do_while_expression_condition_script = @'
Expand All @@ -38,7 +38,7 @@ while ($null[0])
$do_while_pipeline_condition_script = @'
$test = 1
do {}
while (Test-Path $null)
while (Test-Path $null -ErrorAction Stop)
'@
$do_until_expression_condition_script = @'
$test = 1
Expand All @@ -48,7 +48,7 @@ until ($null[0])
$do_until_pipeline_condition_script = @'
$test = 1
do {}
until (Test-Path $null)
until (Test-Path $null -ErrorAction Stop)
'@

$testCases = @(
Expand Down
Loading