coapum 0.2.0

A modern, ergonomic CoAP (Constrained Application Protocol) library for Rust with support for DTLS, observers, and asynchronous handlers
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
//! Handler trait implementation coverage tests
//!
//! These tests specifically target the Handler trait implementations
//! for different parameter counts (2-9 parameters) that were identified
//! as having low coverage in the handler module.

use std::sync::Arc;

use coapum::{
    ContentFormat,
    extract::{Bytes, Cbor, Json, Path, Source, State, StatusCode},
    observer::memory::MemObserver,
    router::RouterBuilder,
};
use serde::{Deserialize, Serialize};
use tower::Service;

#[derive(Debug, Clone)]
struct HandlerTraitTestState {
    counter: Arc<std::sync::Mutex<u32>>,
    data: Arc<std::sync::Mutex<String>>,
}

impl AsRef<HandlerTraitTestState> for HandlerTraitTestState {
    fn as_ref(&self) -> &HandlerTraitTestState {
        self
    }
}

impl Default for HandlerTraitTestState {
    fn default() -> Self {
        Self {
            counter: Arc::new(std::sync::Mutex::new(0)),
            data: Arc::new(std::sync::Mutex::new(String::new())),
        }
    }
}

#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct TestData {
    id: u32,
    message: String,
}

// Handler implementations for different parameter counts to test trait coverage

// 2 parameters: State + Path
async fn handler_2_params(
    State(state): State<HandlerTraitTestState>,
    Path(id): Path<String>,
) -> StatusCode {
    let mut counter = state.counter.lock().unwrap();
    *counter += 1;
    let mut data = state.data.lock().unwrap();
    *data = format!("id:{}", id);
    StatusCode::Content
}

// 3 parameters: State + Path + Bytes
async fn handler_3_params(
    State(state): State<HandlerTraitTestState>,
    Path(id): Path<String>,
    bytes: Bytes,
) -> Json<serde_json::Value> {
    let mut counter = state.counter.lock().unwrap();
    *counter += 1;
    let mut data = state.data.lock().unwrap();
    *data = format!("id:{},bytes:{}", id, bytes.len());

    Json(serde_json::json!({
        "id": id,
        "byte_count": bytes.len(),
        "counter": *counter
    }))
}

// 4 parameters: State + Path + JSON + Source
async fn handler_4_params(
    State(state): State<HandlerTraitTestState>,
    Path(id): Path<String>,
    Json(payload): Json<TestData>,
    Source(addr): Source,
) -> Cbor<TestData> {
    let mut counter = state.counter.lock().unwrap();
    *counter += 1;

    Cbor(TestData {
        id: payload.id + *counter,
        message: format!("{}:{}:{}", id, payload.message, addr.port()),
    })
}

// Handler with maximum 4 parameters (the actual limit)
async fn handler_max_params(
    State(state): State<HandlerTraitTestState>,
    Path(id): Path<String>,
    Cbor(payload): Cbor<TestData>,
    Source(addr): Source,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let mut counter = state.counter.lock().unwrap();
    *counter += 1;

    if payload.id == 0 {
        return Err(StatusCode::BadRequest);
    }

    Ok(Json(serde_json::json!({
        "id": id,
        "payload_id": payload.id,
        "payload_message": payload.message,
        "source_port": addr.port(),
        "counter": *counter
    })))
}

// Error handling handler for trait coverage
async fn handler_with_result_error() -> Result<StatusCode, StatusCode> {
    Err(StatusCode::InternalServerError)
}

async fn handler_with_result_success() -> Result<StatusCode, StatusCode> {
    Ok(StatusCode::Content)
}

// Response conversion handlers
async fn handler_json_response() -> Json<TestData> {
    Json(TestData {
        id: 42,
        message: "json response test".to_string(),
    })
}

async fn handler_cbor_response() -> Cbor<TestData> {
    Cbor(TestData {
        id: 99,
        message: "cbor response test".to_string(),
    })
}

// Async handler variations
async fn handler_async_delay(State(state): State<HandlerTraitTestState>) -> StatusCode {
    tokio::time::sleep(std::time::Duration::from_millis(1)).await;
    let mut counter = state.counter.lock().unwrap();
    *counter += 1;
    StatusCode::Content
}

mod handler_trait_implementation_tests {
    use super::*;

