bacnet-cli 0.14.0

BACnet command-line tool for device discovery, reading, and writing
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
use super::*;
use bacnet_objects::database::ObjectDatabase;
use bacnet_objects::file::FileObject;
use bacnet_server::handlers::{handle_atomic_read_file, handle_atomic_write_file};
use bacnet_services::file::{
    AtomicReadFileAck, AtomicReadFileRequest, AtomicWriteFileRequest, FileReadAckMethod,
};
use bacnet_types::error::Error;
use bytes::BytesMut;
use std::cell::RefCell;
use std::collections::VecDeque;
use std::future::{pending, ready};
use std::path::{Path, PathBuf};
use std::rc::Rc;
use std::sync::atomic::{AtomicU64, Ordering};

static TEMP_ID: AtomicU64 = AtomicU64::new(0);

struct TempDir(PathBuf);

impl TempDir {
    fn new(label: &str) -> Self {
        let path = std::env::temp_dir().join(format!(
            "rusty-bacnet-cli-file-{label}-{}-{}",
            std::process::id(),
            TEMP_ID.fetch_add(1, Ordering::Relaxed)
        ));
        std::fs::create_dir(&path).unwrap();
        Self(path)
    }
}

impl Drop for TempDir {
    fn drop(&mut self) {
        let _ = std::fs::remove_dir_all(&self.0);
    }
}

#[derive(Default)]
struct MemorySink {
    stream: Vec<u8>,
    records: Vec<(i32, Vec<u8>)>,
}

impl FileReadSink for MemorySink {
    fn write_stream(&mut self, data: &[u8]) -> std::io::Result<()> {
        self.stream.extend_from_slice(data);
        Ok(())
    }

    fn write_record(&mut self, index: i32, data: &[u8]) -> std::io::Result<()> {
        self.records.push((index, data.to_vec()));
        Ok(())
    }
}

fn stream_ack(start: i32, data: &[u8], eof: bool) -> AtomicReadFileAck {
    AtomicReadFileAck {
        end_of_file: eof,
        access: FileReadAckMethod::Stream {
            file_start_position: start,
            file_data: data.to_vec(),
        },
    }
}

fn record_ack(start: i32, records: Vec<Vec<u8>>, eof: bool) -> AtomicReadFileAck {
    AtomicReadFileAck {
        end_of_file: eof,
        access: FileReadAckMethod::Record {
            file_start_record: start,
            returned_record_count: records.len() as u32,
            file_record_data: records,
        },
    }
}

#[tokio::test]
async fn stream_retrieval_uses_payload_and_returned_progress_until_eof() {
    let replies = Rc::new(RefCell::new(VecDeque::from([
        Ok(stream_ack(0, &[0x10, 0x20], false)),
        Ok(stream_ack(2, &[0x30], true)),
    ])));
    let requests = Rc::new(RefCell::new(Vec::new()));
    let mut sink = MemorySink::default();
    let replies_for_fetch = Rc::clone(&replies);
    let requests_for_fetch = Rc::clone(&requests);

    let summary = retrieve_windows(FileReadAccess::Stream, 0, 2, &mut sink, move |access| {
        requests_for_fetch.borrow_mut().push(access);
        ready(replies_for_fetch.borrow_mut().pop_front().unwrap())
    })
    .await
    .unwrap();

    assert_eq!(sink.stream, vec![0x10, 0x20, 0x30]);
    assert_eq!(summary.octets, 3);
    assert_eq!(requests.borrow().len(), 2);
    assert!(matches!(
        requests.borrow()[1],
        FileAccessMethod::Stream {
            file_start_position: 2,
            requested_octet_count: 2,
        }
    ));
}

#[tokio::test]
async fn display_payload_limit_rejects_a_progressing_multi_window_overflow() {
    const DISPLAY_LIMIT: usize = 1024 * 1024;
    let mut replies = VecDeque::from([
        Ok(stream_ack(0, &vec![0xAA; DISPLAY_LIMIT], false)),
        Ok(stream_ack(DISPLAY_LIMIT as i32, &[0xBB], true)),
    ]);
    let mut destination = FileReadDestination::create(FileReadAccess::Stream, None).unwrap();

    let error = retrieve_windows(
        FileReadAccess::Stream,
        0,
        DISPLAY_LIMIT as u32,
        &mut destination,
        move |_| ready(replies.pop_front().unwrap()),
    )
    .await
    .unwrap_err();

    assert!(error.to_string().contains("--output"));
    assert_eq!(destination.display_data().len(), DISPLAY_LIMIT);
}

