more notes on configuration
[buildfarm-client.git] / build-farm.conf.template
1
2 # -*-perl-*- hey - emacs - this is a perl file
3
4 =comment
5
6 Copyright (c) 2003-2010, Andrew Dunstan
7
8 See accompanying License file for license details
9
10 =cut 
11
12 package EximBuild;
13
14 use 5.010;
15 use strict;
16 use warnings;
17
18 my $branch = $::branch;
19
20 # This could be changed to use the standard layout but in a different place.
21 # Appending /buildfarm is common.
22 my $basedir = "$ENV{HOME}";
23
24 # This template assumes that the user running the buildfarm process is "farm"
25 my $farm_user_name = getpwuid($<) // die "$0: can't get user name from uid $<: $!\n";
26
27 our %conf =(
28     scm => 'git',
29     # default is github mirror of Exim
30     # Only used for the initial clone (?).
31     # If running multiple animals on a single system,
32     # consider pointing to a local mirror (git clone --mirror)
33     # and separately updating that using cron (git -C /mirrordir fetch).
34     # If running multiple VMs for animals, consider pointing
35     # to a mirror on the hypervisor.
36     scmrepo => 'https://github.com/Exim/exim.git',
37     # webref for diffs on server - use default for community
38     scm_url => undef,
39     # for --reference on git repo
40     # git_reference => undef,
41     # or gmake if required. can include path if necessary.
42     make => 'make',
43     # 1 = any make will do, 0 = require GNU (default)
44     non_gnu_make => 0,
45     # >1 for parallel "make" and "make check" steps
46     make_jobs => undef,
47     # default is "tar -z -cf runlogs.tgz *.log"
48     # replacement must have the same effect
49     # must be absolute, can be either Unix or Windows style for MSVC
50     tar_log_cmd => undef,
51     # If running multiple animals, an explicit common directory for
52     # the lockfile so that runs do not conflict. Otherwise, leave unset.
53     global_lock_dir => $basedir,
54     # If running multiple animals, the root must differ for each.
55     # This directory must exist before anything will work.
56     build_root => "$basedir/buildfarm",
57     # set true to do vpath builds
58     use_vpath => undef,
59
60     keep_error_builds => 0,
61     # Linux style, use "*.core" for BSD
62     core_file_glob => 'core*',
63
64     # Note about HTTPS: HTTPS support is experimental. For a
65     # limited time you may try to use HTTP, in case HTTPS doesn't
66     # work for you.
67
68     # build process will connect to this URL to upload results
69     target => 'https://buildfarm.exim.org/cgi-bin/eximstatus.pl',
70     # update_personality uses this when you want to update your
71     # machine's info (OS, version, compiler, version)
72     upgrade_target => 'https://buildfarm.exim.org/cgi-bin/upgrade.pl',
73
74     # Your host alias and password in the BuildFarm
75     animal => 'alias_assigned_by_build_team',
76     secret => 'secret_assigned_by_build_team',
77
78     # allow automatic updates of the buildfarm client code.
79     # Leave it *unset* to get the default behaviour, set it
80     # to some false value to disable automatic updates or set it
81     # to the name of the remote Git repo you follow for your
82     # buildfarm-client code.
83     #auto_update => 'origin',
84
85     # if force_every is a scalar it will be used on all branches, like this
86     # for legacy reasons:
87     # force_every => 336 , # max hours between builds, undef or 0 = unforced
88     # we now prefer it to be a hash with branch names as the keys, like this
89     #
90     # this setting should be kept conservatively high, or not used at all  -
91     # for the most part it's best to let the script decide if something
92     # has changed that requires a new run for the branch.
93     #
94     # an entry with a name of 'default' matches any branch not named
95     force_every => {
96         HEAD => 24*7,
97         # default => 168,
98     },
99
100     # alerts are triggered if the server doesn't see a build on a branch after
101     # this many hours, and then sent out every so often,
102     alerts => {
103         #HEAD          => { alert_after => 72,  alert_every => 24 },
104     },
105
106     print_success => undef,
107
108     # include / exclude pattern for files whose trigger a build
109     # if both are specified then they are both applied as filters
110     # undef means don't ignore anything.
111     # exclude qr[/(doc|po)/] to ignore changes to docs and po files (recommended)
112     # undef means null filter.
113     trigger_exclude => qr[/(doc|po)/],
114     trigger_include => undef,
115
116     # settings for mail notices - default to notifying nobody
117     # (putting the operator of the animal is a good idea)
118     # these lists contain addresses to be notified
119     # must be complete email addresses, as the email is sent from the server
120     # put single-quote (') around the address string
121     mail_events =>{
122         all => [], # unconditional
123         fail => [], # if this build fails
124         change => [], # if this build causes a state change
125         green => [], # if this build causes a state change to/from OK
126         # green => ['me@example.com'],
127     },
128
129     # env settings to apply within build/report process
130     # these settings will be seen by all the processes, including the
131     # configure process.
132     build_env =>{
133         # use a dedicated cache for the build farm. this should give us
134         # very high hit rates and slightly faster cache searching.
135         CCACHE_DIR => "$basedir/buildfarm/ccache/$branch",
136
137         ### set this if you need a proxy setting for the
138         # outbound web transaction that reports the results
139         # BF_PROXY => 'http://my.proxy.server:portnum/',
140     },
141
142     # Environment settings on the make commandline.
143     # These cause full compile output and don't strip the binary.
144     make_args => q/FULLECHO='' STRIP_COMMAND=''/,
145
146     # Settings to add to Local/Makefile. These will set or override
147     # previous definitions of variables.  Example:
148     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
149     makefile_set =>{
150         # uncomment to use ccache
151         #CC => 'ccache gcc',
152         HAVE_IPV6 => 'yes',
153         # Required for some tests to pass
154         AUTH_PLAINTEXT => 'yes',
155         SUPPORT_MAILDIR => 'yes',
156         # Other examples. Could use makefile_regex instead.
157         #
158         #USE_GDBM = yes
159         #DBMLIB = -lgdbm
160         #
161         WITH_CONTENT_SCAN => 'yes',
162         #DISABLE_TLS => 'yes',
163         #  Enable the proper libs here or see in makefile_regex
164         #  for use of pkg-config
165         #USE_OPENSSL => 'yes',
166         #USE_GNUTLS => 'yes',
167         #TLS_LIBS => '-lssl -lcrypto',
168         #
169         # Many testcases need dsearch
170         LOOKUP_DSEARCH => 'yes',
171         #LOOKUP_LDAP => 'yes',
172         #LOOKUP_INCLUDE => '-I/usr/include/mysql -I/usr/include/postgresql'
173         #LOOKUP_LIBS => '-lmysqlclient -lpq -lldap -llber',
174         #LDAP_LIB_TYPE => 'OPENLDAP2',
175         #LOOKUP_MYSQL => 'yes',
176         #LOOKUP_PGSQL => 'yes',
177         #SUPPORT_PROXY => 'yes',
178         #SUPPORT_SOCKS => 'yes',
179         #SUPPORT_SPF => 'yes',
180         #SUPPORT_DANE => 'yes',
181     },
182     # Settings to add to Local/Makefile. These will add to variables that
183     # are already defined earlier in the Makefile.  Example:
184     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
185     makefile_add =>{
186         # Show all warnings and errors
187         # Some platforms need the c99 setting enabled; some hate it
188         #CFLAGS => '-std=c99 -Wall -Wno-parentheses -Werror=format-security',
189         CFLAGS => '-Wall -Wno-parentheses -Wno-dangling-else -Werror=format-security',
190         # Or enable debugging flags
191         #CFLAGS => '-g -Wall',
192         #LFLAGS => '-g',
193         # If set SUPPORT_SPF above, add it to the linker:
194         #LDFLAGS => '-lspf2',
195     },
196
197     # Another way to enable things in the Local/Makefile.
198     # Use a simple regex to change a default to what you want.
199     makefile_regex =>[
200         # If have perl devel libraries installed, can build embedded perl
201         #q(s/^# EXIM_PERL=/EXIM_PERL=/),
202         # Use SSL libraries
203         #q(s/^# (USE_GNUTLS(?:_PC)?=.*)/$1/),
204         #q(s/^# (USE_OPENSSL_PC=.*)/$1/),
205         # Several experimental features to consider
206         # May be outdated, please check a current EDITME for
207         # for options.
208         #q(s/^# (EXPERIMENTAL_CERTNAMES.*)/$1/),
209     ],
210
211     # The user compiled as the master exim username.
212     # Requirement: The buildfarm user that runs the build farm script *MUST* have
213     # the group of the exim user as a secondary group. Example:
214     # user=>farm, group=>farm, secondary_groups=>exim
215     # user=>exim, group=>exim
216     master_exim_user => 'exim',
217
218     # Range of tests to run if enable make_test in optional steps.
219     # Start with just a couple while getting the aminal set up,
220     # then enable the full set
221     range_num_tests => '1 2',
222     #range_num_tests => '1 5999',
223     # Hardcode some valid version for use during make test
224     exim_test_version => '4.84',
225
226     optional_steps =>{
227         # which optional steps to run and when to run them
228         # 'make-doc' => {min_hours_since => 24*7},
229         test  => {min_hours_since => 24*7},
230     },
231
232     # locales to test
233     locales => [qw( C )],
234
235     # Placemarker for auto-generated build features
236     config_opts =>[
237         qw()
238     ],
239
240     # Configuration tuning for test suite ./configure
241     test_configure_env => {},
242     test_configure_args => [],
243     # Configuration tuning for test suite run
244     # eg. test_run_args = '-FLAVOUR openssl_1_1_1',
245     test_run_args => '',        
246 );
247
248 if ($branch eq 'global')
249 {
250
251     $conf{branches_to_build} = 'ALL';
252
253     # or 'HEAD_PLUS_LATEST' or 'HEAD_PLUS_LATEST2'
254     # or [qw( HEAD RELx_y_STABLE etc )]
255
256 }
257
258 ##################################
259 #
260 # Can use perl below for
261 # per branch processing.
262 #
263 ##################################
264
265 # Eg:
266 #if ($branch eq 'exim-4.90+fixes')
267 #{
268 #       $conf{makefile_set}{SUPPORT_DANE} = '';
269 #}
270
271 1;