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

//! Helper utilities for driving `WireframeApp` instances in tests.
//!
//! These functions spin up an application on an in-memory duplex stream and
//! collect the bytes written back by the app for assertions.

use wireframe::{
    app::Envelope,
    frame::FrameMetadata,
    serializer::{MessageCompatibilitySerializer, Serializer},
};

mod codec;
mod codec_drive;
mod codec_ext;
mod codec_fixtures;
mod drive;
mod payloads;
mod runtime;

#[cfg(test)]
mod tests;

/// Serializer bounds expected by the in-memory test harness.
pub trait TestSerializer:
    Serializer
    + MessageCompatibilitySerializer
    + FrameMetadata<Frame = Envelope>
    + Send
    + Sync
    + 'static
{
}

impl<T> TestSerializer for T where
    T: Serializer
        + MessageCompatibilitySerializer
        + FrameMetadata<Frame = Envelope>
        + Send
        + Sync
        + 'static
{
}

pub(crate) const DEFAULT_CAPACITY: usize = 4096;
pub(crate) const MAX_CAPACITY: usize = wireframe::testkit::MAX_SLOW_IO_CAPACITY;
pub(crate) const EMPTY_SERVER_CAPACITY: usize = 64;
/// Shared frame cap used by helpers and tests to avoid drift.
pub const TEST_MAX_FRAME: usize = DEFAULT_CAPACITY;

pub use codec::{decode_frames, decode_frames_with_max, encode_frame, new_test_codec};
pub use codec_drive::{
    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,
};
pub use codec_ext::{decode_frames_with_codec, encode_payloads_with_codec, extract_payloads};
pub use codec_fixtures::{
    MaxFrameLength,
    PayloadLength,
    TransactionId,
    correlated_hotline_wire,
    mismatched_total_size_wire,
    oversized_hotline_wire,
    sequential_hotline_wire,
    truncated_hotline_header,
    truncated_hotline_payload,
    valid_hotline_frame,
    valid_hotline_wire,
};
pub use drive::{
    drive_with_frame,
    drive_with_frame_mut,
    drive_with_frame_with_capacity,
    drive_with_frame_with_capacity_mut,
    drive_with_frames,
    drive_with_frames_mut,
    drive_with_frames_with_capacity,
    drive_with_frames_with_capacity_mut,
};
pub use payloads::{drive_with_bincode, drive_with_payloads, drive_with_payloads_mut};
pub use runtime::{run_app, run_with_duplex_server};
pub use wireframe::testkit::{
    MAX_SLOW_IO_CAPACITY,
    SlowIoConfig,
    SlowIoPacing,
    drive_with_fragment_frames,
    drive_with_fragments,
    drive_with_fragments_mut,
    drive_with_fragments_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_slow_codec_frames,
    drive_with_slow_codec_payloads,
    drive_with_slow_frames,
    drive_with_slow_payloads,
};