summaryrefslogtreecommitdiffstats
path: root/test/README.test
diff options
context:
space:
mode:
Diffstat (limited to 'test/README.test')
-rw-r--r--test/README.test20
1 files changed, 20 insertions, 0 deletions
diff --git a/test/README.test b/test/README.test
new file mode 100644
index 00000000..a8ec1cfe
--- /dev/null
+++ b/test/README.test
@@ -0,0 +1,20 @@
+Wireshark Tests
+
+The recommended steps to prepare for and to run tests:
+
+* Install two Python packages, pytest: `pip install pytest pytest-xdist`
+* Build programs (“wireshark”, “tshark”, etc.): `ninja`
+* Build additional programs for the “unittests” suite: `ninja test-programs`
+* Run tests in the build directory: `pytest`
+
+Replace `ninja test-programs` by `make test-programs` as needed.
+
+See the “Wireshark Tests” chapter of the Developer's Guide for details:
+https://www.wireshark.org/docs/wsdg_html_chunked/ChapterTests.html
+
+If you need to update the baseline files use the following commands (on a Linux system)
+mkdir ~/.config/wireshark/profiles/ctest
+TZ=UTC WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 build/run/tshark -C ctest -T ek -r test/captures/dhcp.pcap > test/baseline/dhcp.ek
+TZ=UTC WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 build/run/tshark -C ctest -T json -r test/captures/dhcp.pcap > test/baseline/dhcp.json
+TZ=UTC WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 build/run/tshark -C ctest -T jsonraw -r test/captures/dhcp.pcap > test/baseline/dhcp.jsonraw
+TZ=UTC WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 build/run/tshark -C ctest -T ek -r test/captures/dhcp.pcap -x > test/baseline/dhcp-raw.ek