Skip to content

[release/7.0] backport Tar fixes #76322

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
carlossanlop merged 12 commits into from
Oct 4, 2022
Merged

[release/7.0] backport Tar fixes #76322

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
abe6daf
Use UTF8 encoding on Tar string fields
jozkee Sep 20, 2022
646a96b
Slice destination on Checksum
jozkee Sep 20, 2022
90a1f51
Use Encoding.GetByteCount as fast path
jozkee Sep 20, 2022
e4b1c69
Use escape sequences on hardcoded UTF8 characters
jozkee Sep 20, 2022
130bad1
Fix ustar prefix logic and throw if name would be truncated
jozkee Sep 22, 2022
512eb04
Address feedback
jozkee Sep 22, 2022
d774bf0
Fix truncation and prefix logic
jozkee Sep 26, 2022
818ab42
Fix nits
jozkee Sep 27, 2022
ae3a623
Add async tests
jozkee Sep 27, 2022
14571b0
Add tests for unseekable streams
jozkee Sep 27, 2022
a255c73
Address feedback
jozkee Sep 28, 2022
0aa84d2
Tar: Use indexer setter instead of Add on ExtendedAttributes dictiona…
jozkee Oct 3, 2022
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
Prev Previous commit
Next Next commit
Add tests for unseekable streams
  • Loading branch information
@jozkee
jozkee authored and github-actions committed Sep 28, 2022
commit 14571b03af2c71fcf42d46fdd596eb12c4696cf5
91 changes: 53 additions & 38 deletions ...ibraries/System.Formats.Tar/tests/TarWriter/TarWriter.WriteEntry.Entry.Roundtrip.Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,42 +12,47 @@ public class TarWriter_WriteEntry_Roundtrip_Tests : TarTestsBase
{
public static IEnumerable<object[]> NameRoundtripsTheoryData()
{
foreach (TarEntryType entryType in new[] { TarEntryType.RegularFile, TarEntryType.Directory })
foreach (bool unseekableStream in new[] { false, true })
{
foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Name).Concat(GetNamesPrefixedTestData(NameCapabilities.Name)))
foreach (TarEntryType entryType in new[] { TarEntryType.RegularFile, TarEntryType.Directory })
{
TarEntryType v7EntryType = entryType is TarEntryType.RegularFile ? TarEntryType.V7RegularFile : entryType;
yield return new object[] { TarEntryFormat.V7, v7EntryType, name };
}

foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.NameAndPrefix).Concat(GetNamesPrefixedTestData(NameCapabilities.NameAndPrefix)))
{
yield return new object[] { TarEntryFormat.Ustar, entryType, name };
}

foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Unlimited).Concat(GetNamesPrefixedTestData(NameCapabilities.Unlimited)))
{
yield return new object[] { TarEntryFormat.Pax, entryType, name };
yield return new object[] { TarEntryFormat.Gnu, entryType, name };
foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Name).Concat(GetNamesPrefixedTestData(NameCapabilities.Name)))
{
TarEntryType v7EntryType = entryType is TarEntryType.RegularFile ? TarEntryType.V7RegularFile : entryType;
yield return new object[] { TarEntryFormat.V7, v7EntryType, unseekableStream, name };
}

foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.NameAndPrefix).Concat(GetNamesPrefixedTestData(NameCapabilities.NameAndPrefix)))
{
yield return new object[] { TarEntryFormat.Ustar, entryType, unseekableStream, name };
}

foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Unlimited).Concat(GetNamesPrefixedTestData(NameCapabilities.Unlimited)))
{
yield return new object[] { TarEntryFormat.Pax, entryType, unseekableStream, name };
yield return new object[] { TarEntryFormat.Gnu, entryType, unseekableStream, name };
}
}
}
}

