Cross Reference: /test/ontest-stc2/src/suites/share/README

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# ident	"@(#)README	1.5	07/07/10 SMI"
#


DESCRIPTION:
===========
This test suite is designed to test the functionality of the sharemgr
file system share configuration utility.

PREREQUISITES:
============
1. 4 slices on a spare disk are required to test the sharemgr functionality.

2. The cti-tet test harness lite package is required to be installed,
or be accessible via nfs.


CTI-TET PACKAGE INSTALLATION:
===========================
As root do the following :

In the majority of cases, the test suite can be installed from packages. The
package is called SUNWstc-tetlite and installs into "/opt" by default.
Installation is via the standard Solaris package installation tool pkgadd(1m).
To install SUNWstc-tetlite simply enter the following command line:

# pkgadd -d <package location>  SUNWstc-tetlite

Where <package location> refers to the path containing the SUNWstc-tetlite
package directory.

o It is recommended that you install the packages from scratch,
rather than on top of an existing installation.  Thus, if an old
version of the tests is installed:

# pkgrm SUNWstc-tetlite

It is also acceptable to use an nfs accessible version of the SUNWstc-tetlite
package.

TEST SUITE INSTALLATION :
=======================

As root do the following :

In the majority of cases, the test suite can be installed from packages. The
package is called SUNWstc-share and installs into "/opt" by default.
Installation is via the standard Solaris package installation tool pkgadd(1m).
To install SUNWstc-share simply enter the following command line:

# pkgadd -d <package location>  SUNWstc-share

Where <package location> refers to the path containing the SUNWstc-share
package directory.

 o It is recommended that you install the packages from scratch,
 rather than on top of an existing installation.  Thus, if an old
 version of the tests is installed:

# pkgrm SUNWstc-share

It is also acceptable to use an nfs accessible version of the SUNWstc-share
package.

The test suite source can also be installed locally, built in the source
tree and run from that location. (optional)

As any user do the following after installing the test suite source :

1. TET_ROOT=/opt/SUNWstc-tetlite
2. export TET_ROOT
3. CTI_ROOT=$TET_ROOT/contrib/ctitools
4. export CTI_ROOT
5. TET_SUITE_ROOT=/export/home/cti_share/src/suites (e.g location)
6. export TET_SUITE_ROOT
7. cd $TET_SUITE_ROOT/share
8. /usr/ccs/bin/make

The build can also install into a proto directory below the defined CODEMGR_WS
environment variable.  In addition, test suite packages can be built using
the proto directory and stored in the packages directory below the defined
CODEMGR_WS environment variable. For example :

Define CODEMGR_WS, if not already defined.

9. export CODEMGR_WS=<workspace root>

Build the test suite code and install it under CODEMGR_WS/proto with :

10. /usr/ccs/bin/make install

Create the tests suite package under CODEMGR_WS/packages :

11. /usr/ccs/bin/make package


TEST SUITE CONFIGURATION :
========================

As root do the following steps :

1. Set the following environment variables
export TET_ROOT=/opt/SUNWstc-tetlite
export CTI_ROOT=$TET_ROOT/contrib/ctitools
export TET_SUITE_ROOT=/opt/SUNWstc-share (installation path of suite)
PATH=$PATH:$CTI_ROOT/bin
export PATH

2. To configure the test suite :

# run_test -v share_disk="slice1,slice2,slice3,slice4" share [<ufs_|zfs_>]configure

where slice<n> is one of either /dev/dsk/cntndnsn, cntndnsn or a lofi device of the
format /dev/lofi/n.

4 slices are required for the test suite to operate on.  The slices do not have
to have filesystems created on them.  The test suite will create the appropriate
filesystem types on the devices given, based on the configuration type.  This
means that any data on the slices given will be destroyed.

ufs_ configures strict ufs filesystems.
zfs_ configures strict zfs filesystems.
neither will configure a mix of ufs and zfs filesystems.

TEST SUITE EXECUTION :
====================

The test suite executions is required to be done as root.

If not already done, from the configuration phase do the following to
set the environment variables :

export TET_ROOT=/opt/SUNWstc-tetlite
export CTI_ROOT=$TET_ROOT/contrib/ctitools
export TET_SUITE_ROOT=/opt/SUNWstc-share (installation path of suite)
PATH=$PATH:$CTI_ROOT/bin
export PATH

To run the entire test suite do the following.

# run_test share

The following is the syntax of the command line usage :

# run_test share [<scenario>|tc_dir:[tp_list]]

additional examples using optional arguments :

# run_test share create

# run_test share sharemgr/create:3

TEST SUITE UNCONFIGURE :
======================

The unconfiguration of the test suite simply takes out the configuration file
for the current host, so that an nfs mounted point for execution can be used.
This does not unconfigure any shares that might have been left due to test suite
failure.

# run_test share unconfigure