    #[tokio::test]
    async fn test_2_parameter_handler_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state.clone(), observer)
            .get("/test/:id", handler_2_params)
            .build();

        let request = coapum::test_utils::create_test_request("/test/abc123");
        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        // Verify state was modified
        let counter = state.counter.lock().unwrap();
        assert_eq!(*counter, 1);
        let data = state.data.lock().unwrap();
        assert_eq!(*data, "id:abc123");
    }

    #[tokio::test]
    async fn test_3_parameter_handler_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state.clone(), observer)
            .post("/data/:id", handler_3_params)
            .build();

        let payload = vec![1, 2, 3, 4, 5];
        let request = coapum::test_utils::create_test_request_with_payload("/data/xyz789", payload);

        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        let json_data: serde_json::Value =
            serde_json::from_slice(&response.message.payload).unwrap();
        assert_eq!(json_data["id"], "xyz789");
        assert_eq!(json_data["byte_count"], 5);
        assert_eq!(json_data["counter"], 1);
    }

    #[tokio::test]
    async fn test_4_parameter_handler_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state.clone(), observer)
            .post("/items/:id", handler_4_params)
            .build();

        let test_payload = TestData {
            id: 100,
            message: "test message".to_string(),
        };
        let json_data = serde_json::to_vec(&test_payload).unwrap();

        let request = coapum::test_utils::create_test_request_with_content(
            "/items/item001",
            json_data,
            ContentFormat::ApplicationJSON,
        );

        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        let cbor_data: TestData = ciborium::de::from_reader(&response.message.payload[..]).unwrap();
        assert_eq!(cbor_data.id, 101); // 100 + 1 counter
        assert!(cbor_data.message.contains("item001"));
        assert!(cbor_data.message.contains("test message"));
    }

    #[tokio::test]
    async fn test_max_parameter_handler_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state.clone(), observer)
            .post("/complex/:id", handler_max_params)
            .build();

        let test_payload = TestData {
            id: 200,
            message: "complex test".to_string(),
        };

        let mut cbor_data = Vec::new();
        ciborium::ser::into_writer(&test_payload, &mut cbor_data).unwrap();

        let request = coapum::test_utils::create_test_request_with_content(
            "/complex/comp001",
            cbor_data,
            ContentFormat::ApplicationCBOR,
        );

        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        let json_data: serde_json::Value =
            serde_json::from_slice(&response.message.payload).unwrap();
        assert_eq!(json_data["id"], "comp001");
        assert_eq!(json_data["payload_id"], 200);
        assert_eq!(json_data["payload_message"], "complex test");
        assert_eq!(json_data["counter"], 1);
    }

    #[tokio::test]
    async fn test_max_parameter_handler_error_path() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state, observer)
            .post("/complex/:id", handler_max_params)
            .build();

        // Send payload with id=0 to trigger error
        let test_payload = TestData {
            id: 0, // This will trigger error in handler
            message: "error test".to_string(),
        };

        let mut cbor_data = Vec::new();
        ciborium::ser::into_writer(&test_payload, &mut cbor_data).unwrap();

        let request = coapum::test_utils::create_test_request_with_content(
            "/complex/error001",
            cbor_data,
            ContentFormat::ApplicationCBOR,
        );

        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::BadRequest);
    }
}

mod handler_result_and_response_tests {
    use super::*;

    #[tokio::test]
    async fn test_handler_result_error_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state, observer)
            .get("/error", handler_with_result_error)
            .build();

        let request = coapum::test_utils::create_test_request("/error");
        let response = router.call(request).await.unwrap();

        assert_eq!(
            *response.get_status(),
            coapum::ResponseType::InternalServerError
        );
    }

    #[tokio::test]
    async fn test_handler_result_success_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state, observer)
            .get("/success", handler_with_result_success)
            .build();

        let request = coapum::test_utils::create_test_request("/success");
        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);
    }

    #[tokio::test]
    async fn test_handler_json_response_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state, observer)
            .get("/json", handler_json_response)
            .build();

        let request = coapum::test_utils::create_test_request("/json");
        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        let test_data: TestData = serde_json::from_slice(&response.message.payload).unwrap();
        assert_eq!(test_data.id, 42);
        assert_eq!(test_data.message, "json response test");
    }

    #[tokio::test]
    async fn test_handler_cbor_response_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state, observer)
            .get("/cbor", handler_cbor_response)
            .build();

        let request = coapum::test_utils::create_test_request("/cbor");
        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        let test_data: TestData = ciborium::de::from_reader(&response.message.payload[..]).unwrap();
        assert_eq!(test_data.id, 99);
        assert_eq!(test_data.message, "cbor response test");
    }

    #[tokio::test]
    async fn test_handler_async_delay_trait() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state.clone(), observer)
            .get("/async", handler_async_delay)
            .build();

        let request = coapum::test_utils::create_test_request("/async");
        let response = router.call(request).await.unwrap();

        assert_eq!(*response.get_status(), coapum::ResponseType::Content);

        // Verify async handler was executed
        let counter = state.counter.lock().unwrap();
        assert_eq!(*counter, 1);
    }
}

mod handler_trait_edge_cases {
    use super::*;

    #[tokio::test]
    async fn test_handler_trait_with_extraction_failure() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let mut router = RouterBuilder::new(state, observer)
            .post("/extract/:id", handler_4_params)
            .build();

        // Send invalid JSON to trigger extraction failure
        let request = coapum::test_utils::create_test_request_with_content(
            "/extract/test123",
            vec![0xFF, 0xFE, 0xFD], // Invalid JSON
            ContentFormat::ApplicationJSON,
        );

        let response = router.call(request).await.unwrap();

        // Should handle extraction failure gracefully
        assert_ne!(*response.get_status(), coapum::ResponseType::Content);
    }

    #[tokio::test]
    async fn test_concurrent_handler_trait_execution() {
        let state = HandlerTraitTestState::default();
        let observer = MemObserver::new();
        let router = RouterBuilder::new(state.clone(), observer)
            .post("/concurrent/:id", handler_3_params)
            .build();

        let mut handles = vec![];
        for i in 0..3 {
            let mut router_clone = router.clone();
            let handle = tokio::spawn(async move {
                let payload = vec![i; 5];
                let request = coapum::test_utils::create_test_request_with_payload(
                    &format!("/concurrent/test{}", i),
                    payload,
                );
                router_clone.call(request).await
            });
            handles.push(handle);
        }

        // Wait for all concurrent requests
        for handle in handles {
            let result = handle.await.unwrap().unwrap();
            assert_eq!(*result.get_status(), coapum::ResponseType::Content);
        }

        // Verify all handlers were executed
        let counter = state.counter.lock().unwrap();
        assert_eq!(*counter, 3);
    }
}