1MUT(1)                          MySQL Utilities                         MUT(1)
2
3
4

NAME

6       mut - Testing environment for MySQL utilities
7

SYNOPSIS

9       mut [[--help | --version ] | --verbose | --sorted | --record |
10                  --utildir=<path> | --width=<num> | --start-port=<num> |
11                  --testdir=<path> | --do-test=<prefix> | --force |
12                  [ --server=<user>[<passwd>]@<host>:[<port>][:<socket>] |
13                  [, --server=<user>[<passwd>]@<host>:[<port>][:<socket>] ] |
14                  [ --suite=<suite> | [, --suite=<suite> ]] |
15                  [ --skip-suite=<suite> | [, --skip-suite=<suite> ]] |
16                    --skip-tests=<test_prefix> | --skip-long |
17                  [ --skip-test=<testname> | [, --skip-test=<testname> ]] |
18                  [ <testname> | <suite>.<testname> |
19                  [, <testname> | <suite>.<testname> ]]
20

DESCRIPTION

22       This  utility is designed to execute predefined tests to test the MySQL
23       Utilities. The tests are divided into suites (stored  as  folders).  By
24       default,  all  tests  located  in  the  /test folder are considered the
25       'main' suite.
26
27       You can select any number of tests to run, select one or more suites to
28       restrict  the tests, exclude suites and tests, and specify the location
29       of the utilities and tests.
30
31       The utility requires the existance of at least one server with which to
32       use  to  clone  for  testing  purposes.  You  must specify at least one
33       server, but you may specify multiple servers for tests designed to  use
34       additional servers.
35
36       The  utility has a special test suite named 'performance' where perfor‐
37       mance related tests are placed. This suite is not included  by  default
38       and  must  be specified with the --suite= option to execute the perfor‐
39       mance tests.
40

OPTIONS

42       --version
43              Show program's version number and exit
44
45       --help Show this help message and exit
46
47       --server <server>
48
49              Server given by server will be used in the tests. The format  of
50              server is given in connspec. List option multiple times for mul‐
51              tiple servers to use
52
53       --do-test <prefix>
54
55              Execute all tests that begin with prefix.
56
57       --suite <suite>
58
59              test suite to execute - list option multiple times for  multiple
60              suites
61
62       --skip-test <test>
63
64              exclude test - list option multiple times for multiple tests
65
66       --skip-tests <tests>
67
68              exclude tests that begin with this string
69
70       --start-test <prefix>
71
72              start executing tests that begin with prefix
73
74       --skip-long
75              exclude tests that require greater resources or take a long time
76              to run
77
78       --testdir <path>
79
80              Path to test directory
81
82       --start-port <port>
83
84              starting port for spawned servers
85
86       --record
87              record output of specified test if successful - works with  only
88              one test selected
89
90       --sorted
91              execute tests sorted by suite.name (default = True)
92
93       --utildir <path>
94
95              location of utilities
96
97       --width <number>
98
99              Display width
100
101       --force, -f
102
103              Do not abort when a test fails
104
105       --verbose, -v
106
107              control  how  much  information  is displayed. For example, -v =
108              verbose, -vv = more verbose, -vvv = debug. Use -vvv  to  display
109              actual  results  of  test  cases to the screen and ignore result
110              processing - used to diagnose test execution problems
111

NOTES

113       The information specified for the server must be a valid login account.
114

EXAMPLES

116       The following example demonstrates how to use mut to execute  a  subset
117       of the tests using an existing server which is cloned.:
118
119       $ python mut --server=root@localhost --do-tests=clone_user --width=70
120
121       MySQL Utilities Testing - MUT
122
123       Parameters used:
124         Display Width       = 70
125         Sorted              = True
126         Force               = False
127         Test directory      = './test'
128         Utilities directory = '../scripts'
129         Starting port       = 3310
130         Test wildcard       = 'clone_user%'
131
132       Servers:
133         Connecting to localhost as user root on port 3306: CONNECTED
134
135       ----------------------------------------------------------------------
136       TEST NAME                                                STATUS   TIME
137       ======================================================================
138       main.clone_user                                          [pass]     54
139       main.clone_user_errors                                   [pass]     27
140       main.clone_user_parameters                               [pass]     17
141       ----------------------------------------------------------------------
142       Testing completed: Friday 03 December 2010 09:50:06
143
144       All 3 tests passed.
145
146       Notice in the example above the test name, status, and relative time is
147       displayed.
148
150       Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
151
152       This program is free software; you can redistribute it and/or modify it
153       under  the  terms of the GNU General Public License as published by the
154       Free Software Foundation; version 2 of the License.
155
156       This program is distributed in the hope that it  will  be  useful,  but
157       WITHOUT  ANY  WARRANTY;  without  even  the  implied  warranty  of MER‐
158       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  General
159       Public License for more details.
160
161       You should have received a copy of the GNU General Public License along
162       with this program; if not, write to the Free Software Foundation, Inc.,
163       51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
164

AUTHOR

166       MySQL Utilities Team
167
169       2010, Oracle and/or its affiliates. All rights reserved.
170
171
172
173
1741.0.1                         September 23, 2011                        MUT(1)
Impressum