Debian Codegraph @

mysql-test/collections/README

raw
1 This directory contains collections of test runs that we run during our
2 integration and release testing. These files are not directly useful
3 outside this context, but need to be part of the source repository
4 and are included for reference. Each file contains zero or more lines,
5 with one invocation of mysql-test-run.pl on each. These invocations are
6 written so that, with the assumption that perl is in your search path,
7 any collection can in principle run as a shell script or a batch file,
8 with the parent mysql-test directory being the current working directory.
9
10 During integration testing, we choose the collection to run by following
11 these steps:
12
13 1) We choose the extension to look for, based on these rules:
14 - If we're running a per-push test, we choose ".push" as the extension.
15 - If we're running a daily test, we choose ".daily" as the extension.
16 - If we're running a weekly test, we choose ".weekly" as the extension.
17
18 2) If there is a collection that has the same name as the branch we're
19 testing plus the extension as determined in step 1, we choose that
20 collection.
21
22 2b) If we are running a valgrind test and there is a collection with
23 the chosen name and the suffix "-valgrind" we choose that instead.
24
25 3) If the branch is unknown or we have removed all characters from it
26 and still not found a matching collection, we choose the name "default"
27 plus the extension determined in step 1. If there is no such file,
28 we give up and don't test anything at all.
29
30 4) If we haven't found a collection yet, we remove the last character from
31 the branch name and go back to step 2.
32
33 5) The commands from the collection are run line by line via execv() or
34 similar system calls. They are not run as a shell script. Shell
35 expansions are not guaranteed to work and most likely won't.
36
37 Notes on some of the mysql-test-run.pl arguments and how they work in
38 our continous intergation test framework. These are mostly for those
39 writing or editing such files as they are specific to that setup.
40
41 1) The --comment argument produces a header which is parsed by the log
42 analyzer to produce an entry for the result summary, seen as the
43 name of the test batch. The names should be unique. Also, avoid too
44 long names as it may clutter the presentation.
45
46 2) Do not use --mem, use --vardir instead. Before the test is run, a
47 host specific ramdisk path is prepended to the vardir argument to
48 ensure that tests always run on ramdisk. This also works on Windows
49 or Mac OSX where --mem is not supported.
50
51 3) The name of the --vardir directory must start with 'var' in order for
52 the test results to be correctly included in the result
53 tarballs. They should also be unique across the collection file to
54 avoid clashes. If --vardir is not specified, the --comment name will
55 be used with a prefix "var-".
56
57 4) Any --parallel setting will be overridden by a host specific
58 setting (which may be modified by branch; e.g. some hosts may need a
59 lower setting for cluster). Most hosts use 8. It does not hurt to
60 add --parallel=auto but this will only have effect should we have
61 forgotten to set a parallel setting for a host.
62
63 There are some files called disabled-*.list which are referenced in the
64 commands in the default.* files to explicitly disable some tests.
65
66 disabled-asan.list contains a list of tests to be disabled for asan
67 test runs. This is done automatically by the test framework. A similar
68 test list may be added for valgrind, which will then be disabled in
69 valgrind tests.