Cross Reference: /test/stcnv/usr/src/suites/storage/iSCSI/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	08/12/17 SMI"
#

DESCRIPTION:
============
This test suite is designed to test the functionality of the iSCSI
target software-level creation utility.  If configured the test suite
will also confirm the target creation and configurations, use the
iscsiadm command to make connections to the target and further verify
the functionality of the iscsitadm(1M) command.


PREREQUISITES:
==============
1. A spare disk is required for this test suite to use for its work.

2. There should be no iscsi targets configured via the iscsitadm
   command.

3. The CTI-TET test harness lite package (SUNWstc-tetlite) is required
   to be installed, or to be accessible via NFS.

4. If a second host is to be used to check with the iscsiadm(1M)
   command, that host should accept rcp and rsh calls from the test
   host.


CTI-TET INSTALLATION:
=====================
In the majority of cases, the CTI-TET lite test harness 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, enter the following command:

    root# pkgadd -d <package location>  SUNWstc-tetlite

Where <package location> is the path containing the SUNWstc-tetlite
package directory.  'root#' indicates that this command must be run
as root.

o It is recommended that SUNWstc-tetlite be installed from scratch,
  rather than on top of an existing installation.  Thus, if a copy
  of SUNWstc-tetlite is already installed, remove it:

    root# pkgrm SUNWstc-tetlite

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


TEST SUITE INSTALLATION:
========================
In the majority of cases, the test suite can be installed from packages.
The package is called SUNWstc-storage-iSCSI and it installs into
"/opt" by default.  Installation is via the standard Solaris package
installation tool, pkgadd(1M).  To install SUNWstc-storage-iSCSI, enter
the following command:

    root# pkgadd -d <package location>  SUNWstc-storage-iSCSI

Where <package location> is the path containing the SUNWstc-storage-iSCSI
package directory.

o It is recommended that the test suite package be installed from
  scratch, rather than on top of an existing installation.  Thus,
  if a version of SUNWstc-storage-iSCSI is already installed, first
  remove it:

    root# pkgrm SUNWstc-storage-iSCSI

It is also acceptable to use an NFS-accessible installation of the
SUNWstc-storage-iSCSI package.

ALTERNATIVELY, the test suite source can be installed locally, built in
the source directory tree and run from that location.  This is optional.

To build the test suite from source, first install the test suite
source, and then do the following (the 'user$' prompt indicates that
these commands need not be run as root):

    user$ TET_ROOT=/opt/SUNWstc-tetlite
    user$ export TET_ROOT
    user$ CTI_ROOT=$TET_ROOT/contrib/ctitools
    user$ export CTI_ROOT
    user$ TET_SUITE_ROOT=/export/STC/usr/src/suites/storage (e.g location)
    user$ export TET_SUITE_ROOT
    user$ cd $TET_SUITE_ROOT/iSCSI
    user$ /usr/ccs/bin/make

The build can also install into a 'proto' directory below the workspace
root directory.  The workspace root is the directory under which the
'usr/src/suites/storage'  directory resides (in the example above, the
workspace root is "/export/STC").  To install binaries into the proto
directory, do:

    user$ /usr/ccs/bin/make install

In addition, test suite binary packages can be constructed using the
contents of the proto directory.  To build test suite packages, do:

    user$ /usr/ccs/bin/make package

This can be done instead of, or in addition to 'make install'.  The
packages thus constructed will be stored in the 'packages' directory
under the workspace root.


TEST SUITE CONFIGURATION:
=========================
Test suite configuration is required to be done as root.

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-iSCSI (installation path of suite)
	PATH=$PATH:$CTI_ROOT/bin
	export PATH

2. To configure the test suite:

	root# run_test -v iscsi_disk=c0t1d0 iSCSI configure

Other configurable variables that can be set in the configuration line:

FSCONFIGTYPE	- [ ufs || zfs ] default ufs
THINPROV	- [ on || off ] default off
target_ip	- [ iscsi target ip address to use for initiator ] default null
iscsiadm_ip	- [ iscsi initiator ip address ] default null
online_wait	- [ number of 5 second intervals to wait for initiator ] 24
verbose		- [ TRUE || FALSE ] default FALSE


TEST SUITE EXECUTION:
=====================
The test suite execution is required to be done as root.

If not already available from the configuration phase, set the following
environment variables:

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

To run the entire test suite do the following.
	root# run_test iSCSI

To execute individual scenarios (create modify delete)
	root# run_test iSCSI <scenario>
For example:
	root# run_test iSCSI create

To execute Test Purposes within a given scenario:
	root# run_test iSCSI iscsitadm/<test case dir>:<test purpose number>
For example:
	root# run_test iSCSI iscsitadm/create:1

Available test case directories are create, modify and delete


TEST SUITE UNCONFIGURATION:
===========================
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.  More important, this does not unconfigure any iSCSI
targets from the host.

To unconfigure the test suite, run:
	root# run_test iSCSI unconfigure