From 8382ec8c254e37bfbbf26e2fcefcaa9e901d417d Mon Sep 17 00:00:00 2001 From: bruingineer Date: Sat, 3 Jan 2026 17:41:04 -0800 Subject: [PATCH] update readme test description --- .cargo/config.toml | 2 ++ README.md | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 .cargo/config.toml diff --git a/.cargo/config.toml b/.cargo/config.toml new file mode 100644 index 0000000..747a437 --- /dev/null +++ b/.cargo/config.toml @@ -0,0 +1,2 @@ +[alias] +test_ip = "test --test ipv4_tests -- --ignored --test-threads=1" \ No newline at end of file diff --git a/README.md b/README.md index b8f8edf..fbdc0a6 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,10 @@ Compliance with the ANSI E1.31-2018 protocol was tested (April 2020) and the res ## Testing Quick library logic and parse testing: `cargo test` -Ipv4 testing requires that the computer have (a) network interface(s) with the IPs of `192.168.0.6`, `192.168.0.7`, and `192.168.0.8`. These IPs are set in the testing file. Ip tests are ignored by default. Run the ip tests in a single thread to avoid socket conflicts within the OS. To run ipv4 tests, use -`cargo test ipv4 -- --ignored --test-threads=1 --nocapture` +Ipv4 testing requires that the computer have (a) network interface(s) with the IPs of `192.168.0.6`, `192.168.0.7`, and `192.168.0.8`. These IPs are set in the testing file. Ip tests are ignored by default. Run the ip tests in a single thread to avoid socket conflicts within the OS. To run ipv4 tests, use `cargo test_ip`, which is an alias for +`cargo test --test ipv4_tests -- --ignored --test-threads=1`. -There is a Dockerfile to run the ipv4 tests on linux. In the project root, run `docker build -t sacn-test -f docker-linux/Dockerfile .` to build the image. Then, run `docker run --cap-add=NET_ADMIN sacn-test` to run the ipv4 tests within the image. +There is a Dockerfile to run the tests, inluding ipv4 tests, on linux. In the project root, run `docker build -t sacn-test -f docker-linux/Dockerfile .` to build the image. Then, run `docker run --cap-add=NET_ADMIN sacn-test` to run the ipv4 tests within the image. The docker engine must be running in linux container mode. ## Demo Implementation