[libvirt PATCH 7/7] docs: testtck: Expand the 'Run TCK' section on making use of ci/jobs.sh

Ever since commit 6e9bd600 added a new GitLab job description function handling the integration test suite process to ci/jobs.sh it should be mentioned in the docs. This patch splits the 'Run TCK' section in two, giving user the option to run the integration test suite in their VM environment the same way as we do in GitLab CI or execute everything manually. This patch takes the opportunity to also link to the virtiofs kbase article to give users a different option to get the local libvirt repositories to be used in testing inside a VM. Signed-off-by: Erik Skultety <eskultet(a)redhat.com&gt; --- docs/testtck.rst | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/testtck.rst b/docs/testtck.rst index f57af61aa8..568899dcdd 100644 --- a/docs/testtck.rst +++ b/docs/testtck.rst @@ -90,8 +90,33 @@ in the future we plan on making the TCK internal coupling with Avocado tighter. Running TCK ~~~~~~~~~~~ -Once you have all the dependencies installed, you can then proceed with running -as root the test suite as root (when running with Avocado): +Once you have all the dependencies installed, you can then proceed with either +of the following procedures to execute the test suite as root. + +Replicating upstream CI test suite execution locally +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Similarly to how local container builds utilize the standalone ``ci/jobs.sh`` +script containing functions describing GitLab job definitions it can be +utilized to run integration test suite as well. In this case, one needs to +get a copy of their libvirt repository containing the changes to be tested +inside the VM (either by cloning it manually or sharing the repo e.g. via +`virtiofs <https://libvirt.org/kbase/virtiofs.html>`__). Make sure that the +user which is going to execute the following has passwordless "sudo" permissions +(lcitool's default "test" user does). Then it's just a matter of running + +:: + + $ source ci/jobs.sh + $ run_integration + +Manual invocation +^^^^^^^^^^^^^^^^^ + +If you want to have more control over the whole procedure or simply don't want +to run the exact same steps as libvirt's upstream CI pipeline does in context +of integration tests then start by cloning the +`TCK <https://gitlab.com/libvirt/libvirt-tck.git>`__ repository and run :: -- 2.41.0