[Theory]
[MemberData(nameof(NameRoundtripsTheoryData))]
public void NameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, string name)
public void NameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, bool unseekableStream, string name)
{
TarEntry entry = InvokeTarEntryCreationConstructor(entryFormat, entryType, name);
entry.Name = name;

MemoryStream ms = new();
using (TarWriter writer = new(ms, leaveOpen: true))
Stream s = unseekableStream ? new WrappedStream(ms, ms.CanRead, ms.CanWrite, canSeek: false) : ms;

using (TarWriter writer = new(s, leaveOpen: true))
{
writer.WriteEntry(entry);
}

ms.Position = 0;
using TarReader reader = new(ms);
using TarReader reader = new(s);

entry = reader.GetNextEntry();
Assert.Null(reader.GetNextEntry());
Expand All @@ -56,38 +61,43 @@ public void NameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, s

public static IEnumerable<object[]> LinkNameRoundtripsTheoryData()
{
foreach (TarEntryType entryType in new[] { TarEntryType.SymbolicLink, TarEntryType.HardLink })
foreach (bool unseekableStream in new[] { false, true })
{
foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Name).Concat(GetNamesPrefixedTestData(NameCapabilities.Name)))
foreach (TarEntryType entryType in new[] { TarEntryType.SymbolicLink, TarEntryType.HardLink })
{
yield return new object[] { TarEntryFormat.V7, entryType, name };
yield return new object[] { TarEntryFormat.Ustar, entryType, name };
}

foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Unlimited).Concat(GetNamesPrefixedTestData(NameCapabilities.Unlimited)))
{
yield return new object[] { TarEntryFormat.Pax, entryType, name };
yield return new object[] { TarEntryFormat.Gnu, entryType, name };
foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Name).Concat(GetNamesPrefixedTestData(NameCapabilities.Name)))
{
yield return new object[] { TarEntryFormat.V7, entryType, unseekableStream, name };
yield return new object[] { TarEntryFormat.Ustar, entryType, unseekableStream, name };
}

foreach (string name in GetNamesNonAsciiTestData(NameCapabilities.Unlimited).Concat(GetNamesPrefixedTestData(NameCapabilities.Unlimited)))
{
yield return new object[] { TarEntryFormat.Pax, entryType, unseekableStream, name };
yield return new object[] { TarEntryFormat.Gnu, entryType, unseekableStream, name };
}
}
}
}