#[tokio::test]
async fn display_payload_limit_accepts_exact_boundary_across_windows() {
    const DISPLAY_LIMIT: usize = 1024 * 1024;
    let half = DISPLAY_LIMIT / 2;
    let mut replies = VecDeque::from([
        Ok(stream_ack(0, &vec![0xAA; half], false)),
        Ok(stream_ack(half as i32, &vec![0xBB; half], true)),
    ]);
    let mut destination = FileReadDestination::create(FileReadAccess::Stream, None).unwrap();

    let summary = retrieve_windows(
        FileReadAccess::Stream,
        0,
        half as u32,
        &mut destination,
        move |_| ready(replies.pop_front().unwrap()),
    )
    .await
    .unwrap();

    assert_eq!(summary.octets, DISPLAY_LIMIT as u64);
    assert_eq!(destination.display_data().len(), DISPLAY_LIMIT);
}

#[tokio::test]
async fn empty_stream_and_record_eof_complete_without_false_progress() {
    let mut stream_sink = MemorySink::default();
    let stream = retrieve_windows(FileReadAccess::Stream, 0, 4, &mut stream_sink, |_| {
        ready(Ok(stream_ack(0, &[], true)))
    })
    .await
    .unwrap();
    assert_eq!(stream.octets, 0);

    let mut record_sink = MemorySink::default();
    let record = retrieve_windows(FileReadAccess::Record, 0, 4, &mut record_sink, |_| {
        ready(Ok(record_ack(0, vec![], true)))
    })
    .await
    .unwrap();
    assert_eq!(record.records, 0);
}

#[tokio::test]
async fn record_retrieval_preserves_boundaries_absolute_names_and_empty_records() {
    let mut sink = MemorySink::default();
    let summary = retrieve_windows(FileReadAccess::Record, 5, 3, &mut sink, |_| {
        ready(Ok(record_ack(
            5,
            vec![vec![0x00, 0xFF], vec![], vec![0x10]],
            true,
        )))
    })
    .await
    .unwrap();

    assert_eq!(summary.records, 3);
    assert_eq!(
        sink.records,
        vec![(5, vec![0x00, 0xFF]), (6, vec![]), (7, vec![0x10])]
    );
    assert_eq!(record_file_name(6), "record-0000000006.bin");
}

#[tokio::test]
async fn record_output_uses_one_deterministically_named_file_per_record() {
    let temp = TempDir::new("record-output");
    let output = temp.0.join("records");
    let mut replies = VecDeque::from([
        Ok(record_ack(7, vec![vec![0x00, 0xFF], vec![]], false)),
        Ok(record_ack(9, vec![vec![0x10]], true)),
    ]);
    let summary = read_file_with(FileReadAccess::Record, 7, 2, Some(&output), move |_| {
        ready(replies.pop_front().unwrap())
    })
    .await
    .unwrap();

    assert_eq!(summary.records, 3);
    assert_eq!(
        std::fs::read(output.join("record-0000000007.bin")).unwrap(),
        vec![0x00, 0xFF]
    );
    assert_eq!(
        std::fs::read(output.join("record-0000000008.bin")).unwrap(),
        Vec::<u8>::new()
    );
    assert_eq!(
        std::fs::read(output.join("record-0000000009.bin")).unwrap(),
        vec![0x10]
    );

    let empty_output = temp.0.join("empty-records");
    read_file_with(FileReadAccess::Record, 0, 2, Some(&empty_output), |_| {
        ready(Ok(record_ack(0, vec![], true)))
    })
    .await
    .unwrap();
    assert!(empty_output.is_dir());
    assert!(std::fs::read_dir(empty_output).unwrap().next().is_none());
}

#[test]
fn invalid_start_count_and_record_output_fail_before_fetch_or_staging() {
    assert!(validate_file_read_options(FileReadAccess::Stream, -1, 1, None).is_err());
    assert!(validate_file_read_options(FileReadAccess::Stream, 0, 0, None).is_err());
    assert!(validate_file_read_options(FileReadAccess::Record, 0, 1, None).is_err());
}

#[tokio::test]
async fn malformed_cursor_windows_fail_before_writes() {
    let mut sink = MemorySink::default();
    let error = retrieve_windows(FileReadAccess::Stream, 2, 2, &mut sink, |_| {
        ready(Ok(stream_ack(2, &[], false)))
    })
    .await
    .unwrap_err();
    assert!(error.to_string().contains("progress"));
    assert!(sink.stream.is_empty());

    let error = retrieve_windows(FileReadAccess::Stream, i32::MAX, 1, &mut sink, |_| {
        ready(Ok(stream_ack(i32::MAX, &[0xAA], true)))
    })
    .await
    .unwrap_err();
    assert!(error.to_string().contains("range"));
    assert!(sink.stream.is_empty());
}

