medius 3.4.6

Rust library for Medius, replacement firmware for the MAKCU box
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

use std::sync::Arc;
use std::time::Duration;

use std::time::Instant;

use crate::Device;
use crate::link::reconnect::probe_clip;
use crate::protocol::opcode::Q_CLIP;
use crate::protocol::{FrameType, encode};
use crate::transport::Disconnected;
use crate::transport::mock::MockTransport;
use crate::types::{
    Button, ClipAction, ClipBuilder, ClipPacketTrigger, ClipTrigger, Direction, Edge, LogLevel,
    TrafficClass,
};

#[test]
fn transport_swap_resets_decoder() {
    let mock_a = Arc::new(MockTransport::new());
    let device = Device::from_transport_with_cadence(mock_a.clone(), Duration::from_secs(60));
    let rx = device.logs();

    let partial = encode(FrameType::Log, 0, &[2, b'o', b'l', b'd']).unwrap();
    let cut = partial.len() / 2;
    mock_a.push_bytes(&partial[..cut]);
    std::thread::sleep(Duration::from_millis(20));

    let mock_b = Arc::new(MockTransport::new());
    device.link.transport_slot().swap(mock_b.clone());
    mock_b.push_frame(FrameType::Log, 0, &[2, b'n', b'e', b'w']);

    let line = rx
        .recv_timeout(Duration::from_secs(1))
        .expect("the post-swap LOG must decode cleanly");
    assert_eq!(line.level, LogLevel::Info);
    assert_eq!(line.text, "new");
}

// RESP(CLIP) with `total` bytes loaded, nothing held and no triggers of either kind.
fn clip_reply(total: u32) -> Vec<u8> {
    let mut p = vec![0u8; 31];
    p[0] = Q_CLIP;
    p[6..10].copy_from_slice(&total.to_le_bytes());
    p.extend_from_slice(&[0, 0, 0, 0]);
    p
}

fn answering(replies: Vec<Vec<u8>>) -> MockTransport {
    MockTransport::with_responder(move |ty, seq, _| {
        let mut out = Vec::new();
        if ty == FrameType::Query {
            for r in &replies {
                out.extend(encode(FrameType::Resp, seq, r).unwrap());
            }
        }
        out
    })
}

// A reconnect reads the box's clip off the reopened port before the reader thread is on it.
#[test]
fn the_clip_probe_takes_the_first_reply_for_its_selector() {
    // A reply for another selector ahead of it is some other query's.
    let other = vec![1u8, 7, 3, 4, 1];
    let got = probe_clip(&answering(vec![other, clip_reply(40)])).expect("a clip reply");
    assert_eq!(got.0.total, 40);

    // A later reply never replaces the one already taken, readable or not.
    let got = probe_clip(&answering(vec![
        clip_reply(40),
        clip_reply(9),
        vec![Q_CLIP, 0],
    ]))
    .expect("the first reply stands");
    assert_eq!(got.0.total, 40);
}

// The reconnect adopts what the probe reads; a packet trigger the box holds keeps the keepalive
// running by itself.
#[test]
fn the_clip_probe_reads_a_packet_trigger_the_reconnect_adopts() {
    let mut reply = clip_reply(0);
    *reply.last_mut().unwrap() = 1;
    reply.extend_from_slice(&[
        0x04, 0x02, 0x00, 0x01, 0x00, 0x04, 0x01, 0x02, 0x09, 0x00, 0x07, 0x20, 0xFF, 0x20,
    ]);
    let (status, settings) = probe_clip(&answering(vec![reply])).expect("a clip reply");
    let held = ClipPacketTrigger::new(TrafficClass::HidIn, 2, Direction::IN, ClipAction::Start)
        .matching([0x07, 0x20], [0xFF, 0x20])
        .once_per_run(1);
    assert_eq!(settings.packet_triggers.len(), 1);
    assert_eq!(settings.packet_triggers[0].trigger, held);
    assert_eq!(settings.packet_triggers[0].hits, 9);

    let mock = Arc::new(MockTransport::new());
    let device = Device::from_transport_with_cadence(mock, Duration::from_secs(60));
    let idle = || device.link.desired().lock().is_idle();
    device.link.desired().lock().clip_adopt(&status, &settings);
    assert!(!idle(), "the adopted trigger is held");
    // The adopted key is the one the caller's trigger names, so its unbind lets the keepalive idle.
    device.clip().unbind_packet(&held).unwrap();
    assert!(idle());
}

// A box that replies in an unreadable shape does so to every re-send, so the probe ends on the
// first reply and the reconnect doesn't wait out the deadline.
#[test]
fn a_clip_reply_the_crate_cannot_read_ends_the_probe_at_once() {
    let mut older = vec![0u8; 25];
    older[0] = Q_CLIP;
    older.extend_from_slice(&[0, 0, 0]);
    let start = Instant::now();
    assert!(probe_clip(&answering(vec![older])).is_none());
    assert!(
        start.elapsed() < Duration::from_millis(300),
        "{:?}",
        start.elapsed()
    );
}

