Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Tar: Add missing TarFile.CreateFromDirectoryAsync roundtrip tests #84303

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
merged 1 commit into from
Apr 14, 2023
Merged

Tar: Add missing TarFile.CreateFromDirectoryAsync roundtrip tests #84303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions src/libraries/System.Formats.Tar/tests/System.Formats.Tar.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<Compile Include="SimulatedDataStream.cs" />
<Compile Include="TarEntry\TarEntry.ExtractToFile.Tests.cs" />
<Compile Include="TarEntry\TarEntry.ExtractToFileAsync.Tests.cs" />
<Compile Include="TarFile\TarFile.CreateFromDirectoryAsync.File.Roundtrip.cs" />
<Compile Include="TarFile\TarFile.ExtractToDirectoryAsync.Stream.Tests.cs" />
<Compile Include="TarFile\TarFile.ExtractToDirectoryAsync.File.Tests.cs" />
<Compile Include="TarFile\TarFile.CreateFromDirectoryAsync.Stream.Tests.cs" />
Expand Down
80 changes: 80 additions & 0 deletions ...aries/System.Formats.Tar/tests/TarFile/TarFile.CreateFromDirectoryAsync.File.Roundtrip.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.IO;
using System.Threading.Tasks;
using Xunit;

namespace System.Formats.Tar.Tests
{
public class TarFile_CreateFromDirectoryAsync_Roundtrip_Tests : TarTestsBase
{
[ConditionalTheory(typeof(MountHelper), nameof(MountHelper.CanCreateSymbolicLinks))]
[InlineData("./file.txt", "subDirectory")]
[InlineData("../file.txt", "subDirectory")]
[InlineData("../file.txt", "subDirectory1/subDirectory1.1")]
[InlineData("./file.txt", "subDirectory1/subDirectory1.1")]
[InlineData("./file.txt", null)]
public async Task SymlinkRelativeTargets_InsideTheArchive_RoundtripsSuccessfully_Async(string symlinkTargetPath, string subDirectory)
{
using TempDirectory root = new TempDirectory();

string destinationArchive = Path.Join(root.Path, "destination.tar");

string sourceDirectoryName = Path.Join(root.Path, "baseDirectory");
Directory.CreateDirectory(sourceDirectoryName);

string destinationDirectoryName = Path.Join(root.Path, "destinationDirectory");
Directory.CreateDirectory(destinationDirectoryName);

string sourceSubDirectory = Path.Join(sourceDirectoryName, subDirectory);
if (subDirectory != null) Directory.CreateDirectory(sourceSubDirectory);

File.Create(Path.Join(sourceDirectoryName, subDirectory, symlinkTargetPath)).Dispose();
File.CreateSymbolicLink(Path.Join(sourceSubDirectory, "linkToFile"), symlinkTargetPath);

await TarFile.CreateFromDirectoryAsync(sourceDirectoryName, destinationArchive, includeBaseDirectory: false);

await using FileStream archiveStream = File.OpenRead(destinationArchive);
await TarFile.ExtractToDirectoryAsync(archiveStream, destinationDirectoryName, overwriteFiles: true);

string destinationSubDirectory = Path.Join(destinationDirectoryName, subDirectory);
string symlinkPath = Path.Join(destinationSubDirectory, "linkToFile");
Assert.True(File.Exists(symlinkPath));

FileInfo? fileInfo = new(symlinkPath);
Assert.Equal(symlinkTargetPath, fileInfo.LinkTarget);

FileSystemInfo? symlinkTarget = File.ResolveLinkTarget(symlinkPath, returnFinalTarget: true);
Assert.True(File.Exists(symlinkTarget.FullName));
}

[ConditionalTheory(typeof(MountHelper), nameof(MountHelper.CanCreateSymbolicLinks))]
[InlineData("../file.txt", null)]
[InlineData("../../file.txt", "subDirectory")]
public async Task SymlinkRelativeTargets_OutsideTheArchive_Fails_Async(string symlinkTargetPath, string subDirectory)
{
using TempDirectory root = new TempDirectory();

string destinationArchive = Path.Join(root.Path, "destination.tar");

string sourceDirectoryName = Path.Join(root.Path, "baseDirectory");
Directory.CreateDirectory(sourceDirectoryName);

string destinationDirectoryName = Path.Join(root.Path, "destinationDirectory");
Directory.CreateDirectory(destinationDirectoryName);

string sourceSubDirectory = Path.Join(sourceDirectoryName, subDirectory);
Copy link
Member

Choose a reason for hiding this comment

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

I guess Path.Join handles null values fine but I would have probably put that operation into the if block below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, let me confirm.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Join handles it properly: null is treated like empty string. The resulting path is just the first argument's path.

I would prefer to avoid restarting the CI for that, hope you don't mind.

if (subDirectory != null) Directory.CreateDirectory(sourceSubDirectory);

File.CreateSymbolicLink(Path.Join(sourceSubDirectory, "linkToFile"), symlinkTargetPath);

await TarFile.CreateFromDirectoryAsync(sourceDirectoryName, destinationArchive, includeBaseDirectory: false);

using FileStream archiveStream = File.OpenRead(destinationArchive);
Exception exception = await Assert.ThrowsAsync<IOException>(() => TarFile.ExtractToDirectoryAsync(archiveStream, destinationDirectoryName, overwriteFiles: true));

Assert.Equal(SR.Format(SR.TarExtractingResultsLinkOutside, symlinkTargetPath, destinationDirectoryName), exception.Message);
}
}
}