#[tokio::test]
async fn terminal_stream_and_record_gaps_and_overlaps_fail_before_bad_window_write() {
    for returned_start in [1, 3] {
        let mut replies = VecDeque::from([
            Ok(stream_ack(0, &[0x10, 0x20], false)),
            Ok(stream_ack(returned_start, &[0x30], true)),
        ]);
        let mut sink = MemorySink::default();
        let error = retrieve_windows(FileReadAccess::Stream, 0, 2, &mut sink, move |_| {
            ready(replies.pop_front().unwrap())
        })
        .await
        .unwrap_err();
        assert!(error.to_string().contains("cursor-continuity"));
        assert_eq!(sink.stream, vec![0x10, 0x20]);
    }

    for returned_start in [5, 7] {
        let mut replies = VecDeque::from([
            Ok(record_ack(5, vec![vec![0x10]], false)),
            Ok(record_ack(returned_start, vec![vec![0x20]], true)),
        ]);
        let mut sink = MemorySink::default();
        let error = retrieve_windows(FileReadAccess::Record, 5, 1, &mut sink, move |_| {
            ready(replies.pop_front().unwrap())
        })
        .await
        .unwrap_err();
        assert!(error.to_string().contains("cursor-continuity"));
        assert_eq!(sink.records, vec![(5, vec![0x10])]);
    }
}

#[tokio::test]
async fn zero_non_eof_arm_mismatch_oversize_and_cardinality_fail_before_writes() {
    let cases = [
        AtomicReadFileAck {
            end_of_file: false,
            access: FileReadAckMethod::Stream {
                file_start_position: 0,
                file_data: vec![],
            },
        },
        record_ack(0, vec![vec![1]], true),
        stream_ack(0, &[1, 2], true),
    ];
    for ack in cases {
        let mut sink = MemorySink::default();
        assert!(
            retrieve_windows(FileReadAccess::Stream, 0, 1, &mut sink, |_| {
                ready(Ok(ack.clone()))
            })
            .await
            .is_err()
        );
        assert!(sink.stream.is_empty());
    }

    let malformed = AtomicReadFileAck {
        end_of_file: true,
        access: FileReadAckMethod::Record {
            file_start_record: 0,
            returned_record_count: 2,
            file_record_data: vec![vec![1]],
        },
    };
    let mut sink = MemorySink::default();
    assert!(
        retrieve_windows(FileReadAccess::Record, 0, 2, &mut sink, |_| {
            ready(Ok(malformed.clone()))
        })
        .await
        .is_err()
    );
    assert!(sink.records.is_empty());
}

fn only_directory_entry(path: &Path) -> Option<PathBuf> {
    let mut entries = std::fs::read_dir(path).unwrap();
    let first = entries.next().transpose().unwrap().map(|e| e.path());
    assert!(entries.next().is_none());
    first
}

async fn assert_cursor_failure_cleans_staging(
    label: &str,
    access: FileReadAccess,
    start: i32,
    replies: VecDeque<Result<AtomicReadFileAck, Error>>,
) {
    let temp = TempDir::new(label);
    let output = temp.0.join("output");
    let mut replies = replies;
    let result = read_file_with(access, start, 2, Some(&output), move |_| {
        ready(replies.pop_front().unwrap())
    })
    .await;

    assert!(result.is_err());
    assert!(!output.exists(), "{label}: final target must stay absent");
    assert!(only_directory_entry(&temp.0).is_none(), "{label}");
}

#[tokio::test]
async fn cursor_continuity_failures_remove_staging_and_do_not_publish() {
    for (label, returned_start) in [("stream-overlap", 1), ("stream-gap", 3)] {
        assert_cursor_failure_cleans_staging(
            label,
            FileReadAccess::Stream,
            0,
            VecDeque::from([
                Ok(stream_ack(0, &[0x10, 0x20], false)),
                Ok(stream_ack(returned_start, &[0x30], true)),
            ]),
        )
        .await;
    }

    for (label, returned_start) in [("record-overlap", 5), ("record-gap", 7)] {
        assert_cursor_failure_cleans_staging(
            label,
            FileReadAccess::Record,
            5,
            VecDeque::from([
                Ok(record_ack(5, vec![vec![0x10]], false)),
                Ok(record_ack(returned_start, vec![vec![0x20]], true)),
            ]),
        )
        .await;
    }
}

