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 2009 Sun Microsystems, Inc. All rights reserved.
24 # Use is subject to license terms.
25 #
26 # pragma ident "@(#)README 1.4 09/06/09 SMI"
27 #
28
29 The SMF Test Suite README
30
31
32 CONTENTS
33
34 1. Building & Installation
35 1.1 Installing from Packages
36 1.2 Uninstalling the Test Suite Package
37 1.3 Building the Test Suite (optional)
38 1.4 System Requirements
39 2. Running the tests
40 2.1 Configuring and running the tests
41 3. Unconfigure the suite
42 4. Special requirements
43 4.1 Zones Test
44
45
46
47 ================================================================================
48
49 1. Building & Installation
50
51 1.1 Installing from Packages
52
53 o In the majority of cases, the test suite can be installed from
54 packages. The package is called SUNWstc-os-smf and its default
55 installation directory is /opt/SUNWstc-os-smf. Installation is via
56 the standard Solaris package installation tool pkgadd(1m).
57
58 To install SUNWstc-os-smf simply enter the following command line:
59
60 % sudo pkgadd -d <package location> SUNWstc-os-smf
61
62 Where <package location> refers to the path containing the
63 SUNWstc-os-smf package directory.
64
65 o It is recommended that you install the packages from scratch, rather
66 than on top of an existing installation. Thus, if an old version of
67 the tests is installed:
68
69 % sudo pkgrm SUNWstc-os-smf
70
71 1.2 Uninstalling the Test Suite Package
72
73 o Prior to uninstalling the SUNWstc-os-smf package, you may want to
74 run stf_unconfigure from the top level directory. Typically, this
75 will be "/opt/SUNWstc-os-smf". Unconfiguring the test suite is
76 recommended if you have previously run the suite, and especially so,
77 if you have run the test suite in non-global zones. For more detail
78 on how to unconfigure the suite see section 3.1.
79
80 o To uninstall the package, use the standard Solaris package removal
81 tool pkgrm(1m) as follows:
82
83 % sudo pkgrm SUNWstc-os-smf
84
85 1.3 Building the Test Suite (optional)
86
87 o This method uses the standard STF techniques to create a Solaris
88 package, which will be installed under the base directory
89 "/opt/SUNWstc-os-smf".
90
91 Briefly, this build and installation is performed as follows:
92
93 # set path to STF bin directory
94 % PATH=<path-to-STF>/bin/`uname -p`:$PATH
95 % export PATH
96
97 # WS_ROOT is the root of the STC workspace containing the
98 # SMF test suite source code
99 #
100 % cd <WS_ROOT>/usr/src/suites/smf
101 % stf_build package
102 % cd <WS_ROOT>/packages/`uname -p`
103 % sudo pkgadd -d `pwd` SUNWstc-os-smf
104
105 o It is recommended that you install the packages from scratch, rather
106 than on top of an existing installation. Thus, if an old version of
107 the tests is installed:
108
109 % sudo pkgrm SUNWstc-os-smf
110
111 1.4 System Requirements
112
113 o Beginning with version 1.7 of this test suite, snv_102 or greater is
114 required to successfully build and execute all tests.
115
116 ================================================================================
117
118 2. Running the tests
119
120 2.1 Configuring and running the tests
121
122 2.1.1 Configure the tests
123
124 o Configuration of the test suite is completed with the stf_configure
125 command.
126
127 % cd /opt/SUNWstc-os-smf; stf_configure
128
129 o For stf_configure options refer to the STF User's Guide.
130
131 2.1.2 Run the tests
132
133 o To execute all of the modes on current system platform:
134
135 % cd /opt/SUNWstc-os-smf; stf_execute
136
137 o To execute in a specific mode:
138
139 % stf_execute -m <mode>
140
141 o To execute only test cases in a specific directory:
142
143 % cd /opt/SUNWstc-os-smf/<test directory>; stf_execute
144
145 o For other stf_execute options, refer to the STF User's Guide.
146
147 ================================================================================
148
149 3. Unconfigure the suite.
150
151 o Use the STF unconfigure tool.
152
153 % cd /opt/SUNWstc-os-smf; stf_unconfigure
154
155 ================================================================================
156
157 4. Special Requirements
158
159 4.1 Zones test
160 o This suite includes a zones test to verify SMF services are properly
161 handled in non-global zones. The test requires the Solaris package
162 management scripts (pkgadd, pkgrm etc) and will not work with the IPS
163 packaging mechanism.
164