wt-daily.config.template

#####
#
# Configuration file for wt-daily
#
#####

# Defines the directory where to store the files for the daily tests.
#
# This directory has the following structure:
#   src        - The Wine source.
#   wine       - The 32 bit Wine build.
#   wow32      - The 32 bit Wine build for the mixed 32/64 build.
#   wow64      - The 64 bit Wine build for the mixed 32/64 build.
#   wineprefix - The Wine prefix used for the tests.
#   winetest   - The WineTest files.
test_root="$dir0/winetest"

# WineTest needs a valid email address so Wine developers can contact you
# if they have questions about a failing Wine test
email=""

# If empty the test report will be uploaded to the official WineTest website.
# To send the results to a development website set submit_urls to a
# comma-separated list of URLs to use. Note that an empty URL will send the
# results to the official website.
submit_urls=""

# For each test specify:
# - tag
#   WineTest's tag identifying this test configuration
# - desc
#   A string describing this test configuration. This is meant to help Wine
#   developers figure out what could impact the test results like which
#   graphics card you have, the graphics driver (open-source/proprietary),
#   your locale if non-English, etc.
# - exclude
#   Tests to exclude because you know that cannot work on your machine.
#   You should really not have to use this field: it's better to adjust the
#   system's configuration so all the tests can run. Furthermore if you exclude
#   too many tests your results will be rejected.

# If tag is non empty then the regular 32 bit tests will be run.
tag=""
desc=""
exclude=""

# If tagmac is non empty then the regular 32 bit tests will be run using the
# Mac graphics driver. This obviously only makes sense on Mac OS/X.
tagmac=""
descmac=""
excludemac=""

# If tagwow32 is non empty then the 32 bit tests will be run in a Wine prefix
# supporting 32 and 64 bit applications.
tagwow32=""
descwow32=""
excludewow32=""

# If tagwow64 is non empty then the 64 bit tests will be run in a Wine prefix
# supporting 32 and 64 bit applications.
tagwow64=""
descwow64=""
excludewow64=""

# A space-separated list of wt-image files to reboot to so they can run the
# tests.
otheroses=""

# If non-empty, wt-daily will update itself and the related scripts before
# running.
#
# **** SECURITY NOTICE ***
#
# _It is quite recommended_ to set self_update to true so the tests will keep
# running unattented even when wt-daily updates are needed to deal with Wine
# changes.
# However that supposes you trust whoever administrates or has commit access
# to the upstream Git repository. Thus, despite this being suboptimal, the
# default is to not self-update.
self_update=""

# If non-empty this value will be passed to wt-power once all the tests have
# been run. This makes it possible to automatically shut down the machine
# after running the tests for instance.
shutdown=""

# A set of default options. They can be overridden by options specified on the
# command line.
default_options=""


#####
#
# Hooks for extra tasks
#
#####

# Use this hook to trace the wt-daily actions.
# The arguments are a message describing the action wt-daily is starting.
trace()
{
    return
}

# Use this to extend wt-daily with extra command line options.
# The option under consideration is passed as the first argument and
# is_extra_option() should return 0 if it is valid, 1 otherwise.
is_extra_option()
{
    return 1
}

# This allows documenting the extra options.
print_extra_usage()
{
    return
}

# Use this to get the user's input before wt-daily asks its own questions.
# This function is invoked in a subshell and will block the tests until it
# returns. "$flock" "$ready_lock" will return as soon as the tests are ready
# to run which you can use as a timeout for answering the question.
pre_interactive()
{
    # For instance uncomment the line below to watch TV while wt-daily does
    # the builds and ensure the tests will only start once you're done.
    # mythfrontend
    return
}

# Use this to get the user's input after wt-daily has asked its questions.
# See pre_interactive() for more details.
post_interactive()
{
    return
}

# Called before updating the Wine source.
#
# See the register_xxx_task() functions for how to handle background tasks.
# For instance to ensure the tests will not start until mytask is done,
# register it as a build task:
#   mytask &
#   register_build_task $!
pre_update()
{
    return
}

# Called after the update tasks and before starting the build ones.
# Note that this is always called, even if --no-build was specified.
# Skip tasks if [ "$opt_build" != "1" ].
pre_build()
{
    return
}

# Called after the build tasks and before starting the test ones.
# Note that this is always called, even if --no-test was specified.
# Skip tasks if [ "$opt_test" != "1" ].
pre_tests()
{
    return
}

# Called before starting a WineTest run.
# The argument (mac, win32, wow32, wow64) describes which WineTest run is
# about to start.
pre_test()
{
    return
}

# Called when a WineTest run completes.
# The argument describes which WineTest run completed. See pre_test().
post_test()
{
    return
}

# Called after the test tasks.
post_tests()
{
    return
}