Skip to content

Commit cf76017

Browse files
authored
update readme test description (#61)
1 parent a760c04 commit cf76017

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

.cargo/config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[alias]
2+
test_ip = "test --test ipv4_tests -- --ignored --test-threads=1"

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Compliance with the ANSI E1.31-2018 protocol was tested (April 2020) and the res
2020
## Testing
2121
Quick library logic and parse testing: `cargo test`
2222

23-
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
24-
`cargo test ipv4 -- --ignored --test-threads=1 --nocapture`
23+
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
24+
`cargo test --test ipv4_tests -- --ignored --test-threads=1`.
2525

26-
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.
26+
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.
2727

2828
## Demo Implementation
2929

0 commit comments

Comments
 (0)