wireframe 0.3.0

Simplify building servers and clients for custom binary protocols.
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

//! Step definitions for wireframe client tracing behavioural tests.

use rstest_bdd_macros::{given, then, when};
use wireframe::client::TracingConfig;

use crate::fixtures::client_tracing::{ClientTracingWorld, TestResult};

// ---------------------------------------------------------------------------
// Given steps
// ---------------------------------------------------------------------------

#[given("a running echo server for tracing tests")]
fn given_echo_server(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.start_echo_server())
}

#[given("a client with connect timing enabled")]
fn given_client_with_connect_timing(client_tracing_world: &mut ClientTracingWorld) {
    client_tracing_world.set_tracing_config(TracingConfig::default().with_connect_timing(true));
}

#[given("a connected tracing client with send timing enabled")]
fn given_connected_send_timing(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.start_echo_server())?;
    client_tracing_world.set_tracing_config(TracingConfig::default().with_send_timing(true));
    rt.block_on(client_tracing_world.connect())
}

#[given("a connected tracing client with receive timing enabled")]
fn given_connected_receive_timing(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.start_echo_server())?;
    client_tracing_world.set_tracing_config(TracingConfig::default().with_receive_timing(true));
    rt.block_on(client_tracing_world.connect())
}

#[given("a connected tracing client with default config")]
fn given_connected_default_config(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.start_echo_server())?;
    rt.block_on(client_tracing_world.connect())
}

#[given("a connected tracing client with close timing enabled")]
fn given_connected_close_timing(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.start_echo_server())?;
    client_tracing_world.set_tracing_config(TracingConfig::default().with_close_timing(true));
    rt.block_on(client_tracing_world.connect())
}

// ---------------------------------------------------------------------------
// When steps
// ---------------------------------------------------------------------------

#[when("the client connects to the server")]
fn when_client_connects(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.connect())
}

#[when("the client sends an envelope via the tracing client")]
fn when_client_sends(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.send_envelope())
}

#[when("the client sends and receives via the tracing client")]
fn when_client_sends_and_receives(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.send_and_receive())
}

#[when("the tracing client closes the connection")]
fn when_client_closes(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let rt = client_tracing_world.handle()?;
    rt.block_on(client_tracing_world.close_connection());
    Ok(())
}

// ---------------------------------------------------------------------------
// Then steps
// ---------------------------------------------------------------------------

#[then("the tracing output contains \"client.connect\"")]
fn then_output_contains_connect(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    client_tracing_world.assert_output_contains("client.connect")
}

#[then("the tracing output contains the peer address")]
fn then_output_contains_peer_address(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    let addr = client_tracing_world.peer_addr_string();
    client_tracing_world.assert_output_contains(&addr)
}

#[then("the tracing output contains \"client.send\"")]
fn then_output_contains_send(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    client_tracing_world.assert_output_contains("client.send")
}

#[then("the tracing output contains \"frame.bytes\"")]
fn then_output_contains_frame_bytes(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    client_tracing_world.assert_output_contains("frame.bytes")
}

#[then("the tracing output contains \"client.receive\"")]
fn then_output_contains_receive(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    client_tracing_world.assert_output_contains("client.receive")
}

#[then("the tracing output contains \"elapsed_us\"")]
fn then_output_contains_elapsed_us(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    client_tracing_world.assert_output_contains("elapsed_us")
}

#[then("the tracing output does not contain \"elapsed_us\"")]
fn then_output_not_contains_elapsed_us(
    client_tracing_world: &mut ClientTracingWorld,
) -> TestResult {
    client_tracing_world.assert_output_not_contains("elapsed_us")
}

#[then("the tracing output contains \"client.close\"")]
fn then_output_contains_close(client_tracing_world: &mut ClientTracingWorld) -> TestResult {
    client_tracing_world.assert_output_contains("client.close")
}