xref: /illumos-gate/usr/src/test/elf-tests/doc/README (revision 4db555a5)
1*4db555a5SRichard Lowe#
2*4db555a5SRichard Lowe# This file and its contents are supplied under the terms of the
3*4db555a5SRichard Lowe# Common Development and Distribution License ("CDDL"), version 1.0.
4*4db555a5SRichard Lowe# You may only use this file in accordance with the terms of version
5*4db555a5SRichard Lowe# 1.0 of the CDDL.
6*4db555a5SRichard Lowe#
7*4db555a5SRichard Lowe# A full copy of the text of the CDDL should have accompanied this
8*4db555a5SRichard Lowe# source.  A copy of the CDDL is also available via the Internet at
9*4db555a5SRichard Lowe# http://www.illumos.org/license/CDDL.
10*4db555a5SRichard Lowe#
11*4db555a5SRichard Lowe
12*4db555a5SRichard Lowe#
13*4db555a5SRichard Lowe# Copyright (c) 2012 by Delphix. All rights reserved.
14*4db555a5SRichard Lowe# Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
15*4db555a5SRichard Lowe#
16*4db555a5SRichard Lowe
17*4db555a5SRichard LoweELF Software Generation Utilities Unit Test Suite README
18*4db555a5SRichard Lowe
19*4db555a5SRichard Lowe1. Building and installing the ELF/SGS Unit Test Suite
20*4db555a5SRichard Lowe2. Running the ELF/SGS Unit Test Suite
21*4db555a5SRichard Lowe3. Test results
22*4db555a5SRichard Lowe
23*4db555a5SRichard Lowe--------------------------------------------------------------------------------
24*4db555a5SRichard Lowe
25*4db555a5SRichard Lowe1. Building and installing the ELF/SGS Unit Test Suite
26*4db555a5SRichard Lowe
27*4db555a5SRichard LoweThe ELF/SGS Unit Test Suite runs under the testrunner framework (which can be
28*4db555a5SRichard Loweinstalled as pkg:/system/test/testrunner). To build both the ELF/SGS Unit Test Suite
29*4db555a5SRichard Loweand the testrunner without running a full nightly:
30*4db555a5SRichard Lowe
31*4db555a5SRichard Lowe	build_machine$ bldenv [-d] <your_env_file>
32*4db555a5SRichard Lowe	build_machine$ cd $SRC/test
33*4db555a5SRichard Lowe	build_machine$ dmake install
34*4db555a5SRichard Lowe	build_machine$ cd $SRC/pkg
35*4db555a5SRichard Lowe	build_machine$ dmake install
36*4db555a5SRichard Lowe
37*4db555a5SRichard LoweThen set the publisher on the test machine to point to your repository and
38*4db555a5SRichard Loweinstall the ELF/SGS Unit Test Suite.
39*4db555a5SRichard Lowe
40*4db555a5SRichard Lowe	test_machine# pkg install pkg:/system/test/elftest
41*4db555a5SRichard Lowe
42*4db555a5SRichard LoweNote, the framework will be installed automatically, as the ELF/SGS Unit Test Suite
43*4db555a5SRichard Lowedepends on it.
44*4db555a5SRichard Lowe
45*4db555a5SRichard Lowe2. Running the ELF/SGS Unit Test Suite
46*4db555a5SRichard Lowe
47*4db555a5SRichard LoweThe pre-requisites for running the ELF/SGS Unit Test Suite are:
48*4db555a5SRichard Lowe    None
49*4db555a5SRichard Lowe
50*4db555a5SRichard LoweOnce the pre-requisites are satisfied, simply run the elftest script:
51*4db555a5SRichard Lowe
52*4db555a5SRichard Lowe	test_machine$ /opt/elf-tests/bin/elftest
53*4db555a5SRichard Lowe
54*4db555a5SRichard Lowe3. Test results
55*4db555a5SRichard Lowe
56*4db555a5SRichard LoweWhile the ELF/SGS Unit Test Suite is running, one informational line is printed at
57*4db555a5SRichard Lowethe end of each test, and a results summary is printed at the end of the run.
58*4db555a5SRichard LoweThe results summary includes the location of the complete logs, which is of the
59*4db555a5SRichard Loweform /var/tmp/test_results/<ISO 8601 date>.
60