xref: /illumos-gate/usr/src/test/smbsrv-tests/doc/README (revision f2ae17ede4a9a93585872a9aa83120497285bdd0)
1*f2ae17edSMatt Barden#
2*f2ae17edSMatt Barden# This file and its contents are supplied under the terms of the
3*f2ae17edSMatt Barden# Common Development and Distribution License ("CDDL"), version 1.0.
4*f2ae17edSMatt Barden# You may only use this file in accordance with the terms of version
5*f2ae17edSMatt Barden# 1.0 of the CDDL.
6*f2ae17edSMatt Barden#
7*f2ae17edSMatt Barden# A full copy of the text of the CDDL should have accompanied this
8*f2ae17edSMatt Barden# source.  A copy of the CDDL is also available via the Internet at
9*f2ae17edSMatt Barden# http://www.illumos.org/license/CDDL.
10*f2ae17edSMatt Barden#
11*f2ae17edSMatt Barden
12*f2ae17edSMatt Barden#
13*f2ae17edSMatt Barden# Copyright 2021 Tintri by DDN, Inc. All rights reserved.
14*f2ae17edSMatt Barden#
15*f2ae17edSMatt Barden
16*f2ae17edSMatt BardenSMB Server Test Suite README
17*f2ae17edSMatt Barden
18*f2ae17edSMatt Barden1. Building and installing the SMB Server Test Suite
19*f2ae17edSMatt Barden2. Running the SMB Server Test Suite
20*f2ae17edSMatt Barden3. Test Results
21*f2ae17edSMatt Barden
22*f2ae17edSMatt Barden--------------------------------------------------------------------------------
23*f2ae17edSMatt Barden
24*f2ae17edSMatt Barden1. Building and installing the SMB Server Test Suite
25*f2ae17edSMatt Barden
26*f2ae17edSMatt BardenThe SMB Server test suite uses external programs including:
27*f2ae17edSMatt Barden	smbtorture (and more to come)
28*f2ae17edSMatt Bardenwhich is installed via a package dependency on:
29*f2ae17edSMatt Barden	service/network/samba
30*f2ae17edSMatt BardenThose are run by python and ksh wrappers found here.
31*f2ae17edSMatt Barden
32*f2ae17edSMatt BardenTo build, just do:
33*f2ae17edSMatt Barden	cd $SRC/test/smbsrv-tests
34*f2ae17edSMatt Barden	make install
35*f2ae17edSMatt Barden
36*f2ae17edSMatt BardenTo install the full suite, run:
37*f2ae17edSMatt Barden	pkg install pkg:/system/test/smbsrvtest
38*f2ae17edSMatt Barden
39*f2ae17edSMatt Barden--------------------------------------------------------------------------------
40*f2ae17edSMatt Barden
41*f2ae17edSMatt Barden2. Running the SMB Server Test Suite
42*f2ae17edSMatt Barden
43*f2ae17edSMatt BardenThe default configuration:
44*f2ae17edSMatt Barden	/opt/smbsrv-tests/include/default.cfg
45*f2ae17edSMatt Bardenruns tests against a server instance on "localhost",
46*f2ae17edSMatt Bardenusing a share named "test" and user=test, pw=test
47*f2ae17edSMatt Barden
48*f2ae17edSMatt BardenIt's common to copy that default.cfg to something new
49*f2ae17edSMatt Bardenand modify the SMBT_... variables to specify different
50*f2ae17edSMatt Bardenhost, share, user, etc.
51*f2ae17edSMatt Barden
52*f2ae17edSMatt BardenTo run all tests using the default configuration run:
53*f2ae17edSMatt Barden	/opt/smbsrv-tests/bin/smbsrvtests
54*f2ae17edSMatt Barden
55*f2ae17edSMatt BardenTo run all tests using a different configuration:
56*f2ae17edSMatt Barden	/opt/smbsrv-tests/bin/smbsrvtests -c config_file
57*f2ae17edSMatt Barden
58*f2ae17edSMatt BardenYou can also run individual tests found under:
59*f2ae17edSMatt Barden	/opt/smbsrv-tests/tests/*
60*f2ae17edSMatt BardenFor example:
61*f2ae17edSMatt Barden	/opt/smbsrv-tests/tests/smbtorture/runst-smb2
62*f2ae17edSMatt Barden
63*f2ae17edSMatt BardenThese take similar options (eg. -c config_file).
64*f2ae17edSMatt Barden
65*f2ae17edSMatt BardenTo run only a subset of the tests, you can pass match patterns
66*f2ae17edSMatt Bardenas additional arguments to the individual test, eg
67*f2ae17edSMatt Barden	/opt/smbsrv-tests/tests/smbtorture/runst-smb2 smb2.lease
68*f2ae17edSMatt Barden
69*f2ae17edSMatt Barden--------------------------------------------------------------------------------
70*f2ae17edSMatt Barden
71*f2ae17edSMatt Barden3. Test Results
72*f2ae17edSMatt Barden
73*f2ae17edSMatt BardenWhile the SMB Server Test Suite is running, one informational line is
74*f2ae17edSMatt Bardenprinted for each test, ending with one of:
75*f2ae17edSMatt Barden	PASS, FAIL, SKIP, KILLED, UNKNOWN
76*f2ae17edSMatt Barden
77*f2ae17edSMatt BardenThe test outputs can be found in:
78*f2ae17edSMatt Barden	/var/tmp/test_results/smbsrv-tests/
79*f2ae17edSMatt BardenFor example:
80*f2ae17edSMatt Barden	smbtor-smb2-20210317T162827.summary
81*f2ae17edSMatt Barden	smbtor-smb2-20210317T162827.log
82*f2ae17edSMatt Barden
83*f2ae17edSMatt BardenThe *.summary file is the same as what's shown while the test runs.
84*f2ae17edSMatt BardenThe *.log file is the detailed output from the test program(s).
85