//
// Copyright (c) PlaceholderCompany. All rights reserved.
//
#pragma warning disable CA1707 // Identifiers should not contain underscores - xUnit test naming convention
#pragma warning disable CA1861 // Avoid constant arrays as arguments - required for xUnit theory test data
namespace Jellyfin.Extensions.Tests.Json.Converters
{
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Text.Json;
using System.Text.Json.Serialization;
using Jellyfin.Extensions.Tests.Json.Models;
using MediaBrowser.Model.Session;
using Xunit;
///
/// Tests for JSON comma delimited collection converter.
///
public class JsonCommaDelimitedCollectionTests
{
private readonly JsonSerializerOptions jsonOptions = new()
{
Converters =
{
new JsonStringEnumConverter(),
},
};
///
/// Tests that deserializing null string value succeeds.
///
[Fact]
public void Deserialize_String_Null_Success()
{
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": null }", this.jsonOptions);
Assert.Null(value?.Value);
}
///
/// Tests that deserializing empty string succeeds.
///
[Fact]
public void Deserialize_Empty_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = [],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": """" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing empty string to list throws exception.
///
[Fact]
public void Deserialize_EmptyList_Success()
{
GenericBodyListModel desiredValue = new()
{
Value = [],
};
_ = Assert.Throws(() => JsonSerializer.Deserialize>(@"{ ""Value"": """" }", this.jsonOptions));
}
///
/// Tests that deserializing empty string to IReadOnlyList succeeds.
///
[Fact]
public void Deserialize_EmptyIReadOnlyList_Success()
{
GenericBodyIReadOnlyListModel desiredValue = new()
{
Value = [],
};
GenericBodyIReadOnlyListModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": """" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing comma-delimited string succeeds.
///
[Fact]
public void Deserialize_String_Valid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = ["a", "b", "c"],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": ""a,b,c"" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing comma-delimited string to list throws exception.
///
[Fact]
public void Deserialize_StringList_Valid_Success()
{
GenericBodyListModel desiredValue = new()
{
Value = ["a", "b", "c"],
};
_ = Assert.Throws(() => JsonSerializer.Deserialize>(@"{ ""Value"": ""a,b,c"" }", this.jsonOptions));
}
///
/// Tests that deserializing comma-delimited string with spaces succeeds.
///
[Fact]
public void Deserialize_String_Space_Valid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = ["a", "b", "c"],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": ""a, b, c"" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing comma-delimited enum string succeeds.
///
[Fact]
public void Deserialize_GenericCommandType_Valid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = [GeneralCommandType.MoveUp, GeneralCommandType.MoveDown],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": ""MoveUp,MoveDown"" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing comma-delimited enum string with empty entry succeeds.
///
[Fact]
public void Deserialize_GenericCommandType_EmptyEntry_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = [GeneralCommandType.MoveUp, GeneralCommandType.MoveDown],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": ""MoveUp,,MoveDown"" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing comma-delimited enum string with invalid value succeeds.
///
[Fact]
public void Deserialize_GenericCommandType_Invalid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = [GeneralCommandType.MoveUp, GeneralCommandType.MoveDown],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": ""MoveUp,TotallyNotAValidCommand,MoveDown"" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing comma-delimited enum string with spaces succeeds.
///
[Fact]
public void Deserialize_GenericCommandType_Space_Valid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = [GeneralCommandType.MoveUp, GeneralCommandType.MoveDown],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": ""MoveUp, MoveDown"" }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing JSON array of strings succeeds.
///
[Fact]
public void Deserialize_String_Array_Valid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = ["a", "b", "c"],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": [""a"",""b"",""c""] }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that deserializing JSON array of enums succeeds.
///
[Fact]
public void Deserialize_GenericCommandType_Array_Valid_Success()
{
GenericBodyArrayModel desiredValue = new()
{
Value = [GeneralCommandType.MoveUp, GeneralCommandType.MoveDown],
};
GenericBodyArrayModel? value = JsonSerializer.Deserialize>(@"{ ""Value"": [""MoveUp"", ""MoveDown""] }", this.jsonOptions);
Assert.Equal(desiredValue.Value, value?.Value);
}
///
/// Tests that serializing readonly collection succeeds.
///
[Fact]
public void Serialize_GenericCommandType_ReadOnlyArray_Valid_Success()
{
GenericBodyIReadOnlyCollectionModel valueToSerialize = new()
{
Value = new[] { GeneralCommandType.MoveUp, GeneralCommandType.MoveDown }.AsReadOnly(),
};
string value = JsonSerializer.Serialize>(valueToSerialize, this.jsonOptions);
Assert.Equal(@"{""Value"":[""MoveUp"",""MoveDown""]}", value);
}
///
/// Tests that serializing immutable array succeeds.
///
[Fact]
public void Serialize_GenericCommandType_ImmutableArrayArray_Valid_Success()
{
GenericBodyIReadOnlyCollectionModel valueToSerialize = new()
{
Value = ImmutableArray.Create([GeneralCommandType.MoveUp, GeneralCommandType.MoveDown]),
};
string value = JsonSerializer.Serialize>(valueToSerialize, this.jsonOptions);
Assert.Equal(@"{""Value"":[""MoveUp"",""MoveDown""]}", value);
}
///
/// Tests that serializing list succeeds.
///
[Fact]
public void Serialize_GenericCommandType_List_Valid_Success()
{
GenericBodyIReadOnlyListModel valueToSerialize = new()
{
Value = [GeneralCommandType.MoveUp, GeneralCommandType.MoveDown],
};
string value = JsonSerializer.Serialize>(valueToSerialize, this.jsonOptions);
Assert.Equal(@"{""Value"":[""MoveUp"",""MoveDown""]}", value);
}
}
}
#pragma warning restore CA1707
#pragma warning restore CA1861