Adopt Developer Resources section
Signed-off-by: George Melikov <mail@gmelikov.ru>
This commit is contained in:
George Melikov
245
docs/Developer Resources/Buildbot-Options.rst
Normal file
245
docs/Developer Resources/Buildbot-Options.rst
Normal file
@@ -0,0 +1,245 @@
|
||||
There are a number of ways to control the ZFS Buildbot at a commit
|
||||
level. This page provides a summary of various options that the ZFS
|
||||
Buildbot supports and how it impacts testing. More detailed information
|
||||
regarding its implementation can be found at the `ZFS Buildbot Github
|
||||
page <https://github.com/zfsonlinux/zfs-buildbot>`__.
|
||||
|
||||
Choosing Builders
|
||||
-----------------
|
||||
|
||||
By default, all commits in your ZFS pull request are compiled by the
|
||||
BUILD builders. Additionally, the top commit of your ZFS pull request is
|
||||
tested by TEST builders. However, there is the option to override which
|
||||
types of builder should be used on a per commit basis. In this case, you
|
||||
can add
|
||||
``Requires-builders: <none|all|style|build|arch|distro|test|perf|coverage|unstable>``
|
||||
to your commit message. A comma separated list of options can be
|
||||
provided. Supported options are:
|
||||
|
||||
- ``all``: This commit should be built by all available builders
|
||||
- ``none``: This commit should not be built by any builders
|
||||
- ``style``: This commit should be built by STYLE builders
|
||||
- ``build``: This commit should be built by all BUILD builders
|
||||
- ``arch``: This commit should be built by BUILD builders tagged as
|
||||
'Architectures'
|
||||
- ``distro``: This commit should be built by BUILD builders tagged as
|
||||
'Distributions'
|
||||
- ``test``: This commit should be built and tested by the TEST builders
|
||||
(excluding the Coverage TEST builders)
|
||||
- ``perf``: This commit should be built and tested by the PERF builders
|
||||
- ``coverage`` : This commit should be built and tested by the Coverage
|
||||
TEST builders
|
||||
- ``unstable`` : This commit should be built and tested by the Unstable
|
||||
TEST builders (currently only the Fedora Rawhide TEST builder)
|
||||
|
||||
A couple of examples on how to use ``Requires-builders:`` in commit
|
||||
messages can be found below.
|
||||
|
||||
.. _preventing-a-commit-from-being-built-and-tested:
|
||||
|
||||
Preventing a commit from being built and tested.
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Requires-builders: none
|
||||
|
||||
.. _submitting-a-commit-to-style-and-test-builders-only:
|
||||
|
||||
Submitting a commit to STYLE and TEST builders only.
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Requires-builders: style test
|
||||
|
||||
Requiring SPL Versions
|
||||
----------------------
|
||||
|
||||
Currently, the ZFS Buildbot attempts to choose the correct SPL branch to
|
||||
build based on a pull request's base branch. In the cases where a
|
||||
specific SPL version needs to be built, the ZFS buildbot supports
|
||||
specifying an SPL version for pull request testing. By opening a pull
|
||||
request against ZFS and adding ``Requires-spl:`` in a commit message,
|
||||
you can instruct the buildbot to use a specific SPL version. Below are
|
||||
examples of a commit messages that specify the SPL version.
|
||||
|
||||
Build SPL from a specific pull request
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Requires-spl: refs/pull/123/head
|
||||
|
||||
Build SPL branch ``spl-branch-name`` from ``zfsonlinux/spl`` repository
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Requires-spl: spl-branch-name
|
||||
|
||||
Requiring Kernel Version
|
||||
------------------------
|
||||
|
||||
Currently, Kernel.org builders will clone and build the master branch of
|
||||
Linux. In cases where a specific version of the Linux kernel needs to be
|
||||
built, the ZFS buildbot supports specifying the Linux kernel to be built
|
||||
via commit message. By opening a pull request against ZFS and adding
|
||||
``Requires-kernel:`` in a commit message, you can instruct the buildbot
|
||||
to use a specific Linux kernel. Below is an example commit message that
|
||||
specifies a specific Linux kernel tag.
|
||||
|
||||
.. _build-linux-kernel-version-414:
|
||||
|
||||
Build Linux Kernel Version 4.14
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Requires-kernel: v4.14
|
||||
|
||||
Build Steps Overrides
|
||||
---------------------
|
||||
|
||||
Each builder will execute or skip build steps based on its default
|
||||
preferences. In some scenarios, it might be possible to skip various
|
||||
build steps. The ZFS buildbot supports overriding the defaults of all
|
||||
builders in a commit message. The list of available overrides are:
|
||||
|
||||
- ``Build-linux: <Yes|No>``: All builders should build Linux for this
|
||||
commit
|
||||
- ``Build-lustre: <Yes|No>``: All builders should build Lustre for this
|
||||
commit
|
||||
- ``Build-spl: <Yes|No>``: All builders should build the SPL for this
|
||||
commit
|
||||
- ``Build-zfs: <Yes|No>``: All builders should build ZFS for this
|
||||
commit
|
||||
- ``Built-in: <Yes|No>``: All Linux builds should build in SPL and ZFS
|
||||
- ``Check-lint: <Yes|No>``: All builders should perform lint checks for
|
||||
this commit
|
||||
- ``Configure-lustre: <options>``: Provide ``<options>`` as configure
|
||||
flags when building Lustre
|
||||
- ``Configure-spl: <options>``: Provide ``<options>`` as configure
|
||||
flags when building the SPL
|
||||
- ``Configure-zfs: <options>``: Provide ``<options>`` as configure
|
||||
flags when building ZFS
|
||||
|
||||
A couple of examples on how to use overrides in commit messages can be
|
||||
found below.
|
||||
|
||||
Skip building the SPL and build Lustre without ldiskfs
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Build-lustre: Yes
|
||||
Configure-lustre: --disable-ldiskfs
|
||||
Build-spl: No
|
||||
|
||||
Build ZFS Only
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
This is a commit message
|
||||
|
||||
This text is part of the commit message body.
|
||||
|
||||
Signed-off-by: Contributor <contributor@email.com>
|
||||
Build-lustre: No
|
||||
Build-spl: No
|
||||
|
||||
Configuring Tests with the TEST File
|
||||
------------------------------------
|
||||
|
||||
At the top level of the ZFS source tree, there is the ```TEST``
|
||||
file <https://github.com/zfsonlinux/zfs/blob/master/TEST>`__ which
|
||||
contains variables that control if and how a specific test should run.
|
||||
Below is a list of each variable and a brief description of what each
|
||||
variable controls.
|
||||
|
||||
- ``TEST_PREPARE_WATCHDOG`` - Enables the Linux kernel watchdog
|
||||
- ``TEST_PREPARE_SHARES`` - Start NFS and Samba servers
|
||||
- ``TEST_SPLAT_SKIP`` - Determines if ``splat`` testing is skipped
|
||||
- ``TEST_SPLAT_OPTIONS`` - Command line options to provide to ``splat``
|
||||
- ``TEST_ZTEST_SKIP`` - Determines if ``ztest`` testing is skipped
|
||||
- ``TEST_ZTEST_TIMEOUT`` - The length of time ``ztest`` should run
|
||||
- ``TEST_ZTEST_DIR`` - Directory where ``ztest`` will create vdevs
|
||||
- ``TEST_ZTEST_OPTIONS`` - Options to pass to ``ztest``
|
||||
- ``TEST_ZTEST_CORE_DIR`` - Directory for ``ztest`` to store core dumps
|
||||
- ``TEST_ZIMPORT_SKIP`` - Determines if ``zimport`` testing is skipped
|
||||
- ``TEST_ZIMPORT_DIR`` - Directory used during ``zimport``
|
||||
- ``TEST_ZIMPORT_VERSIONS`` - Source versions to test
|
||||
- ``TEST_ZIMPORT_POOLS`` - Names of the pools for ``zimport`` to use
|
||||
for testing
|
||||
- ``TEST_ZIMPORT_OPTIONS`` - Command line options to provide to
|
||||
``zimport``
|
||||
- ``TEST_XFSTESTS_SKIP`` - Determines if ``xfstest`` testing is skipped
|
||||
- ``TEST_XFSTESTS_URL`` - URL to download ``xfstest`` from
|
||||
- ``TEST_XFSTESTS_VER`` - Name of the tarball to download from
|
||||
``TEST_XFSTESTS_URL``
|
||||
- ``TEST_XFSTESTS_POOL`` - Name of pool to create and used by
|
||||
``xfstest``
|
||||
- ``TEST_XFSTESTS_FS`` - Name of dataset for use by ``xfstest``
|
||||
- ``TEST_XFSTESTS_VDEV`` - Name of the vdev used by ``xfstest``
|
||||
- ``TEST_XFSTESTS_OPTIONS`` - Command line options to provide to
|
||||
``xfstest``
|
||||
- ``TEST_ZFSTESTS_SKIP`` - Determines if ``zfs-tests`` testing is
|
||||
skipped
|
||||
- ``TEST_ZFSTESTS_DIR`` - Directory to store files and loopback devices
|
||||
- ``TEST_ZFSTESTS_DISKS`` - Space delimited list of disks that
|
||||
``zfs-tests`` is allowed to use
|
||||
- ``TEST_ZFSTESTS_DISKSIZE`` - File size of file based vdevs used by
|
||||
``zfs-tests``
|
||||
- ``TEST_ZFSTESTS_ITERS`` - Number of times ``test-runner`` should
|
||||
execute its set of tests
|
||||
- ``TEST_ZFSTESTS_OPTIONS`` - Options to provide ``zfs-tests``
|
||||
- ``TEST_ZFSTESTS_RUNFILE`` - The runfile to use when running
|
||||
``zfs-tests``
|
||||
- ``TEST_ZFSTESTS_TAGS`` - List of tags to provide to ``test-runner``
|
||||
- ``TEST_ZFSSTRESS_SKIP`` - Determines if ``zfsstress`` testing is
|
||||
skipped
|
||||
- ``TEST_ZFSSTRESS_URL`` - URL to download ``zfsstress`` from
|
||||
- ``TEST_ZFSSTRESS_VER`` - Name of the tarball to download from
|
||||
``TEST_ZFSSTRESS_URL``
|
||||
- ``TEST_ZFSSTRESS_RUNTIME`` - Duration to run ``runstress.sh``
|
||||
- ``TEST_ZFSSTRESS_POOL`` - Name of pool to create and use for
|
||||
``zfsstress`` testing
|
||||
- ``TEST_ZFSSTRESS_FS`` - Name of dataset for use during ``zfsstress``
|
||||
tests
|
||||
- ``TEST_ZFSSTRESS_FSOPT`` - File system options to provide to
|
||||
``zfsstress``
|
||||
- ``TEST_ZFSSTRESS_VDEV`` - Directory to store vdevs for use during
|
||||
``zfsstress`` tests
|
||||
- ``TEST_ZFSSTRESS_OPTIONS`` - Command line options to provide to
|
||||
``runstress.sh``
|
||||
Reference in New Issue
Block a user