test: add serialization tests and guidelines for handling null and omitted fields (#583)
This commit is contained in:
parent
3e7ea39bf7
commit
1454229ad9
3 changed files with 52 additions and 0 deletions
|
|
@ -92,6 +92,10 @@ Follow these rules to keep changes safe, comprehensible, and easy to maintain.
|
||||||
- **mockk**: Mocking library
|
- **mockk**: Mocking library
|
||||||
- **Ktor MockEngine**: For HTTP client mocking (`io.ktor:ktor-client-mock`)
|
- **Ktor MockEngine**: For HTTP client mocking (`io.ktor:ktor-client-mock`)
|
||||||
- **Java tests**: Use JUnit5, Mockito, AssertJ core
|
- **Java tests**: Use JUnit5, Mockito, AssertJ core
|
||||||
|
- **Serialization test utilities** (`io.modelcontextprotocol.kotlin.test.utils`):
|
||||||
|
- `verifySerialization(value, json, expectedJson)` — serializes, asserts match, round-trips back; use for most serialization tests
|
||||||
|
- `verifyDeserialization(json, payload)` — deserializes from JSON, re-serializes, asserts match; returns the object for further assertions
|
||||||
|
- Always test both empty/null/omitted and non-null cases for nullable fields; `McpJson` has `explicitNulls = false` so null properties must be absent from JSON, not `null`
|
||||||
|
|
||||||
### Kotest Patterns
|
### Kotest Patterns
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -189,6 +189,34 @@ class InitializeTest {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun `should serialize InitializeResult without meta - meta must be omitted`() {
|
||||||
|
val result = InitializeResult(
|
||||||
|
protocolVersion = "2025-03-26",
|
||||||
|
capabilities = ServerCapabilities(tools = ServerCapabilities.Tools(listChanged = false)),
|
||||||
|
serverInfo = Implementation(name = "test-server", version = "1.0.0"),
|
||||||
|
)
|
||||||
|
|
||||||
|
verifySerialization(
|
||||||
|
result,
|
||||||
|
McpJson,
|
||||||
|
"""
|
||||||
|
{
|
||||||
|
"protocolVersion": "2025-03-26",
|
||||||
|
"capabilities": {
|
||||||
|
"tools": {
|
||||||
|
"listChanged": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"serverInfo": {
|
||||||
|
"name": "test-server",
|
||||||
|
"version": "1.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""".trimIndent(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
fun `should deserialize InitializeResult from JSON`() {
|
fun `should deserialize InitializeResult from JSON`() {
|
||||||
val json = """
|
val json = """
|
||||||
|
|
|
||||||
|
|
@ -265,6 +265,26 @@ class JsonRpcTest {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun `should serialize JSONRPCResponse with EmptyResult - null meta must be omitted`() {
|
||||||
|
val response = JSONRPCResponse(
|
||||||
|
id = RequestId("call-2"),
|
||||||
|
result = EmptyResult(), // meta = null by default
|
||||||
|
)
|
||||||
|
|
||||||
|
verifySerialization(
|
||||||
|
response,
|
||||||
|
McpJson,
|
||||||
|
"""
|
||||||
|
{
|
||||||
|
"id": "call-2",
|
||||||
|
"result": {},
|
||||||
|
"jsonrpc": "2.0"
|
||||||
|
}
|
||||||
|
""".trimIndent(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
fun `should deserialize JSONRPCResponse with EmptyResult`() {
|
fun `should deserialize JSONRPCResponse with EmptyResult`() {
|
||||||
val json = """
|
val json = """
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue