Skip to content

Commit

Permalink
Cleanup code in System.Runtime.Serialization.Formatters.Tests (dotnet…
Browse files Browse the repository at this point in the history 
…#23940)

* Cleanup code in System.Runtime.Serialization.Formatters.Tests

* Moved UnitySerializationHolder serialization test to System.Runtime.Tests
  • Loading branch information
@ViktorHofer
ViktorHofer committed Nov 3, 2017
1 parent 48c54b9 commit 8804784
Show file tree
Hide file tree
Showing 6 changed files with 158 additions and 114 deletions.
37 changes: 37 additions & 0 deletions src/Common/tests/System/Runtime/Serialization/Formatters/BinaryFormatterHelpers.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,42 @@ public static void AssertRoundtrips<T>(T expected, params Func<T, object>[] addi
}
}
}

public static byte[] ToByteArray(object obj,
FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Full)
{
BinaryFormatter bf = new BinaryFormatter();
bf.AssemblyFormat = assemblyStyle;
using (MemoryStream ms = new MemoryStream())
{
bf.Serialize(ms, obj);
return ms.ToArray();
}
}

public static string ToBase64String(object obj,
FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Full)
{
byte[] raw = ToByteArray(obj, assemblyStyle);
return Convert.ToBase64String(raw);
}

public static object FromByteArray(byte[] raw,
FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Full)
{
var binaryFormatter = new BinaryFormatter();
binaryFormatter.AssemblyFormat = assemblyStyle;
using (var serializedStream = new MemoryStream(raw))
{
return binaryFormatter.Deserialize(serializedStream);
}
}

public static object FromBase64String(string base64Str,
FormatterAssemblyStyle assemblyStyle = FormatterAssemblyStyle.Full)
{
byte[] raw = Convert.FromBase64String(base64Str);
return FromByteArray(raw, assemblyStyle);
}
}
}
81 changes: 34 additions & 47 deletions src/System.Runtime.Serialization.Formatters/tests/BinaryFormatterTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
using System.Reflection;
using System.Runtime.Serialization.Formatters.Binary;
using System.Text;
using System.Text.RegularExpressions;
using Xunit;

