#  Copyright 1989-1998, 2002 Sun Microsystems, Inc. All rights reserved.
#  Use is subject to license terms.
#ident  "@(#)README  1.102  02/09/24  SMI."

SunVTS 5.1 README File
----------------------

Introduction
============

   SunVTS 5.1 is Sun's Validation Test Suite. SunVTS is a comprehensive
   software diagnostic tool that tests and validates Sun hardware by 
   verifying the connectivity and functionality of most hardware controllers
   and devices on Sun platforms.

   The SunVTS 5.1 release is supported in the Solaris 8 update 7 & Solaris 9 
   operating environment.

   Solaris       SunOS   SunVTS
   ===========   =====   ======
   9 12/02       5.9     5.1
   9 09/02       5.9     5.1
   9 05/02       5.9     5.1
   8 12/02       5.8     5.1
   8 02/02       5.8     5.1
   9             5.9     5.0
   8 2/02        5.8     4.6
   8 10/01       5.8     4.5
   8 7/01        5.8     4.4
   8 4/01        5.8     4.3
   8 1/01        5.8     4.2
   8 10/00       5.8     4.1
   8 6/00        5.8     4.0
   8             5.8     4.0
   7 11/99       5.7     3.4
   7 8/99        5.7     3.3
   7 5/99        5.7     3.2
   7 3/99        5.7     3.1
   7             5.7     3.0
   2.6 5/98      5.6     2.1.3
   2.6 3/98      5.6     2.1.2
   2.5.1 11/97   5.5.1   2.1.1

  This product makes use of open source libxml2 dynamic library.
  For copyright information of libxml2, please see the Copyright.libxml2 file 
  found in this distribution. For more information about libxml2, see the 
  web URL http://xmlsoft.org

SunVTS 5.1 Package Information
==============================

   SunVTS 5.1 contains 3 packages:
    
   	SUNWvts   - contains the SunVTS kernel, user interface, and the
		    collection of tests.
   	SUNWvtsx  - is a package extension to provide SunVTS 64-bit package 
   		    components.
   	SUNWvtsmn - contains the SunVTS man pages.

SunVTS 5.1 Installation
=======================

   The following example will install SunVTS into the default 
   directory (/opt):
   
   #cd 'directory of SUNWvts' (for example, if loading from the "Solaris 
		       Supplement" CD, "cd /cdrom/cdrom0/SunVTS_5.1/Product")
   #pkgadd -d `pwd` SUNWvts  SUNWvtsmn SUNWvtsx
         
   Note: If you want SunVTS to install in a directory other than the 
         default (/opt), use the "-a none" argument with the pkgadd command.
         You will be asked where you want to install the package. 



How to run SunVTS 5.1 
=====================

   # cd /opt/SUNWvts/bin (or cd to the directory that holds the SUNWvts package)
   
   Choose one of the following commands to start SunVTS:
   # ./sunvts     (to run SunVTS kernel and default GUI on the local machine.)
   # ./sunvts -t  (to run SunVTS kernel in TTY mode on the local machine.)
   # ./sunvts -h hostname (To connect and test a remote machine 'hostname',
                           but display GUI on the local host.)
   # ./sunvts -display local_hostname:0 (When run remotely, this option starts 
     					SunVTS kernel on the remote machine 
					and the GUI is displayed on the local 
     					machine designated as local_hostname:0)

     Note: Make sure the DISPLAY environment variable is set correctly while
     running "sunvts" remotely. Otherwise SunVTS will use vtstty as the
     default user interface.
			 
     Note: The SUNWvts package must be installed on the local and remote
     machines for the above examples. The SUNWvtsx package must be installed
     on systems that run in 64-bit mode.
     
     Note: The sunvts startup program will start the appropriate SunVTS kernel
     (32-bit or 64-bit) based on the mode that the operating system is
     running.
			 
     More detailed description about sunvts usage and other utility commands
     can be found in the SunVTS 5.1 User's Guide.
   
Special Note on OpenWindows package 
===================================

   As of SunVTS 5.1, the SunVTS OpenLook testing and GUI capability which was 
   available using the SUNWvtsol package is no longer available. The SUNWvtsol 
   package providing this openlook testing/GUI functionality has been removed.
 
NEWS update for this release:
=============================

TBD

SunVTS Usage Notes:
===================
  
