Skip to content

Tar: Use indexer setter instead of Add on ExtendedAttributes dictionary #76404

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
jozkee merged 3 commits into from
Oct 3, 2022
Merged

Tar: Use indexer setter instead of Add on ExtendedAttributes dictionary #76404

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
335ace1
Use indexer setter instead of Add on ExtendedAttributes dictionary
jozkee Sep 29, 2022
d472c64
Add roundtrip tests
jozkee Sep 30, 2022
9d4d7f3
Fix TryAddStringField and always set mtime
jozkee Sep 30, 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 roundtrip tests
  • Loading branch information
@jozkee
jozkee committed Sep 30, 2022
commit d472c64de56e649d92c14cf085d92f9790096522
98 changes: 98 additions & 0 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 @@ -147,5 +147,103 @@ public void UserNameGroupNameRoundtrips(TarEntryFormat entryFormat, bool unseeka
Assert.Equal(userGroupName, posixEntry.UserName);
Assert.Equal(userGroupName, posixEntry.GroupName);
}

[Theory]
[InlineData(TarEntryType.RegularFile)]
[InlineData(TarEntryType.Directory)]
[InlineData(TarEntryType.HardLink)]
[InlineData(TarEntryType.SymbolicLink)]
public void PaxExtendedAttributes_DoNotOverwritePublicProperties_WhenTheyFitOnLegacyFields(TarEntryType entryType)
{
Dictionary<string, string> extendedAttributes = new();
extendedAttributes[PaxEaName] = "ea_name";
extendedAttributes[PaxEaGName] = "ea_gname";
extendedAttributes[PaxEaUName] = "ea_uname";
extendedAttributes[PaxEaMTime] = GetTimestampStringFromDateTimeOffset(TestModificationTime);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
extendedAttributes[PaxEaLinkName] = "ea_linkname";
}

PaxTarEntry writeEntry = new PaxTarEntry(entryType, "name", extendedAttributes);
writeEntry.Name = new string('a', 100);
// GName and UName must be longer than 32 to be written as extended attribute.
writeEntry.GroupName = new string('b', 32);
writeEntry.UserName = new string('c', 32);
// There's no limit on MTime, we just ensure it roundtrips.
writeEntry.ModificationTime = TestModificationTime.AddDays(1);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
writeEntry.LinkName = new string('d', 100);
}

MemoryStream ms = new();
using (TarWriter w = new(ms, leaveOpen: true))
{
w.WriteEntry(writeEntry);
}
ms.Position = 0;

using TarReader r = new(ms);
PaxTarEntry readEntry = Assert.IsType<PaxTarEntry>(r.GetNextEntry());
Assert.Null(r.GetNextEntry());

Assert.Equal(writeEntry.Name, readEntry.Name);
Assert.Equal(writeEntry.GroupName, readEntry.GroupName);
Assert.Equal(writeEntry.UserName, readEntry.UserName);
Assert.Equal(writeEntry.ModificationTime, readEntry.ModificationTime);
Assert.Equal(writeEntry.LinkName, readEntry.LinkName);
}

[Theory]
[InlineData(TarEntryType.RegularFile)]
[InlineData(TarEntryType.Directory)]
[InlineData(TarEntryType.HardLink)]
[InlineData(TarEntryType.SymbolicLink)]
public void PaxExtendedAttributes_DoNotOverwritePublicProperties_WhenLargerThanLegacyFields(TarEntryType entryType)
{
Dictionary<string, string> extendedAttributes = new();
extendedAttributes[PaxEaName] = "ea_name";
extendedAttributes[PaxEaGName] = "ea_gname";
extendedAttributes[PaxEaUName] = "ea_uname";
extendedAttributes[PaxEaMTime] = GetTimestampStringFromDateTimeOffset(TestModificationTime);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
extendedAttributes[PaxEaLinkName] = "ea_linkname";
}

PaxTarEntry writeEntry = new PaxTarEntry(entryType, "name", extendedAttributes);
writeEntry.Name = new string('a', MaxPathComponent);
// GName and UName must be longer than 32 to be written as extended attribute.
writeEntry.GroupName = new string('b', 32 + 1);
writeEntry.UserName = new string('c', 32 + 1);
// There's no limit on MTime, we just ensure it roundtrips.
writeEntry.ModificationTime = TestModificationTime.AddDays(1);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
writeEntry.LinkName = new string('d', 100 + 1);
}

MemoryStream ms = new();
using (TarWriter w = new(ms, leaveOpen: true))
{
w.WriteEntry(writeEntry);
}
ms.Position = 0;

using TarReader r = new(ms);
PaxTarEntry readEntry = Assert.IsType<PaxTarEntry>(r.GetNextEntry());
Assert.Null(r.GetNextEntry());

