hostap/tests/hwsim
Jouni Malinen f9174c3b4e tests: Flush stdout after each status line print
This makes it more convenient to follow live test execution status.

Signed-hostap: Jouni Malinen <j@w1.fi>
2013-09-29 20:42:37 +03:00
..
auth_serv tests: Start RADIUS authentication server 2013-09-29 19:14:16 +03:00
example-hostapd.config tests: Document automated mac80211_hwsim test setup 2013-09-29 15:55:43 +03:00
example-wpa_supplicant.config tests: Document automated mac80211_hwsim test setup 2013-09-29 15:55:43 +03:00
hostapd.py tests: Add test cases for WPA2-Enterprise 2013-09-29 20:35:26 +03:00
hwsim_utils.py tests: Add test cases for per-STA PSK in P2P group 2013-09-01 21:35:10 +03:00
p2p0.conf tests: Add start/stop scripts and configuration files 2013-03-02 11:39:54 +02:00
p2p1.conf tests: Add start/stop scripts and configuration files 2013-03-02 11:39:54 +02:00
p2p2.conf tests: Add start/stop scripts and configuration files 2013-03-02 11:39:54 +02:00
README tests: Start RADIUS authentication server 2013-09-29 19:14:16 +03:00
run-all.sh tests: Merge start-p2p-concurrent.sh functionality into start.sh 2013-09-29 16:37:25 +03:00
run-tests.py tests: Flush stdout after each status line print 2013-09-29 20:42:37 +03:00
sta-dummy.conf tests: Add concurrent version of P2P test setup 2013-03-19 10:58:28 +02:00
start.sh tests: Start RADIUS authentication server 2013-09-29 19:14:16 +03:00
stop-wifi.sh tests: Start RADIUS authentication server 2013-09-29 19:14:16 +03:00
test_ap_eap.py tests: Add test cases for WPA2-Enterprise 2013-09-29 20:35:26 +03:00
test_ap_ft.py tests: Add test cases for Fast BSS Transition 2013-05-24 16:05:40 +03:00
test_ap_hs20.py tests: Add a test case for Hotspot 2.0 network selection 2013-04-01 01:01:24 +03:00
test_ap_pmf.py tests: Pass AP devices to test cases 2013-03-31 18:05:31 +03:00
test_ap_roam.py tests: Pass AP devices to test cases 2013-03-31 18:05:31 +03:00
test_ap_tdls.py tests: Validate AP connection in each TDLS step 2013-07-31 13:38:34 +03:00
test_ap_wps.py tests: Use longer timeout in test_ap_wps_er_add_enrollee 2013-08-31 11:54:23 +03:00
test_ibss.py tests: Detect BSSID mismatch in test_ibss_rsn 2013-08-27 03:11:02 +03:00
test_nfc_wps.py tests: Increase WPS timeout to 30 seconds 2013-08-31 10:45:03 +03:00
test_p2p_autogo.py tests: Test GO functionality with legacy STAs 2013-09-29 12:42:05 +03:00
test_p2p_discovery.py tests: Use wpa_supplicant global control interface for P2P 2013-07-01 00:36:33 +03:00
test_p2p_grpform.py tests: Use a helper function for waiting session termination 2013-09-01 21:35:10 +03:00
test_p2p_invitation.py tests: Add a test case for P2P invitation 2013-09-28 12:09:40 +03:00
test_p2p_persistent.py tests: Add a test case for invitation after client removal 2013-09-01 21:53:03 +03:00
test_p2p_service.py tests: Add test cases for P2P service discovery 2013-09-29 13:15:26 +03:00
wlantest.py tests: Silence wlantest clear_tdls_counters output from stdout 2013-08-25 21:48:51 +03:00
wpasupplicant.py tests: Add test cases for WPA2-Enterprise 2013-09-29 20:35:26 +03:00

Automated hostapd/wpa_supplicant testing with mac80211_hwsim
------------------------------------------------------------

This directory contains testing infrastructure and test cases to run
automated tests of full hostapd and wpa_supplicant functionality. This
testing is done with the help of mac80211_hwsim which is Linux kernel
driver that simulates IEEE 802.11 radios without requiring any
additional hardware. This setup most of the hostapd and wpa_supplicant
functionality (and large parts of the Linux cfg80211 and mac80211
functionality for that matter) to be tested.

mac80211_hwsim is loaded with five simulated radios to allow different
device combinations to be tested. wlantest is used analyze raw packets
captured through the hwsim0 monitor interface that capture all frames
sent on all channels. tcpdump is used to store the frames for
analysis. Three wpa_supplicant processed are used to control three
virtual radios and one hostapd process is used to dynamically control
the other two virtual radios. hwsim_test is used to verify that data
connection (both unicast and broadcast) works between two netdevs.

The python scripts and tools in this directory control test case
execution. They interact wpa_supplicant and hostapd through control
interfaces to perform the operations. In addition, wlantest_cli and
hwsim_test are used to verify that operations have been performed
correctly and that the network connection works in the expected way.