[Theory]
[MemberData(nameof(LinkNameRoundtripsTheoryData))]
public void LinkNameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, string linkName)
public void LinkNameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, bool unseekableStream, string linkName)
{
string name = "foo";
TarEntry entry = InvokeTarEntryCreationConstructor(entryFormat, entryType, name);
entry.LinkName = linkName;

MemoryStream ms = new();
using (TarWriter writer = new(ms, leaveOpen: true))
Stream s = unseekableStream ? new WrappedStream(ms, ms.CanRead, ms.CanWrite, canSeek: false) : ms;

using (TarWriter writer = new(s, leaveOpen: true))
{
writer.WriteEntry(entry);
}

ms.Position = 0;
using TarReader reader = new(ms);
using TarReader reader = new(s);

entry = reader.GetNextEntry();
Assert.Null(reader.GetNextEntry());
Expand All @@ -97,17 +107,20 @@ public void LinkNameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryTyp

public static IEnumerable<object[]> UserNameGroupNameRoundtripsTheoryData()
{
foreach (TarEntryFormat entryFormat in new[] { TarEntryFormat.Ustar, TarEntryFormat.Pax, TarEntryFormat.Gnu })
foreach (bool unseekableStream in new[] { false, true })
{
yield return new object[] { entryFormat, Repeat(OneByteCharacter, 32) };
yield return new object[] { entryFormat, Repeat(TwoBytesCharacter, 32 / 2) };
yield return new object[] { entryFormat, Repeat(FourBytesCharacter, 32 / 4) };
foreach (TarEntryFormat entryFormat in new[] { TarEntryFormat.Ustar, TarEntryFormat.Pax, TarEntryFormat.Gnu })
{
yield return new object[] { entryFormat, unseekableStream, Repeat(OneByteCharacter, 32) };
yield return new object[] { entryFormat, unseekableStream, Repeat(TwoBytesCharacter, 32 / 2) };
yield return new object[] { entryFormat, unseekableStream, Repeat(FourBytesCharacter, 32 / 4) };
}
}
}

[Theory]
[MemberData(nameof(UserNameGroupNameRoundtripsTheoryData))]
public void UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, string userGroupName)
public void UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, bool unseekableStream, string userGroupName)
{
string name = "foo";
TarEntry entry = InvokeTarEntryCreationConstructor(entryFormat, TarEntryType.RegularFile, name);
Expand All @@ -116,13 +129,15 @@ public void UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, string userG
posixEntry.GroupName = userGroupName;

MemoryStream ms = new();
using (TarWriter writer = new(ms, leaveOpen: true))
Stream s = unseekableStream ? new WrappedStream(ms, ms.CanRead, ms.CanWrite, canSeek: false) : ms;

using (TarWriter writer = new(s, leaveOpen: true))
{
writer.WriteEntry(posixEntry);
}

ms.Position = 0;
using TarReader reader = new(ms);
using TarReader reader = new(s);

entry = reader.GetNextEntry();
posixEntry = Assert.IsAssignableFrom<PosixTarEntry>(entry);
Expand Down
24 changes: 15 additions & 9 deletions ...ies/System.Formats.Tar/tests/TarWriter/TarWriter.WriteEntryAsync.Entry.Roundtrip.Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,21 @@ public static IEnumerable<object[]> NameRoundtripsAsyncTheoryData()

[Theory]
[MemberData(nameof(NameRoundtripsAsyncTheoryData))]
public async Task NameRoundtripsAsync(TarEntryFormat entryFormat, TarEntryType entryType, string name)
public async Task NameRoundtripsAsync(TarEntryFormat entryFormat, TarEntryType entryType, bool unseekableStream, string name)
{
TarEntry entry = InvokeTarEntryCreationConstructor(entryFormat, entryType, name);
entry.Name = name;

MemoryStream ms = new();
using (TarWriter writer = new(ms, leaveOpen: true))
Stream s = unseekableStream ? new WrappedStream(ms, ms.CanRead, ms.CanWrite, canSeek: false) : ms;

using (TarWriter writer = new(s, leaveOpen: true))
{
await writer.WriteEntryAsync(entry);
}

ms.Position = 0;
using TarReader reader = new(ms);
using TarReader reader = new(s);

entry = await reader.GetNextEntryAsync();
Assert.Null(await reader.GetNextEntryAsync());
Expand All @@ -39,20 +41,22 @@ public static IEnumerable<object[]> LinkNameRoundtripsAsyncTheoryData()

[Theory]
[MemberData(nameof(LinkNameRoundtripsAsyncTheoryData))]
public async Task LinkNameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, string linkName)
public async Task LinkNameRoundtrips(TarEntryFormat entryFormat, TarEntryType entryType, bool unseekableStream, string linkName)
{
string name = "foo";
TarEntry entry = InvokeTarEntryCreationConstructor(entryFormat, entryType, name);
entry.LinkName = linkName;

MemoryStream ms = new();
using (TarWriter writer = new(ms, leaveOpen: true))
Stream s = unseekableStream ? new WrappedStream(ms, ms.CanRead, ms.CanWrite, canSeek: false) : ms;

using (TarWriter writer = new(s, leaveOpen: true))
{
await writer.WriteEntryAsync(entry);
}

ms.Position = 0;
using TarReader reader = new(ms);
using TarReader reader = new(s);

entry = await reader.GetNextEntryAsync();
Assert.Null(await reader.GetNextEntryAsync());
Expand All @@ -65,7 +69,7 @@ public static IEnumerable<object[]> UserNameGroupNameRoundtripsAsyncTheoryData()

[Theory]
[MemberData(nameof(UserNameGroupNameRoundtripsAsyncTheoryData))]
public async Task UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, string userGroupName)
public async Task UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, bool unseekableStream, string userGroupName)
{
string name = "foo";
TarEntry entry = InvokeTarEntryCreationConstructor(entryFormat, TarEntryType.RegularFile, name);
Expand All @@ -74,13 +78,15 @@ public async Task UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, string
posixEntry.GroupName = userGroupName;

MemoryStream ms = new();
using (TarWriter writer = new(ms, leaveOpen: true))
Stream s = unseekableStream ? new WrappedStream(ms, ms.CanRead, ms.CanWrite, canSeek: false) : ms;

using (TarWriter writer = new(s, leaveOpen: true))
{
await writer.WriteEntryAsync(posixEntry);
}

ms.Position = 0;
using TarReader reader = new(ms);
using TarReader reader = new(s);

entry = await reader.GetNextEntryAsync();
posixEntry = Assert.IsAssignableFrom<PosixTarEntry>(entry);
Expand Down