Handle NULL return from os_zalloc() in sta_track_add()
[mech_eap.git] / tests / hwsim / README
index 8195aa4..e68b0dc 100644 (file)
@@ -12,22 +12,23 @@ 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
+sent on all channels. wlantest is used to store the frames for
+analysis. Three wpa_supplicant processes 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 other two virtual radios. wpa_supplicant/hostapd test functionality
+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.
+interfaces to perform the operations. In addition, wlantest_cli is 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
+http://buildbot.w1.fi/hwsim/
 
 
 Building binaries for testing
@@ -48,12 +49,24 @@ make hostapd hlr_auc_gw
 cd ../wlantest
 make clean
 make
-cd ../mac80211_hwsim/tools
-make
+
+Alternatively, the build.sh script here can be used to run these steps
+with conditional creation of .config files only if they do not exist.
 
 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.
+built. It is also possible to install wlantest_cli somewhere on the path
+to use pre-built tools.
+
+Please note that some of the configuration parameters used to enable
+more testing coverage may require development packages that may not be
+installed by default in many distributions. For example, following
+Debian/Ubuntu packages are likely to be needed:
+- binutils-dev
+- libsqlite3-dev
+- libpcap-dev
+
+example-setup.txt provides more complete step-by-step example on how a
+test setup can be built.
 
 
 wpaspy
@@ -102,6 +115,16 @@ 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.
 
+Please also note that some commonly enabled tools, like NetworkManager,
+may end up trying to control new network interfaces automatically. This
+can result in conflicts with the test scripts and you may need to
+disable such network services or at least mark the mac80211_hwsim wlan#
+interfaces as umanaged. As an example, this can be done in
+/etc/NetworkManager/NetworkManager.conf with following addition:
+
+[keyfile]
+unmanaged-devices=mac:02:00:00:00:00:00;mac:02:00:00:00:01:00;mac:02:00:00:00:02:00;mac:02:00:00:00:03:00;mac:02:00:00:00:04:00
+
 
 Running tests
 -------------
@@ -110,7 +133,7 @@ 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
+test cases and stop.sh to stop the programs and unload the kernel
 module.
 
 run-all.sh can be used to run the same test cases under different
@@ -125,23 +148,19 @@ conditions:
 # run normal test cases with Linux tracing
 ./run-all.sh trace
 
-# run P2P test cases with concurrent station interface
-./run-all.sh concurrent
+# run normal test cases with multi channel support (see details below)
+./run-all.sh channels=<num of channels>
 
-# 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
+run-all.sh directs debug logs into the logs subdirectory (or $LOGDIR if
+present in the environment). 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
+- hwsim0.pcapng = capture with all frames exchanged during the tests
+- *.log = 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
@@ -151,10 +170,16 @@ 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").
+line. "-f <module name>" (pointing to file test_<module name>.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 ap_pmf_required").
+
+Notice that some tests require the driver to support concurrent
+operation on multi channels in order to run. These tests will be skipped
+in case the driver does not support multi channels. To enable support
+for multi channel, the number of supported channel is passed as an
+argument to run-all.sh or start.sh
 
 
 Adding/modifying test cases
@@ -171,7 +196,8 @@ 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.
+in these files are assumed to be test cases. Each test case is named by
+the function name following the "test_" prefix.
 
 
 Results database
@@ -187,4 +213,8 @@ CREATE TABLE results (test,result,run,time,duration,build,commitid);
 CREATE INDEX results_idx ON results (test);
 CREATE INDEX results_idx2 ON results (run);
 CREATE TABLE tests (test,description);
+CREATE UNIQUE INDEX tests_idx ON tests (test);
+CREATE TABLE logs (test,run,type,contents);
+CREATE INDEX logs_idx ON logs (test);
+CREATE INDEX logs_idx2 ON logs (run);
 EOF