Add tests for GameVersionConverter and fix edge case (#1726)

- Adds tests for GameVersionConverter
- Refactors GameVersionConverter to reduce nesting
- Fixes an edge case in GameVersion deserialization in which the JsonConstructor will be invoked even if no properties match
- Adds a test for the GameVersion deserialization edge case
This commit is contained in:
Kara 2024-03-18 20:12:34 -07:00 committed by GitHub
parent 7fcd10ecd8
commit d393fa64b6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 171 additions and 22 deletions

View file

@ -0,0 +1,138 @@
using Dalamud.Common.Game;
using JetBrains.Annotations;
using Newtonsoft.Json;
using Xunit;
namespace Dalamud.Test.Game;
public class GameVersionConverterTests
{
[Fact]
public void ReadJson_ConvertsFromString()
{
var serialized = """
{
"Version": "2020.06.15.0000.0000"
}
""";
var deserialized = JsonConvert.DeserializeObject<TestSerializationClass>(serialized);
Assert.NotNull(deserialized);
Assert.Equal(GameVersion.Parse("2020.06.15.0000.0000"), deserialized.Version);
}
[Fact]
public void ReadJson_ConvertsFromNull()
{
var serialized = """
{
"Version": null
}
""";
var deserialized = JsonConvert.DeserializeObject<TestSerializationClass>(serialized);
Assert.NotNull(deserialized);
Assert.Null(deserialized.Version);
}
[Fact]
public void ReadJson_WhenInvalidType_Throws()
{
var serialized = """
{
"Version": 2
}
""";
Assert.Throws<JsonSerializationException>(
() => JsonConvert.DeserializeObject<TestSerializationClass>(serialized));
}
[Fact]
public void ReadJson_WhenInvalidVersion_Throws()
{
var serialized = """
{
"Version": "junk"
}
""";
Assert.Throws<JsonSerializationException>(
() => JsonConvert.DeserializeObject<TestSerializationClass>(serialized));
}
[Fact]
public void WriteJson_ConvertsToString()
{
var deserialized = new TestSerializationClass
{
Version = GameVersion.Parse("2020.06.15.0000.0000"),
};
var serialized = JsonConvert.SerializeObject(deserialized);
Assert.Equal("""{"Version":"2020.06.15.0000.0000"}""", RemoveWhitespace(serialized));
}
[Fact]
public void WriteJson_ConvertsToNull()
{
var deserialized = new TestSerializationClass
{
Version = null,
};
var serialized = JsonConvert.SerializeObject(deserialized);
Assert.Equal("""{"Version":null}""", RemoveWhitespace(serialized));
}
[Fact]
public void WriteJson_WhenInvalidVersion_Throws()
{
var deserialized = new TestWrongTypeSerializationClass
{
Version = 42,
};
Assert.Throws<JsonSerializationException>(() => JsonConvert.SerializeObject(deserialized));
}
[Fact]
public void CanConvert_WhenGameVersion_ReturnsTrue()
{
var converter = new GameVersionConverter();
Assert.True(converter.CanConvert(typeof(GameVersion)));
}
[Fact]
public void CanConvert_WhenNotGameVersion_ReturnsFalse()
{
var converter = new GameVersionConverter();
Assert.False(converter.CanConvert(typeof(int)));
}
[Fact]
public void CanConvert_WhenNull_ReturnsFalse()
{
var converter = new GameVersionConverter();
Assert.False(converter.CanConvert(null!));
}
private static string RemoveWhitespace(string input)
{
return input.Replace(" ", "").Replace("\r", "").Replace("\n", "");
}
private class TestSerializationClass
{
[JsonConverter(typeof(GameVersionConverter))]
[CanBeNull]
public GameVersion Version { get; init; }
}
private class TestWrongTypeSerializationClass
{
[JsonConverter(typeof(GameVersionConverter))]
public int Version { get; init; }
}
}

View file

@ -225,6 +225,17 @@ namespace Dalamud.Test.Game
Assert.Throws<ArgumentOutOfRangeException>(() => JsonConvert.DeserializeObject<GameVersion>(serialized));
}
[Fact]
public void VersionInvalidTypeDeserialization()
{
var serialized = """
{
"Value": "Hello"
}
""";
Assert.Throws<JsonSerializationException>(() => JsonConvert.DeserializeObject<GameVersion>(serialized));
}
[Fact]
public void VersionConstructorNegativeYear()
{