git://git.exim.org / buildfarm-client.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
more notes on configuration
[buildfarm-client.git] / build-farm.conf.template
diff --git a/build-farm.conf.template b/build-farm.conf.template
index 0f44dfc04ab1eb1dd996e008feb68356f51581e8..03588112d4a2056e773e504c053cea7b8c6f9194 100644 (file)
--- a/build-farm.conf.template
+++ b/build-farm.conf.template
@@ -11,61 +11,76 @@ See accompanying License file for license details
 
 package EximBuild;
 
 
 package EximBuild;
 
+use 5.010;
 use strict;
 use strict;
+use warnings;
 
 
-use vars qw(%conf);
+my $branch = $::branch;
 
 
-# use vars qw($VERSION); $VERSION = 'REL_0.1';
-
-my $branch;
-{
-    no warnings qw(once);
-    $branch = $main::branch;
-}
+# This could be changed to use the standard layout but in a different place.
+# Appending /buildfarm is common.
+my $basedir = "$ENV{HOME}";
 
 # This template assumes that the user running the buildfarm process is "farm"
 
 # This template assumes that the user running the buildfarm process is "farm"
-%conf =(
+my $farm_user_name = getpwuid($<) // die "$0: can't get user name from uid $<: $!\n";
+
+our %conf =(
     scm => 'git',
     # default is github mirror of Exim
     scm => 'git',
     # default is github mirror of Exim
+    # Only used for the initial clone (?).
+    # If running multiple animals on a single system,
+    # consider pointing to a local mirror (git clone --mirror)
+    # and separately updating that using cron (git -C /mirrordir fetch).
+    # If running multiple VMs for animals, consider pointing
+    # to a mirror on the hypervisor.
     scmrepo => 'https://github.com/Exim/exim.git',
     scmrepo => 'https://github.com/Exim/exim.git',
-    # Wishlist for future, track and build from multiple repos.
-    # Doesn't do anything yet.
-    repos => {
-      'exim' => 'git://www.mrball.net/exim/exim.git',
-      'exim.jgh' => 'git://www.mrball.net/exim/exim-jgh.git',
-      'exim.pdp' => 'git://www.mrball.net/exim/exim-pdp.git',
-      'exim.tlyons' => 'git://www.mrball.net/exim/exim-tlyons.git',
-    },
     # webref for diffs on server - use default for community
     scm_url => undef,
     # for --reference on git repo
     # git_reference => undef,
     # or gmake if required. can include path if necessary.
     make => 'make',
     # webref for diffs on server - use default for community
     scm_url => undef,
     # for --reference on git repo
     # git_reference => undef,
     # or gmake if required. can include path if necessary.
     make => 'make',
+    # 1 = any make will do, 0 = require GNU (default)
+    non_gnu_make => 0,
     # >1 for parallel "make" and "make check" steps
     make_jobs => undef,
     # default is "tar -z -cf runlogs.tgz *.log"
     # replacement must have the same effect
     # must be absolute, can be either Unix or Windows style for MSVC
     tar_log_cmd => undef,
     # >1 for parallel "make" and "make check" steps
     make_jobs => undef,
     # default is "tar -z -cf runlogs.tgz *.log"
     # replacement must have the same effect
     # must be absolute, can be either Unix or Windows style for MSVC
     tar_log_cmd => undef,
-    # this directory must exist before anything will work
-    build_root => '/home/farm/buildfarm',
+    # If running multiple animals, an explicit common directory for
+    # the lockfile so that runs do not conflict. Otherwise, leave unset.
+    global_lock_dir => $basedir,
+    # If running multiple animals, the root must differ for each.
+    # This directory must exist before anything will work.
+    build_root => "$basedir/buildfarm",
     # set true to do vpath builds
     use_vpath => undef,
 
     keep_error_builds => 0,
     # Linux style, use "*.core" for BSD
     # set true to do vpath builds
     use_vpath => undef,
 
     keep_error_builds => 0,
     # Linux style, use "*.core" for BSD
-    core_file_glob => "core*",
+    core_file_glob => 'core*',
+
+    # Note about HTTPS: HTTPS support is experimental. For a
+    # limited time you may try to use HTTP, in case HTTPS doesn't
+    # work for you.
 
     # build process will connect to this URL to upload results
 
     # build process will connect to this URL to upload results
-    target => "http://eximbuild.mrball.net/cgi-bin/eximstatus.pl",
+    target => 'https://buildfarm.exim.org/cgi-bin/eximstatus.pl',
     # update_personality uses this when you want to update your
     # machine's info (OS, version, compiler, version)
     # update_personality uses this when you want to update your
     # machine's info (OS, version, compiler, version)
-    upgrade_target => "http://eximbuild.mrball.net/cgi-bin/upgrade.pl",
+    upgrade_target => 'https://buildfarm.exim.org/cgi-bin/upgrade.pl',
 
     # Your host alias and password in the BuildFarm
 
     # Your host alias and password in the BuildFarm
-    animal => "alias_assigned_by_build_team",
-    secret => "secret_assigned_by_build_team",
+    animal => 'alias_assigned_by_build_team',
+    secret => 'secret_assigned_by_build_team',
+
+    # allow automatic updates of the buildfarm client code.
+    # Leave it *unset* to get the default behaviour, set it
+    # to some false value to disable automatic updates or set it
+    # to the name of the remote Git repo you follow for your
+    # buildfarm-client code.
+    #auto_update => 'origin',
 
     # if force_every is a scalar it will be used on all branches, like this
     # for legacy reasons:
 
     # if force_every is a scalar it will be used on all branches, like this
     # for legacy reasons:
@@ -99,13 +114,16 @@ my $branch;
     trigger_include => undef,
 
     # settings for mail notices - default to notifying nobody
     trigger_include => undef,
 
     # settings for mail notices - default to notifying nobody
+    # (putting the operator of the animal is a good idea)
     # these lists contain addresses to be notified
     # must be complete email addresses, as the email is sent from the server
     # these lists contain addresses to be notified
     # must be complete email addresses, as the email is sent from the server
+    # put single-quote (') around the address string
     mail_events =>{
         all => [], # unconditional
         fail => [], # if this build fails
         change => [], # if this build causes a state change
         green => [], # if this build causes a state change to/from OK
     mail_events =>{
         all => [], # unconditional
         fail => [], # if this build fails
         change => [], # if this build causes a state change
         green => [], # if this build causes a state change to/from OK
+        # green => ['me@example.com'],
     },
 
     # env settings to apply within build/report process
     },
 
     # env settings to apply within build/report process
@@ -114,7 +132,7 @@ my $branch;
     build_env =>{
         # use a dedicated cache for the build farm. this should give us
         # very high hit rates and slightly faster cache searching.
     build_env =>{
         # use a dedicated cache for the build farm. this should give us
         # very high hit rates and slightly faster cache searching.
-        CCACHE_DIR => "/home/farm/buildfarm/ccache/$branch",
+        CCACHE_DIR => "$basedir/buildfarm/ccache/$branch",
 
         ### set this if you need a proxy setting for the
         # outbound web transaction that reports the results
 
         ### set this if you need a proxy setting for the
         # outbound web transaction that reports the results
@@ -129,27 +147,65 @@ my $branch;
     # previous definitions of variables.  Example:
     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
     makefile_set =>{
     # previous definitions of variables.  Example:
     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
     makefile_set =>{
-        # comment out if not using ccache
-        CC => 'ccache gcc',
+        # uncomment to use ccache
+        #CC => 'ccache gcc',
+       HAVE_IPV6 => 'yes',
+        # Required for some tests to pass
+        AUTH_PLAINTEXT => 'yes',
+        SUPPORT_MAILDIR => 'yes',
         # Other examples. Could use makefile_regex instead.
         # Other examples. Could use makefile_regex instead.
-        #SUPPORT_TLS => 'yes',
+       #
+       #USE_GDBM = yes
+       #DBMLIB = -lgdbm
+        #
+       WITH_CONTENT_SCAN => 'yes',
+        #DISABLE_TLS => 'yes',
+        #  Enable the proper libs here or see in makefile_regex
+        #  for use of pkg-config
+        #USE_OPENSSL => 'yes',
+        #USE_GNUTLS => 'yes',
         #TLS_LIBS => '-lssl -lcrypto',
         #TLS_LIBS => '-lssl -lcrypto',
+        #
+       # Many testcases need dsearch
+        LOOKUP_DSEARCH => 'yes',
+        #LOOKUP_LDAP => 'yes',
+        #LOOKUP_INCLUDE => '-I/usr/include/mysql -I/usr/include/postgresql'
+        #LOOKUP_LIBS => '-lmysqlclient -lpq -lldap -llber',
+        #LDAP_LIB_TYPE => 'OPENLDAP2',
+        #LOOKUP_MYSQL => 'yes',
+        #LOOKUP_PGSQL => 'yes',
+        #SUPPORT_PROXY => 'yes',
+        #SUPPORT_SOCKS => 'yes',
+        #SUPPORT_SPF => 'yes',
+        #SUPPORT_DANE => 'yes',
     },
     # Settings to add to Local/Makefile. These will add to variables that
     # are already defined earlier in the Makefile.  Example:
     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
     makefile_add =>{
         # Show all warnings and errors
     },
     # Settings to add to Local/Makefile. These will add to variables that
     # are already defined earlier in the Makefile.  Example:
     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
     makefile_add =>{
         # Show all warnings and errors
-        CFLAGS => '-Wall -Werror=format-security',
+       # Some platforms need the c99 setting enabled; some hate it
+        #CFLAGS => '-std=c99 -Wall -Wno-parentheses -Werror=format-security',
+        CFLAGS => '-Wall -Wno-parentheses -Wno-dangling-else -Werror=format-security',
         # Or enable debugging flags
         #CFLAGS => '-g -Wall',
         #LFLAGS => '-g',
         # Or enable debugging flags
         #CFLAGS => '-g -Wall',
         #LFLAGS => '-g',
+        # If set SUPPORT_SPF above, add it to the linker:
+        #LDFLAGS => '-lspf2',
     },
 
     # Another way to enable things in the Local/Makefile.
     # Use a simple regex to change a default to what you want.
     makefile_regex =>[
     },
 
     # Another way to enable things in the Local/Makefile.
     # Use a simple regex to change a default to what you want.
     makefile_regex =>[
-        #q(s/^# EXPERIMENTAL_PRDR.*/EXPERIMENTAL_PRDR=yes/),
+        # If have perl devel libraries installed, can build embedded perl
+        #q(s/^# EXIM_PERL=/EXIM_PERL=/),
+        # Use SSL libraries
+        #q(s/^# (USE_GNUTLS(?:_PC)?=.*)/$1/),
+        #q(s/^# (USE_OPENSSL_PC=.*)/$1/),
+        # Several experimental features to consider
+        # May be outdated, please check a current EDITME for
+        # for options.
+        #q(s/^# (EXPERIMENTAL_CERTNAMES.*)/$1/),
     ],
 
     # The user compiled as the master exim username.
     ],
 
     # The user compiled as the master exim username.
@@ -157,50 +213,36 @@ my $branch;
     # the group of the exim user as a secondary group. Example:
     # user=>farm, group=>farm, secondary_groups=>exim
     # user=>exim, group=>exim
     # the group of the exim user as a secondary group. Example:
     # user=>farm, group=>farm, secondary_groups=>exim
     # user=>exim, group=>exim
-    master_exim_user => "exim",
+    master_exim_user => 'exim',
 
     # Range of tests to run if enable make_test in optional steps.
 
     # Range of tests to run if enable make_test in optional steps.
-    #range_num_tests => '1 999',
-    range_num_tests => '1 999',
+    # Start with just a couple while getting the aminal set up,
+    # then enable the full set
+    range_num_tests => '1 2',
+    #range_num_tests => '1 5999',
     # Hardcode some valid version for use during make test
     # Hardcode some valid version for use during make test
-    exim_test_version => '4.80',
+    exim_test_version => '4.84',
 
     optional_steps =>{
         # which optional steps to run and when to run them
 
     optional_steps =>{
         # which optional steps to run and when to run them
-        # build_docs => {min_hours_since => 24*7},
-        make_test  => {min_hours_since => 24*7},
+        # 'make-doc' => {min_hours_since => 24*7},
+        test  => {min_hours_since => 24*7},
     },
 
     # locales to test
     locales => [qw( C )],
 
     },
 
     # locales to test
     locales => [qw( C )],
 
-    # Unused
+    # Placemarker for auto-generated build features
     config_opts =>[
         qw()
     ],
 
     config_opts =>[
         qw()
     ],
 
-    # per-branch contents of extra config for check stages.
-    # each branch has an array of setting lines (no \n required)
-    # a DEFAULT entry is used for all branches, before any
-    # branch-specific settings.
-    extra_config =>{
-        DEFAULT => [
-            #q(log_line_prefix = '[%c:%l] '),
-            #"log_connections = 'true'",
-            #"log_disconnections = 'true'",
-            #"log_statement = 'all'",
-            #"fsync = off"
-        ],
-    },
-
-    # Unused
-    # port number actually used will be based on this param and the branch,
-    # so we ensure they don't collide
-    base_port => 5678,
-
-    # Unused
-    modules => [qw(TestUpgrade)],
-
+    # Configuration tuning for test suite ./configure
+    test_configure_env => {},
+    test_configure_args => [],
+    # Configuration tuning for test suite run
+    # eg. test_run_args = '-FLAVOUR openssl_1_1_1',
+    test_run_args => '',       
 );
 
 if ($branch eq 'global')
 );
 
 if ($branch eq 'global')
@@ -220,4 +262,10 @@ if ($branch eq 'global')
 #
 ##################################
 
 #
 ##################################
 
+# Eg:
+#if ($branch eq 'exim-4.90+fixes')
+#{
+#      $conf{makefile_set}{SUPPORT_DANE} = '';
+#}
+
 1;
 1;
Client to build Exim and report results to a central server for developers to look for problems or regressions