Assert.Equal(writeEntry.Name, readEntry.Name);
Assert.Equal(writeEntry.GroupName, readEntry.GroupName);
Assert.Equal(writeEntry.UserName, readEntry.UserName);
Assert.Equal(writeEntry.ModificationTime, readEntry.ModificationTime);
Assert.Equal(writeEntry.LinkName, readEntry.LinkName);
}
}
}
98 changes: 98 additions & 0 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 @@ -96,5 +96,103 @@ public async Task UserNameGroupNameRoundtripsAsync(TarEntryFormat entryFormat, b
Assert.Equal(userGroupName, posixEntry.UserName);
Assert.Equal(userGroupName, posixEntry.GroupName);
}

[Theory]
[InlineData(TarEntryType.RegularFile)]
[InlineData(TarEntryType.Directory)]
[InlineData(TarEntryType.HardLink)]
[InlineData(TarEntryType.SymbolicLink)]
public async Task PaxExtendedAttributes_DoNotOverwritePublicProperties_WhenTheyFitOnLegacyFieldsAsync(TarEntryType entryType)
{
Dictionary<string, string> extendedAttributes = new();
extendedAttributes[PaxEaName] = "ea_name";
extendedAttributes[PaxEaGName] = "ea_gname";
extendedAttributes[PaxEaUName] = "ea_uname";
extendedAttributes[PaxEaMTime] = GetTimestampStringFromDateTimeOffset(TestModificationTime);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
extendedAttributes[PaxEaLinkName] = "ea_linkname";
}

PaxTarEntry writeEntry = new PaxTarEntry(entryType, "name", extendedAttributes);
writeEntry.Name = new string('a', 100);
// GName and UName must be longer than 32 to be written as extended attribute.
writeEntry.GroupName = new string('b', 32);
writeEntry.UserName = new string('c', 32);
// There's no limit on MTime, we just ensure it roundtrips.
writeEntry.ModificationTime = TestModificationTime.AddDays(1);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
writeEntry.LinkName = new string('d', 100);
}

MemoryStream ms = new();
await using (TarWriter w = new(ms, leaveOpen: true))
{
await w.WriteEntryAsync(writeEntry);
}
ms.Position = 0;

await using TarReader r = new(ms);
PaxTarEntry readEntry = Assert.IsType<PaxTarEntry>(await r.GetNextEntryAsync());
Assert.Null(await r.GetNextEntryAsync());

Assert.Equal(writeEntry.Name, readEntry.Name);
Assert.Equal(writeEntry.GroupName, readEntry.GroupName);
Assert.Equal(writeEntry.UserName, readEntry.UserName);
Assert.Equal(writeEntry.ModificationTime, readEntry.ModificationTime);
Assert.Equal(writeEntry.LinkName, readEntry.LinkName);
}

[Theory]
[InlineData(TarEntryType.RegularFile)]
[InlineData(TarEntryType.Directory)]
[InlineData(TarEntryType.HardLink)]
[InlineData(TarEntryType.SymbolicLink)]
public async Task PaxExtendedAttributes_DoNotOverwritePublicProperties_WhenLargerThanLegacyFieldsAsync(TarEntryType entryType)
{
Dictionary<string, string> extendedAttributes = new();
extendedAttributes[PaxEaName] = "ea_name";
extendedAttributes[PaxEaGName] = "ea_gname";
extendedAttributes[PaxEaUName] = "ea_uname";
extendedAttributes[PaxEaMTime] = GetTimestampStringFromDateTimeOffset(TestModificationTime);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
extendedAttributes[PaxEaLinkName] = "ea_linkname";
}

PaxTarEntry writeEntry = new PaxTarEntry(entryType, "name", extendedAttributes);
writeEntry.Name = new string('a', MaxPathComponent);
// GName and UName must be longer than 32 to be written as extended attribute.
writeEntry.GroupName = new string('b', 32 + 1);
writeEntry.UserName = new string('c', 32 + 1);
// There's no limit on MTime, we just ensure it roundtrips.
writeEntry.ModificationTime = TestModificationTime.AddDays(1);

if (entryType is TarEntryType.HardLink or TarEntryType.SymbolicLink)
{
writeEntry.LinkName = new string('d', 100 + 1);
}

MemoryStream ms = new();
await using (TarWriter w = new(ms, leaveOpen: true))
{
await w.WriteEntryAsync(writeEntry);
}
ms.Position = 0;

await using TarReader r = new(ms);
PaxTarEntry readEntry = Assert.IsType<PaxTarEntry>(await r.GetNextEntryAsync());
Assert.Null(await r.GetNextEntryAsync());

Assert.Equal(writeEntry.Name, readEntry.Name);
Assert.Equal(writeEntry.GroupName, readEntry.GroupName);
Assert.Equal(writeEntry.UserName, readEntry.UserName);
Assert.Equal(writeEntry.ModificationTime, readEntry.ModificationTime);
Assert.Equal(writeEntry.LinkName, readEntry.LinkName);
}
}
}