These test cases are run automatically against the hostap.git commits
for regression testing and to help in keeping the hostap.git master
branch in stable state. Results from these tests are available here:
http://buildbot.w1.fi:8010/waterfall


Building binaries for testing
-----------------------------

You will need to build (or use already built) components to be
tested. These are available in the hostap.git repository and can be
built for example as follows:

cd ../../wpa_supplicant
cp ../tests/hwsim/example-wpa_supplicant.config .config
make clean
make
cd ../hostapd
cp ../tests/hwsim/example-hostapd.config .config
make clean
make hostapd hlr_auc_gw
cd ../wlantest
make clean
make
cd ../mac80211_hwsim/tools
make

The test scripts can find the binaries in the locations where they were
built. It is also possible to install hwsim_test and wlantest_cli
somewhat on the path to use pre-built tools.


wpaspy
------

The python scripts use wpaspy.py to interact with the wpa_supplicant
control interface. This needs to be installed in a way that python can
find it. For example, with this command:

sudo cp ../wpaspy/wpaspy.py /usr/local/lib/python2.7/dist-packages



mac80211_hwsim
--------------

mac80211_hwsim kernel module is available from the upstream Linux
kernel. Some Linux distributions enable it by default. If that's not the
case, you can either enable it in the kernel configuration
(CONFIG_MAC80211_HWSIM=m) and rebuild your kernel or use Backports with
CPTCFG_MAC80211_HWSIM=m to replace the wireless LAN components in the
base kernel.


sudo
----

Some parts of the testing process requires root privileges. The test
scripts are currently using sudo to achieve this. To be able to run the
tests, you'll probably want to enable sudo with a timeout to not expire
password entry very quickly. For example, use this in the sudoers file:

Defaults        env_reset,timestamp_timeout=180

Or on a dedicated test system, you could even disable password prompting
with this in sudoers:

%sudo   ALL=NOPASSWD: ALL


Other network interfaces
------------------------

Some of the test scripts are still using hardcoded interface names, so
the easiest way of making things work is to avoid using other network
devices that may use conflicting interface names. For example, unload
any wireless LAN driver before running the tests and make sure that
wlan0..4 gets assigned as the interface names for the mac80211_hwsim
radios. It may also be possible to rename the interface expectations in
run-tests.py to allow other names to be used.


Running tests
-------------

Simplest way to run a full set of the test cases is by running
run-all.sh in tests/hwsim directory. This will use start.sh to load the
mac80211_hwsim module and start wpa_supplicant, hostapd, and various
test tools. run-tests.sh is then used to run through all the defined
test cases and stop-wifi.sh to stop the programs and unload the kernel
module.

run-all.sh can be used to run the same test cases under different
conditions:

# run normal test cases
./run-all.sh

# run normal test cases under valgrind
./run-all.sh valgrind

# run normal test cases with Linux tracing
./run-all.sh trace

# run P2P test cases with concurrent station interface
./run-all.sh concurrent

# run P2P test cases with concurrent station interface under valgrind
./run-all.sh concurrent-valgrind

run-all.sh directs debug logs into the logs subdirectory. Log file names
include the current UNIX timestamp and a postfix to identify the
specific log:
- log0 = wpa_supplicant debug log for the first radio
- log1 = wpa_supplicant debug log for the second radio
- log2 = wpa_supplicant debug log for the third radio
- hostapd = hostapd debug log
- hwsim0 = wlantest debug log
- hwsim0.dump = pcap containing all frames exchanged during the tests
- tcpdump = tcpdump output
- run = debug prints from the test scripts
- trace.dat = Linux tracing record (if enabled)
- hlr_auc_gw - hlr_auc_gw (EAP-SIM/AKA/AKA' authentication) log
- auth_serv - hostapd as RADIUS authentication server log


For manual testing, ./start.sh can be used to initialize interfaces and
programs and run-tests.py to execute one or more test
cases. run-tests.py output verbosity can be controlled with -d (more
verbose debug output) and -q (less verbose output) on the command
line. "-f <test_*.py>" can be used to specify that all test cases from a
single file are to be run. Test name as the last command line argument
can be specified that a single test case is to be run (e.g.,
"./run-tests.py test_ap_pmf_required").


Adding/modifying test cases
---------------------------

All the test cases are defined in the test_*.py files. These are python
scripts that can use the local helper classes to interact with the test
components. While various python constructs can be used in the scripts,
only a minimal level of python knowledge should really be needed to
modify and add new test cases. The easiest starting point for this is
likely to take a look at some of the example scripts. When working on a
new test, run-tests.py with -d and the test case name on the command
line is a convenient way of verifying functionality.

run-tests.py will automatically import all test cases from the test_*.py
files in this directory. All functions starting with the "test_" prefix
in these files are assumed to be test cases.