1) The disktest has the capability of premounting all unmounted disks so 
   that it could run the file system subtests against those disks. 
   (The test would do read-write operations on the file system).  
   However, by default all unmounted disks are left untouched. 

   As of SunVTS 3.0, the disktest probe by default does not pre-mount any
   partitions.  If the user wants SunVTS to pre-mount all the unmounted
   partitions which have filesystem, the user has to set the environment
   variable BYPASS_FS_PROBE to zero.

   For Example:
   # BYPASS_FS_PROBE=0; export BYPASS_FS_PROBE
   # ./sunvts

   However, even if pre-mounting is enabled, SunVTS disk probe does check
   for the existence of Veritas and Solstice Disksuite on the system and
   does not pre-mount any partitions if their presence is detected.

   Caution: Running a media subtest on a disk partition in the WriteRead mode
            may cause data corruption if the same partition is being used by
            other programs.

   Loading an option file that was created when BYPASS_FS_PROBE was set to 0
   (zero) might not work if the BYPASS_FS_PROBE environment variable is no
   longer set to 0 (zero).

   This error is caused when SunVTS expects to use the predefined mount point
   names (/disktest_cntndnsn) that are created when BYPASS_FS_PROBE is set to
   0 (zero), but these mount points do not exist while BYPASS_FS_PROBE is not
   set to 0 (zero).  The workaround is to create two separate option files
   for the two different states of the BYPASS_FS_PROBE environment variable.

2) By default, SunVTS security mode is turned on.  This is a change from the
   earlier revisions prior to SunVTS 3.1. To turn it off or to make
   modifications to the default settings refer to the Security section in this
   README and in the SunVTS 5.1 User's Guide.
   
3) Running SunVTS graphic tests with EStar screen saver enabled may cause a
   graphics test error.  Use 'xset s off' to turn the screen saver functions
   off before starting the test.   When you are done testing, use
   'xset s default' to set the system to its default screen saver
   characteristics.

4) When running SunVTS on large configurations (E.g., E10000) take these issues
   into consideration:

     For configurations with larger number of devices use the CDE GUI (vtsui)
     or the TTY UI (vtstty) which have support for up to 10000 devices.
   
     The amount of time required for SunVTS to complete its probing and to start
     the interface depends on the size of the SUT's configuration.  A probing
     time of as much as 10 minutes has been observed on a E10000 system with
     about 2000 disks. 
      
5) Option files from SunVTS 2.0 or later, are not backward compatible to
   SunVTS 1.0.
    
6) Running the CDE GUI (vtsui) in the localized environment may not display the
   proper fonts if the vtsui resource file (Vtsui) is not properly translated.
   Refer to the SunVTS 5.1 User's Guide for more information.

7) If the SunVTS kernel (vtsk) was inappropriately killed by SIGKILL (-9), 
   the next time it is started vtsk could possibly hang. Use
   "kill -HUP pid_of_inetd" to reinitialize the inetd if no other significant
   application software is running at the same time. Then restart sunvts.   

8) Running sunvts and vtsui in background (&) mode is not allowed, and is not 
   necessary since SunVTS releases the display window once the GUI starts. The 
   same is true while running in TTY-mode, vtstty needs the window for display 
   and key-in for input.  
   
9) To display physical mapping, click the "Physical" button next to the 
   "System View". This will result in a re-mapping of the entire GUI test 
   buttons as well as the test status.  Changing the Logical and 
   Physical View during SunVTS testing is NOT recommended because the 
   previous system/test status may get reset. 

   
10) Separate files exist for .customtest and .customtest_OtherDevices in
   64 bit version (SUNWvtsx).  They are by default installed in the directory
   /opt/SUNWvts/bin/sparcv9 whereas the package SUNWvts installs them in
   /opt/SUNWvts/bin for 32 bit version.

11) The environment variable VTS_PM_PATH will be used to locate the pix map
   files when they are not in the default installation directory.  If SunVTS
   is installed under a different base directory from the default, SunVTS
   will issue the following error message about the use of this environment
   variable when it is run.

   ERROR: Unable to locate image files. Please set environment variable
          VTS_PM_PATH to image file directory.

   For example, to set the environment variable in Bourne shell, do the
   following:

   # VTS_PM_PATH=<your-installation-base-directory>/SUNWvts/bin/pm
   # export VTS_PM_PATH
   # ./sunvts

