libguestfs-test-tool(1) - Linux man page

Name

libguestfs-test-tool - Diagnostics for libguestfs

Synopsis

libguestfs-test-tool [--options]

Description

libguestfs-test-tool is a test program shipped with libguestfs to allow you to check basic libguestfs functionality is working. This is needed because libguestfs occasionally breaks for reasons beyond our control: usually because of changes in the underlying qemu or kernel packages, or the host environment.

If you suspect a problem in libguestfs, then just run:

libguestfs-test-tool

It will print lots of diagnostic messages.

If it runs to completion successfully, you will see this near the end:

===== TEST FINISHED OK =====

and the test tool will exit with code 0.

If it fails (and/or exits with non-zero error code), please paste the complete, unedited output of the test tool into a bug report. More information about reporting bugs can be found on the http://libguestfs.org/ website.

Options

--help

Display short usage information and exit.
--qemu qemu_binary: If you have downloaded another qemu binary, point this option at the full path of the binary to try it.
--qemudir qemu_source_dir: If you have compiled qemu from source, point this option at the source directory to try it.
-t N
--timeout N: Set the launch timeout to "N" seconds. The default is 600 seconds (10 minutes) which does not usually need to be adjusted.
-V
--version: Display the libguestfs version number and exit.

Trying Out A Different Version Of Qemu

If you have compiled another version of qemu from source and would like to try that, then you can use the --qemudir option to point to the qemu source directory.

If you have downloaded a qemu binary from somewhere, use the --qemu option to point to the binary.

Note when using these options, you can ignore the business of qemu wrapper scripts (" QEMU WRAPPERS " in guestfs(3)), since libguestfs-test-tool writes a wrapper script for you if one is needed.

Trying Out A Different Kernel

If you are using febootstrap ≥ 3.8 then you can select which kernel libguestfs tries. You do this by setting the environment variables "FEBOOTSTRAP_KERNEL" and/or "FEBOOTSTRAP_MODULES".

Refer to " ENVIRONMENT VARIABLES " in febootstrap-supermin-helper(8) for further information.

Self-diagnosis

Refer to " APPLIANCE BOOT PROCESS " in guestfs(3) to understand the messages produced by libguestfs-test-tool and/or possible errors.

Exit Status

libguestfs-test-tool returns 0 if the tests completed without error, or 1 if there was an error.

Environment Variables

For the full list of environment variables which may affect libguestfs, please see the guestfs(3) manual page.

Authors

Richard W.M. Jones ("rjones at redhat dot com")

Copyright

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY ; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .

Bugs

To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools

To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

When reporting a bug, please supply:

• The version of libguestfs.
• Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
• Describe the bug accurately and give a way to reproduce it.
• Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug report.

Referenced By

guestfish(1), guestfs-examples(3), guestfs-java(3), guestfs-ocaml(3), guestfs-perl(3), guestfs-python(3), guestfs-recipes(1), guestfs-ruby(3), guestfs-testing(1), guestmount(1), virt-alignment-scan(1), virt-cat(1), virt-copy-in(1), virt-copy-out(1), virt-df(1), virt-edit(1), virt-filesystems(1), virt-format(1), virt-inspector2(1), virt-list-filesystems(1), virt-list-partitions(1), virt-ls(1), virt-make-fs(1), virt-rescue(1), virt-resize(1), virt-sparsify(1), virt-sysprep(1), virt-tar(1), virt-tar-in(1), virt-tar-out(1), virt-win-reg(1)