// Clip state is recorded once the frame is sent, so a call that failed on a dropped link leaves
// nothing for the keepalive.
#[test]
fn a_clip_call_that_never_went_out_records_nothing() {
    let mock = Arc::new(MockTransport::new());
    let device = Device::from_transport_with_cadence(mock.clone(), Duration::from_secs(60));
    let clip = device.clip();
    let idle = || device.link.desired().lock().is_idle();
    let mut one = ClipBuilder::new();
    one.move_by(1, 0);
    let trigger = ClipTrigger::new(Button::SIDE1, Edge::Press, ClipAction::Start);
    let packet = ClipPacketTrigger::new(TrafficClass::Emit, 1, Direction::IN, ClipAction::Start);

    device.link.transport_slot().swap(Arc::new(Disconnected));
    assert!(clip.append(&one).is_err());
    assert!(clip.set_ride(true).is_err());
    assert!(clip.bind(trigger).is_err());
    assert!(clip.bind_packet(&packet).is_err());
    assert!(idle());

    device.link.transport_slot().swap(mock.clone());
    clip.append(&one).unwrap();
    device.link.transport_slot().swap(Arc::new(Disconnected));
    assert!(clip.clear().is_err());
    assert!(
        !idle(),
        "a clear that never went out leaves the clip loaded"
    );

    device.link.transport_slot().swap(mock.clone());
    clip.clear().unwrap();
    assert!(idle());
    clip.bind(trigger).unwrap();
    device.link.transport_slot().swap(Arc::new(Disconnected));
    assert!(clip.unbind(Button::SIDE1, Edge::Press).is_err());
    assert!(clip.clear_triggers().is_err());
    assert!(
        !idle(),
        "an unbind that never went out leaves the trigger bound"
    );

    // The same for a packet trigger, and one clear that was sent forgets both kinds.
    device.link.transport_slot().swap(mock.clone());
    clip.unbind(Button::SIDE1, Edge::Press).unwrap();
    clip.bind_packet(&packet).unwrap();
    assert!(!idle());
    device.link.transport_slot().swap(Arc::new(Disconnected));
    assert!(clip.unbind_packet(&packet).is_err());
    assert!(clip.clear_triggers().is_err());
    assert!(
        !idle(),
        "an unbind that never went out leaves the packet trigger bound"
    );
    device.link.transport_slot().swap(mock);
    clip.bind(trigger).unwrap();
    clip.clear_triggers().unwrap();
    assert!(idle());
}

// RESP(VERSION) for a box on `proto` with base MAC `mac`.
fn version_reply(proto: u8, mac: [u8; 6]) -> Vec<u8> {
    let mut p = vec![crate::protocol::opcode::Q_VERSION, proto, 3, 4, 0];
    p.extend_from_slice(&mac);
    p
}

// The same box after a reflash: every other query gets an unreadable reply, ending that probe at
// once.
fn reflashed(proto: u8, mac: [u8; 6]) -> Arc<dyn crate::transport::Transport> {
    Arc::new(MockTransport::with_responder(
        move |ty, seq, payload| match (ty, payload.first()) {
            (FrameType::Query, Some(&crate::protocol::opcode::Q_VERSION)) => {
                encode(FrameType::Resp, seq, &version_reply(proto, mac)).unwrap()
            }
            (FrameType::Query, Some(&what)) => encode(FrameType::Resp, seq, &[what]).unwrap(),
            _ => Vec::new(),
        },
    ))
}

#[test]
fn a_rescan_refuses_the_box_back_on_another_protocol() {
    let mac = [0x5A, 0x4E, 0x00, 0x11, 0x1E, 0x28];
    let device = Device::from_transport_with_cadence(
        Arc::new(MockTransport::new()),
        Duration::from_secs(60),
    );
    device
        .link
        .set_identity(crate::link::reconnect::BoxIdentity { serial: None, mac });

    // v3.4.1 firmware reports protocol 8, and a later one 10. Neither is taken back.
    for proto in [8, crate::PROTO_VER + 1] {
        let port = reflashed(proto, mac);
        let err = device
            .link
            .adopt_reopened(vec![("/dev/ttyACM0".into(), Arc::clone(&port))])
            .unwrap_err();
        assert!(
            matches!(err, crate::Error::BadProtoVer { got } if got == proto),
            "{proto}: {err:?}"
        );
        assert_eq!(Arc::strong_count(&port), 1, "{proto}: the port was adopted");
        assert_eq!(device.counters().reconnects, 0);
    }

    // On this build's protocol the same box is taken back.
    let port = reflashed(crate::PROTO_VER, mac);
    device
        .link
        .adopt_reopened(vec![("/dev/ttyACM0".into(), Arc::clone(&port))])
        .expect("the box on this build's protocol is adopted");
    assert_eq!(device.counters().reconnects, 1);
}