12) Support for 64-bit testing capabilities as supported by Solaris operating
   environment was added since the SunVTS 3.0 release.  However the following
   tests are not supported in 64-bit mode:

      cg14test   tcxtest

   More detailed descriptions about the above tests can be found in the 
   SunVTS 5.1 Test Reference Manual.

13) As of SunVTS 3.3, the way that StorEdge-A5XXX devices are grouped in the
   SunVTS System Map (for logical mapping) changed.  Prior to version 3.3,
   the enclosure was grouped under the SENA(n) group and the disks were
   grouped under the SCSI-Devices group.  Now the enclosure and disks are
   both grouped under the StorEdge-A5XXXX_enclosure_name group.

14) SunVTS 5.1 now has the TTY UI support for Deterministic test scheduler. 

15) Automatic Configuration (available from the SunVTS 4.3 release) is 
    supported with the CDE GUI only.  The TTY UI support will be available in 
    a future release.

16) As of SunVTS 4.1, there is a new environment variable.

         VTS_CMD_HOST=<hostname>

    This environment variable is used by vts_cmd.  The hostname is the test
    machine running the SunVTS kernel (vtsk).  If this is not set, vts_cmd
    will attempt to send the commands to the local machine's SunVTS kernel.

17) mpconstest will only run on machines that support the "v8plus"
    instructions. If the "v8plus" instructions are not supported, the test
    will not appear on the Test Selection GUI."

18) For sctest , the smart card hardware needs to be initialized properly as a
    part of  hardware installation or during bootup. If it is not initialized,
    the test will fail  printing the message "Card detection test failed"  in
    sunvts.err file .

19) For dvdtest, Volume Manager reads entire Toshiba DVD TSD-1 test disc when
    loaded. It takes more than 7 mins for SunVTS probe to register the dvdtest
    device.

        The work around is to stop volmgt before starting SunVTS:

        1. check if vold is running.
        # ps -ef |grep vold
        root  1407  1392  0 14:16:57 pts/6    0:00 grep vold
        root   259     1  0 12:47:11 ?        0:00 /usr/sbin/vold

        2. stop volmgt
        # /etc/init.d/volmgt stop


SunVTS Overview 
===============

SunVTS TEST MODES
-----------------

SunVTS 5.1 has the following supported test modes:

  Connection Test:	Minimal access of device to verify
			accessibility/availability.

  Functional Test:	Detailed tests to thoroughly test device/system on an  
	(default)	"offline" system. 

  Auto Config:		Invokes Automatic Configuration.

  Exclusive Test:	A exclusive test requires that no other  tests should 
			be  running when that test is running.  
			The exclusive mode requirement for a test can be due 
			to the nature of the device being tested for a better
		 	effective diagnostics.

  Online Test:		Online testing is the non-intrusive testing while 
			customer applications may be running

			
Online Diagnostics
------------------
TBD

SECURITY
--------

SunVTS has two security mechanisms, basic security and SEAM security.
Refer to the SunVTS 5.1 User's Guide.

Logfile and Option File Directory 
---------------------------------

Default log directory is /var/opt/SUNWvts/logs
Default option file directory is /var/opt/SUNWvts/options


Internationalization
--------------------

SunVTS 5.1 is I18N compliant.

SunVTS 5.1 software has an internationalization hook available. However, 
there is no specific language, other than English, localized so far. 
The hook is therefore not fully verified. A user needs to be familiar with 
internationalization to use this feature. If you are running SunVTS in
English, in a locale environment and the font display is not right, refer
to the installation chapter of the SunVTS 5.1 User's Guide for additional
instructions.

All test messages are located in the /opt/SUNWvts/lib/locale/C/LC_MESSAGES
directory (assuming SunVTS was installed in the default directory). The CDE
GUI resource file, Vtsui, can be found in /opt/SUNWvts/lib/Vtsui 


Year 2000 
---------

SunVTS 5.1 is Y2000 compliant.


Other Documents Available
=========================

   SunVTS 5.1 User's Guide 
   SunVTS 5.1 Test Reference Manual 
   SunVTS Quick Reference Card 

   These documents will become part of Solaris 9/update 1 and any future 
   Solaris 8 releases on Sun Hardware AnswerBook set.  These and other 
   documents can be accessed at http://docs.sun.com.
