Home | History | Annotate | Download | only in stf
      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.1	07/06/25 SMI"
     27 #
     28 
     29 ===============================================================================
     30 
     31 Overview
     32 
     33 The Solaris Test Framework (STF) is a test harness - a collection of software
     34 that builds, configures, executes, unconfigures, cleans and packages tests in
     35 a standard way. STF provides the framework needed to develop and execute test
     36 suites for Solaris technology in a consistent manner. 
     37 
     38 STF contains the following features:
     39 
     40 * Commands for building (stf_build), configuring (stf_configure), executing 
     41 (stf_execute) and unconfiguring (stf_unconfigure) test suites and tools
     42 * Makefile support that defines macros and targets helpful for test development
     43 * Support for assertion-based testing and standard result codes
     44 * Standard build environment that can be customized if needed
     45 * Support for building and running on all Solaris-supported platforms
     46 * Configurable timeout values for test case execution
     47 * Journaling interfaces for complete, parsable test suite logging
     48 * Support for running tests as regular user and super user
     49 * Support for test-case specific setup and cleanup
     50 * Seamless integration with STC 2.0 packaging and checkenv features
     51 * Journal parsing tool (stf_filter)
     52 * Extensible user-defined execution modes
     53 * Support for table-driven testing and automated test case generation
     54 * Support for synchronized execution of multi-system tests (mstf)
     55 
     56 ===============================================================================
     57 
     58 Installing the Package
     59 
     60 To install the STF package, use the following command as super user:
     61 
     62 	% pkgadd -d <package location>  SUNWstc-stf
     63 
     64 Where <package location> refers to the path containing the SUNWstc-stf
     65 package directory. This will install STF into the /opt/SUNWstc-stf
     66 directory.
     67 
     68 ===============================================================================
     69 
     70 Removing the Package
     71 
     72 It is recommended that you install the package from scratch, rather than on
     73 top of an existing installation.  Thus, if an old version of the package is
     74 present use the following command as super user to remove the package:
     75 
     76         % pkgrm SUNWstc-stf
     77 
     78 ===============================================================================
     79 
     80 Building the Package (Optional)
     81 
     82 If you need to create the STF package from the source code use the following
     83 steps:
     84 
     85 	# build STF proto area (See Note 1 below)
     86 	% cd <workspace_path>/src/tools/stf
     87 	% make
     88 
     89 	# set path to STF bin directory
     90 	% PATH=<workspace_path>/proto/tools/stf/bin/`uname -p`:$PATH
     91 	% export PATH
     92 
     93 	# build STF package
     94 	% stf_build package
     95 
     96 The binaries will be located in the proto area at:
     97 <workspace_path>/proto/tools/stf
     98 
     99 The SUNWstc-stf package will be located at:
    100 <workspace_path>/packages/`uname -p`
    101 
    102