ia64/xen-unstable

changeset 7878:9a8110cb09bd

Updates to the xm-test README file.
author dan@guaranine.beaverton.ibm.com
date Thu Nov 17 12:09:09 2005 +0100 (2005-11-17)
parents 88c2d4bbe7c9
children c0ef782130db
files tools/xm-test/README
line diff
     1.1 --- a/tools/xm-test/README	Thu Nov 17 12:01:13 2005 +0100
     1.2 +++ b/tools/xm-test/README	Thu Nov 17 12:09:09 2005 +0100
     1.3 @@ -38,26 +38,60 @@ source.  All source needed for this proc
     1.4  downloaded, extracted, and compiled.  Due to the need to create
     1.5  special files, this process must be done as root:
     1.6  
     1.7 +   # ./autogen
     1.8     # ./configure
     1.9     # make
    1.10  
    1.11 -NB: If you have the initrd.img from a previous version of xm-test, you
    1.12 -can copy it into the ramdisk directory to eliminate the need to
    1.13 -rebuild it.  So far, nothing has changed in the ramdisk since xm-test
    1.14 -version 0.1.1.  If you do this, there is no need to run 'make' again.
    1.15 +NB: If you have the initrd.img from another installation of xm-test,
    1.16 +you can copy it into the ramdisk directory to eliminate the need to
    1.17 +rebuild it.  If you do this, there is no need to run 'make' again.
    1.18  Simply copy the initrd.img file into ramdisk/ and then run the
    1.19 -runtest.sh script.
    1.20 +runtest.sh script.  Note that in general, you should not attempt to
    1.21 +use a ramdisk from a previous minor version of xm-test (i.e., don't
    1.22 +use a ramdisk from 0.4.0 with 0.5.0.  0.5.0 should work for 0.5.3
    1.23 +though)
    1.24  
    1.25  
    1.26  Running
    1.27  =======
    1.28  
    1.29 -By running "./runtest.sh logfile" at the top level, all tests will be
    1.30 -run in alphabetic order.  To run a specific test group, run "make
    1.31 -check" from inside that group directory.  For example:
    1.32 +To run the full test suite, do the following as root:
    1.33 +
    1.34 +   # ./runtest.sh <logfile>
    1.35 +
    1.36 +This will run all tests, as well as generate and submit a report at
    1.37 +the end.  All output files will begin with "<logfile>."  If you wish to
    1.38 +prevent submission of a report, add "-d" to the command line like this:
    1.39 +
    1.40 +   # ./runtest.sh -d <logfile>
    1.41 +
    1.42 +It may be useful to run tests without submission as above, and then
    1.43 +submit the report at a later time.  To do so, run runtest.sh with the
    1.44 +-s flag and the name of the previously-generated report:
    1.45 +
    1.46 +   # ./runtest.sh -s <logfile>
    1.47 +
    1.48 +For people needing a quick test run instead the full suite, a quick
    1.49 +mode has been added that will attempt to run a representative subset
    1.50 +of tests.  This is not a substitute for the whole suite, but will
    1.51 +verify that some of the major functions of xen and xm are working:
    1.52 +
    1.53 +   # ./runtest.sh -q <logfile>
    1.54 +
    1.55 +Because of the current structure of the reporting software, submission
    1.56 +of quick test run results is not supported.
    1.57 +
    1.58 +It may be desirable to run a specific test group.  This can be
    1.59 +accomplished by doing the following:
    1.60  
    1.61     # cd tests/create
    1.62 -   # make check
    1.63 +   # TEST_VERBOSE=1 make check
    1.64 +
    1.65 +When developing or debugging a specific feature, a single test can be
    1.66 +run to avoid having to run even a whole test group:
    1.67 +
    1.68 +   # cd tests/create
    1.69 +   # TEST_VERBOSE=1 make check TESTS=01_create_basic_pos.test
    1.70  
    1.71  The runtest.sh script will create several files, including a .report
    1.72  file, which is the cleaned up, email-friendly report of failures.
    1.73 @@ -69,15 +103,9 @@ Note: you should generally run xm-test w
    1.74  allocated to Dom0.  More memory available for allocation to DomUs
    1.75  means a more rigorous test.
    1.76  
    1.77 -If you wish to run xm-test in an automated batch environment, you can
    1.78 -run the script with the "-b" flag, which will try to prevent it from
    1.79 -asking any questions interactively.  You should run it manually at
    1.80 -least once to generate the "contact_info" file, which will be used in
    1.81 -subsequent runs.
    1.82 -
    1.83 -BIG FAT WARNING: The framework assumes it is running on a dedicated
    1.84 -machine.  As such, the library automatically destroys any running
    1.85 -DomUs on the sytem to provide each test with a "clean slate".
    1.86 +BIG FAT WARNING: The test framework assumes it is running on a
    1.87 +dedicated machine.  As such, the library automatically destroys any
    1.88 +running DomUs on the system to provide each test with a "clean slate".
    1.89  
    1.90  
    1.91  Extending
    1.92 @@ -99,6 +127,9 @@ New subcommand groups should be added as
    1.93  subcommand itself.  The "Makefile.am.template" should be copied into
    1.94  the new group directory as "Makefile.am".
    1.95  
    1.96 +See the Writing_Tests_HOWTO file for more detailed information on
    1.97 +adding tests to the suite.
    1.98 +
    1.99  
   1.100  Developer Notes
   1.101  ===============
   1.102 @@ -114,21 +145,6 @@ use it with relatively few problems.
   1.103  Known Issues
   1.104  ============
   1.105  
   1.106 -- 08/22/2005 Dan Smith:
   1.107 -    Current versions of Xen experience long delays on
   1.108 -    boot, due to the blkif frontend waiting (and timing
   1.109 -    out) for the backend.  We now implicitly introduce
   1.110 -    a pause in XmTestDomain.start() to remedy
   1.111 -    this across all tests that need it.
   1.112 -
   1.113 -- 09/22/2005 Dan Smith:
   1.114 -    The save, restore, and migrate tests have been turned
   1.115 -    back on, as we have implemented timeout functionality 
   1.116 -    in "traceCommand".  Since migrate is known to hang, we 
   1.117 -    can now safely include it in the default test run, and
   1.118 -    have it be killed if it never finishes.  As before,
   1.119 -    feedback about these tests would be specifically
   1.120 -    appreciated.
   1.121  
   1.122  Reporting Bugs
   1.123  ==============