namespace System.Runtime.Serialization.Formatters.Tests
Expand All @@ -21,8 +22,9 @@ public partial class BinaryFormatterTests : RemoteExecutorTestBase
[MemberData(nameof(BasicObjectsRoundtrip_MemberData))]
public void ValidateBasicObjectsRoundtrip(object obj, FormatterAssemblyStyle assemblyFormat, TypeFilterLevel filterLevel, FormatterTypeStyle typeFormat)
{
object clone = FormatterClone(obj, null, assemblyFormat, filterLevel, typeFormat);
if (!ReferenceEquals(obj, string.Empty) && !(obj is DBNull)) // "" is interned and will roundtrip as the same object
object clone = BinaryFormatterHelpers.Clone(obj, null, assemblyFormat, filterLevel, typeFormat);
// string.Empty and DBNull are both singletons
if (!ReferenceEquals(obj, string.Empty) && !(obj is DBNull))
{
Assert.NotSame(obj, clone);
}
Expand All @@ -35,8 +37,10 @@ public void ValidateBasicObjectsRoundtrip(object obj, FormatterAssemblyStyle ass
public void UpdateBlobs()
{
string testDataFilePath = GetTestDataFilePath();
IEnumerable<object[]> coreTypeRecords = GetCoreTypeRecords();
string[] coreTypeBlobs = GetCoreTypeBlobs(coreTypeRecords, FormatterAssemblyStyle.Full).ToArray();
string[] coreTypeBlobs = SerializableEqualityComparers_MemberData()
.Concat(SerializableObjects_MemberData())
.Select(record => BinaryFormatterHelpers.ToBase64String(record[0]))
.ToArray();

var (numberOfBlobs, numberOfFoundBlobs, numberOfUpdatedBlobs) = UpdateCoreTypeBlobs(testDataFilePath, coreTypeBlobs);
Console.WriteLine($"{numberOfBlobs} existing blobs" +
Expand All @@ -46,7 +50,15 @@ public void UpdateBlobs()

[Theory]
[MemberData(nameof(SerializableObjects_MemberData))]
public void ValidateAgainstBlobs(object obj, string[] blobs)
public void ValidateAgainstBlobs(object obj, string[] blobs)
=> ValidateAndRoundtrip(obj, blobs, false);

[Theory]
[MemberData(nameof(SerializableEqualityComparers_MemberData))]
public void ValidateEqualityComparersAgainstBlobs(object obj, string[] blobs)
=> ValidateAndRoundtrip(obj, blobs, true);

private static void ValidateAndRoundtrip(object obj, string[] blobs, bool isEqualityComparer)
{
if (obj == null)
{
Expand All @@ -56,7 +68,7 @@ public void ValidateAgainstBlobs(object obj, string[] blobs)
if (blobs == null || blobs.Length == 0)
{
throw new ArgumentOutOfRangeException($"Type {obj} has no blobs to deserialize and test equality against. Blob: " +
SerializeObjectToBlob(obj, FormatterAssemblyStyle.Full));
BinaryFormatterHelpers.ToBase64String(obj, FormatterAssemblyStyle.Full));
}

SanityCheckBlob(obj, blobs);
Expand All @@ -72,20 +84,19 @@ public void ValidateAgainstBlobs(object obj, string[] blobs)

foreach (string blob in blobs)
{
CheckForAnyEquals(obj, DeserializeBlobToObject(blob, FormatterAssemblyStyle.Simple));
CheckForAnyEquals(obj, DeserializeBlobToObject(blob, FormatterAssemblyStyle.Full));
if (isEqualityComparer)
{
ValidateEqualityComparer(BinaryFormatterHelpers.FromBase64String(blob, FormatterAssemblyStyle.Simple));
ValidateEqualityComparer(BinaryFormatterHelpers.FromBase64String(blob, FormatterAssemblyStyle.Full));
}
else
{
CheckForAnyEquals(obj, BinaryFormatterHelpers.FromBase64String(blob, FormatterAssemblyStyle.Simple));
CheckForAnyEquals(obj, BinaryFormatterHelpers.FromBase64String(blob, FormatterAssemblyStyle.Full));
}
}
}

[Fact]
[SkipOnTargetFramework(TargetFrameworkMonikers.Uap | TargetFrameworkMonikers.UapAot)]
public void UnitySerializationHolderWithAssemblySingleton()
{
const string UnitySerializationHolderAssemblyBase64String = "AAEAAAD/////AQAAAAAAAAAEAQAAAB9TeXN0ZW0uVW5pdHlTZXJpYWxpemF0aW9uSG9sZGVyAwAAAAREYXRhCVVuaXR5VHlwZQxBc3NlbWJseU5hbWUBAAEIBgIAAABLbXNjb3JsaWIsIFZlcnNpb249NC4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1iNzdhNWM1NjE5MzRlMDg5BgAAAAkCAAAACw==";
AssertExtensions.ThrowsIf<ArgumentException>(!PlatformDetection.IsFullFramework,
() => DeserializeBlobToObject(UnitySerializationHolderAssemblyBase64String, FormatterAssemblyStyle.Full));
}

[Fact]
public void ArraySegmentDefaultCtor()
{
Expand All @@ -94,8 +105,8 @@ public void ArraySegmentDefaultCtor()
object obj = new ArraySegment<int>();
string corefxBlob = "AAEAAAD/////AQAAAAAAAAAEAQAAAHJTeXN0ZW0uQXJyYXlTZWdtZW50YDFbW1N5c3RlbS5JbnQzMiwgbXNjb3JsaWIsIFZlcnNpb249NC4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1iNzdhNWM1NjE5MzRlMDg5XV0DAAAABl9hcnJheQdfb2Zmc2V0Bl9jb3VudAcAAAgICAoAAAAAAAAAAAs=";
string netfxBlob = "AAEAAAD/////AQAAAAAAAAAEAQAAAHJTeXN0ZW0uQXJyYXlTZWdtZW50YDFbW1N5c3RlbS5JbnQzMiwgbXNjb3JsaWIsIFZlcnNpb249NC4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1iNzdhNWM1NjE5MzRlMDg5XV0DAAAABl9hcnJheQdfb2Zmc2V0Bl9jb3VudAcAAAgICAoAAAAAAAAAAAs=";
CheckForAnyEquals(obj, DeserializeBlobToObject(corefxBlob, FormatterAssemblyStyle.Full));
CheckForAnyEquals(obj, DeserializeBlobToObject(netfxBlob, FormatterAssemblyStyle.Full));
CheckForAnyEquals(obj, BinaryFormatterHelpers.FromBase64String(corefxBlob, FormatterAssemblyStyle.Full));
CheckForAnyEquals(obj, BinaryFormatterHelpers.FromBase64String(netfxBlob, FormatterAssemblyStyle.Full));
}

[Fact]
Expand All @@ -106,7 +117,7 @@ public void ValidateDeserializationOfObjectWithDifferentAssemblyVersion()
var obj = new SomeType() { SomeField = 7 };
string serializedObj = @"AAEAAAD/////AQAAAAAAAAAMAgAAAHNTeXN0ZW0uUnVudGltZS5TZXJpYWxpemF0aW9uLkZvcm1hdHRlcnMuVGVzdHMsIFZlcnNpb249OS45OC43Ljk4NywgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj05ZDc3Y2M3YWQzOWI2OGViBQEAAAA2U3lzdGVtLlJ1bnRpbWUuU2VyaWFsaXphdGlvbi5Gb3JtYXR0ZXJzLlRlc3RzLlNvbWVUeXBlAQAAAAlTb21lRmllbGQACAIAAAAHAAAACw==";

var deserialized = (SomeType)DeserializeBlobToObject(serializedObj, FormatterAssemblyStyle.Simple);
var deserialized = (SomeType)BinaryFormatterHelpers.FromBase64String(serializedObj, FormatterAssemblyStyle.Simple);
Assert.Equal(obj, deserialized);
}

Expand All @@ -118,34 +129,10 @@ public void ValidateDeserializationOfObjectWithGenericTypeWhichGenericArgumentHa
var obj = new GenericTypeWithArg<SomeType>() { Test = new SomeType() { SomeField = 9 } };
string serializedObj = @"AAEAAAD/////AQAAAAAAAAAMAgAAAHNTeXN0ZW0uUnVudGltZS5TZXJpYWxpemF0aW9uLkZvcm1hdHRlcnMuVGVzdHMsIFZlcnNpb249OS45OC43Ljk4NywgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj05ZDc3Y2M3YWQzOWI2OGViBQEAAADxAVN5c3RlbS5SdW50aW1lLlNlcmlhbGl6YXRpb24uRm9ybWF0dGVycy5UZXN0cy5HZW5lcmljVHlwZVdpdGhBcmdgMVtbU3lzdGVtLlJ1bnRpbWUuU2VyaWFsaXphdGlvbi5Gb3JtYXR0ZXJzLlRlc3RzLlNvbWVUeXBlLCBTeXN0ZW0uUnVudGltZS5TZXJpYWxpemF0aW9uLkZvcm1hdHRlcnMuVGVzdHMsIFZlcnNpb249OS45OC43Ljk4NywgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj05ZDc3Y2M3YWQzOWI2OGViXV0BAAAABFRlc3QENlN5c3RlbS5SdW50aW1lLlNlcmlhbGl6YXRpb24uRm9ybWF0dGVycy5UZXN0cy5Tb21lVHlwZQIAAAACAAAACQMAAAAFAwAAADZTeXN0ZW0uUnVudGltZS5TZXJpYWxpemF0aW9uLkZvcm1hdHRlcnMuVGVzdHMuU29tZVR5cGUBAAAACVNvbWVGaWVsZAAIAgAAAAkAAAAL";

var deserialized = (GenericTypeWithArg<SomeType>)DeserializeBlobToObject(serializedObj, FormatterAssemblyStyle.Simple);
var deserialized = (GenericTypeWithArg<SomeType>)BinaryFormatterHelpers.FromBase64String(serializedObj, FormatterAssemblyStyle.Simple);
Assert.Equal(obj, deserialized);
}

[Theory]
[MemberData(nameof(SerializableEqualityComparers_MemberData))]
public void ValidateEqualityComparersAgainstBlobs(object obj, string[] blobs)
{
if (obj == null)
{
throw new ArgumentNullException("The serializable object must not be null", nameof(obj));
}

if (blobs == null || blobs.Length == 0)
{
throw new ArgumentOutOfRangeException($"Type {obj} has no blobs to deserialize and test equality against. Blob: " +
SerializeObjectToBlob(obj, FormatterAssemblyStyle.Full));
}

SanityCheckBlob(obj, blobs);

foreach (string blob in blobs)
{
ValidateEqualityComparer(DeserializeBlobToObject(blob, FormatterAssemblyStyle.Simple));
ValidateEqualityComparer(DeserializeBlobToObject(blob, FormatterAssemblyStyle.Full));
}
}

[Fact]
public void RoundtripManyObjectsInOneStream()
{
Expand Down Expand Up @@ -406,7 +393,7 @@ public void ObjectReference_RealObjectSerialized()
public void Deserialize_FuzzInput(object obj, Random rand)
{
// Get the serialized data for the object
byte[] data = SerializeObjectToRaw(obj, FormatterAssemblyStyle.Simple);
byte[] data = BinaryFormatterHelpers.ToByteArray(obj, FormatterAssemblyStyle.Simple);

// Make some "random" changes to it
for (int i = 1; i < rand.Next(1, 100); i++)
Expand All @@ -417,7 +404,7 @@ public void Deserialize_FuzzInput(object obj, Random rand)
// Try to deserialize that.
try
{
DeserializeRawToObject(data, FormatterAssemblyStyle.Simple);
BinaryFormatterHelpers.FromByteArray(data, FormatterAssemblyStyle.Simple);
// Since there's no checksum, it's possible we changed data that didn't corrupt the instance
}
catch (ArgumentOutOfRangeException) { }
Expand Down
Loading

0 comments on commit 8804784

Please sign in to comment.