Cross Reference: /test/stcnv/usr/src/suites/storage/megacli/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 2008 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# ident	"@(#)README	1.4	09/01/15 SMI"
#

DESCRIPTION
===========
The LSI MegaCli tool is a command line interface application for MegaRAID
SAS controllers.  You can use this utility to configure, monitor, and
maintain MegaRAID SAS controllers and the devices connected to them.

megacli is a test suite for mega_sas driver regression testing.  It uses
the LSI MegaCli tool to verify:

- mega_sas driver support the LSI MegaRAID SAS 1078 based controllers
  working on Solaris platform.

- mega_sas driver support the LSI MegaCli tool running on Solaris platform.


PREREQUISITES
============
1. One LSI MegaRAID SAS 1078 based controller as the testing target.
2. One hard disk drive attached to the LSI MegaRAID SAS 1078 controller
   and doesn't configured in a volume. You need to attach 8 such disk
   drives if you want to run all the test cases.
3. For SNV users, use SNV_88 or above.  For S10 Updates users, use
   S10U6_02 or above as the base OS.
4. CTI-TET lite harness SUNWstc-tetlite.  Refer to the following section
   for instructions on how to get and install the CTI-TET package.
5. MegaCli binary.  Refer to the following section on how to get and
   install the MegaCli binary.


CTI-TET PACKAGE INSTALLATION
============================
As root do the following:
1. Download SUNWstc-tetlite-YYYMMDD.i386.tar.bz2 from
	http://dlc.sun.com/osol/test/downloads/current/
2. bzcat SUNWstc-tetlite-YYYYMMDD.i386.tar.bz2 | tar -xvf -
3. pkgadd -d ./packages/i386/


MEGACLI TOOL INSTALLATION
=========================
Download MegaCli tool archive from:
	http://tinyurl.com/megacli-solaris

After downloading the archive, run the following commands (as root) to
install the binary:

1. unzip 2.00.15_Solaris_MegaCLI.zip
2. cp MegaCli /usr/bin
3. chmod +x /usr/bin/MegaCli


TEST SUITE INSTALLATION
=======================
You can install the test suite on the system under testing, or at a
network location which is accessible by the system under test.

As root do the following:

I: Based on megacli package
1. get megacli package SUNWstc-storage-megacli
2. pkgadd -d . SUNWstc-storage-megacli

II: Based on megacli source code
1. get megacli source code and put it into /export/STC (example location)
2. export TET_ROOT=/opt/SUNWstc-tetlite
3. export CTI_ROOT=/opt/SUNWstc-tetlite/contrib/ctitools
4. export TET_SUITE_ROOT=/export/STC/usr/src/suites
5. cd $TET_SUITE_ROOT/storage/megacli
6. /usr/ccs/bin/make


TEST SUITE CONFIGURATION
========================
As root do the following:
1. Set the following environment variables

Using megacli pakcage:
	export TET_ROOT=/opt/SUNWstc-tetlite
	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin
	export TET_SUITE_ROOT=/opt/SUNWstc-storage-megacli

Using megacli source code:
	export TET_ROOT=/opt/SUNWstc-tetlite
	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin
	export TET_SUITE_ROOT=/export/STC/usr/src/suites

2. To configure the test suite

# run_test -v ADAPTER=1 storage/megacli configure

Note: You can get the ADAPTER number by running "MegaCli -AdpAllInfo -aALL".

Warning: the execution of this test suite will destroy all data on the
disks used for testing.  Make sure the disks available for the testing
adapter do not have any useful data.

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

DEBUG		- [ TRUE || FALSE ] default FALSE

Following is an example to enable DEBUG:
# run_test -v ADAPTER=1 -v DEBUG=TRUE storage/megacli configure

CFGCLEAR	- [ TRUE || FALSE] default FALSE

Following is an example to enable CFGCLEAR:
# run_test -v ADAPTER=1 -v DEBUG=TRUE storage/megacli configure

Warning: the enable of CFGCLEAR option will destroy all configuration on
testing controller. Make sure the testing controller do not have any useful
configuration, especially there should not have root file system located
on this controller.


TEST SUITE EXECUTION
====================
The test suite must be executed as root.

If you haven't done this at configuration phase, set the environment
variables as following:

For user using megacli pakcage:
	export TET_ROOT=/opt/SUNWstc-tetlite
	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin
	export TET_SUITE_ROOT=/opt/SUNWstc-storage-megacli
For user using megacli source code:
	export TET_ROOT=/opt/SUNWstc-tetlite
	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin
	export TET_SUITE_ROOT=/export/STC/usr/src/suites

To run the entire test suite do the following:

# run_test storage/megacli

To execute individual scenario (basic raid0 raid1 raid5 raid6 raid10
raid50 raid60):

run_test storage/megacli <scenario>

# run_test storage/megacli raid0

To execute Test Purpose within a scenario:

run_test storage/megacli cmd/<test case dir>:<test purpose number>

# run_test storage/megacli cmd/raid0:1

Note: You can define customized test scenarios by adding entries to
the test scenario file: $TET_SUITE_ROOT/storage/megacli/tet_scen.

For how to edit the test scenario file, refer to the TET user guide at:
http://tetworks.opengroup.org/tet/


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

# run_test storage/megacli unconfigure


TEST SUITE BUILDING
===================
Test suite build does not need to be run as root.

1. Get megacli source code and put it into /export/STC (example)

2. Set the environment variables
	user$ export TET_ROOT=/opt/SUNWstc-tetlite
	user$ export CTI_ROOT=/opt/SUNWstc-tetlite/contrib/ctitools
	user$ export TET_SUITE_ROOT=/export/STC/usr/src/suites

3. cd $TET_SUITE_ROOT/storage/megacli

4. Build code
	user$ /usr/ccs/bin/make
	user$ /usr/ccs/bin/make install
	user$ /usr/ccs/bin/make package

5. Build clean
	user$ /usr/ccs/bin/make clean
	user$ /usr/ccs/bin/make clobber