README
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 2008 Sun Microsystems, Inc. All rights reserved.
24 # Use is subject to license terms.
25 #
26 # ident "@(#)README 1.5 08/07/16 SMI"
27 #
28
29 DESCRIPTION
30 ===========
31 SDTS means Storage Driver Test Suite. It automates most of storage
32 HBA driver function testing and SMP expander driver function testing.
33
34 PREREQUISITES
35 ============
36 1. A spare disk is required for this test suite to run.
37 2. The test harness package SUNWcti-tetlite is required to be installed.
38 You can find the package on OpenSolaris Test Consolidation:
39 http://www.opensolaris.org/os/community/testing/testsuites/ctifortet/
40 3. To test SMP expander function, you need to download the binary of "lsiutil"
41 from LSI's website. Otherwise, you can not test SMP expander function and
42 you can ignore the section to install lsiutil binary.
43
44 CTI-TET PACKAGE INSTALLATION
45 ===========================
46 As root do the following:
47 1. get SUNWstc-tetlite
48 2. pkgadd -d . SUNWstc-tetlite
49
50 LSIUTIL BINARY INSTALLATION
51 ============================
52 To run SMP test cases, you must copy lsiutil binary to testing platform.
53 You can download the following archives from LSI's website.
54 Here is the web link:
55 For x86 platform:
56 http://www.lsi.com/support/downloads/hbas/sas/software_drivers/other/SAS_Solaris_8-9_x86.zip
57
58 For sparc platform:
59 http://www.lsi.com/support/downloads/hbas/sas/software_drivers/other/SAS_Solaris_8-9_sparc.zip
60
61 After download the archive, run the following commands to install the
62 binary, following is an example of x86 platform.
63 1. unzip SAS_Solaris_8-9_x86.zip
64 2. uncompress itmpt_XXXX_i386.tar.Z
65 3. tar xvpf itmpt_XXXX_i386.tar
66 4. cd install/ITImpt/reloc/usr/bin
67 5. cp -rfp lsiutil /usr/bin
68
69 TEST SUITE INSTALLATION
70 =======================
71
72 I: Based on SDTS package
73 1. get sdts package SUNWstc-sdts
74 2. pkgadd -d . SUNWstc-sdts
75
76 II: Based on SDTS source code
77 1. get SDTS source code and put it in /export/home/
78 2. export TET_ROOT=/opt/SUNWstc-tetlite
79 3. export CTI_ROOT=/opt/SUNWstc-tetlite/contrib/ctitools
80 4. export TET_SUITE_ROOT=/export/home/sdts/src/suites/storage
81 5. cd $TET_SUITE_ROOT/sdts
82 6. /usr/ccs/bin/make
83
84 TEST SUITE CONFIGURATION
85 ========================
86 As root do the following steps:
87 1. Set the following environment variables
88
89 Using SDTS package:
90 export TET_ROOT=/opt/SUNWstc-tetlite
91 export CTI_ROOT=$TET_ROOT/contrib/ctitools
92 export PATH=$PATH:$CTI_ROOT/bin
93 export TET_SUITE_ROOT=/opt/SUNWstc-sdts
94
95 Using SDTS source code:
96 export TET_ROOT=/opt/SUNWstc-tetlite
97 export CTI_ROOT=$TET_ROOT/contrib/ctitools
98 export PATH=$PATH:$CTI_ROOT/bin
99 export TET_SUITE_ROOT=/export/home/sdts/src/suites/storage
100
101 2. To configure the test suite
102 Assuming that the sdts test disk is c2t1d0, running the following command
103 creates the test_config file.
104
105 # run_test -v disk=c2t1d0 sdts configure
106
107 Note: the disk name must be in the form of cxtxdx or cxdx.
108 Warning: the execution of this test suite will destroy all data on the
109 disk. Make sure the test disk doesn't have any data you don't want to lose.
110
111 Another variable that can be set in the configuration line:
112
113 debug - [ TRUE || FALSE ] default FALSE
114
115 Following is an example to enable debug:
116 # run_test -v disk=c1t1d0 -v debug=TRUE sdts configure
117
118 TEST SUITE EXECUTION
119 ====================
120 The test suite must be executed as root.
121
122 If not already done, from the configuration phase, do the following to
123 set the environmental variables:
124
125 Using SDTS package:
126 export TET_ROOT=/opt/SUNWstc-tetlite
127 export CTI_ROOT=$TET_ROOT/contrib/ctitools
128 export PATH=$PATH:$CTI_ROOT/bin
129 export TET_SUITE_ROOT=/opt/SUNWstc-sdts
130
131 Using SDTS source code:
132 export TET_ROOT=/opt/SUNWstc-tetlite
133 export CTI_ROOT=$TET_ROOT/contrib/ctitools
134 export PATH=$PATH:$CTI_ROOT/bin
135 export TET_SUITE_ROOT=/export/home/sdts/src/suites/storage
136
137 To run the test suite do the following:
138
139 # run_test sdts
140
141 Note: The command above will not run SMP function test.
142
143 To run all the test purposes you should run following command:
144
145 # run_test sdts diskcmd
146
147 To execute individual scenarios (fdisk format newfs vtoc):
148
149 # run_test sdts <scenario>
150
151 # run_test sdts fdisk
152
153 To execute a Test Purpose within a scenario:
154
155 run_test sdts diskcmd/<test case dir>:<test purpose number>
156
157 # run_test sdts diskcmd/fdisk:1
158
159 Test case directories are fdisk, format, newfs, and vtoc.
160
161 To run the SMP expander function test:
162
163 # run_test sdts smp
164
165 Note: You can define customized test scenarios by adding entries to
166 the test scenario file: $TET_SUITE_ROOT/sdts/tet_scen.
167
168 For how to edit the test scenario file, refer to the TET user guide at:
169 http://tetworks.opengroup.org/tet/
170
171 TEST SUITE UNCONFIGURATION
172 ==========================
173
174 # run_test sdts unconfigure
175