xref: /illumos-gate/usr/src/test/os-tests/doc/README (revision 09fbbb7d1b5a956a9b81304070dcff318a4a158e)
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
16OS Unit Test Suite README
17
181. Building and installing the OS Unit Test Suite
192. Running the OS Unit Test Suite
203. Test results
21
22--------------------------------------------------------------------------------
23
241. Building and installing the OS Unit Test Suite
25
26The OS Unit Test Suite runs under the testrunner framework (which can be
27installed as pkg:/system/test/testrunner). To build both the OS Unit Test Suite
28and 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
36Then set the publisher on the test machine to point to your repository and
37install the OS Unit Test Suite.
38
39	test_machine# pkg install pkg:/system/test/ostest
40
41Note, the framework will be installed automatically, as the OS Unit Test Suite
42depends on it.
43
442. Running the OS Unit Test Suite
45
46The pre-requisites for running the OS Unit Test Suite are:
47	- A non-root user with the ability to sudo(8) to root without a
48	  password or the root user must run the test.
49
50Once the pre-requisites are satisfied, simply run the ostest script:
51
52	test_machine$ /opt/os-tests/bin/ostest
53
543. Test results
55
56While the OS Unit Test Suite is running, one informational line is printed at
57the end of each test, and a results summary is printed at the end of the run.
58The results summary includes the location of the complete logs, which is of the
59form /var/tmp/test_results/<ISO 8601 date>.
60