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.2 08/11/07 SMI"
27 #
28
29 DESCRIPTION
30 ===========
31 The LSI MegaCli tool is a command line interface application for MegaRAID SAS
32 controllers. You can use this utility to configure, monitor, and maintain
33 MegaRAID SAS controllers and the devices connected to them.
34 megacli is a test suite for mega_sas driver regression testing. It will use
35 LSI MegaCli tool to verify:
36 - mega_sas driver support the LSI MegaRAID SAS 1078 based controllers working
37 on Solaris platform.
38 - mega_sas driver support the LSI MegaCli tool running on Solaris platform.
39
40 PREREQUISITES
41 ============
42 1. One LSI MegaRAID SAS 1078 based controller as the testing target.
43 2. One hard disk drive attached to the LSI MegaRAID SAS 1078 controller and
44 doesn't configured in a volume. You need to attach 6 such disk drives if you
45 want to run all the test cases.
46 3. For SNV users, use SNV_88 or above. For S10 Updates users, use
47 S10U6_02 or above as the base OS.
48 4. CTI-TET lite package; Refer to the following section on how to get
49 and install the CTI-TET package.
50 5. MegaCli binary; Refer to the following section on how to get
51 and install the MegaCli binary.
52
53 CTI-TET PACKAGE INSTALLATION
54 ============================
55 As root do the following:
56 1. Download SUNWstc-tetlite-YYYMMDD.i386.tar.bz2 from:
57 http://dlc.sun.com/osol/test/downloads/current/
58 2. bzcat SUNWstc-tetlite-YYYYMMDD.i386.tar.bz2 | tar -xvf -
59 3. pkgadd -d ./packages/i386/
60
61 MEGACLI TOOL INSTALLATION
62 =========================
63 Download MegaCli tool archive from:
64 http://tinyurl.com/megacli-solaris
65
66 As root do the following:
67 After downloading the archive, run the following commands to install the binary:
68 1. unzip 2.00.15_Solaris_MegaCLI.zip
69 2. cp MegaCli /usr/bin
70 3. chmod +x /usr/bin/MegaCli
71
72 TEST SUITE INSTALLATION
73 =======================
74 You can install the test suite on the system under testing, or at a network
75 location which is accessible by the system under testing.
76
77 As root do the following:
78
79 I: Based on megacli package
80 1. get megacli package SUNWstc-storage-megacli
81 2. pkgadd -d . SUNWstc-storage-megacli
82
83 II: Based on megacli source code
84 1. get megacli source code and put it into /export/home/
85 2. export TET_ROOT=/opt/SUNWstc-tetlite
86 3. export CTI_ROOT=/opt/SUNWstc-tetlite/contrib/ctitools
87 4. export TET_SUITE_ROOT=/export/home/megacli/src/suites
88 5. cd $TET_SUITE_ROOT/storage/megacli
89 6. /usr/ccs/bin/make
90
91 TEST SUITE CONFIGURATION
92 ========================
93 As root do the following:
94 1. Set the following environment variables
95
96 Using megacli pakcage:
97 export TET_ROOT=/opt/SUNWstc-tetlite
98 export CTI_ROOT=$TET_ROOT/contrib/ctitools
99 export PATH=$PATH:$CTI_ROOT/bin
100 export TET_SUITE_ROOT=/opt/SUNWstc-storage-megacli
101
102 Using megacli source code:
103 export TET_ROOT=/opt/SUNWstc-tetlite
104 export CTI_ROOT=$TET_ROOT/contrib/ctitools
105 export PATH=$PATH:$CTI_ROOT/bin
106 export TET_SUITE_ROOT=/export/home/megacli/src/suites
107
108 2. To configure the test suite
109
110 # run_test -v ADAPTER=1 storage/megacli configure
111
112 Note: You can get the ADAPTER number by running "MegaCli -AdpAllInfo -aALL".
113
114 Warning: the execution of this test suite will destroy all data on testing
115 disks. Make sure the disks available for the testing adapter do not have
116 any useful data.
117
118 Other configurable variables that can be set in the configuration line:
119
120 DEBUG - [ TRUE || FALSE ] default FALSE
121
122 Following is an example to enable DEBUG:
123 # run_test -v ADAPTER=1 -v DEBUG=TRUE storage/megacli configure
124
125 CFGCLEAR - [ TRUE || FALSE] default FALSE
126
127 Following is an example to enable CFGCLEAR:
128 # run_test -v ADAPTER=1 -v DEBUG=TRUE storage/megacli configure
129
130 Warning: the enable of CFGCLEAR option will destroy all configuration on
131 testing controller. Make sure the testing controller do not have any useful
132 configuration, especially there should not have root file system located
133 on this controller.
134
135 TEST SUITE EXECUTION
136 ====================
137 The test suite must be executed as root.
138
139 If you haven't done this at configuration phase, set the environment
140 variables as following:
141
142 For user using megacli pakcage:
143 export TET_ROOT=/opt/SUNWstc-tetlite
144 export CTI_ROOT=$TET_ROOT/contrib/ctitools
145 export PATH=$PATH:$CTI_ROOT/bin
146 export TET_SUITE_ROOT=/opt/SUNWstc-storage-megacli
147 For user using megacli source code:
148 export TET_ROOT=/opt/SUNWstc-tetlite
149 export CTI_ROOT=$TET_ROOT/contrib/ctitools
150 export PATH=$PATH:$CTI_ROOT/bin
151 export TET_SUITE_ROOT=/export/home/megacli/src/suites
152
153 To run the entire test suite do the following:
154
155 # run_test storage/megacli
156
157 To execute individual scenario (basic raid0 raid1 raid5 raid6 raid10
158 raid50 raid60):
159
160 run_test storage/megacli <scenario>
161
162 # run_test storage/megacli raid0
163
164 To execute Test Purpose within a scenario:
165
166 run_test storage/megacli cmd/<test case dir>:<test purpose number>
167
168 # run_test storage/megacli cmd/raid0:1
169
170 Note: You can define customized test scenarios by adding entries to
171 the test scenario file: $TET_SUITE_ROOT/storage/megacli/tet_scen.
172
173 For how to edit the test scenario file, refer to the TET user guide at:
174 http://tetworks.opengroup.org/tet/
175
176 TEST SUITE UNCONFIGURE
177 ======================
178
179 # run_test storage/megacli unconfigure
180
181 TEST SUITE BUILDING
182 ===================
183 As root do the following:
184 1. Get megacli source code and put it into /export/home/
185
186 2. Set the environment variables
187 # export TET_ROOT=/opt/SUNWstc-tetlite
188 # export CTI_ROOT=/opt/SUNWstc-tetlite/contrib/ctitools
189 # export TET_SUITE_ROOT=/export/home/megacli/src/suites
190
191 3. cd $TET_SUITE_ROOT/storage/megacli
192
193 4. Build code
194 # /usr/ccs/bin/make
195 # /usr/ccs/bin/make install
196 # /usr/ccs/bin/make package
197
198 5. Build clean
199 # /usr/ccs/bin/make clean
200 # /usr/ccs/bin/make clobber
201