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 2007 Sun Microsystems, Inc. All rights reserved.
24 # Use is subject to license terms.
25 #
26 # ident "@(#)README 1.4 07/06/25 SMI"
27 #
28
29 DESCRIPTION:
30 ===========
31 This test suite is designed to test the functionality of the iscsi
32 target software level creation utility. If configured the test
33 suite will also confirm the target creation and configurations,
34 use the iscsiadm command to make connections to the target and further
35 verify the functionality of the iscsitadm command.
36
37 PREREQUISITES:
38 ============
39 1. A spare disk is required for this test suite to use for its work.
40
41 2. There should be no iscsi targets configured via the iscsitadm
42 command.
43
44 3. The cti-tet test harness lite package is required to be installed,
45 or be accessible via nfs.
46
47 4. If a second host is to be used to check with the iscsiadm command,
48 that host should accept rcp and rsh calls from the test host.
49
50 CTI-TET PACKAGE INSTALLATION:
51 ===========================
52 As root do the following :
53
54 In the majority of cases, the test suite can be installed from packages. The
55 package is called SUNWstc-tetlite and installs into "/opt" by default.
56 Installation is via the standard Solaris package installation tool pkgadd(1m).
57 To install SUNWstc-tetlite simply enter the following command line:
58
59 # pkgadd -d <package location> SUNWstc-tetlite
60
61 Where <package location> refers to the path containing the SUNWstc-tetlite
62 package directory.
63
64 o It is recommended that you install the packages from scratch,
65 rather than on top of an existing installation. Thus, if an old
66 version of the tests is installed:
67
68 # pkgrm SUNWstc-tetlite
69
70 It is also acceptable to use an nfs accessible version of the SUNWstc-tetlite
71 package.
72
73
74 TEST SUITE INSTALLATION :
75 =======================
76
77 As root do the following :
78
79 In the majority of cases, the test suite can be installed from packages. The
80 package is called SUNWstc-iSCSI and installs into "/opt" by default.
81 Installation is via the standard Solaris package installation tool pkgadd(1m).
82 To install SUNWstc-iSCSI simply enter the following command line:
83
84 # pkgadd -d <package location> SUNWstc-iSCSI
85
86 Where <package location> refers to the path containing the SUNWstc-iSCSI
87 package directory.
88
89 o It is recommended that you install the packages from scratch,
90 rather than on top of an existing installation. Thus, if an old
91 version of the tests is installed:
92
93 # pkgrm SUNWstc-iSCSI
94
95 It is also acceptable to use an nfs accessible version of the SUNWstc-iSCSI
96 package.
97
98
99 The test suite source can also be installed locally, built in the source
100 tree and run from that location.
101
102 As any user do the following after installing the test suite source :
103 1. TET_ROOT=/opt/SUNWstc-tetlite
104 2. export TET_ROOT
105 3. CTI_ROOT=$TET_ROOT/contrib/ctitools
106 4. export CTI_ROOT
107 5. TET_SUITE_ROOT=/export/home/cti_iscsi/src/suites (e.g location)
108 6. export TET_SUITE_ROOT
109 7. cd $TET_SUITE_ROOT/iSCSI
110 8. /usr/ccs/bin/make
111
112
113 TEST SUITE CONFIGURATION :
114 ========================
115
116 As root do the following steps :
117
118 1. Set the following environment variables
119 export TET_ROOT=/opt/SUNWstc-tetlite
120 export CTI_ROOT=$TET_ROOT/contrib/ctitools
121 export TET_SUITE_ROOT=/opt/SUNWstc-iSCSI (installation path of suite)
122 PATH=$PATH:$CTI_ROOT/bin
123 export PATH
124
125 2. To configure the test suite :
126
127 # run_test -v iscsi_disk=c0t1d0 iSCSI configure
128
129 Other configurable variables that can be set in the configuration line :
130
131 FSCONFIGTYPE - [ ufs || zfs ] default ufs
132 THINPROV - [ on || off ] default off
133 target_ip - [ iscsi target ip address to use for initiator ] default null
134 iscsiadm_ip - [ iscsi initiator ip address ] default null
135 online_wait - [ number of 5 second intervals to wait for initiator ] 24
136 verbose - [ TRUE || FALSE ] default FALSE
137
138 TEST SUITE EXECUTION :
139 ====================
140
141 The test suite executions is required to be done as root.
142
143 If not already done, from the configuration phase do the following to
144 set the environment variables :
145
146 export TET_ROOT=/opt/SUNWstc-tetlite
147 export CTI_ROOT=$TET_ROOT/contrib/ctitools
148 export TET_SUITE_ROOT=/opt/SUNWstc-iSCSI (installation path of suite)
149 PATH=$PATH:$CTI_ROOT/bin
150 export PATH
151
152 To run the entire test suite do the following.
153
154 # run_test iSCSI
155
156 To execute individual scenarios (create modify delete)
157
158 # run_test iSCSI <scenario>
159
160 # run_test iSCSI create
161
162 To execute Test Purposes within a scenario :
163
164 run_test iSCSI iscsitadm/<test case dir>:<test purpose number>
165
166 # run_test iSCSI iscsitadm/create:1
167
168 Test case directories are create, modify and delete
169
170 TEST SUITE UNCONFIGURE :
171 ======================
172
173 The unconfiguration of the test suite simply takes out the configuration file
174 for the current host, so that an nfs mounted point for execution can be used.
175 This does not unconfigure any iscsi targets etc from the host.
176
177 # run_test iSCSI unconfigure
178