Skip to content

Commit 86b0eef

Browse files
bradwilsonbradwilson
committed
#2770: Make SerializationHelper public
1 parent f49dafc commit 86b0eef

9 files changed

+121
-46
lines changed

‎src/common/SerializationHelper.cs

+19-35
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@
33
using System.Collections.Generic;
44
using System.Linq;
55
using System.Reflection;
6-
using Xunit.Abstractions;
76
using Xunit.Serialization;
87

8+
#if XUNIT_FRAMEWORK
99
namespace Xunit.Sdk
10+
#else
11+
namespace Xunit
12+
#endif
1013
{
1114
/// <summary>
1215
/// Serializes and de-serializes objects. Serialization of objects is typically limited to supporting
1316
/// the VSTest-based test runners (Visual Studio Test Explorer, Visual Studio Code, dotnet test, etc.).
1417
/// Serializing values with this is not guaranteed to be cross-compatible and should not be used for
1518
/// anything durable.
1619
/// </summary>
17-
static class SerializationHelper
20+
public static class SerializationHelper
1821
{
1922
static readonly ConcurrentDictionary<Type, string> typeToTypeNameMap = new ConcurrentDictionary<Type, string>();
2023

@@ -37,15 +40,7 @@ public static T Deserialize<T>(string serializedValue)
3740
if (deserializedType == null)
3841
throw new ArgumentException($"Could not load type '{pieces[0]}' from serialization value '{serializedValue}'", nameof(serializedValue));
3942

40-
if (!typeof(IXunitSerializable).IsAssignableFrom(deserializedType))
41-
throw new ArgumentException("Cannot de-serialize an object that does not implement " + typeof(IXunitSerializable).FullName, nameof(serializedValue));
42-
43-
var obj = XunitSerializationInfo.Deserialize(deserializedType, pieces[1]);
44-
var arraySerializer = obj as XunitSerializationInfo.ArraySerializer;
45-
if (arraySerializer != null)
46-
obj = arraySerializer.ArrayData;
47-
48-
return (T)obj;
43+
return (T)XunitSerializationInfo.Deserialize(deserializedType, pieces[1]);
4944
}
5045

5146
/// <summary>
@@ -162,10 +157,16 @@ public static Type GetType(string assemblyName, string typeName)
162157
return assembly.GetType(typeName);
163158
}
164159

160+
#if XUNIT_FRAMEWORK
161+
/// <summary>
162+
/// Gets an assembly qualified type name for serialization, with special handling for types which
163+
/// live in assembly decorated by <see cref="PlatformSpecificAssemblyAttribute"/>.
164+
/// </summary>
165+
#else
165166
/// <summary>
166-
/// Gets an assembly qualified type name for serialization, with special dispensation for types which
167-
/// originate in the execution assembly.
167+
/// Gets an assembly qualified type name for serialization.
168168
/// </summary>
169+
#endif
169170
public static string GetTypeNameForSerialization(Type type)
170171
{
171172
// Use the abstract Type instead of concretes like RuntimeType
@@ -220,9 +221,11 @@ string GetTypeNameAsString(Type typeToMap)
220221
}
221222
}
222223

223-
/// <summary>Gets whether the specified <paramref name="value"/> is serializable with <see cref="Serialize"/>.</summary>
224+
/// <summary>
225+
/// Determines whether the given <paramref name="value"/> is serializable with <see cref="Serialize"/>.
226+
/// </summary>
224227
/// <param name="value">The object to test for serializability.</param>
225-
/// <returns>true if the object can be serialized; otherwise, false.</returns>
228+
/// <returns>Returns <c>true</c> if the object can be serialized; <c>false</c>, otherwise.</returns>
226229
public static bool IsSerializable(object value)
227230
{
228231
return XunitSerializationInfo.CanSerializeObject(value);
@@ -238,16 +241,7 @@ public static string Serialize(object value)
238241
if (value == null)
239242
throw new ArgumentNullException(nameof(value));
240243

241-
var array = value as object[];
242-
if (array != null)
243-
value = new XunitSerializationInfo.ArraySerializer(array);
244-
245-
var serializable = value as IXunitSerializable;
246-
if (serializable == null)
247-
throw new ArgumentException("Cannot serialize an object that does not implement " + typeof(IXunitSerializable).FullName, nameof(value));
248-
249-
var serializationInfo = new XunitSerializationInfo(serializable);
250-
return $"{GetTypeNameForSerialization(value.GetType())}:{serializationInfo.ToSerializedString()}";
244+
return $"{GetTypeNameForSerialization(value.GetType())}:{XunitSerializationInfo.Serialize(value)}";
251245
}
252246

