vmimage: allow the qemu-img binary to be overriden #3374
Conversation
Avocado currently searches for the qemu-img binary on the system, picking the first one available (respecting the PATH environment variable and looking at common places). In some specific circurnstances, such as when testing QEMU itself, it's desirable to use a matching qemu-img binary. Let's allow this configuration to be done at the module level, to be less intrusive on the API, so that the vast majority of vmimage users don't have to care about it. Signed-off-by: Cleber Rosa <crosa@redhat.com>
|
Congratulations! The build has finished successfully. 🍾 You can install the built RPMs by following these steps:
Please note that the RPMs should be used only in a testing environment. |
Codecov Report
@@ Coverage Diff @@
## master #3374 +/- ##
==========================================
- Coverage 69.86% 69.85% -0.01%
==========================================
Files 135 135
Lines 16536 16539 +3
==========================================
+ Hits 11553 11554 +1
- Misses 4983 4985 +2
Continue to review full report at Codecov.
|
| #: The "qemu-img" binary used when creating the snapshot images. If | ||
| #: set to None (the default), it will attempt to find a suitable binary | ||
| #: with :func:`avocado.utils.path.find_command`, which uses the the | ||
| #: system's PATH environment variable |
There was a problem hiding this comment.
@clebergnu, Out of curiosity: Why #: on comments?
There was a problem hiding this comment.
The variable gets automatically documented with that comment style.
| #: set to None (the default), it will attempt to find a suitable binary | ||
| #: with :func:`avocado.utils.path.find_command`, which uses the the | ||
| #: system's PATH environment variable | ||
| QEMU_IMG = None |
There was a problem hiding this comment.
Checking if I understood correctly... If I as an user of the vmimage module want to override qemu-img path then I do this:
import avocado.utils.vmimage
vmimage.QEMU_IMG = '/path/to/qemu-img'
If so then should it be documented because it may not be obvious to some users (like me:)?
There was a problem hiding this comment.
Yes, that's why it's commented with #:, it will be documented automatically with that long comment.
| @@ -431,7 +438,10 @@ def _take_snapshot(self): | |||
| """ | |||
| Takes a snapshot from the current image. | |||
| """ | |||
| qemu_img = utils_path.find_command('qemu-img') | |||
| if QEMU_IMG is None: | |||
There was a problem hiding this comment.
Reviewed this block. looks good to me!
Avocado currently searches for the qemu-img binary on the system,
picking the first one available (respecting the PATH environment
variable and looking at common places).
In some specific circurnstances, such as when testing QEMU itself,
it's desirable to use a matching qemu-img binary. Let's allow this
configuration to be done at the module level, to be less intrusive on
the API, so that the vast majority of vmimage users don't have to
care about it.
Signed-off-by: Cleber Rosa crosa@redhat.com