wireframe_testing 0.3.0

Helper utilities for exercising Wireframe applications in tests
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

//! Utilities for driving a [`WireframeApp`](wireframe::app::WireframeApp)
//! with in-memory streams during tests.
//!
//! These helpers spawn the application on a `tokio::io::duplex` stream and
//! return all bytes written by the app for easy assertions. They work with any
//! message implementing [`serde::Serialize`]. The payload is encoded with
//! [`bincode::encode_to_vec`] using [`bincode::config::standard()`], which means
//! little-endian byte order, variable-length integer encoding and no byte limit
//! are applied. The example uses a simple `u8` value so no generics are
//! required.
//!
//! ```rust
//! use wireframe::app::WireframeApp;
//! use wireframe_testing::drive_with_bincode;
//!
//! # async fn example(app: WireframeApp) {
//! let bytes = drive_with_bincode(app, 42u8).await.unwrap();
//! # }
//! ```

pub mod client_pair;
pub mod echo_server;
pub mod helpers;
pub mod integration_helpers;
pub mod logging;
pub mod macros;
pub mod multi_packet;
pub mod observability;
pub mod reassembly;

pub use client_pair::{WireframePair, spawn_wireframe_pair, spawn_wireframe_pair_default};
pub use echo_server::{ServerMode, process_frame};
pub use helpers::{
    MAX_SLOW_IO_CAPACITY,
    MaxFrameLength,
    PayloadLength,
    SlowIoConfig,
    SlowIoPacing,
    TEST_MAX_FRAME,
    TestSerializer,
    TransactionId,
    correlated_hotline_wire,
    decode_frames,
    decode_frames_with_codec,
    decode_frames_with_max,
    drive_with_bincode,
    drive_with_codec_frames,
    drive_with_codec_frames_with_capacity,
    drive_with_codec_payloads,
    drive_with_codec_payloads_mut,
    drive_with_codec_payloads_with_capacity,
    drive_with_codec_payloads_with_capacity_mut,
    drive_with_fragment_frames,
    drive_with_fragments,
    drive_with_fragments_mut,
    drive_with_fragments_with_capacity,
    drive_with_frame,
    drive_with_frame_mut,
    drive_with_frame_with_capacity,
    drive_with_frames,
    drive_with_frames_mut,
    drive_with_frames_with_capacity,
    drive_with_partial_codec_frames,
    drive_with_partial_fragments,
    drive_with_partial_frames,
    drive_with_partial_frames_mut,
    drive_with_partial_frames_with_capacity,
    drive_with_payloads,
    drive_with_payloads_mut,
    drive_with_slow_codec_frames,
    drive_with_slow_codec_payloads,
    drive_with_slow_frames,
    drive_with_slow_payloads,
    encode_frame,
    encode_payloads_with_codec,
    extract_payloads,
    mismatched_total_size_wire,
    new_test_codec,
    oversized_hotline_wire,
    run_app,
    run_with_duplex_server,
    sequential_hotline_wire,
    truncated_hotline_header,
    truncated_hotline_payload,
    valid_hotline_frame,
    valid_hotline_wire,
};
pub use integration_helpers::{
    CommonHandler,
    CommonTestApp,
    CommonTestEnvelope,
    Echo,
    TestApp,
    TestError,
    TestResult,
    echo_app_factory,
    echo_handler,
    factory,
    unused_listener,
};
pub use logging::{LoggerHandle, logger};
#[doc(inline)]
pub use multi_packet::collect_multi_packet;
pub use observability::{Labels, ObservabilityHandle, obs_handle};