253247
static IList<string> SplitAtOuterCommas(string value, bool trimWhitespace = false)
@@ -290,16 +284,6 @@ static IList<string> SplitAtOuterCommas(string value, bool trimWhitespace = fals
290284
return results;
291285
}
292286

293-
/// <summary>
294-
/// Retrieves a substring from the string, with whitespace trimmed on both ends.
295-
/// </summary>
296-
/// <param name="str">The string.</param>
297-
/// <param name="startIndex">The starting index.</param>
298-
/// <param name="length">The length.</param>
299-
/// <returns>
300-
/// A substring starting no earlier than startIndex and ending no later
301-
/// than startIndex + length.
302-
/// </returns>
303287
static string SubstringTrim(string str, int startIndex, int length)
304288
{
305289
int endIndex = startIndex + length;

‎src/common/XunitSerializationInfo.cs

+7-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@
44
using System.Linq;
55
using System.Text;
66
using Xunit.Abstractions;
7+
8+
#if XUNIT_FRAMEWORK
79
using Xunit.Sdk;
10+
#endif
811

9-
#if !NET35
12+
#if !NETFRAMEWORK
1013
using System.Numerics;
14+
#endif
15+
16+
#if !NET35
1117
using System.Reflection;
1218
#endif
1319

‎test/test.xunit.execution/Common/SerializationHelperTests.cs

+91-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
using System;
22
using Xunit;
3+
using Xunit.Abstractions;
34
using Xunit.Sdk;
5+
using SerializationHelper = Xunit.Sdk.SerializationHelper;
6+
using TestMethodDisplay = Xunit.Sdk.TestMethodDisplay;
7+
8+
#if NET6_0
9+
using System.Numerics;
10+
#endif
411

512
public class SerializationHelperTests
613
{
@@ -49,16 +56,93 @@ public static void CannotRoundTripTypesFromTheGAC()
4956
#endif
5057
}
5158

52-
public class IsSerializable
59+
public class Serialization
5360
{
54-
[Fact]
55-
public void TypeSerialization()
61+
public static TheoryData<object, string> ValidValueData = new TheoryData<object, string>
5662
{
57-
Assert.True(SerializationHelper.IsSerializable(typeof(string))); // Can serialization types from mscorlib
58-
Assert.True(SerializationHelper.IsSerializable(typeof(SerializationHelper))); // Can serialize types from local libraries
59-
#if NETFRAMEWORK
60-
Assert.False(SerializationHelper.IsSerializable(typeof(Uri))); // Can't serialize types from the GAC
63+
{ 'a', "System.Char:97" },
64+
{ "a", "System.String:YQ==" },
65+
{ (byte)42, "System.Byte:42" },
66+
{ (sbyte)-42, "System.SByte:-42" },
67+
{ (ushort)42, "System.UInt16:42" },
68+
{ (short)-42, "System.Int16:-42" },
69+
{ 42U, "System.UInt32:42" },
70+
{ -42, "System.Int32:-42" },
71+
{ 42UL, "System.UInt64:42" },
72+
{ -42L, "System.Int64:-42" },
73+
{ 42.2112F, "System.Single:RWxlbWVudFR5cGU6U3lzdGVtLlN0cmluZzpVM2x6ZEdWdExrSjVkR1U9ClJhbms6U3lzdGVtLkludDMyOjEKVG90YWxMZW5ndGg6U3lzdGVtLkludDMyOjQKTGVuZ3RoMDpTeXN0ZW0uSW50MzI6NApMb3dlckJvdW5kMDpTeXN0ZW0uSW50MzI6MApJdGVtMDpTeXN0ZW0uQnl0ZTo2OQpJdGVtMTpTeXN0ZW0uQnl0ZToyMTYKSXRlbTI6U3lzdGVtLkJ5dGU6NDAKSXRlbTM6U3lzdGVtLkJ5dGU6NjY=" },
74+
{ 42.2112D, "System.Double:RWxlbWVudFR5cGU6U3lzdGVtLlN0cmluZzpVM2x6ZEdWdExrSjVkR1U9ClJhbms6U3lzdGVtLkludDMyOjEKVG90YWxMZW5ndGg6U3lzdGVtLkludDMyOjgKTGVuZ3RoMDpTeXN0ZW0uSW50MzI6OApMb3dlckJvdW5kMDpTeXN0ZW0uSW50MzI6MApJdGVtMDpTeXN0ZW0uQnl0ZTozNwpJdGVtMTpTeXN0ZW0uQnl0ZToxMTcKSXRlbTI6U3lzdGVtLkJ5dGU6MgpJdGVtMzpTeXN0ZW0uQnl0ZToxNTQKSXRlbTQ6U3lzdGVtLkJ5dGU6OApJdGVtNTpTeXN0ZW0uQnl0ZToyNwpJdGVtNjpTeXN0ZW0uQnl0ZTo2OQpJdGVtNzpTeXN0ZW0uQnl0ZTo2NA==" },
75+
{ 42.2112M, "System.Decimal:42.2112" },
76+
{ true, "System.Boolean:True" },
77+
{ new DateTime(2112L), "System.DateTime:0001-01-01T00:00:00.0002112" },
78+
{ new DateTimeOffset(2112L, TimeSpan.Zero), "System.DateTimeOffset:0001-01-01T00:00:00.0002112+00:00" },
79+
{ new TimeSpan(3, 4, 5), "System.TimeSpan:03:04:05" },
80+
#if NET6_0
81+
{ new DateOnly(2023, 8, 9), "System.DateOnly:738740" },
82+
{ new TimeOnly(21, 12, 42, 567), "System.TimeOnly:763625670000" },
83+
{ new BigInteger(42), "System.Numerics.BigInteger, System.Runtime.Numerics:42" },
6184
#endif
85+
{ typeof(string), "System.Type:System.String" },
86+
{ TestMethodDisplay.Method, "Xunit.Sdk.TestMethodDisplay, xunit.core:Method" },
87+
{ new[] { 1, 2, 3 }, "System.Int32[]:RWxlbWVudFR5cGU6U3lzdGVtLlN0cmluZzpVM2x6ZEdWdExrbHVkRE15ClJhbms6U3lzdGVtLkludDMyOjEKVG90YWxMZW5ndGg6U3lzdGVtLkludDMyOjMKTGVuZ3RoMDpTeXN0ZW0uSW50MzI6MwpMb3dlckJvdW5kMDpTeXN0ZW0uSW50MzI6MApJdGVtMDpTeXN0ZW0uSW50MzI6MQpJdGVtMTpTeXN0ZW0uSW50MzI6MgpJdGVtMjpTeXN0ZW0uSW50MzI6Mw==" },
88+
{ 42, "System.Int32:42" },
89+
{ new MySerializable(42), "SerializationHelperTests+Serialization+MySerializable, test.xunit.execution:dmFsdWU6U3lzdGVtLkludDMyOjQy" },
90+
};
91+
92+
[Theory]
93+
[MemberData(nameof(ValidValueData))]
94+
public void ValidValues<T>(T value, string serializedValue)
95+
{
96+
// Serialization
97+
var serialized = SerializationHelper.Serialize(value);
98+
99+
Assert.Equal(serializedValue, serialized);
100+
101+
// Deserialization
102+
var deserialized = SerializationHelper.Deserialize<T>(serializedValue);
103+
104+
Assert.Equal(value, deserialized);
105+
}
106+
107+
[Fact]
108+
public void InvalidValue()
109+
{
110+
var obj = new object();
111+
112+
Assert.False(SerializationHelper.IsSerializable(obj));
113+
var ex = Record.Exception(() => SerializationHelper.Serialize(obj));
114+
var argEx = Assert.IsType<ArgumentException>(ex);
115+
Assert.Equal("value", argEx.ParamName);
116+
Assert.StartsWith("We don't know how to serialize type System.Object", argEx.Message);
117+
}
118+
119+
class MySerializable : IXunitSerializable, IEquatable<MySerializable>
120+
{
121+
int value;
122+
123+
[Obsolete("For deserialization purposes only")]
124+
public MySerializable()
125+
{ }
126+
127+
public MySerializable(int value)
128+
{
129+
this.value = value;
130+
}
131+
132+
public void Deserialize(IXunitSerializationInfo info)
133+
{
134+
value = info.GetValue<int>(nameof(value));
135+
}
136+
137+
public bool Equals(MySerializable other)
138+
{
139+
return other != null && value == other.value;
140+
}
141+
142+
public void Serialize(IXunitSerializationInfo info)
143+
{
144+
info.AddValue(nameof(value), value);
145+
}
62146
}
63147
}
64148
}

