Home | History | Annotate | Download | only in driver-wifi
      1 #
      2 # CDDL HEADER START
      3 #
      4 # The contents of this file are subject to the terms of the
      5 # Common Development and Distribution License (the "License").
      6 # You may not use this file except in compliance with the License.
      7 #
      8 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9 # or http://www.opensolaris.org/os/licensing.
     10 # See the License for the specific language governing permissions
     11 # and limitations under the License.
     12 #
     13 # When distributing Covered Code, include this CDDL HEADER in each
     14 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15 # If applicable, add the following below this CDDL HEADER, with the
     16 # fields enclosed by brackets "[]" replaced with your own identifying
     17 # information: Portions Copyright [yyyy] [name of copyright owner]
     18 #
     19 # CDDL HEADER END
     20 #
     21 
     22 #
     23 # Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     24 # Use is subject to license terms.
     25 #
     26 # ident	"@(#)README	1.2	09/09/03 SMI"
     27 #
     28 
     29 DESCRIPTION:
     30 ============
     31 
     32 This test suite tests the functionality and performance of WiFi drivers.
     33 
     34 
     35 PREREQUISITES:
     36 ==============
     37 
     38 The SUNWstc-tetlite test harness package is required to be installed,
     39 or be accessible via nfs.
     40 
     41 This test suite requres two test machines.  Both of them should have a
     42 WiFi and a NIC interfaces.  The NIC interface is used to control the
     43 execution of the test suite.  Rsh service should be enabled on remote
     44 host for user root.  Here is the steps to enable rsh service:
     45 
     46 # echo "+ +" > $HOME/.rhosts;
     47 # svcadm enable svc:/network/shell:default;
     48 
     49 If the system is OpenSolaris instead of Nevada, please disable nwam service
     50 and enable physical:default service.
     51 
     52 # svcadm disable svc:/network/physical:nwam
     53 # svcadm enable svc:/network/physical:default
     54 
     55 Finally, another command is needed to enable rsh service for OpenSolaris.
     56 
     57 # rolemod -K type=normal root
     58 
     59 Driver-wifi test suite uses uperf to do performance test.  User should provide
     60 uperf binaries.  The test suite provides a default value for Sun internal
     61 users in configure file config/test_config.
     62 UPERF=/net/pae.sfbay/export/home/uperf/latest/uperf
     63 Please note that this path is subjected to change without notification by PAE.
     64 For external users, please install uperf manually on both machines at the same
     65 location and set UPERF variable accordingly.
     66 
     67 Uperf is a network performance tool that supports modelling and replay of
     68 various networking patterns. Uperf was developed by the Performance Applications
     69 Engineering group at Sun Microsystems and is released under the GNU General
     70 Public License Version 3.
     71 For more information, please visit the homepage http://www.uperf.org and the
     72 following directories for Sun internal users.
     73 /net/pae.sfbay/export/home/uperf
     74 /net/pae.sfbay/export/home/ncs
     75 
     76 
     77 CTI-TET PACKAGE INSTALLATION:
     78 =============================
     79 
     80 The CTI-TET package is called SUNWstc-tetlite and installs into "/opt"
     81 by default.  Installation is via the standard Solaris package
     82 installation tool pkgadd(1m).  To install SUNWstc-tetlite simply enter
     83 the following command line as root (or having adopted the root role):
     84 
     85 # pkgadd -d <package location>  SUNWstc-tetlite
     86 
     87 Where <package location> refers to the path containing the SUNWstc-tetlite
     88 package directory.
     89 
     90 o It is recommended that you install the packages from scratch, rather
     91   than on top of an existing installation.  Thus, if an old version of
     92   the tests is installed, remove it:
     93 
     94 # pkgrm SUNWstc-tetlite
     95 
     96 It is also acceptable to use an nfs accessible version of SUNWstc-tetlite.
     97 
     98 
     99 TEST SUITE INSTALLATION:
    100 ========================
    101 
    102 In the majority of cases, the test suite can be installed from packages.
    103 The package is called SUNWstc-driver-wifi and installs into "/opt" by
    104 default.  Installation is via the standard Solaris package installation
    105 tool pkgadd(1m).  To install SUNWstc-driver-wifi simply enter the following
    106 command line as root (or having adopted the root role):
    107 
    108 # pkgadd -d <package location>  SUNWstc-driver-wifi
    109 
    110 Where <package location> refers to the path containing the SUNWstc-driver-wifi
    111 package directory.
    112 
    113 o It is recommended that you install the packages from scratch, rather
    114   than on top of an existing installation.  Thus, if an old version of
    115   the tests is installed:
    116 
    117 # pkgrm SUNWstc-driver-wifi
    118 
    119 It is also acceptable to use an nfs accessible version of SUNWstc-driver-wifi.
    120 
    121 Optionally, the test suite source can be installed locally, built in the
    122 source tree and run from that location.
    123 As any user do the following after installing the test suite source :
    124 
    125 1. export TET_ROOT=/opt/SUNWstc-tetlite
    126 2. export CTI_ROOT=$TET_ROOT/contrib/ctitools
    127 3. cd $WIFI_WS/usr/src/suites/net/driver-wifi (e.g location)
    128 4. export PATH=/opt/SUNspro/bin:$PATH (or other Sun Studio path)
    129 5. /usr/bin/make
    130 
    131 The build can also install into a proto directory below the workspace
    132 root directory.  The workspace root is the directory under which the
    133 usr/src or usr/closed directory is located (so, in the example location
    134 used in step 3 above, the workspace root is "$WIFI_WS").
    135 In addition, test suite packages can be built using the proto directory
    136 and stored in the packages directory below the defined workspace root
    137 directory.  To install the binaries into the proto area, do:
    138 
    139 9. /usr/ccs/bin/make install
    140 
    141 To create the test suite package, do
    142 
    143 10. /usr/ccs/bin/make package
    144 
    145 
    146 TEST SUITE CONFIGURATION:
    147 =========================
    148 
    149 The configure file is config/test_config.
    150 
    151      __________       _________      _________
    152     |          |     |         |    |         |
    153     |          |     |         |    |         |
    154     |       NIC|-----|         |----|NIC      |
    155     |          |     |         |    |         |
    156     |      iwk0|     |         |    |iwk1     |
    157     |          |     |         |    |         |
    158     |__________|     |_________|    |_________|
    159      local host        switch       remote host
    160                       (optional)  (hostname: leape)
    161 
    162 Except UPERF, another five variables must be defined to run this test suite.
    163 Two of them have default values.  They are TEST_IP and RMT_TEST_IP.
    164 So for the above picture, please define the configure variables like this:
    165 TEST_IF=iwk0
    166 RMT_HOST=leape
    167 RMT_TEST_IF=iwk1
    168 
    169 Some other variables are configurable also. Here is some examples that
    170 could be used:
    171 1. IBSS test scenario will run in three supported modes, none security,
    172 64-bit WEP and 128-bit WEP by default. To run none security mode only,
    173 do like this,
    174 
    175 IBSS_SEC_MODES=none
    176 
    177 or to run in both none security and 64-bit WEP modes, do like this,
    178 
    179 IBSS_SEC_MODES=none:64wep
    180 
    181 2. To run uperf/NFS Corrupt test for 20 minutes, do like this,
    182 
    183 IBSS_TP{5,6}_DURATION=1200
    184 
    185 3. To run uperf/NFS Corrupt test for udp protocol only, do like this,
    186 
    187 IBSS_TP{5,6}_PROTOCOLS=udp
    188 
    189 or to run for both protocols, do like this,
    190 
    191 IBSS_TP{5,6}_PROTOCOLS=tcp:udp
    192 
    193 The similar configuration apples to IBSS_TP{5,6}_TRAFFICS and
    194 IBSS_TP{5,6}_SESSIONS also.
    195 
    196 To verify the correctness of configuration, do like this,
    197 
    198 # run_test driver-wifi configure
    199 
    200 
    201 TEST SUITE EXECUTION:
    202 =====================
    203 
    204 The test suite execution is required to be done as root.
    205 
    206 Set up the environment variables:
    207 
    208 export TET_ROOT=/opt/SUNWstc-tetlite
    209 export TET_SUITE_ROOT=/opt/SUNWstc-driver-wifi
    210 export PATH=$PATH:$CTI_ROOT/bin
    211 
    212 To run the entire test suite, do the following:
    213 
    214 # run_test driver-wifi
    215 
    216 To run test purpose 4 of IBSS test scenario, do the following:
    217 
    218 # run_test driver-wifi ibss:4
    219 
    220 To run all test purposes of IBSS test scenario, do the following:
    221 
    222 # run_test driver-wifi ibss
    223 
    224 
    225 EVALUATING TEST SUITE RESULTS:
    226 ==============================
    227 
    228 At the completion of a test run, a summary of test results will be
    229 displayed on the terminal where the test suite was invoked.  If only
    230 the configure scenario were run, this typically indicates a problem
    231 was encountered.  Details on any issues can be found by viewing the
    232 journal file, the location of which will be reported by TET at the
    233 end of the test run.
    234 
    235 The following test status values can be reported:
    236 
    237 	PASS - Test ran to completion with no issues
    238 	FAIL - Test ran to completion, but failed to prove the assertion
    239 	UNRESOLVED - Unable to execute test assertion because of an issue
    240 	    in prerequisite steps.
    241 	UNTESTED - Test skipped, either because support for feature missing
    242 	    on test system.
    243 
    244 
    245 TEST SUITE UNCONFIGURE:
    246 =======================
    247 
    248 No test suite unconfiguration step is necessary.  So long as none of
    249 the tests terminated abnormally, the suite will leave the test system
    250 in the same shape that it found it.
    251 
    252 Should the test suite exit abnormally (system goes down during testing,
    253 etc.) then the tests may leave behind connected ad hoc network or secure
    254 object. So to clean up the test environment, do the following:
    255 
    256 # run_test driver-wifi unconfigure
    257