Handle NULL return from os_zalloc() in sta_track_add()

[mech_eap.git] / tests / hwsim / README

diff --git a/tests/hwsim/README b/tests/hwsim/README
index 3b2d7ce..e68b0dc 100644 (file)
--- a/tests/hwsim/README
+++ b/tests/hwsim/README
@@ -12,17 +12,18 @@ 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
@@ -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
 -------------
@@ -125,6 +148,9 @@ conditions:
 # run normal test cases with Linux tracing
 ./run-all.sh trace
 
+# run normal test cases with multi channel support (see details below)
+./run-all.sh channels=<num of channels>
+
 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:
@@ -149,6 +175,12 @@ 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
 ---------------------------
@@ -181,6 +213,7 @@ 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);