External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 13:45:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: testing: Adjust the docs on how to run container workloads locally

Browse Source 
The fact that we need ci/helper script to run the workloads remains
true, but the invocation has changed as of commit
eb41e45630 . We also extracted GitLab job
specs into a standalone ci/jobs.sh script which allows execution of any
container job we run in upstream CI locally, unlike the original
functionality which only allowed builds, tests and shell (although
important to say it could be adjusted with the right meson/ninja args).

lcitool also became mandatory as it enables the container execution
which replaced a Makefile we used to have for this purpose.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
This commit is contained in:
Erik Skultety 2023-09-27 14:40:29 +02:00
parent 5fc4c1b1a1
commit 0b8309af98
1 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/testing.rst
View File

@ -48,11 +48,17 @@ Running container builds with GitLab CI
As long as your GitLab account has CI minutes available, pipelines will run As long as your GitLab account has CI minutes available, pipelines will run
automatically on every branch push to your fork. automatically on every branch push to your fork.
Running container builds locally Running container jobs locally
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In order to run container builds locally, we have a ``helper`` script inside GitLab CI configuration file is the only source of truth when it comes to
the ``ci`` directory that can pull, build, and test (if applicable) changes on various job specifications we execute as part of the upstream pipeline.
Luckily, all "script" (i.e. Bash scripts) were extracted to standalone Shell
functions in ``ci/jobs.sh``. This allows users to run any of the container
GitLab job specifications locally by just referencing the job name.
When it comes to actually running the GitLab jobs locally, we have a
``ci/helper`` script that can pull, build, and test (if applicable) changes on
your current local branch. It supports both the Docker and Podman runtimes your current local branch. It supports both the Docker and Podman runtimes
with an automatic selection of whichever runtime is configured on your system. with an automatic selection of whichever runtime is configured on your system.
In case neither has been enabled/configured, please go through the following In case neither has been enabled/configured, please go through the following
@ -130,12 +136,27 @@ the default libvirt registry:
fedora-rawhide-cross-mingw64 fedora-rawhide-cross-mingw64
... ...
Now let's say one would want to build their local libvirt changes on Alpine Now, let's say one would want to run the ``website`` job from GitLab on Debian
Edge using their own GitLab's registry container. They'd then proceed with 11. This is how a GitLab job specification can be referenced on ``ci/helper``'s
command line:
:: ::
$ ci/helper build --image-prefix registry.gitlab.com/<user>/libvirt/ci- alpine-edge $ ci/helper run --job website debian-10
What if you want to run an rpmbuild of libvirt on an RPM distro?
::
$ ci/helper run --job rpmbuild fedora-38
Want to use your own, say alpine-edge, container image from your GitLab
container registry?
Proceed with the following:
::
$ ci/helper run --job build --image-prefix registry.gitlab.com/<user>/libvirt/ci- alpine-edge
Finally, it would be nice if one could get an interactive shell inside the Finally, it would be nice if one could get an interactive shell inside the
test environment to debug potential build issues. This can be achieved with the test environment to debug potential build issues. This can be achieved with the
@ -143,7 +164,7 @@ following:
:: ::
$ ci/helper shell alpine-edge $ ci/helper run --job shell alpine-edge
Integration tests Integration tests