test: add CI, RingBuffer tests, core proptest, RAII lua fixtures
This commit is contained in:
34
.github/workflows/ci.yml
vendored
Normal file
34
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Install Linux system dependencies
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y libudev-dev libxkbcommon-dev libxcb1-dev libxcb-icccm4-dev libxcb-shape0-dev libxcb-xfixes0-dev libgl1-mesa-dev libgtk-3-dev
|
||||||
|
|
||||||
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
|
with:
|
||||||
|
components: rustfmt, clippy
|
||||||
|
|
||||||
|
- uses: Swatinem/rust-cache@v2
|
||||||
|
|
||||||
|
- name: Check formatting
|
||||||
|
run: cargo fmt --check
|
||||||
|
|
||||||
|
- name: Clippy
|
||||||
|
run: cargo clippy --workspace --all-targets -- -D warnings
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: cargo test --workspace
|
||||||
134
Cargo.lock
generated
134
Cargo.lock
generated
@@ -432,15 +432,30 @@ version = "1.5.1"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
|
checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "bit-set"
|
||||||
|
version = "0.8.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "08807e080ed7f9d5433fa9b275196cfc35414f66a0c79d864dc51a0d825231a3"
|
||||||
|
dependencies = [
|
||||||
|
"bit-vec 0.8.0",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bit-set"
|
name = "bit-set"
|
||||||
version = "0.9.1"
|
version = "0.9.1"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "34ddef2995421ab6a5c779542c81ee77c115206f4ad9d5a8e05f4ff49716a3dd"
|
checksum = "34ddef2995421ab6a5c779542c81ee77c115206f4ad9d5a8e05f4ff49716a3dd"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"bit-vec",
|
"bit-vec 0.9.1",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "bit-vec"
|
||||||
|
version = "0.8.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "5e764a1d40d510daf35e07be9eb06e75770908c27d411ee6c92109c9840eaaf7"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bit-vec"
|
name = "bit-vec"
|
||||||
version = "0.9.1"
|
version = "0.9.1"
|
||||||
@@ -1117,6 +1132,12 @@ dependencies = [
|
|||||||
"miniz_oxide",
|
"miniz_oxide",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "fnv"
|
||||||
|
version = "1.0.7"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "foldhash"
|
name = "foldhash"
|
||||||
version = "0.1.5"
|
version = "0.1.5"
|
||||||
@@ -2044,7 +2065,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
|||||||
checksum = "0dd91265cc2454558f659b3b4b9640f0ddb8cc6521277f166b8a8c181c898079"
|
checksum = "0dd91265cc2454558f659b3b4b9640f0ddb8cc6521277f166b8a8c181c898079"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"arrayvec",
|
"arrayvec",
|
||||||
"bit-set",
|
"bit-set 0.9.1",
|
||||||
"bitflags 2.12.1",
|
"bitflags 2.12.1",
|
||||||
"cfg-if",
|
"cfg-if",
|
||||||
"cfg_aliases",
|
"cfg_aliases",
|
||||||
@@ -2680,6 +2701,7 @@ dependencies = [
|
|||||||
"pipeview-core",
|
"pipeview-core",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
|
"tempfile",
|
||||||
"thiserror 2.0.18",
|
"thiserror 2.0.18",
|
||||||
"tokio",
|
"tokio",
|
||||||
"tracing",
|
"tracing",
|
||||||
@@ -2694,6 +2716,7 @@ dependencies = [
|
|||||||
"bytes",
|
"bytes",
|
||||||
"hex",
|
"hex",
|
||||||
"nom 8.0.0",
|
"nom 8.0.0",
|
||||||
|
"proptest",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"serialport",
|
"serialport",
|
||||||
@@ -2799,6 +2822,15 @@ dependencies = [
|
|||||||
"zerovec",
|
"zerovec",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "ppv-lite86"
|
||||||
|
version = "0.2.21"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9"
|
||||||
|
dependencies = [
|
||||||
|
"zerocopy",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "presser"
|
name = "presser"
|
||||||
version = "0.3.1"
|
version = "0.3.1"
|
||||||
@@ -2861,12 +2893,37 @@ version = "1.0.18"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "3d595e54a326bc53c1c197b32d295e14b169e3cfeaa8dc82b529f947fba6bcf5"
|
checksum = "3d595e54a326bc53c1c197b32d295e14b169e3cfeaa8dc82b529f947fba6bcf5"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "proptest"
|
||||||
|
version = "1.11.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "4b45fcc2344c680f5025fe57779faef368840d0bd1f42f216291f0dc4ace4744"
|
||||||
|
dependencies = [
|
||||||
|
"bit-set 0.8.0",
|
||||||
|
"bit-vec 0.8.0",
|
||||||
|
"bitflags 2.12.1",
|
||||||
|
"num-traits",
|
||||||
|
"rand",
|
||||||
|
"rand_chacha",
|
||||||
|
"rand_xorshift",
|
||||||
|
"regex-syntax",
|
||||||
|
"rusty-fork",
|
||||||
|
"tempfile",
|
||||||
|
"unarray",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pxfm"
|
name = "pxfm"
|
||||||
version = "0.1.29"
|
version = "0.1.29"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "e0c5ccf5294c6ccd63a74f1565028353830a9c2f5eb0c682c355c471726a6e3f"
|
checksum = "e0c5ccf5294c6ccd63a74f1565028353830a9c2f5eb0c682c355c471726a6e3f"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "quick-error"
|
||||||
|
version = "1.2.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "quick-error"
|
name = "quick-error"
|
||||||
version = "2.0.1"
|
version = "2.0.1"
|
||||||
@@ -2904,6 +2961,44 @@ version = "6.0.0"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf"
|
checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "rand"
|
||||||
|
version = "0.9.5"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "b9ef1d0d795eb7d84685bca4f72f3649f064e6641543d3a8c415898726a57b41"
|
||||||
|
dependencies = [
|
||||||
|
"rand_chacha",
|
||||||
|
"rand_core",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "rand_chacha"
|
||||||
|
version = "0.9.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb"
|
||||||
|
dependencies = [
|
||||||
|
"ppv-lite86",
|
||||||
|
"rand_core",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "rand_core"
|
||||||
|
version = "0.9.5"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c"
|
||||||
|
dependencies = [
|
||||||
|
"getrandom 0.3.4",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "rand_xorshift"
|
||||||
|
version = "0.4.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "513962919efc330f829edb2535844d1b912b0fbe2ca165d613e4e8788bb05a5a"
|
||||||
|
dependencies = [
|
||||||
|
"rand_core",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "range-alloc"
|
name = "range-alloc"
|
||||||
version = "0.1.5"
|
version = "0.1.5"
|
||||||
@@ -3053,6 +3148,18 @@ version = "1.0.22"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
|
checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "rusty-fork"
|
||||||
|
version = "0.3.1"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "cc6bf79ff24e648f6da1f8d1f011e9cac26491b619e6b9280f2b47f1774e6ee2"
|
||||||
|
dependencies = [
|
||||||
|
"fnv",
|
||||||
|
"quick-error 1.2.3",
|
||||||
|
"tempfile",
|
||||||
|
"wait-timeout",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "same-file"
|
name = "same-file"
|
||||||
version = "1.0.6"
|
version = "1.0.6"
|
||||||
@@ -3477,7 +3584,7 @@ dependencies = [
|
|||||||
"fax",
|
"fax",
|
||||||
"flate2",
|
"flate2",
|
||||||
"half",
|
"half",
|
||||||
"quick-error",
|
"quick-error 2.0.1",
|
||||||
"weezl",
|
"weezl",
|
||||||
"zune-jpeg",
|
"zune-jpeg",
|
||||||
]
|
]
|
||||||
@@ -3683,6 +3790,12 @@ dependencies = [
|
|||||||
"windows-sys 0.61.2",
|
"windows-sys 0.61.2",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "unarray"
|
||||||
|
version = "0.1.4"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "eaea85b334db583fe3274d12b4cd1880032beab409c0d774be044d4480ab9a94"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "unescaper"
|
name = "unescaper"
|
||||||
version = "0.1.8"
|
version = "0.1.8"
|
||||||
@@ -3793,6 +3906,15 @@ dependencies = [
|
|||||||
"memchr",
|
"memchr",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "wait-timeout"
|
||||||
|
version = "0.2.1"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "09ac3b126d3914f9849036f826e054cbabdc8519970b8998ddaf3b5bd3c65f11"
|
||||||
|
dependencies = [
|
||||||
|
"libc",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "walkdir"
|
name = "walkdir"
|
||||||
version = "2.5.0"
|
version = "2.5.0"
|
||||||
@@ -4130,8 +4252,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
|||||||
checksum = "02da3ad1b568337f25513b317870960ef87073ea0945502e44b864b67a8c77b7"
|
checksum = "02da3ad1b568337f25513b317870960ef87073ea0945502e44b864b67a8c77b7"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"arrayvec",
|
"arrayvec",
|
||||||
"bit-set",
|
"bit-set 0.9.1",
|
||||||
"bit-vec",
|
"bit-vec 0.9.1",
|
||||||
"bitflags 2.12.1",
|
"bitflags 2.12.1",
|
||||||
"bytemuck",
|
"bytemuck",
|
||||||
"cfg_aliases",
|
"cfg_aliases",
|
||||||
@@ -4202,7 +4324,7 @@ dependencies = [
|
|||||||
"android_system_properties",
|
"android_system_properties",
|
||||||
"arrayvec",
|
"arrayvec",
|
||||||
"ash",
|
"ash",
|
||||||
"bit-set",
|
"bit-set 0.9.1",
|
||||||
"bitflags 2.12.1",
|
"bitflags 2.12.1",
|
||||||
"block2 0.6.2",
|
"block2 0.6.2",
|
||||||
"bytemuck",
|
"bytemuck",
|
||||||
|
|||||||
@@ -15,3 +15,4 @@ thiserror = { workspace = true }
|
|||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
tokio = { workspace = true, features = ["full"] }
|
tokio = { workspace = true, features = ["full"] }
|
||||||
tracing-subscriber = { workspace = true }
|
tracing-subscriber = { workspace = true }
|
||||||
|
tempfile = "3"
|
||||||
|
|||||||
@@ -57,3 +57,116 @@ impl RingBuffer<DecodedEntry> {
|
|||||||
.collect()
|
.collect()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use crate::event::DecodedEntry;
|
||||||
|
use pipeview_core::protocol::DecodedData;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn push_evicts_oldest_when_limit_reached() {
|
||||||
|
let mut rb = RingBuffer::new(3);
|
||||||
|
rb.push(1);
|
||||||
|
rb.push(2);
|
||||||
|
rb.push(3);
|
||||||
|
rb.push(4);
|
||||||
|
rb.push(5);
|
||||||
|
|
||||||
|
assert_eq!(rb.len(), 3);
|
||||||
|
assert_eq!(rb.get(0), Some(&3));
|
||||||
|
assert_eq!(rb.get(1), Some(&4));
|
||||||
|
assert_eq!(rb.get(2), Some(&5));
|
||||||
|
assert_eq!(rb.get(3), None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn iter_yields_oldest_to_newest() {
|
||||||
|
let mut rb = RingBuffer::new(3);
|
||||||
|
rb.push("a");
|
||||||
|
rb.push("b");
|
||||||
|
rb.push("c");
|
||||||
|
|
||||||
|
let items: Vec<_> = rb.iter().collect();
|
||||||
|
assert_eq!(items, vec![&"a", &"b", &"c"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn clear_empties_buffer() {
|
||||||
|
let mut rb = RingBuffer::new(3);
|
||||||
|
rb.push(1);
|
||||||
|
rb.push(2);
|
||||||
|
rb.clear();
|
||||||
|
|
||||||
|
assert!(rb.is_empty());
|
||||||
|
assert_eq!(rb.len(), 0);
|
||||||
|
assert_eq!(rb.get(0), None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn set_limit_trims_excess() {
|
||||||
|
let mut rb = RingBuffer::new(5);
|
||||||
|
for i in 0..5 {
|
||||||
|
rb.push(i);
|
||||||
|
}
|
||||||
|
rb.set_limit(2);
|
||||||
|
|
||||||
|
assert_eq!(rb.len(), 2);
|
||||||
|
assert_eq!(rb.get(0), Some(&3));
|
||||||
|
assert_eq!(rb.get(1), Some(&4));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn set_limit_can_grow_without_data_loss() {
|
||||||
|
let mut rb = RingBuffer::new(2);
|
||||||
|
rb.push(1);
|
||||||
|
rb.push(2);
|
||||||
|
rb.set_limit(5);
|
||||||
|
|
||||||
|
assert_eq!(rb.len(), 2);
|
||||||
|
assert_eq!(rb.get(0), Some(&1));
|
||||||
|
assert_eq!(rb.get(1), Some(&2));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn drain_recent_respects_count_and_order() {
|
||||||
|
let mut rb = RingBuffer::new(5);
|
||||||
|
for i in 0..5 {
|
||||||
|
rb.push(i);
|
||||||
|
}
|
||||||
|
|
||||||
|
let empty: Vec<i32> = rb.drain_recent(0);
|
||||||
|
assert!(empty.is_empty());
|
||||||
|
|
||||||
|
let last_two = rb.drain_recent(2);
|
||||||
|
assert_eq!(last_two, vec![3, 4]);
|
||||||
|
|
||||||
|
let all = rb.drain_recent(10);
|
||||||
|
assert_eq!(all, vec![0, 1, 2, 3, 4]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn entries_for_pipeline_filters_by_name() {
|
||||||
|
let mut rb = RingBuffer::new(10);
|
||||||
|
rb.push(DecodedEntry {
|
||||||
|
pipeline_name: "a".into(),
|
||||||
|
data: DecodedData::Text("one".into()),
|
||||||
|
});
|
||||||
|
rb.push(DecodedEntry {
|
||||||
|
pipeline_name: "b".into(),
|
||||||
|
data: DecodedData::Text("two".into()),
|
||||||
|
});
|
||||||
|
rb.push(DecodedEntry {
|
||||||
|
pipeline_name: "a".into(),
|
||||||
|
data: DecodedData::Text("three".into()),
|
||||||
|
});
|
||||||
|
|
||||||
|
let a = rb.entries_for_pipeline("a");
|
||||||
|
assert_eq!(a.len(), 2);
|
||||||
|
assert_eq!(a[0].pipeline_name, "a");
|
||||||
|
assert_eq!(a[1].pipeline_name, "a");
|
||||||
|
|
||||||
|
let none = rb.entries_for_pipeline("missing");
|
||||||
|
assert!(none.is_empty());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
|
use std::io::Write;
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
use std::sync::Once;
|
use std::sync::Once;
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
use std::{fs, path::PathBuf};
|
|
||||||
|
|
||||||
use mlua::Lua;
|
use mlua::Lua;
|
||||||
use tokio::io::{AsyncReadExt, AsyncWriteExt};
|
use tokio::io::{AsyncReadExt, AsyncWriteExt};
|
||||||
@@ -17,14 +18,30 @@ fn init_tracing() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn write_temp_lua(name: &str, script: &str) -> PathBuf {
|
struct TempScript {
|
||||||
let nonce = std::time::SystemTime::now()
|
path: PathBuf,
|
||||||
.duration_since(std::time::UNIX_EPOCH)
|
_guard: tempfile::TempPath,
|
||||||
.unwrap()
|
}
|
||||||
.as_nanos();
|
|
||||||
let path = std::env::temp_dir().join(format!("pipeview_{name}_{nonce}.lua"));
|
impl TempScript {
|
||||||
fs::write(&path, script).unwrap();
|
fn new(name: &str, script: &str) -> Self {
|
||||||
path
|
let mut file = tempfile::Builder::new()
|
||||||
|
.prefix(&format!("pipeview_{name}_"))
|
||||||
|
.suffix(".lua")
|
||||||
|
.tempfile()
|
||||||
|
.unwrap();
|
||||||
|
file.write_all(script.as_bytes()).unwrap();
|
||||||
|
let path = file.path().to_path_buf();
|
||||||
|
let guard = file.into_temp_path();
|
||||||
|
Self {
|
||||||
|
path,
|
||||||
|
_guard: guard,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn path(&self) -> &Path {
|
||||||
|
&self.path
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn text_pipeline_lua() -> &'static str {
|
fn text_pipeline_lua() -> &'static str {
|
||||||
@@ -208,7 +225,7 @@ async fn lua_session_custom_lua_pipeline() {
|
|||||||
let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
|
let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||||
let addr = listener.local_addr().unwrap().to_string();
|
let addr = listener.local_addr().unwrap().to_string();
|
||||||
|
|
||||||
let framer_path = write_temp_lua(
|
let framer_script = TempScript::new(
|
||||||
"custom_framer",
|
"custom_framer",
|
||||||
r#"
|
r#"
|
||||||
local buffer = ""
|
local buffer = ""
|
||||||
@@ -239,7 +256,7 @@ async fn lua_session_custom_lua_pipeline() {
|
|||||||
}
|
}
|
||||||
"#,
|
"#,
|
||||||
);
|
);
|
||||||
let decoder_path = write_temp_lua(
|
let decoder_script = TempScript::new(
|
||||||
"custom_decoder",
|
"custom_decoder",
|
||||||
r#"
|
r#"
|
||||||
return {
|
return {
|
||||||
@@ -287,14 +304,12 @@ async fn lua_session_custom_lua_pipeline() {
|
|||||||
sess:close()
|
sess:close()
|
||||||
"#,
|
"#,
|
||||||
addr,
|
addr,
|
||||||
framer_path.display(),
|
framer_script.path().display(),
|
||||||
decoder_path.display()
|
decoder_script.path().display()
|
||||||
);
|
);
|
||||||
|
|
||||||
lua.load(&script).exec_async().await.unwrap();
|
lua.load(&script).exec_async().await.unwrap();
|
||||||
server.await.unwrap();
|
server.await.unwrap();
|
||||||
fs::remove_file(framer_path).unwrap();
|
|
||||||
fs::remove_file(decoder_path).unwrap();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ── session:on_data callback ─────────────────────────────────────
|
// ── session:on_data callback ─────────────────────────────────────
|
||||||
|
|||||||
@@ -15,3 +15,6 @@ serde_json = { workspace = true }
|
|||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
thiserror = { workspace = true }
|
thiserror = { workspace = true }
|
||||||
hex = "0.4"
|
hex = "0.4"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
proptest = "1"
|
||||||
|
|||||||
96
crates/pipeview-core/tests/properties.rs
Normal file
96
crates/pipeview-core/tests/properties.rs
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
use proptest::prelude::*;
|
||||||
|
|
||||||
|
use pipeview_core::frame::Framer;
|
||||||
|
use pipeview_core::frame::cobs::{CobsFramer, cobs_decode, cobs_encode};
|
||||||
|
use pipeview_core::frame::length::{LengthConfig, LengthPrefixedFramer};
|
||||||
|
use pipeview_core::protocol::Endian;
|
||||||
|
use pipeview_core::protocol::ProtocolDecoder;
|
||||||
|
use pipeview_core::protocol::hex::{HexConfig, HexDecoder};
|
||||||
|
use pipeview_core::protocol::plot::{PlotConfig, PlotDecoder, SampleType};
|
||||||
|
use pipeview_core::protocol::text::{TextDecoder, TextEncoding};
|
||||||
|
|
||||||
|
proptest! {
|
||||||
|
#![proptest_config(ProptestConfig::with_cases(256))]
|
||||||
|
|
||||||
|
// ── COBS ─────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn cobs_roundtrip_any_payload(payload in prop::collection::vec(any::<u8>(), 0..512)) {
|
||||||
|
let encoded = cobs_encode(&payload);
|
||||||
|
let decoded = cobs_decode(&encoded).unwrap();
|
||||||
|
prop_assert_eq!(&decoded, &payload);
|
||||||
|
|
||||||
|
let mut framer = CobsFramer::new(1024 * 1024);
|
||||||
|
let mut wire = encoded;
|
||||||
|
wire.push(0x00);
|
||||||
|
let frames = framer.feed(&wire);
|
||||||
|
prop_assert_eq!(frames.len(), 1);
|
||||||
|
prop_assert_eq!(&frames[0], &payload);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Length-prefixed ──────────────────────────────────────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn length_roundtrip_any_payload(
|
||||||
|
len_bytes in prop_oneof![Just(1usize), Just(2usize), Just(4usize)],
|
||||||
|
little_endian in any::<bool>(),
|
||||||
|
includes_self in any::<bool>(),
|
||||||
|
payload in prop::collection::vec(any::<u8>(), 0..200)
|
||||||
|
) {
|
||||||
|
let endian = if little_endian { Endian::Little } else { Endian::Big };
|
||||||
|
let raw_len = if includes_self {
|
||||||
|
payload.len() + len_bytes
|
||||||
|
} else {
|
||||||
|
payload.len()
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut wire = Vec::with_capacity(len_bytes + payload.len());
|
||||||
|
match (len_bytes, endian) {
|
||||||
|
(1, _) => wire.push(raw_len as u8),
|
||||||
|
(2, Endian::Big) => wire.extend_from_slice(&(raw_len as u16).to_be_bytes()),
|
||||||
|
(2, Endian::Little) => wire.extend_from_slice(&(raw_len as u16).to_le_bytes()),
|
||||||
|
(4, Endian::Big) => wire.extend_from_slice(&(raw_len as u32).to_be_bytes()),
|
||||||
|
(4, Endian::Little) => wire.extend_from_slice(&(raw_len as u32).to_le_bytes()),
|
||||||
|
_ => unreachable!(),
|
||||||
|
}
|
||||||
|
wire.extend_from_slice(&payload);
|
||||||
|
|
||||||
|
let config = LengthConfig {
|
||||||
|
len_bytes,
|
||||||
|
endian,
|
||||||
|
length_includes_self: includes_self,
|
||||||
|
max_payload: 1024 * 1024,
|
||||||
|
};
|
||||||
|
let mut framer = LengthPrefixedFramer::new(config);
|
||||||
|
let frames = framer.feed(&wire);
|
||||||
|
prop_assert_eq!(frames.len(), 1);
|
||||||
|
prop_assert_eq!(&frames[0], &payload);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Protocol decoders never panic on arbitrary bytes ─────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn plot_decode_arbitrary_bytes_never_panics(bytes in prop::collection::vec(any::<u8>(), 0..256)) {
|
||||||
|
let decoder = PlotDecoder::new(PlotConfig {
|
||||||
|
sample_type: SampleType::F32,
|
||||||
|
endian: Endian::Little,
|
||||||
|
channels: 2,
|
||||||
|
format: pipeview_core::protocol::plot::PlotFormat::Interleaved,
|
||||||
|
});
|
||||||
|
let _ = decoder.decode(&bytes);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn hex_decode_arbitrary_bytes_never_panics(bytes in prop::collection::vec(any::<u8>(), 0..256)) {
|
||||||
|
let decoder = HexDecoder::new(HexConfig::default());
|
||||||
|
let decoded = decoder.decode(&bytes);
|
||||||
|
prop_assert!(decoded.is_some());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn latin1_decode_arbitrary_bytes_never_panics(bytes in prop::collection::vec(any::<u8>(), 0..256)) {
|
||||||
|
let decoder = TextDecoder::new(TextEncoding::Latin1);
|
||||||
|
let decoded = decoder.decode(&bytes);
|
||||||
|
prop_assert!(decoded.is_some());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,7 +4,9 @@ use std::time::{Duration, Instant};
|
|||||||
|
|
||||||
use crate::buffers::{HexBuffer, PlotBuffer, TextBuffer};
|
use crate::buffers::{HexBuffer, PlotBuffer, TextBuffer};
|
||||||
use crate::logging::{self, LogWriter};
|
use crate::logging::{self, LogWriter};
|
||||||
use crate::panels::{config, console, font_settings, hex_view, plot_view, send_panel, session_controls, sidebar};
|
use crate::panels::{
|
||||||
|
config, console, font_settings, hex_view, plot_view, send_panel, session_controls, sidebar,
|
||||||
|
};
|
||||||
use crate::perf::{DrainStats, GuiProfiler, GuiSnapshot};
|
use crate::perf::{DrainStats, GuiProfiler, GuiSnapshot};
|
||||||
use crate::shortcuts::{self, default_bindings};
|
use crate::shortcuts::{self, default_bindings};
|
||||||
use crate::ui_fonts::{self, FontCandidate, UiFontSettings};
|
use crate::ui_fonts::{self, FontCandidate, UiFontSettings};
|
||||||
@@ -557,7 +559,10 @@ impl XserialApp {
|
|||||||
let (badge, status_text) = tab.status.badge();
|
let (badge, status_text) = tab.status.badge();
|
||||||
|
|
||||||
ui.horizontal(|ui| {
|
ui.horizontal(|ui| {
|
||||||
ui.add(Label::new(egui::RichText::new(format!("Session {}", tab.id)).heading()).selectable(false));
|
ui.add(
|
||||||
|
Label::new(egui::RichText::new(format!("Session {}", tab.id)).heading())
|
||||||
|
.selectable(false),
|
||||||
|
);
|
||||||
ui.add(Label::new(badge).selectable(false));
|
ui.add(Label::new(badge).selectable(false));
|
||||||
ui.separator();
|
ui.separator();
|
||||||
ui.add(Label::new(status_text).selectable(false));
|
ui.add(Label::new(status_text).selectable(false));
|
||||||
@@ -579,7 +584,8 @@ impl XserialApp {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
let auto_reconnect_changed = session_controls::render_session_controls(ui, &manager, tab);
|
let auto_reconnect_changed =
|
||||||
|
session_controls::render_session_controls(ui, &manager, tab);
|
||||||
persist_state |= auto_reconnect_changed;
|
persist_state |= auto_reconnect_changed;
|
||||||
|
|
||||||
let mut display_changed = false;
|
let mut display_changed = false;
|
||||||
@@ -598,7 +604,10 @@ impl XserialApp {
|
|||||||
session_controls::render_search_bar(ui, tab);
|
session_controls::render_search_bar(ui, tab);
|
||||||
|
|
||||||
if let ConnectionStatus::Error(message) = &tab.status {
|
if let ConnectionStatus::Error(message) = &tab.status {
|
||||||
ui.add(Label::new(egui::RichText::new(message).color(Color32::RED)).selectable(false));
|
ui.add(
|
||||||
|
Label::new(egui::RichText::new(message).color(Color32::RED))
|
||||||
|
.selectable(false),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
let full = ui.available_rect_before_wrap();
|
let full = ui.available_rect_before_wrap();
|
||||||
@@ -620,11 +629,21 @@ impl XserialApp {
|
|||||||
let started = Instant::now();
|
let started = Instant::now();
|
||||||
match tab.view {
|
match tab.view {
|
||||||
View::Text => {
|
View::Text => {
|
||||||
let line_count = console::render(ui, &tab.console, *display, tab.search.active.then_some(&tab.search));
|
let line_count = console::render(
|
||||||
|
ui,
|
||||||
|
&tab.console,
|
||||||
|
*display,
|
||||||
|
tab.search.active.then_some(&tab.search),
|
||||||
|
);
|
||||||
text_render = Some((started.elapsed(), line_count));
|
text_render = Some((started.elapsed(), line_count));
|
||||||
}
|
}
|
||||||
View::Hex => {
|
View::Hex => {
|
||||||
let line_count = hex_view::render(ui, &tab.hex, *display, tab.search.active.then_some(&tab.search));
|
let line_count = hex_view::render(
|
||||||
|
ui,
|
||||||
|
&tab.hex,
|
||||||
|
*display,
|
||||||
|
tab.search.active.then_some(&tab.search),
|
||||||
|
);
|
||||||
hex_render = Some((started.elapsed(), line_count));
|
hex_render = Some((started.elapsed(), line_count));
|
||||||
}
|
}
|
||||||
View::Plot => {
|
View::Plot => {
|
||||||
|
|||||||
@@ -37,8 +37,7 @@ pub fn render(
|
|||||||
input.pointer.button_down(egui::PointerButton::Primary)
|
input.pointer.button_down(egui::PointerButton::Primary)
|
||||||
&& input.pointer.hover_pos().is_some_and(|pos| {
|
&& input.pointer.hover_pos().is_some_and(|pos| {
|
||||||
let area = ui.max_rect();
|
let area = ui.max_rect();
|
||||||
pos.y > area.bottom() - EDGE_SCROLL_ZONE
|
pos.y > area.bottom() - EDGE_SCROLL_ZONE && pos.y < area.bottom() + 20.0
|
||||||
&& pos.y < area.bottom() + 20.0
|
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -56,9 +55,8 @@ pub fn render(
|
|||||||
// offset for the next frame and request a repaint for smooth continuous scrolling.
|
// offset for the next frame and request a repaint for smooth continuous scrolling.
|
||||||
if near_bottom_edge && line_count > 0 {
|
if near_bottom_edge && line_count > 0 {
|
||||||
let mut state = output.state;
|
let mut state = output.state;
|
||||||
let max_offset = (line_count as f32 * row_height)
|
let max_offset =
|
||||||
- output.inner_rect.height()
|
(line_count as f32 * row_height) - output.inner_rect.height() + EDGE_SCROLL_ZONE;
|
||||||
+ EDGE_SCROLL_ZONE;
|
|
||||||
state.offset.y = (state.offset.y + EDGE_SCROLL_NUDGE).min(max_offset.max(0.0));
|
state.offset.y = (state.offset.y + EDGE_SCROLL_NUDGE).min(max_offset.max(0.0));
|
||||||
state.store(ui.ctx(), output.id);
|
state.store(ui.ctx(), output.id);
|
||||||
ui.ctx().request_repaint();
|
ui.ctx().request_repaint();
|
||||||
|
|||||||
@@ -38,8 +38,7 @@ pub fn render(
|
|||||||
input.pointer.button_down(egui::PointerButton::Primary)
|
input.pointer.button_down(egui::PointerButton::Primary)
|
||||||
&& input.pointer.hover_pos().is_some_and(|pos| {
|
&& input.pointer.hover_pos().is_some_and(|pos| {
|
||||||
let area = ui.max_rect();
|
let area = ui.max_rect();
|
||||||
pos.y > area.bottom() - EDGE_SCROLL_ZONE
|
pos.y > area.bottom() - EDGE_SCROLL_ZONE && pos.y < area.bottom() + 20.0
|
||||||
&& pos.y < area.bottom() + 20.0
|
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -57,9 +56,8 @@ pub fn render(
|
|||||||
// offset for the next frame and request a repaint for smooth continuous scrolling.
|
// offset for the next frame and request a repaint for smooth continuous scrolling.
|
||||||
if near_bottom_edge {
|
if near_bottom_edge {
|
||||||
let mut state = output.state;
|
let mut state = output.state;
|
||||||
let max_offset = (line_count as f32 * row_height)
|
let max_offset =
|
||||||
- output.inner_rect.height()
|
(line_count as f32 * row_height) - output.inner_rect.height() + EDGE_SCROLL_ZONE;
|
||||||
+ EDGE_SCROLL_ZONE;
|
|
||||||
state.offset.y = (state.offset.y + EDGE_SCROLL_NUDGE).min(max_offset.max(0.0));
|
state.offset.y = (state.offset.y + EDGE_SCROLL_NUDGE).min(max_offset.max(0.0));
|
||||||
state.store(ui.ctx(), output.id);
|
state.store(ui.ctx(), output.id);
|
||||||
ui.ctx().request_repaint();
|
ui.ctx().request_repaint();
|
||||||
|
|||||||
@@ -44,18 +44,14 @@ pub fn render_send_panel(ui: &mut egui::Ui, manager: &SessionManager, tab: &mut
|
|||||||
|
|
||||||
let log_toggled = ui
|
let log_toggled = ui
|
||||||
.horizontal(|ui| {
|
.horizontal(|ui| {
|
||||||
let toggled = ui
|
let toggled = ui.checkbox(&mut tab.log_enabled, "Log to file").changed();
|
||||||
.checkbox(&mut tab.log_enabled, "Log to file")
|
|
||||||
.changed();
|
|
||||||
ui.checkbox(&mut tab.show_sent, "Show sent data");
|
ui.checkbox(&mut tab.show_sent, "Show sent data");
|
||||||
toggled
|
toggled
|
||||||
})
|
})
|
||||||
.inner;
|
.inner;
|
||||||
if log_toggled {
|
if log_toggled {
|
||||||
if tab.log_enabled {
|
if tab.log_enabled {
|
||||||
tab.log_path = default_log_path(tab.id)
|
tab.log_path = default_log_path(tab.id).to_string_lossy().to_string();
|
||||||
.to_string_lossy()
|
|
||||||
.to_string();
|
|
||||||
tab.log_writer = LogWriter::open(&tab.log_path).ok();
|
tab.log_writer = LogWriter::open(&tab.log_path).ok();
|
||||||
} else {
|
} else {
|
||||||
tab.log_writer = None;
|
tab.log_writer = None;
|
||||||
@@ -63,9 +59,7 @@ pub fn render_send_panel(ui: &mut egui::Ui, manager: &SessionManager, tab: &mut
|
|||||||
}
|
}
|
||||||
if tab.log_enabled {
|
if tab.log_enabled {
|
||||||
ui.horizontal(|ui| {
|
ui.horizontal(|ui| {
|
||||||
let changed = ui
|
let changed = ui.text_edit_singleline(&mut tab.log_path).lost_focus();
|
||||||
.text_edit_singleline(&mut tab.log_path)
|
|
||||||
.lost_focus();
|
|
||||||
if changed && !tab.log_path.is_empty() {
|
if changed && !tab.log_path.is_empty() {
|
||||||
tab.log_writer = LogWriter::open(&tab.log_path).ok();
|
tab.log_writer = LogWriter::open(&tab.log_path).ok();
|
||||||
}
|
}
|
||||||
@@ -96,13 +90,13 @@ pub fn render_send_panel(ui: &mut egui::Ui, manager: &SessionManager, tab: &mut
|
|||||||
send_clicked = ui.button("Send").clicked();
|
send_clicked = ui.button("Send").clicked();
|
||||||
if let Some(status) = &tab.send_status {
|
if let Some(status) = &tab.send_status {
|
||||||
ui.add(
|
ui.add(
|
||||||
Label::new(
|
Label::new(egui::RichText::new(status).color(
|
||||||
egui::RichText::new(status).color(if status.starts_with("Send failed") {
|
if status.starts_with("Send failed") {
|
||||||
Color32::RED
|
Color32::RED
|
||||||
} else {
|
} else {
|
||||||
Color32::GRAY
|
Color32::GRAY
|
||||||
}),
|
},
|
||||||
)
|
))
|
||||||
.selectable(false),
|
.selectable(false),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,7 +19,9 @@ pub fn render_search_bar(ui: &mut egui::Ui, tab: &mut SessionTab) {
|
|||||||
}
|
}
|
||||||
if response.changed() {
|
if response.changed() {
|
||||||
let matches = match tab.view {
|
let matches = match tab.view {
|
||||||
View::Text => tab.console.search(&tab.search.query, tab.search.case_sensitive),
|
View::Text => tab
|
||||||
|
.console
|
||||||
|
.search(&tab.search.query, tab.search.case_sensitive),
|
||||||
View::Hex => tab.hex.search(&tab.search.query, tab.search.case_sensitive),
|
View::Hex => tab.hex.search(&tab.search.query, tab.search.case_sensitive),
|
||||||
View::Plot => Vec::new(),
|
View::Plot => Vec::new(),
|
||||||
};
|
};
|
||||||
@@ -48,7 +50,9 @@ pub fn render_search_bar(ui: &mut egui::Ui, tab: &mut SessionTab) {
|
|||||||
|
|
||||||
if ui.checkbox(&mut tab.search.case_sensitive, "Aa").changed() {
|
if ui.checkbox(&mut tab.search.case_sensitive, "Aa").changed() {
|
||||||
let matches = match tab.view {
|
let matches = match tab.view {
|
||||||
View::Text => tab.console.search(&tab.search.query, tab.search.case_sensitive),
|
View::Text => tab
|
||||||
|
.console
|
||||||
|
.search(&tab.search.query, tab.search.case_sensitive),
|
||||||
View::Hex => tab.hex.search(&tab.search.query, tab.search.case_sensitive),
|
View::Hex => tab.hex.search(&tab.search.query, tab.search.case_sensitive),
|
||||||
View::Plot => Vec::new(),
|
View::Plot => Vec::new(),
|
||||||
};
|
};
|
||||||
|
|||||||
Reference in New Issue
Block a user