1XPDTEST(1) General Commands Manual XPDTEST(1)
2
6 xpdtest - xproofd test utility
7
9 xpdtest [options]
10
12 This manual page documents the xpdtest program, an utility whose pur‐
13 pose is to test the status of an xproofd daemon running on the local
14 machine. The target is to run xpdtest inside a monitor infrastructure,
15 for example monit (see http://mmonit.com/monit/ ), capable to take some
16 decisions and to do some actions following the result of xpdtest.
17
21 --help, -h
22 Gives a short list of options available, and exit
23 -t <test>
25 type of test to be run:
26 0 ping the daemon (includes process existence check if
27 pid specified; see below)
28 1 ping the daemon and check connection for default
29 user
30 2 ping the daemon and check connection for the default
31 user and all recent users
32 The default user is the one specified in the URL (e.g. 'user'
34 for user@localhost); if no explicit specification is found in
35 the URL, the user under which xpdtest is run is used; it can be
36 also passed via the environment variable XPDTEST_TEST.
37 -u <url>
39 URL where the xproofd under test responds; it can be also passed
40 via the environment variable XPDTEST_URL (default is
41 'localhost:1093').
42 -d <sbdir>
44 sandbox directory used to find out the users of the facility
45 when test is 2; it can be also passed via the environment
46 variable XPDTEST_SBOXDIR (default is '/tmp/proofbox').
47 -s <span>
49 define the time interval, in minutes, to define 'recent' users
50 when test is 2: only users who connected within this interval
51 are checked; use -1 for infinite; it can be also passed via the
52 environment variable XPDTEST_TIMESPAN (default is -1).
53 -T <timeout>
55 define the time, in seconds, waited for the session to start
56 successfully; it can be also passed via the environment variable
57 XPDTEST_TIMESOUT (default is 10 seconds).
58 -l <logfile>
60 log file if not screen; deleted if the required test fails
61 unless '-k' is specified (see below);it can be also passed via
62 the environment variable XPDTEST_LOGFILE.
63 -p <pidfile>
65 file with the process ID as a integer number in the first line;
66 if this file is given a quick test on the process existence is
67 done using kill(pid,0); it can be also passed via the
68 environment variable XPDTEST_PIDFILE.
69 -k keep log file at path given via '-l' in all cases; it can be
71 also passed via the environment variable XPDTEST_KEEP (default
72 is 'no keep').
73 -v set gDebug=1 for the underline ROOT calls; it can be also passed
75 via the environment variable XPDTEST_VERBOSE (default is 'no
76 verbose').
77
79 xpdtest returns 0 on success and 1 in case of test failure. Errors are
80 printed on the screen or saved into the specified log file.
81
84 The file xpdtest_popen_file in the temporary directory (typically /tmp)
85 is used to parse the output of TProof::Open(). The file is overwritten
86 by each new attempt; after a run of xpdtest it contains the result of
87 the last session open attempt.
88
91 The connection attempt is done in 'masteronly' mode. For daemons
92 running in 'worker' mode the attempt will fail with a well defined
93 error message ('Server not allowed to be top master'); since this
94 indicates that the daemon is anyhow responsive, a positive detection of
95 such a pattern in the error message is interpreted as the attempt
96 having being successful.
97
100 The ROOT team:
101 Rene Brun and Fons Rademakers
102 More information can be found at the ROOT website: http://root.cern.ch
103
105 This library is free software; you can redistribute it and/or modify it
106 under the terms of the GNU Lesser General Public License as published
107 by the Free Software Foundation; either version 2.1 of the License, or
108 (at your option) any later version.
109 This library is distributed in the hope that it will be useful, but
111 WITHOUT ANY WARRANTY; without even the implied warranty of
112 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
113 Lesser General Public License for more details.
114 You should have received a copy of the GNU Lesser General Public
116 License along with this library; if not, write to the Free Software
117 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
118 USA
119
121 This manual page was written by Gerardo Ganis <gerardo.ganis@cern.ch>,
122 for the GNU/Linux system (but may be used by others).
123ROOT Version 5 XPDTEST(1)