mirror of
https://github.com/wiremock/WireMock.Net.git
synced 2026-03-30 22:32:56 +02:00
Add WebSockets (#1423)
* Add WebSockets * Add tests * fix * more tests * Add tests * ... * remove IOwin * - * tests * fluent * ok * match * . * byte[] * x * func * func * byte * trans * ... * frameworks......... * jmes * xxx * sc
This commit is contained in:
@@ -0,0 +1,53 @@
|
||||
// Copyright © WireMock.Net
|
||||
|
||||
using System.Buffers;
|
||||
using System.Net.WebSockets;
|
||||
using System.Text;
|
||||
|
||||
namespace WireMock.Net.Tests.WebSockets;
|
||||
|
||||
internal static class ClientWebSocketExtensions
|
||||
{
|
||||
internal static Task SendAsync(this ClientWebSocket client, string text, bool endOfMessage = true, CancellationToken cancellationToken = default)
|
||||
{
|
||||
return client.SendAsync(new ArraySegment<byte>(Encoding.UTF8.GetBytes(text)), WebSocketMessageType.Text, endOfMessage, cancellationToken);
|
||||
}
|
||||
|
||||
internal static async Task<string> ReceiveAsTextAsync(this ClientWebSocket client, int bufferSize = 1024, CancellationToken cancellationToken = default)
|
||||
{
|
||||
using var receiveBuffer = ArrayPool<byte>.Shared.Lease(1024);
|
||||
var result = await client.ReceiveAsync(new ArraySegment<byte>(receiveBuffer), cancellationToken);
|
||||
|
||||
if (result.MessageType != WebSocketMessageType.Text)
|
||||
{
|
||||
throw new InvalidOperationException($"Expected a text message but received a {result.MessageType} message.");
|
||||
}
|
||||
|
||||
if (!result.EndOfMessage)
|
||||
{
|
||||
throw new InvalidOperationException("Received message is too large for the buffer. Consider increasing the buffer size.");
|
||||
}
|
||||
|
||||
return Encoding.UTF8.GetString(receiveBuffer, 0, result.Count);
|
||||
}
|
||||
|
||||
internal static async Task<byte[]> ReceiveAsBytesAsync(this ClientWebSocket client, int bufferSize = 1024, CancellationToken cancellationToken = default)
|
||||
{
|
||||
using var receiveBuffer = ArrayPool<byte>.Shared.Lease(1024);
|
||||
var result = await client.ReceiveAsync(new ArraySegment<byte>(receiveBuffer), cancellationToken);
|
||||
|
||||
if (result.MessageType != WebSocketMessageType.Binary)
|
||||
{
|
||||
throw new InvalidOperationException($"Expected a binary message but received a {result.MessageType} message.");
|
||||
}
|
||||
|
||||
if (!result.EndOfMessage)
|
||||
{
|
||||
throw new InvalidOperationException("Received message is too large for the buffer. Consider increasing the buffer size.");
|
||||
}
|
||||
|
||||
var receivedData = new byte[result.Count];
|
||||
Array.Copy(receiveBuffer, receivedData, result.Count);
|
||||
return receivedData;
|
||||
}
|
||||
}
|
||||
248
test/WireMock.Net.Tests/WebSockets/README.md
Normal file
248
test/WireMock.Net.Tests/WebSockets/README.md
Normal file
@@ -0,0 +1,248 @@
|
||||
# WebSocket Integration Tests - Summary
|
||||
|
||||
## Overview
|
||||
Comprehensive integration tests for the WebSockets implementation in WireMock.Net. These tests are based on Examples 1, 2, and 3 from `WireMock.Net.WebSocketExamples` and use `ClientWebSocket` to perform real WebSocket connections.
|
||||
|
||||
## Test File
|
||||
- **Location**: `test\WireMock.Net.Tests\WebSockets\WebSocketIntegrationTests.cs`
|
||||
- **Test Count**: 21 integration tests
|
||||
- **Test Framework**: xUnit with FluentAssertions
|
||||
|
||||
## Test Coverage Summary
|
||||
|
||||
| Category | Tests | Description |
|
||||
|----------|-------|-------------|
|
||||
| **Example 1: Echo Server** | 4 | Basic echo functionality with text/binary messages |
|
||||
| **Example 2: Custom Handlers** | 8 | Command processing and custom message handlers |
|
||||
| **Example 3: JSON (SendJsonAsync)** | 3 | JSON serialization and complex object handling |
|
||||
| **Broadcast** | 6 | Multi-client broadcasting functionality |
|
||||
| **Total** | **21** | |
|
||||
|
||||
## Detailed Test Descriptions
|
||||
|
||||
### Example 1: Echo Server Tests (4 tests)
|
||||
Tests the basic WebSocket echo functionality where messages are echoed back to the sender.
|
||||
|
||||
1. **Example1_EchoServer_Should_Echo_Text_Messages**
|
||||
- ✅ Single text message echo
|
||||
- ✅ Verifies message type and content
|
||||
|
||||
2. **Example1_EchoServer_Should_Echo_Multiple_Messages**
|
||||
- ✅ Multiple sequential messages
|
||||
- ✅ Each message echoed correctly
|
||||
|
||||
3. **Example1_EchoServer_Should_Echo_Binary_Messages**
|
||||
- ✅ Binary data echo
|
||||
- ✅ Byte array verification
|
||||
|
||||
4. **Example1_EchoServer_Should_Handle_Empty_Messages**
|
||||
- ✅ Edge case: empty messages
|
||||
- ✅ Graceful handling
|
||||
|
||||
### Example 2: Custom Message Handler Tests (8 tests)
|
||||
Tests custom message processing with various commands.
|
||||
|
||||
1. **Example2_CustomHandler_Should_Handle_Help_Command**
|
||||
- ✅ `/help` → Returns list of available commands
|
||||
|
||||
2. **Example2_CustomHandler_Should_Handle_Time_Command**
|
||||
- ✅ `/time` → Returns current server time
|
||||
|
||||
3. **Example2_CustomHandler_Should_Handle_Echo_Command**
|
||||
- ✅ `/echo <text>` → Echoes the text
|
||||
|
||||
4. **Example2_CustomHandler_Should_Handle_Upper_Command**
|
||||
- ✅ `/upper <text>` → Converts to uppercase
|
||||
|
||||
5. **Example2_CustomHandler_Should_Handle_Reverse_Command**
|
||||
- ✅ `/reverse <text>` → Reverses the text
|
||||
|
||||
6. **Example2_CustomHandler_Should_Handle_Quit_Command**
|
||||
- ✅ `/quit` → Sends goodbye and closes connection
|
||||
|
||||
7. **Example2_CustomHandler_Should_Handle_Unknown_Command**
|
||||
- ✅ Invalid commands → Error message
|
||||
|
||||
8. **Example2_CustomHandler_Should_Handle_Multiple_Commands_In_Sequence**
|
||||
- ✅ All commands in sequence
|
||||
- ✅ State consistency verification
|
||||
|
||||
### Example 3: SendJsonAsync Tests (3 tests)
|
||||
Tests JSON serialization and the `SendJsonAsync` functionality.
|
||||
|
||||
1. **Example3_JsonEndpoint_Should_Send_Json_Response**
|
||||
- ✅ Basic JSON response
|
||||
- ✅ Structure: `{ timestamp, message, length, type }`
|
||||
- ✅ Proper serialization
|
||||
|
||||
2. **Example3_JsonEndpoint_Should_Handle_Multiple_Json_Messages**
|
||||
- ✅ Sequential JSON messages
|
||||
- ✅ Each properly serialized
|
||||
|
||||
3. **Example3_JsonEndpoint_Should_Serialize_Complex_Objects**
|
||||
- ✅ Nested objects
|
||||
- ✅ Arrays within objects
|
||||
- ✅ Complex structures
|
||||
|
||||
### Broadcast Tests (6 tests)
|
||||
Tests the broadcast functionality with multiple simultaneous clients.
|
||||
|
||||
1. **Broadcast_Should_Send_Message_To_All_Connected_Clients**
|
||||
- ✅ 3 connected clients
|
||||
- ✅ All receive same broadcast
|
||||
- ✅ Timestamp in messages
|
||||
|
||||
2. **Broadcast_Should_Only_Send_To_Open_Connections**
|
||||
- ✅ Closed connections skipped
|
||||
- ✅ Only active clients receive
|
||||
|
||||
3. **BroadcastJson_Should_Send_Json_To_All_Clients**
|
||||
- ✅ JSON broadcasting
|
||||
- ✅ Multiple clients receive
|
||||
- ✅ Sender identification
|
||||
|
||||
4. **Broadcast_Should_Handle_Multiple_Sequential_Messages**
|
||||
- ✅ Sequential broadcasts
|
||||
- ✅ Message ordering
|
||||
- ✅ All clients receive all messages
|
||||
|
||||
5. **Broadcast_Should_Work_With_Many_Clients**
|
||||
- ✅ 5 simultaneous clients
|
||||
- ✅ Scalability test
|
||||
- ✅ Parallel message reception
|
||||
|
||||
6. **Broadcast Integration**
|
||||
- ✅ Complete flow testing
|
||||
|
||||
## Key Testing Features
|
||||
|
||||
### 🔌 Real WebSocket Connections
|
||||
- Uses `System.Net.WebSockets.ClientWebSocket`
|
||||
- Actual network communication
|
||||
- Protocol compliance verification
|
||||
|
||||
### 📤 SendJsonAsync Coverage
|
||||
```csharp
|
||||
await ctx.SendJsonAsync(new {
|
||||
timestamp = DateTime.UtcNow,
|
||||
message = msg.Text,
|
||||
data = complexObject
|
||||
});
|
||||
```
|
||||
- Simple objects
|
||||
- Complex nested structures
|
||||
- Arrays and collections
|
||||
|
||||
### 📡 Broadcast Coverage
|
||||
```csharp
|
||||
await ctx.BroadcastTextAsync("Message to all");
|
||||
await ctx.BroadcastJsonAsync(jsonObject);
|
||||
```
|
||||
- Multiple simultaneous clients
|
||||
- Text and JSON broadcasts
|
||||
- Connection state handling
|
||||
- Scalability testing
|
||||
|
||||
### ✨ Best Practices
|
||||
- ✅ Test isolation (each test has own server)
|
||||
- ✅ Random ports (Port = 0)
|
||||
- ✅ Proper cleanup (`IDisposable`)
|
||||
- ✅ FluentAssertions for readability
|
||||
- ✅ Async/await throughout
|
||||
- ✅ No test interdependencies
|
||||
|
||||
## Running the Tests
|
||||
|
||||
### All WebSocket Tests
|
||||
```bash
|
||||
dotnet test --filter "FullyQualifiedName~WebSocketIntegrationTests"
|
||||
```
|
||||
|
||||
### By Example
|
||||
```bash
|
||||
# Example 1: Echo
|
||||
dotnet test --filter "FullyQualifiedName~Example1"
|
||||
|
||||
# Example 2: Custom Handlers
|
||||
dotnet test --filter "FullyQualifiedName~Example2"
|
||||
|
||||
# Example 3: JSON
|
||||
dotnet test --filter "FullyQualifiedName~Example3"
|
||||
```
|
||||
|
||||
### By Feature
|
||||
```bash
|
||||
# Broadcast tests
|
||||
dotnet test --filter "FullyQualifiedName~Broadcast"
|
||||
|
||||
# JSON tests
|
||||
dotnet test --filter "FullyQualifiedName~Json"
|
||||
```
|
||||
|
||||
### Run Specific Test
|
||||
```bash
|
||||
dotnet test --filter "FullyQualifiedName~Example1_EchoServer_Should_Echo_Text_Messages"
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Package | Purpose |
|
||||
|---------|---------|
|
||||
| `System.Net.WebSockets.ClientWebSocket` | Real WebSocket client |
|
||||
| `WireMock.Server` | WireMock server instance |
|
||||
| `FluentAssertions` | Readable assertions |
|
||||
| `xUnit` | Test framework |
|
||||
| `Newtonsoft.Json` | JSON parsing in assertions |
|
||||
|
||||
All dependencies are included in `WireMock.Net.Tests.csproj`.
|
||||
|
||||
## Implementation Details
|
||||
|
||||
### JSON Testing Pattern
|
||||
```csharp
|
||||
// Send text message
|
||||
await client.SendAsync(bytes, WebSocketMessageType.Text, true, CancellationToken.None);
|
||||
|
||||
// Receive JSON response
|
||||
var result = await client.ReceiveAsync(buffer, CancellationToken.None);
|
||||
var json = JObject.Parse(received);
|
||||
|
||||
// Assert structure
|
||||
json["message"].ToString().Should().Be(expectedMessage);
|
||||
json["timestamp"].Should().NotBeNull();
|
||||
```
|
||||
|
||||
### Broadcast Testing Pattern
|
||||
```csharp
|
||||
// Connect multiple clients
|
||||
var clients = new[] { new ClientWebSocket(), new ClientWebSocket() };
|
||||
foreach (var c in clients)
|
||||
await c.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
// Send from one client
|
||||
await clients[0].SendAsync(message, ...);
|
||||
|
||||
// All clients receive
|
||||
foreach (var c in clients) {
|
||||
var result = await c.ReceiveAsync(buffer, ...);
|
||||
// Assert all received the same message
|
||||
}
|
||||
```
|
||||
|
||||
## Test Timing Notes
|
||||
- Connection registration delays: 100-200ms
|
||||
- Ensures all clients are registered before broadcasting
|
||||
- Prevents race conditions in multi-client tests
|
||||
- Production code does not require delays
|
||||
|
||||
## Coverage Metrics
|
||||
- ✅ Text messages
|
||||
- ✅ Binary messages
|
||||
- ✅ Empty messages
|
||||
- ✅ JSON serialization (simple & complex)
|
||||
- ✅ Multiple sequential messages
|
||||
- ✅ Multiple simultaneous clients
|
||||
- ✅ Connection state transitions
|
||||
- ✅ Broadcast to all clients
|
||||
- ✅ Closed connection handling
|
||||
- ✅ Error scenarios
|
||||
601
test/WireMock.Net.Tests/WebSockets/WebSocketIntegrationTests.cs
Normal file
601
test/WireMock.Net.Tests/WebSockets/WebSocketIntegrationTests.cs
Normal file
@@ -0,0 +1,601 @@
|
||||
// Copyright © WireMock.Net
|
||||
|
||||
using System.Net.WebSockets;
|
||||
using FluentAssertions;
|
||||
using WireMock.Matchers;
|
||||
using WireMock.Net.Xunit;
|
||||
using WireMock.RequestBuilders;
|
||||
using WireMock.ResponseBuilders;
|
||||
using WireMock.Server;
|
||||
using WireMock.Settings;
|
||||
using Xunit.Abstractions;
|
||||
|
||||
namespace WireMock.Net.Tests.WebSockets;
|
||||
|
||||
public class WebSocketIntegrationTests(ITestOutputHelper output)
|
||||
{
|
||||
[Fact]
|
||||
public async Task EchoServer_Should_Echo_Text_Messages()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/echo")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.WithEcho()
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/echo");
|
||||
|
||||
// Act
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
client.State.Should().Be(WebSocketState.Open);
|
||||
|
||||
var testMessage = "Hello, WebSocket!";
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
// Assert
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
received.Should().Be(testMessage);
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WithText_Should_Send_Configured_Text()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
var responseMessage = "This is a predefined response";
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/message")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.SendMessage(m => m.WithText(responseMessage))
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/message");
|
||||
|
||||
// Act
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
client.State.Should().Be(WebSocketState.Open);
|
||||
|
||||
var testMessage = "Any message from client";
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
// Assert
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
received.Should().Be(responseMessage);
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WithText_Should_Send_Same_Text_For_Multiple_Messages()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
var responseMessage = "Fixed response";
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/message")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.SendMessage(m => m.WithText(responseMessage))
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/message");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
var testMessages = new[] { "First", "Second", "Third" };
|
||||
|
||||
// Act & Assert
|
||||
foreach (var testMessage in testMessages)
|
||||
{
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
received.Should().Be(responseMessage, $"should always return the fixed response regardless of input message '{testMessage}'");
|
||||
}
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WithBinary_Should_Send_Configured_Bytes()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
var responseBytes = new byte[] { 0xDE, 0xAD, 0xBE, 0xEF };
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/binary")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.SendMessage(m => m.WithBinary(responseBytes))
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/binary");
|
||||
|
||||
// Act
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
client.State.Should().Be(WebSocketState.Open);
|
||||
|
||||
var testMessage = "Any message from client";
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
// Assert
|
||||
var receivedData = await client.ReceiveAsBytesAsync();
|
||||
receivedData.Should().BeEquivalentTo(responseBytes);
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WithBinary_Should_Send_Same_Bytes_For_Multiple_Messages()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
var responseBytes = new byte[] { 0x01, 0x02, 0x03 };
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/binary")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.SendMessage(m => m.WithBinary(responseBytes))
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/binary");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
var testMessages = new[] { "First", "Second", "Third" };
|
||||
|
||||
// Act & Assert
|
||||
foreach (var testMessage in testMessages)
|
||||
{
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
var receivedData = await client.ReceiveAsBytesAsync();
|
||||
receivedData.Should().BeEquivalentTo(responseBytes, $"should always return the fixed bytes regardless of input message '{testMessage}'");
|
||||
}
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
|
||||
[Fact]
|
||||
public async Task EchoServer_Should_Echo_Multiple_Messages()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/echo")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws.WithEcho())
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/echo");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
var testMessages = new[] { "Hello", "World", "WebSocket", "Test" };
|
||||
|
||||
// Act & Assert
|
||||
foreach (var testMessage in testMessages)
|
||||
{
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
|
||||
received.Should().Be(testMessage, $"message '{testMessage}' should be echoed back");
|
||||
}
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task EchoServer_Should_Echo_Binary_Messages()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/echo")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws.WithEcho())
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/echo");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
var testData = new byte[] { 0x01, 0x02, 0x03, 0x04, 0x05 };
|
||||
|
||||
// Act
|
||||
await client.SendAsync(new ArraySegment<byte>(testData), WebSocketMessageType.Binary, true, CancellationToken.None);
|
||||
|
||||
var receivedData = await client.ReceiveAsBytesAsync();
|
||||
|
||||
// Assert
|
||||
receivedData.Should().BeEquivalentTo(testData);
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task EchoServer_Should_Handle_Empty_Messages()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/echo")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws.WithEcho())
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/echo");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
// Act
|
||||
await client.SendAsync(string.Empty);
|
||||
|
||||
var receiveBuffer = new byte[1024];
|
||||
var result = await client.ReceiveAsync(new ArraySegment<byte>(receiveBuffer), CancellationToken.None);
|
||||
|
||||
// Assert
|
||||
result.Count.Should().Be(0);
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CustomHandler_Should_Handle_Help_Command()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/chat")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.WithMessageHandler(async (message, context) =>
|
||||
{
|
||||
if (message.MessageType == WebSocketMessageType.Text)
|
||||
{
|
||||
var text = message.Text ?? string.Empty;
|
||||
|
||||
if (text.StartsWith("/help"))
|
||||
{
|
||||
await context.SendAsync("Available commands: /help, /time, /echo <text>, /upper <text>, /reverse <text>");
|
||||
}
|
||||
}
|
||||
})
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/chat");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
// Act
|
||||
await client.SendAsync("/help");
|
||||
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
|
||||
// Assert
|
||||
received.Should().Contain("Available commands");
|
||||
received.Should().Contain("/help");
|
||||
received.Should().Contain("/time");
|
||||
received.Should().Contain("/echo");
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CustomHandler_Should_Handle_Multiple_Commands_In_Sequence()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/chat")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.WithMessageHandler(async (message, context) =>
|
||||
{
|
||||
if (message.MessageType == WebSocketMessageType.Text)
|
||||
{
|
||||
var text = message.Text ?? string.Empty;
|
||||
|
||||
if (text.StartsWith("/help"))
|
||||
{
|
||||
await context.SendAsync("Available commands: /help, /time, /echo <text>, /upper <text>, /reverse <text>");
|
||||
}
|
||||
else if (text.StartsWith("/time"))
|
||||
{
|
||||
await context.SendAsync($"Server time: {DateTime.UtcNow:yyyy-MM-dd HH:mm:ss} UTC");
|
||||
}
|
||||
else if (text.StartsWith("/echo "))
|
||||
{
|
||||
await context.SendAsync(text.Substring(6));
|
||||
}
|
||||
else if (text.StartsWith("/upper "))
|
||||
{
|
||||
await context.SendAsync(text.Substring(7).ToUpper());
|
||||
}
|
||||
else if (text.StartsWith("/reverse "))
|
||||
{
|
||||
var toReverse = text.Substring(9);
|
||||
var reversed = new string(toReverse.Reverse().ToArray());
|
||||
await context.SendAsync(reversed);
|
||||
}
|
||||
else if (text.StartsWith("/close"))
|
||||
{
|
||||
await context.CloseAsync(WebSocketCloseStatus.NormalClosure, "Closing connection");
|
||||
}
|
||||
}
|
||||
})
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/chat");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
var commands = new (string, Action<string>)[]
|
||||
{
|
||||
("/help", response => response.Should().Contain("Available commands")),
|
||||
("/time", response => response.Should().Contain("Server time")),
|
||||
("/echo Test", response => response.Should().Be("Test")),
|
||||
("/upper test", response => response.Should().Be("TEST")),
|
||||
("/reverse hello", response => response.Should().Be("olleh"))
|
||||
};
|
||||
|
||||
// Act & Assert
|
||||
foreach (var (command, assertion) in commands)
|
||||
{
|
||||
await client.SendAsync(command);
|
||||
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
|
||||
assertion(received);
|
||||
}
|
||||
|
||||
await client.SendAsync("/close");
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WhenMessage_Should_Handle_Multiple_Conditions_Fluently()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/conditional")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.WithCloseTimeout(TimeSpan.FromSeconds(3))
|
||||
.WhenMessage("/help").SendMessage(m => m.WithText("Available commands"))
|
||||
.WhenMessage("/time").SendMessage(m => m.WithText($"Server time: {DateTime.UtcNow:yyyy-MM-dd HH:mm:ss} UTC"))
|
||||
.WhenMessage("/echo *").SendMessage(m => m.WithText("echo response"))
|
||||
.WhenMessage(new ExactMatcher("/exact")).SendMessage(m => m.WithText("is exact"))
|
||||
.WhenMessage(new FuncMatcher(s => s == "/func")).SendMessage(m => m.WithText("is func"))
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/conditional");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
var testCases = new (string message, string expectedContains)[]
|
||||
{
|
||||
("/help", "Available commands"),
|
||||
("/time", "Server time"),
|
||||
("/echo test", "echo response"),
|
||||
("/exact", "is exact"),
|
||||
("/func", "is func")
|
||||
};
|
||||
|
||||
// Act & Assert
|
||||
foreach (var (message, expectedContains) in testCases)
|
||||
{
|
||||
await client.SendAsync(message);
|
||||
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
|
||||
received.Should().Contain(expectedContains, $"message '{message}' should return response containing '{expectedContains}'");
|
||||
}
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WhenMessage_Should_Close_Connection_When_AndClose_Is_Used()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/close")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.WhenMessage("/close").SendMessage(m => m.WithText("Closing connection").AndClose())
|
||||
)
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/close");
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
|
||||
// Act
|
||||
await client.SendAsync("/close");
|
||||
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
|
||||
// Assert
|
||||
received.Should().Contain("Closing connection");
|
||||
|
||||
// Try to receive again - this will complete the close handshake
|
||||
// and update the client state to Closed
|
||||
try
|
||||
{
|
||||
var receiveBuffer = new byte[1024];
|
||||
var result = await client.ReceiveAsync(new ArraySegment<byte>(receiveBuffer), CancellationToken.None);
|
||||
|
||||
// If we get here, the message type should be Close
|
||||
result.MessageType.Should().Be(WebSocketMessageType.Close);
|
||||
}
|
||||
catch (WebSocketException)
|
||||
{
|
||||
// Connection was closed, which is expected
|
||||
}
|
||||
|
||||
// Verify the connection is CloseReceived
|
||||
client.State.Should().Be(WebSocketState.CloseReceived);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task WithTransformer_Should_Transform_Message_Using_Handlebars()
|
||||
{
|
||||
// Arrange
|
||||
using var server = WireMockServer.Start(new WireMockServerSettings
|
||||
{
|
||||
Logger = new TestOutputHelperWireMockLogger(output),
|
||||
Urls = ["ws://localhost:0"]
|
||||
});
|
||||
|
||||
server
|
||||
.Given(Request.Create()
|
||||
.WithPath("/ws/transform")
|
||||
.WithWebSocketUpgrade()
|
||||
)
|
||||
.RespondWith(Response.Create()
|
||||
.WithWebSocket(ws => ws
|
||||
.SendMessage(m => m.WithText("{{request.Path}} {{[String.Lowercase] message.Text}}"))
|
||||
)
|
||||
.WithTransformer()
|
||||
);
|
||||
|
||||
using var client = new ClientWebSocket();
|
||||
var uri = new Uri($"{server.Url}/ws/transform");
|
||||
|
||||
// Act
|
||||
await client.ConnectAsync(uri, CancellationToken.None);
|
||||
client.State.Should().Be(WebSocketState.Open);
|
||||
|
||||
var testMessage = "HellO";
|
||||
await client.SendAsync(testMessage);
|
||||
|
||||
// Assert
|
||||
var received = await client.ReceiveAsTextAsync();
|
||||
received.Should().Be("/ws/transform hello");
|
||||
|
||||
await client.CloseAsync(WebSocketCloseStatus.NormalClosure, "Test complete", CancellationToken.None);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user