mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-07-06 18:05:45 +00:00
9f64891590
This patch mainly fixes an unfinished sentence that was supposed to describe the LIBVIRT_CI_INTEGRATION_RUNNER_TAG variable, but took the opportunity to update the description of the other variable too. Signed-off-by: Erik Skultety <eskultet@redhat.com> Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
63 lines
2.4 KiB
ReStructuredText
63 lines
2.4 KiB
ReStructuredText
==============================
|
|
Libvirt Continuous Integration
|
|
==============================
|
|
|
|
.. contents::
|
|
|
|
The libvirt project uses GitLab CI for automated testing.
|
|
`Here's <ci-dashboard.html>`__ our CI dashboard which shows the current status
|
|
of our pipelines.
|
|
|
|
Builds and unit tests
|
|
=====================
|
|
|
|
Linux builds and cross-compiled Windows builds happen on GitLab CI's shared
|
|
runners, while FreeBSD and macOS coverage is achieved by triggering `Cirrus CI
|
|
<https://cirrus-ci.com/>`_ jobs behind the scenes.
|
|
|
|
Most of the tooling used to build CI pipelines is maintained as part of the
|
|
`libvirt-ci <https://gitlab.com/libvirt/libvirt-ci>`_ subproject.
|
|
|
|
Integration tests
|
|
=================
|
|
|
|
Integration tests in our CI pipelines require dedicated HW which is not
|
|
available to forks, see `GitLab CI Custom Runners <ci-runners.html>`__.
|
|
Therefore, in order to execute the integration tests as part of your libvirt
|
|
fork's GitLab CI you'll need to provide your own runner. You'll also need to
|
|
set a few CI variables to run the integration tests as part of the CI pipeline,
|
|
see below.
|
|
|
|
GitLab CI variables
|
|
-------------------
|
|
|
|
* ``LIBVIRT_CI_INTEGRATION`` - enables integration test suite execution as part
|
|
of the pipeline (works in forks too if there's a registered shared runner)
|
|
* ``LIBVIRT_CI_INTEGRATION_RUNNER_TAG`` - overrides the gitlab-runner tag for
|
|
the pipeline; this is needed in forks because the default tag only matches
|
|
upstream shared runners which may be (and will be) different from the tags
|
|
defined on shared runners in forks
|
|
|
|
Retrieving test logs
|
|
--------------------
|
|
|
|
In case the integration test suite fails in our CI pipelines, a job artifact is
|
|
generated containing Avocado logs, libvirt debug logs, and the latest traceback
|
|
(if one was produced during a daemon's execution).
|
|
|
|
Adding new OS platforms OR build pre-requisites
|
|
===============================================
|
|
|
|
Since all of the Dockerfiles libvirt uses for CI have been generated by ``lcitool``
|
|
provided by the `libvirt-ci <https://gitlab.com/libvirt/libvirt-ci.git>`__ project,
|
|
most relevant changes will need to be introduced to ``lcitool`` first. Please
|
|
follow the instructions outlined
|
|
`here <https://gitlab.com/libvirt/libvirt-ci/-/blob/master/docs/platforms_and_mappings.rst>`__
|
|
|
|
|
|
Running CI workloads locally
|
|
============================
|
|
|
|
If you're interested in running the CI test workloads locally, please read
|
|
our `testing <testing.html>`__ guide.
|