#[tokio::test]
async fn collision_is_refused_before_fetch_and_existing_target_is_untouched() {
    let temp = TempDir::new("collision");
    let output = temp.0.join("file.bin");
    std::fs::write(&output, b"existing").unwrap();
    let calls = Rc::new(RefCell::new(0));
    let calls_for_fetch = Rc::clone(&calls);

    let result = read_file_with(FileReadAccess::Stream, 0, 1, Some(&output), move |_| {
        *calls_for_fetch.borrow_mut() += 1;
        ready(Ok(stream_ack(0, &[1], true)))
    })
    .await;
    assert!(result.is_err());
    assert_eq!(*calls.borrow(), 0);
    assert_eq!(std::fs::read(&output).unwrap(), b"existing");
    assert_eq!(only_directory_entry(&temp.0), Some(output));
}

#[tokio::test]
async fn remote_decode_and_cursor_failures_remove_staging() {
    for label in ["remote", "decode", "cursor"] {
        let temp = TempDir::new(label);
        let output = temp.0.join("file.bin");
        let mut replies = match label {
            "remote" => VecDeque::from([Err(Error::decoding(0, "remote failure"))]),
            "decode" => VecDeque::from([
                Ok(stream_ack(0, &[1], false)),
                Err(Error::decoding(0, "malformed ACK")),
            ]),
            "cursor" => VecDeque::from([Ok(stream_ack(0, &[], false))]),
            _ => unreachable!(),
        };

        let result = read_file_with(FileReadAccess::Stream, 0, 1, Some(&output), move |_| {
            ready(replies.pop_front().unwrap())
        })
        .await;
        assert!(result.is_err(), "{label}");
        assert!(!output.exists(), "{label}: final target must stay absent");
        assert!(only_directory_entry(&temp.0).is_none(), "{label}");
    }
}

#[tokio::test]
async fn record_write_failure_removes_staging() {
    let temp = TempDir::new("write");
    let output = temp.0.join("records");
    let root = temp.0.clone();

    let result = read_file_with(FileReadAccess::Record, 0, 1, Some(&output), move |_| {
        let staging = only_directory_entry(&root).expect("staging directory must exist");
        std::fs::remove_dir_all(staging).unwrap();
        ready(Ok(record_ack(0, vec![vec![1]], true)))
    })
    .await;

    assert!(result.is_err());
    assert!(!output.exists(), "final target must stay absent");
    assert!(only_directory_entry(&temp.0).is_none());
}

#[tokio::test]
async fn cancellation_removes_unpublished_staging() {
    let temp = TempDir::new("cancel");
    let output = temp.0.join("file.bin");
    let result = tokio::time::timeout(
        std::time::Duration::from_millis(20),
        read_file_with(FileReadAccess::Stream, 0, 1, Some(&output), |_| {
            pending::<Result<AtomicReadFileAck, Error>>()
        }),
    )
    .await;
    assert!(result.is_err());
    assert!(!output.exists());
    assert!(only_directory_entry(&temp.0).is_none());
}

#[tokio::test]
async fn command_layer_server_handler_round_trip_spans_multiple_windows() {
    let temp = TempDir::new("server-round-trip");
    let output = temp.0.join("payload.bin");
    let file_oid = ObjectIdentifier::new(ObjectType::FILE, 1).unwrap();
    let payload = b"multi-window payload".to_vec();
    let mut db = ObjectDatabase::new();
    db.add(Box::new(
        FileObject::new(1, "FILE-1", "application/octet-stream").unwrap(),
    ))
    .unwrap();

    let write = AtomicWriteFileRequest {
        file_identifier: file_oid,
        access: FileWriteAccessMethod::Stream {
            file_start_position: 0,
            file_data: payload.clone(),
        },
    };
    let mut write_wire = BytesMut::new();
    write.encode(&mut write_wire);
    handle_atomic_write_file(&mut db, &write_wire, &mut BytesMut::new()).unwrap();

    let db = Rc::new(db);
    let db_for_fetch = Rc::clone(&db);
    let summary = read_file_with(FileReadAccess::Stream, 0, 3, Some(&output), move |access| {
        let request = AtomicReadFileRequest {
            file_identifier: file_oid,
            access,
        };
        let mut request_wire = BytesMut::new();
        request.encode(&mut request_wire);
        let mut ack_wire = BytesMut::new();
        let result = handle_atomic_read_file(&db_for_fetch, &request_wire, &mut ack_wire)
            .and_then(|()| AtomicReadFileAck::decode(&ack_wire));
        ready(result)
    })
    .await
    .unwrap();

    assert!(summary.windows > 1);
    assert_eq!(std::fs::read(output).unwrap(), payload);
}