osmocom/wireshark
14
0
Fork 1
Code Issues Pull requests Projects Releases Wiki Activity

WSDG: Update test documentation to reflect the latest changes

Browse source
This commit is contained in:
João Valverde 2023-06-07 18:18:01 +01:00
parent 28c3b0dffa
commit 3586dcf61d
1 changed files with 19 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docbook/wsdg_src/wsdg_tests.adoc
View file

@ -185,11 +185,18 @@ Test dependencies (such as programs, directories, or the environment
variables) are injected through method parameters. Commonly used variables) are injected through method parameters. Commonly used
fixtures include `cmd_tshark` and `capture_file`. fixtures include `cmd_tshark` and `capture_file`.
Processes (tshark, capinfos, etc.) are run using the "subprocess" Python module. Processes (tshark, capinfos, etc.) are run using the "subprocess" Python module,
Possible functions include run(), check_call(), check_output() or creating or the Wireshark `subprocesstest` module with some convenience functions.
a Popen object if the utility functions are not sufficient for some reason. Possible functions include `subprocesstest.run()`, `subprocesstest.check_run()`
or creating `subprocess.Popen` object if the utility functions are not sufficient for some reason.
Usually this is only required if two-way communication is performed with Usually this is only required if two-way communication is performed with
the child process. the child process. `subprocesstest.check_run()` is exactly the same as
calling `subprocesstest.run()` with `check=True` as an argument, only
a bit more expressive.
Check the documentation for the Python subprocess module for a full description
of the arguments available to the `subprocesstest.run()` convenience wrapper
and the `subprocess.Popen` object.
All of the current tests run one or more of Wireshark's suite of All of the current tests run one or more of Wireshark's suite of
executables and either check their return code or their output. A executables and either check their return code or their output. A
@ -198,35 +205,34 @@ which reads a capture file using TShark and checks its exit code.
[source,python] [source,python]
---- ----
import subprocess import subprocesstest
import pytest import pytest
class TestBasicClopts: class TestBasicClopts:
def test_existing_file(self, cmd_tshark, capture_file, test_env): def test_existing_file(self, cmd_tshark, capture_file, test_env):
subprocess.check_call((cmd_tshark, '-r', capture_file('dhcp.pcap')), env=test_env) subprocess.check_run((cmd_tshark, '-r', capture_file('dhcp.pcap')), env=test_env)
---- ----
Check the options to the subprocess Popen object for a full description of the arguments
available.
Output can be checked using `assert subprocesstest.grep_output()`, Output can be checked using `assert subprocesstest.grep_output()`,
`assert subprocesstest.count_output()` or any other `assert` statement. `assert subprocesstest.count_output()` or any other `assert` statement.
`subprocesstest.check_run()` also asserts that the child process returns
the value 0 as exit code.
[source,python] [source,python]
---- ----
import subprocess import subprocesstest
import pytest import pytest
class TestDecrypt80211: class TestDecrypt80211:
def test_80211_wpa_psk(self, cmd_tshark, capture_file, test_env): def test_80211_wpa_psk(self, cmd_tshark, capture_file, test_env):
tshark_stdout = subprocess.check_output((cmd_tshark, tshark_proc = subprocesstest.run((cmd_tshark,
'-o', 'wlan.enable_decryption: TRUE', '-o', 'wlan.enable_decryption: TRUE',
'-Tfields', '-Tfields',
'-e', 'http.request.uri', '-e', 'http.request.uri',
'-r', capture_file('wpa-Induction.pcap.gz'), '-r', capture_file('wpa-Induction.pcap.gz'),
'-Y', 'http', '-Y', 'http',
), encoding='utf-8', env=test_env) ), capture_output=True, env=test_env)
assert 'favicon.ico' in tshark_stdout assert 'favicon.ico' in tshark_proc.stdout
---- ----
Tests can be run in parallel. This means that any files you create must Tests can be run in parallel. This means that any files you create must