usr/src/test/os-tests/doc/README

   1 #
   2 # This file and its contents are supplied under the terms of the
   3 # Common Development and Distribution License ("CDDL"), version 1.0.
   4 # You may only use this file in accordance with the terms of version
   5 # 1.0 of the CDDL.
   6 #
   7 # A full copy of the text of the CDDL should have accompanied this
   8 # source.  A copy of the CDDL is also available via the Internet at
   9 # http://www.illumos.org/license/CDDL.
  10 #
  11
  12 #
  13 # Copyright (c) 2012 by Delphix. All rights reserved.
  14 #
  15
  16 OS Unit Test Suite README
  17
  18 1. Building and installing the OS Unit Test Suite
  19 2. Running the OS Unit Test Suite
  20 3. Test results
  21
  22 --------------------------------------------------------------------------------
  23
  24 1. Building and installing the OS Unit Test Suite
  25
  26 The OS Unit Test Suite runs under the testrunner framework (which can be
  27 installed as pkg:/system/test/testrunner). To build both the OS Unit Test Suite
  28 and the testrunner without running a full nightly:
  29
  30         build_machine$ bldenv [-d] <your_env_file>
  31         build_machine$ cd $SRC/test
  32         build_machine$ dmake install
  33         build_machine$ cd $SRC/pkg
  34         build_machine$ dmake install
  35
  36 Then set the publisher on the test machine to point to your repository and
  37 install the OS Unit Test Suite.
  38
  39         test_machine# pkg install pkg:/system/test/zfstest
  40
  41 Note, the framework will be installed automatically, as the OS Unit Test Suite
  42 depends on it.
  43
  44 2. Running the OS Unit Test Suite
  45
  46 The pre-requisites for running the OS Unit Test Suite are:
  47         - A non-root user with the ability to sudo(1M) to root without a
  48           password or the root user must run the test.
  49
  50 Once the pre-requisites are satisfied, simply run the ostest script:
  51
  52         test_machine$ /opt/os-tests/bin/ostest
  53
  54 3. Test results
  55
  56 While the OS Unit Test Suite is running, one informational line is printed at
  57 the end of each test, and a results summary is printed at the end of the run.
  58 The results summary includes the location of the complete logs, which is of the
  59 form /var/tmp/test_results/<ISO 8601 date>.