X Tutup
Skip to content

Change how relative paths in Resolve-Path are handled when using the RelativeBasePath parameter #19755

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
daxian-dbw merged 5 commits into from
Jul 24, 2023
Merged

Change how relative paths in Resolve-Path are handled when using the RelativeBasePath parameter #19755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1760132
Support resolving full paths from relative input with RelativeBasePat…
MartinGC94 Jun 6, 2023
f24c63b
Check for bound parameter instead of value.
MartinGC94 Jun 6, 2023
e89f4db
Merge branch 'PowerShell:master' into RelativeBasePathFix
MartinGC94 Jul 11, 2023
5953205
Update tests
MartinGC94 Jul 11, 2023
79463bb
Move finally block and address test feedback.
MartinGC94 Jul 17, 2023
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
106 changes: 58 additions & 48 deletions src/Microsoft.PowerShell.Commands.Management/commands/management/ResolvePathCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ public class ResolvePathCommand : CoreCommandWithCredentialsBase
/// </summary>
[Parameter(Position = 0, ParameterSetName = "Path",
Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
[Parameter(Position = 0, ParameterSetName = "PathWithRelativeBase",
Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
public string[] Path
{
get
Expand All @@ -42,8 +40,6 @@ public string[] Path
/// </summary>
[Parameter(ParameterSetName = "LiteralPath",
Mandatory = true, ValueFromPipeline = false, ValueFromPipelineByPropertyName = true)]
[Parameter(ParameterSetName = "LiteralPathWithRelativeBase",
Mandatory = true, ValueFromPipeline = false, ValueFromPipelineByPropertyName = true)]
[Alias("PSPath", "LP")]
public string[] LiteralPath
{
Expand Down Expand Up @@ -83,8 +79,7 @@ public SwitchParameter Relative
/// <summary>
/// Gets or sets the path the resolved relative path should be based off.
/// </summary>
[Parameter(Mandatory = true, ParameterSetName = "PathWithRelativeBase")]
[Parameter(Mandatory = true, ParameterSetName = "LiteralPathWithRelativeBase")]
[Parameter]
public string RelativeBasePath
{
get
Expand All @@ -94,7 +89,6 @@ public string RelativeBasePath

set
{
_relative = true;
_relativeBasePath = value;
}
}
Expand All @@ -121,52 +115,50 @@ public string RelativeBasePath
/// </summary>
protected override void BeginProcessing()
{
if (_relative)
if (!string.IsNullOrEmpty(RelativeBasePath))
{
if (!string.IsNullOrEmpty(RelativeBasePath))
try
{
try
{
_relativeBasePath = SessionState.Internal.Globber.GetProviderPath(RelativeBasePath, CmdletProviderContext, out _, out _relativeDrive);
}
catch (ProviderNotFoundException providerNotFound)
{
ThrowTerminatingError(
new ErrorRecord(
providerNotFound.ErrorRecord,
providerNotFound));
}
catch (DriveNotFoundException driveNotFound)
{
ThrowTerminatingError(
new ErrorRecord(
driveNotFound.ErrorRecord,
driveNotFound));
}
catch (ProviderInvocationException providerInvocation)
{
ThrowTerminatingError(
new ErrorRecord(
providerInvocation.ErrorRecord,
providerInvocation));
}
catch (NotSupportedException notSupported)
{
ThrowTerminatingError(
new ErrorRecord(notSupported, "ProviderIsNotNavigationCmdletProvider", ErrorCategory.InvalidArgument, RelativeBasePath));
}
catch (InvalidOperationException invalidOperation)
{
ThrowTerminatingError(
new ErrorRecord(invalidOperation, "InvalidHomeLocation", ErrorCategory.InvalidOperation, RelativeBasePath));
}

return;
_relativeBasePath = SessionState.Internal.Globber.GetProviderPath(RelativeBasePath, CmdletProviderContext, out _, out _relativeDrive);
}
catch (ProviderNotFoundException providerNotFound)
{
ThrowTerminatingError(
new ErrorRecord(
providerNotFound.ErrorRecord,
providerNotFound));
}
catch (DriveNotFoundException driveNotFound)
{
ThrowTerminatingError(
new ErrorRecord(
driveNotFound.ErrorRecord,
driveNotFound));
}
catch (ProviderInvocationException providerInvocation)
{
ThrowTerminatingError(
new ErrorRecord(
providerInvocation.ErrorRecord,
providerInvocation));
}
catch (NotSupportedException notSupported)
{
ThrowTerminatingError(
new ErrorRecord(notSupported, "ProviderIsNotNavigationCmdletProvider", ErrorCategory.InvalidArgument, RelativeBasePath));
}
catch (InvalidOperationException invalidOperation)
{
ThrowTerminatingError(
new ErrorRecord(invalidOperation, "InvalidHomeLocation", ErrorCategory.InvalidOperation, RelativeBasePath));
}

return;
}
else if (_relative)
{
_relativeDrive = SessionState.Path.CurrentLocation.Drive;
_relativeBasePath = SessionState.Path.CurrentLocation.ProviderPath;
return;
}
}

Expand All @@ -181,7 +173,25 @@ protected override void ProcessRecord()
Collection<PathInfo> result = null;
try
{
result = SessionState.Path.GetResolvedPSPathFromPSPath(path, CmdletProviderContext);
if (MyInvocation.BoundParameters.ContainsKey("RelativeBasePath"))
{
// Pushing and popping the location is done because GetResolvedPSPathFromPSPath uses the current path to resolve relative paths.
// It's important that we pop the location before writing an object to the pipeline to avoid affecting downstream commands.
try
{
SessionState.Path.PushCurrentLocation(string.Empty);
_ = SessionState.Path.SetLocation(_relativeBasePath);
result = SessionState.Path.GetResolvedPSPathFromPSPath(path, CmdletProviderContext);
}
finally
{
_ = SessionState.Path.PopLocation(string.Empty);
}
}
else
{
result = SessionState.Path.GetResolvedPSPathFromPSPath(path, CmdletProviderContext);
}

if (_relative)
{
Expand Down
68 changes: 65 additions & 3 deletions test/powershell/Modules/Microsoft.PowerShell.Management/Resolve-Path.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,70 @@ Describe "Resolve-Path returns proper path" -Tag "CI" {
Pop-Location
}
}
It 'Resolve-Path should support user specified base paths' {
$Expected = Join-Path -Path .\ -ChildPath fakeroot
Resolve-Path -Path $fakeRoot -RelativeBasePath $testRoot | Should -BeExactly $Expected
It 'Resolve-Path RelativeBasePath should handle <Scenario>' -TestCases @(
@{
Scenario = "Absolute Path, Absolute ReleativeBasePath"
Path = $root
Basepath = $testRoot
Expected = $root, ".$([System.IO.Path]::DirectorySeparatorChar)fakeroot"
CD = $null
}
@{
Scenario = "Relative Path, Absolute ReleativeBasePath"
Path = ".$([System.IO.Path]::DirectorySeparatorChar)fakeroot"
Basepath = $testRoot
Expected = $root, ".$([System.IO.Path]::DirectorySeparatorChar)fakeroot"
CD = $null
}
@{
Scenario = "Relative Path, Relative ReleativeBasePath"
Path = ".$([System.IO.Path]::DirectorySeparatorChar)fakeroot"
Basepath = ".$([System.IO.Path]::DirectorySeparatorChar)"
Expected = $root, ".$([System.IO.Path]::DirectorySeparatorChar)fakeroot"
CD = $testRoot
}
@{
Scenario = "Invalid Path, Absolute ReleativeBasePath"
Path = Join-Path $testRoot ThisPathDoesNotExist
Basepath = $root
Expected = $null
CD = $null
}
@{
Scenario = "Invalid Path, Invalid ReleativeBasePath"
Path = Join-Path $testRoot ThisPathDoesNotExist
Basepath = Join-Path $testRoot ThisPathDoesNotExist
Expected = $null
CD = $null
}
) -Test {
param($Path, $BasePath, $Expected, $CD)

if ($null -eq $Expected)
{
{Resolve-Path -Path $Path -RelativeBasePath $BasePath -ErrorAction Stop} | Should -Throw -ErrorId "PathNotFound,Microsoft.PowerShell.Commands.ResolvePathCommand"
{Resolve-Path -Path $Path -RelativeBasePath $BasePath -ErrorAction Stop -Relative} | Should -Throw -ErrorId "PathNotFound,Microsoft.PowerShell.Commands.ResolvePathCommand"
}
else
{
try
{
$OldLocation = if ($null -ne $CD)
{
$PWD
Set-Location $CD
}

(Resolve-Path -Path $Path -RelativeBasePath $BasePath).ProviderPath | Should -BeExactly $Expected[0]
Resolve-Path -Path $Path -RelativeBasePath $BasePath -Relative | Should -BeExactly $Expected[1]
}
finally
{
if ($null -ne $OldLocation)
{
Set-Location $OldLocation
}
}
}
}
}
X Tutup