zuul-jobs/roles/test-setup/README.rst
James E. Blair 9d8e765881 Add test_setup_skip role variable
This allows jobs which inherit from unittests to specify that
the test-setup script should not be run.  Some "unit test" jobs
are simple enough that they do not need to perform costly setup
for a full test run.

Change-Id: I5826bed411c42f9b3e0477b351bd82bd964d2fac
2019-07-10 09:22:30 -07:00

34 lines
924 B
ReStructuredText

Perform project test setup tasks.
This role assumes that Zuul has checked out a change for a project at
``{{ zuul_work_dir }}`` and looks for a file named
``tools/test-setup.sh``. If that file exists and is executable, it
will be run.
This allows projects to specify test-setup steps (such as creating or
initializing a database) in a form that can be easily run by both an
automated testing system and developers.
**Role Variables**
.. zuul:rolevar:: test_setup_environment
Environment variables to pass in to the test-setup script.
.. zuul:rolevar:: test_setup_args
String of optional command line options passed to
the test-setup script.
.. zuul:rolevar:: test_setup_skip
:default: false
Set this to true to skip running the test-setup script even if it
exists.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The directory in which to look for the setup script.