xmodem 0.4.0

An implementation of the XMODEM file-transfer protocol.
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

//! Test against the `sx` program, and itself
extern crate rand;
extern crate tempfile;
extern crate xmodem;

use rand::{RngCore, rng};
use std::io::{self, Read, Seek, Write};
use std::process::{ChildStdin, ChildStdout, Command, Stdio};
use tempfile::NamedTempFile;
use xmodem::{BlockLength, Checksum, Xmodem};

struct ChildStdInOut {
    stdin: ChildStdin,
    stdout: ChildStdout,
}

impl Read for ChildStdInOut {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        self.stdout.read(buf)
    }
}

impl Write for ChildStdInOut {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        self.stdin.write(buf)
    }

    fn flush(&mut self) -> io::Result<()> {
        self.stdin.flush()
    }
}

#[cfg(test)]
fn xmodem_recv(checksum_mode: Checksum, block_length: BlockLength, data_len: usize) {
    let mut data = vec![0; data_len];
    rng().fill_bytes(&mut data);

    let mut send_file = NamedTempFile::new().unwrap();
    send_file.write_all(&data).unwrap();

    let mut send_builder = Command::new("sb");
    send_builder.arg("--xmodem");
    match block_length {
        BlockLength::OneK => {
            send_builder.arg("--1k");
        }
        _ => {}
    }
    let send = send_builder
        .arg(send_file.path())
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .stderr(Stdio::null())
        .spawn()
        .unwrap();

    let tx_stream = send.stdin.unwrap();
    let rx_stream = send.stdout.unwrap();
    let mut serial_dev = ChildStdInOut {
        stdin: tx_stream,
        stdout: rx_stream,
    };

    let mut xmodem = Xmodem::new();
    let mut recv_data = Vec::new();
    let bytes = xmodem
        .recv(&mut serial_dev, &mut recv_data, checksum_mode)
        .unwrap();
    assert_eq!(bytes, (data_len + 127) & !127);

    let mut sent_data = Vec::new();
    send_file.seek(std::io::SeekFrom::Start(0)).unwrap();
    send_file.read_to_end(&mut sent_data).unwrap();
    let mut padded_data = sent_data.clone();
    for _ in 0..(128 - sent_data.len() % 128) {
        padded_data.push(0x1a);
    }
    assert_eq!(padded_data, recv_data);
}

#[test]
fn xmodem_recv_standard() {
    xmodem_recv(Checksum::Standard, BlockLength::Standard, 2000);
}

#[test]
fn xmodem_recv_crc() {
    xmodem_recv(Checksum::CRC16, BlockLength::Standard, 2000);
}

#[test]
fn xmodem_recv_1k_crc() {
    xmodem_recv(Checksum::CRC16, BlockLength::OneK, 8500);
}

#[test]
fn xmodem_recv_long() {
    xmodem_recv(Checksum::CRC16, BlockLength::Standard, 50000);
}

#[test]
fn xmodem_send_standard() {
    let data_len = 2000;
    let mut data = vec![0; data_len];
    rng().fill_bytes(&mut data);

    let mut recv_file = NamedTempFile::new().unwrap();
    let recv = Command::new("rb")
        .arg("--xmodem")
        .arg(recv_file.path())
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .stderr(Stdio::null())
        .spawn()
        .unwrap();

    let tx_stream = recv.stdin.unwrap();
    let rx_stream = recv.stdout.unwrap();
    let mut serial_dev = ChildStdInOut {
        stdin: tx_stream,
        stdout: rx_stream,
    };

    let mut xmodem = Xmodem::new();
    let bytes = xmodem.send(&mut serial_dev, &mut &data[..]).unwrap();
    assert_eq!(bytes, data_len);

    let mut received_data = Vec::new();
    recv_file.read_to_end(&mut received_data).unwrap();
    let mut padded_data = data.clone();
    for _ in 0..(128 - data.len() % 128) {
        padded_data.push(0x1a);
    }
    assert_eq!(received_data, padded_data);
}

#[test]
fn xmodem_send_crc() {
    let data_len = 2000;
    let mut data = vec![0; data_len];
    rng().fill_bytes(&mut data);

    let mut recv_file = NamedTempFile::new().unwrap();
    let recv = Command::new("rb")
        .arg("--xmodem")
        .arg("--with-crc")
        .arg(recv_file.path())
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .stderr(Stdio::null())
        .spawn()
        .unwrap();

    let tx_stream = recv.stdin.unwrap();
    let rx_stream = recv.stdout.unwrap();
    let mut serial_dev = ChildStdInOut {
        stdin: tx_stream,
        stdout: rx_stream,
    };

    let mut xmodem = Xmodem::new();
    xmodem.send(&mut serial_dev, &mut &data[..]).unwrap();

    let mut received_data = Vec::new();
    recv_file.read_to_end(&mut received_data).unwrap();
    let mut padded_data = data.clone();

    for _ in 0..(128 - data.len() % 128) {
        padded_data.push(0x1a);
    }
    assert_eq!(received_data, padded_data);
}