‎test/test.xunit.execution/Sdk/Frameworks/TheoryDiscovererTests.cs

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
using Xunit;
77
using Xunit.Abstractions;
88
using Xunit.Sdk;
9+
using SerializationHelper = Xunit.Sdk.SerializationHelper;
910

1011
public class TheoryDiscovererTests
1112
{

‎test/test.xunit.execution/Sdk/Frameworks/XunitTestCaseTests.cs

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
using Xunit.Abstractions;
88
using Xunit.Sdk;
99
using IAttributeInfo = Xunit.Abstractions.IAttributeInfo;
10+
using SerializationHelper = Xunit.Sdk.SerializationHelper;
1011
using TestMethodDisplay = Xunit.Sdk.TestMethodDisplay;
1112
using TestMethodDisplayOptions = Xunit.Sdk.TestMethodDisplayOptions;
1213

‎test/test.xunit.execution/Sdk/TestCaseSerializerTests.cs

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using System;
22
using Xunit;
33
using Xunit.Sdk;
4+
using SerializationHelper = Xunit.Sdk.SerializationHelper;
45

56
public class TestCaseSerializerTests
67
{

‎test/test.xunit.execution/SerializationTests.cs

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
using Xunit;
77
using Xunit.Abstractions;
88
using Xunit.Sdk;
9+
using SerializationHelper = Xunit.Sdk.SerializationHelper;
910

1011
public class SerializationTests
1112
{

‎test/test.xunit.execution/test.xunit.execution.csproj

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
<Compile Include="..\..\src\common\ExecutionHelper.cs" LinkBase="Common" />
1111
<Compile Include="..\..\src\common\Guard.cs" LinkBase="Common" />
1212
<Compile Include="..\..\src\common\NewReflectionExtensions.cs" LinkBase="Common" />
13-
<Compile Include="..\..\src\common\SerializationHelper.cs" LinkBase="Common" />
1413
<Compile Include="..\..\src\common\TestOptionsNames.cs" LinkBase="Common" />
1514
<Compile Include="..\..\src\common\XunitSerializationInfo.cs" LinkBase="Common" />
1615
</ItemGroup>

‎test/test.xunit.runner.utility/test.xunit.runner.utility.csproj

-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
<Compile Include="..\..\src\common\Guard.cs" LinkBase="Common" />
1414
<Compile Include="..\..\src\common\Json.cs" LinkBase="Common" />
1515
<Compile Include="..\..\src\common\NewReflectionExtensions.cs" LinkBase="Common" />
16-
<Compile Include="..\..\src\common\SerializationHelper.cs" LinkBase="Common" />
1716
<Compile Include="..\..\src\common\TestOptionsNames.cs" LinkBase="Common" />
18-
<Compile Include="..\..\src\common\XunitSerializationInfo.cs" LinkBase="Common" />
1917
<Compile Include="..\..\src\common\AssemblyResolution\**\*.cs" LinkBase="Common\AssemblyResolution" />
2018
<Compile Include="..\..\src\xunit.runner.utility\Frameworks\v1\Xunit1ExceptionUtility.cs" LinkBase="Common\RunnerUtility" />
2119
</ItemGroup>

0 commit comments

Comments
 (0)