[libvirt PATCH 02/10] docs: Provide more information about the TCK test suite

[Daniel P. Berrangé]

On Tue, Jul 12, 2022 at 02:44:34PM +0200, Erik Skultety wrote:
> Most importantly, how to get it, how install dependencies and how
> to run it.
> 
> Signed-off-by: Erik Skultety <eskultet at redhat.com>
> ---
>  docs/testtck.rst | 92 ++++++++++++++++++++++++++++++++++++++++++------
>  1 file changed, 81 insertions(+), 11 deletions(-)

> +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):
> +
> +::
> +
> +    # avocado --config avocado.config run --tap - ./scripts/
> +
> +from the TCK's git root.
> +
> +
> +If you don't want to install Avocado you can execute tests using the
> +``libvirt-tck`` binary directly (again, from the git root). You'll need to pass
> +a few options that Avocado takes care of:
> +
> +::
> +
> +    # PERL5LIB=./lib perl bin/libvirt-tck -c <path_to_config> --force ./scripts

We don't need --force here technically - that's only if you want it
to cleanup a previously aborted test run that didn't do cleanup itself.

> +Note that running with root privileges is necessary since some tests need
> +access to system resources or configs. This, along with the fact that some
> +tests might affect the host system are good reasons to consider using a test VM
> +as described above.

One day we ought to make it work again as non-root, as it used to be
ok in the past. It would be useful to have coverage of qemu:///session
as we've had a few times where we caused regressions in unprivileged
libvirtd usage, since most of our developers test privileged. Unpriv
is getting more important given KubeVirt's desire to get fully
unprivileged.

With '--force' removed, or a note about it added

Reviewed-by: Daniel P. Berrangé <berrange at redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|