tests: begin the march to test coverage

This commit is contained in:
Stevan Freeborn
2025-05-19 22:57:32 -05:00
parent bb1fadeac0
commit 06425f4c05
7 changed files with 89 additions and 247 deletions
@@ -0,0 +1,19 @@
namespace StevesBot.Worker.Tests.Unit;
public class ActivityTypeTests
{
[Theory]
[MemberData(nameof(TestData))]
public void ActivityType_WhenCalled_ItShouldReturnExpectedResult(int activityType, int expected)
{
activityType.Should().Be(expected);
}
public static TheoryData<int, int> TestData => new()
{
{
ActivityType.Custom,
4
},
};
}
@@ -0,0 +1,20 @@
namespace StevesBot.Worker.Tests.Unit;
public class DiscordCloseCodesTests
{
[Theory]
[InlineData(4004, false)]
[InlineData(4010, false)]
[InlineData(4011, false)]
[InlineData(4012, false)]
[InlineData(4013, false)]
[InlineData(4014, false)]
[InlineData(null, true)]
[InlineData(1000, true)]
public void IsReconnectable_WhenCalledWithCloseCode_ItShouldReturnExpectedResult(int? closeCode, bool expected)
{
var result = DiscordCloseCodes.IsReconnectable(closeCode);
result.Should().Be(expected);
}
}
@@ -69,7 +69,7 @@ public class DiscordEventConverterTests
t = null as string,
d = null as object
},
typeof(DiscordEvent)
typeof(DispatchDiscordEvent)
},
{
new
@@ -138,252 +138,6 @@ public sealed class DiscordGatewayClientTests : IDisposable
);
}
[Fact]
public async Task ConnectAsync_WhenCalledAndWebSocketIsClosed_ItShouldStopReceivingMessages()
{
_mockDiscordRestClient
.Setup(static x => x.GetGatewayUrlAsync(It.IsAny<CancellationToken>()))
.ReturnsAsync("wss://gateway.discord.gg");
var mockWebSocket = new Mock<IWebSocket>();
mockWebSocket
.Setup(static x => x.State)
.Returns(WebSocketState.Closed);
_mockWebSocketFactory
.Setup(static x => x.Create())
.Returns(mockWebSocket.Object);
await _discordGatewayClient.ConnectAsync(CancellationToken.None);
mockWebSocket.Verify(
static x => x.ReceiveAsync(It.IsAny<ArraySegment<byte>>(), It.IsAny<CancellationToken>()),
Times.Never
);
}
[Fact]
public async Task ConnectAsync_WhenCalledAndCancellationIsRequested_ItShouldStopReceivingMessages()
{
_mockDiscordRestClient
.Setup(static x => x.GetGatewayUrlAsync(It.IsAny<CancellationToken>()))
.ReturnsAsync("wss://gateway.discord.gg");
var mockWebSocket = new Mock<IWebSocket>();
_mockWebSocketFactory
.Setup(static x => x.Create())
.Returns(mockWebSocket.Object);
using var cts = new CancellationTokenSource();
await _discordGatewayClient.ConnectAsync(cts.Token);
await Task.Delay(100);
await cts.CancelAsync();
mockWebSocket.Verify(static x => x.State, Times.AtMostOnce);
mockWebSocket.Verify(
static x => x.ReceiveAsync(It.IsAny<ArraySegment<byte>>(), It.IsAny<CancellationToken>()),
Times.AtMostOnce
);
}
[Fact]
public async Task ConnectAsync_WhenCalledAndHelloEventReceived_ItShouldStartSendingHeartbeats()
{
_mockDiscordRestClient
.Setup(static x => x.GetGatewayUrlAsync(It.IsAny<CancellationToken>()))
.ReturnsAsync("wss://gateway.discord.gg");
var mockWebSocket = new Mock<IWebSocket>();
mockWebSocket
.Setup(static x => x.State)
.Returns(WebSocketState.Open);
var messageQueue = new Queue<(WebSocketReceiveResult, byte[])>();
var heartbeatInterval = 100;
var helloEventPayload = CreateEventPayload(new
{
op = 10,
d = new
{
heartbeat_interval = heartbeatInterval,
}
});
messageQueue.Enqueue((
new(helloEventPayload.Bytes.Length, WebSocketMessageType.Text, true),
helloEventPayload.Bytes
));
SetupReceiveMessageSequence(mockWebSocket, messageQueue);
_mockWebSocketFactory
.Setup(static x => x.Create())
.Returns(mockWebSocket.Object);
var cts = new CancellationTokenSource();
await _discordGatewayClient.ConnectAsync(cts.Token);
await Task.Delay((int)(heartbeatInterval * 1.5));
await cts.CancelAsync();
var expectedHeartbeatPayload = CreateEventPayload(new HeartbeatDiscordEvent(null));
mockWebSocket.Verify(
x => x.SendAsync(
It.Is<ArraySegment<byte>>(b => expectedHeartbeatPayload.Bytes.SequenceEqual(b)),
It.IsAny<WebSocketMessageType>(),
It.IsAny<bool>(),
It.IsAny<CancellationToken>()
),
Times.Once
);
}
[Fact]
public async Task ConnectAsync_WhenCalledAndHeartbeatIsNotAcknowledged_ItShouldDisconnectAndAttemptToResume()
{
_mockDiscordRestClient
.Setup(static x => x.GetGatewayUrlAsync(It.IsAny<CancellationToken>()))
.ReturnsAsync("wss://gateway.discord.gg");
var mockWebSocket = new Mock<IWebSocket>();
mockWebSocket
.Setup(static x => x.State)
.Returns(WebSocketState.Open);
var messageQueue = new Queue<(WebSocketReceiveResult, byte[])>();
var heartbeatInterval = 100;
var helloEventPayload = CreateEventPayload(new
{
op = 10,
d = new
{
heartbeat_interval = heartbeatInterval,
}
});
messageQueue.Enqueue((
new(helloEventPayload.Bytes.Length, WebSocketMessageType.Text, true),
helloEventPayload.Bytes
));
SetupReceiveMessageSequence(mockWebSocket, messageQueue);
_mockWebSocketFactory
.Setup(static x => x.Create())
.Returns(mockWebSocket.Object);
var cts = new CancellationTokenSource();
await _discordGatewayClient.ConnectAsync(cts.Token);
await Task.Delay((int)(heartbeatInterval * 2.5));
await cts.CancelAsync();
var expectedHeartbeatPayload = CreateEventPayload(new HeartbeatDiscordEvent(null));
mockWebSocket.Verify(
x => x.SendAsync(
It.Is<ArraySegment<byte>>(b => expectedHeartbeatPayload.Bytes.SequenceEqual(b)),
It.IsAny<WebSocketMessageType>(),
It.IsAny<bool>(),
It.IsAny<CancellationToken>()
),
Times.Once
);
mockWebSocket.Verify(
static x => x.CloseAsync(
It.Is<WebSocketCloseStatus>(
x => x != WebSocketCloseStatus.NormalClosure && x != WebSocketCloseStatus.EndpointUnavailable
),
It.IsAny<string>(),
It.IsAny<CancellationToken>()
),
Times.Once
);
}
[Fact]
public async Task ConnectAsync_WhenCalledAndHeartbeatNotAcknowlegedAndAlreadyClosed_ItShouldNotDisconnect()
{
_mockDiscordRestClient
.Setup(static x => x.GetGatewayUrlAsync(It.IsAny<CancellationToken>()))
.ReturnsAsync("wss://gateway.discord.gg");
var mockWebSocket = new Mock<IWebSocket>();
mockWebSocket
.SetupSequence(static x => x.State)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Open)
.Returns(WebSocketState.Closed);
var messageQueue = new Queue<(WebSocketReceiveResult, byte[])>();
var heartbeatInterval = 100;
var helloEventPayload = CreateEventPayload(new
{
op = 10,
d = new
{
heartbeat_interval = heartbeatInterval,
}
});
messageQueue.Enqueue((
new(helloEventPayload.Bytes.Length, WebSocketMessageType.Text, true),
helloEventPayload.Bytes
));
SetupReceiveMessageSequence(mockWebSocket, messageQueue);
_mockWebSocketFactory
.Setup(static x => x.Create())
.Returns(mockWebSocket.Object);
var cts = new CancellationTokenSource();
await _discordGatewayClient.ConnectAsync(cts.Token);
await Task.Delay((int)(heartbeatInterval * 2.5));
await cts.CancelAsync();
var expectedHeartbeatPayload = CreateEventPayload(new HeartbeatDiscordEvent(null));
mockWebSocket.Verify(
x => x.SendAsync(
It.Is<ArraySegment<byte>>(b => expectedHeartbeatPayload.Bytes.SequenceEqual(b)),
It.IsAny<WebSocketMessageType>(),
It.IsAny<bool>(),
It.IsAny<CancellationToken>()
),
Times.Once
);
mockWebSocket.Verify(
static x => x.CloseAsync(
It.IsAny<WebSocketCloseStatus>(),
It.IsAny<string>(),
It.IsAny<CancellationToken>()
),
Times.Never
);
}
private static void SetupReceiveMessageSequence(
Mock<IWebSocket> mockWebSocket,
Queue<(WebSocketReceiveResult, byte[])> messageQueue
@@ -0,0 +1,23 @@
namespace StevesBot.Worker.Tests.Unit;
public class PresenceStatusTests
{
[Theory]
[MemberData(nameof(TestData))]
public void PresenceStatus_WhenCalled_ItShouldReturnExpectedResult(string status, string expected)
{
status.Should().Be(expected);
}
public static TheoryData<string, string> TestData => new()
{
{
PresenceStatus.Online,
"online"
},
{
PresenceStatus.Idle,
"idle"
},
};
}
@@ -0,0 +1,6 @@
namespace StevesBot.Worker.Tests.Unit;
public class UpdatePresenceDataTests
{
}
@@ -0,0 +1,20 @@
namespace StevesBot.Worker.Tests.Unit;
public class UpdatePresenceDiscordEventTests
{
[Fact]
public void Constructor_WhenCalled_ItShouldReturnInstance()
{
var activities = new List<Activity>();
var since = 1234567890L;
var e = new UpdatePresenceDiscordEvent(since, activities, PresenceStatus.Online, false);
e.Should().NotBeNull();
e.Data.Should().NotBeNull();
e.Data.Since.Should().Be(since);
e.Data.Activities.Should().BeSameAs(activities);
e.Data.Status.Should().Be(PresenceStatus.Online);
e.Data.Afk.Should().BeFalse();
}
}