Replace discouraged function listVolumes #135
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
According to the libvirt storage API reference, the function - listVolumes (virStoragePoolListVolumes) should not be used anymore: "The use of this function is discouraged. Instead, use virStoragePoolListAllVolumes()." Source: https://libvirt.org/html/libvirt-libvirt-storage.html#virStoragePoolListVolumes Compatibility / Risk: The function "virStoragePoolListAllVolumes()" appeared in version 0.10.2 which was released in 2012. It seems rather unlikely that somebody is still using an older unsupported libvirt version, so the risk should be rather low. Source: https://libvirt.org/hvsupport.html#virStorageDriver
|
This looks good, thanks @bturmann. |
dseeley
added a commit
to dseeley/community.libvirt
that referenced
this pull request
Oct 17, 2022
* main: Improved domain definition handling Parse incoming XML instead of using regex to get name Refactor define command handling into separate function CI: add 2.14 tests, ignore-2.15 to avoid CI failing doc: set booleans to true/false for consistency Combine REVIEW_CHECKLIST.md and CONTRIBUTING.md and fix links CI: remove f35 from devel fix up failing pylint test, use before assignment Fix virt module to undefine a domain with nvram or other metadata (ansible-collections#136) Replace discouraged function listVolumes (ansible-collections#135) Replace functions listStoragePools and listDefinedStoragePools (ansible-collections#134) Update galaxy to next expected release (ansible-collections#133) Release 1.2.0 commit (ansible-collections#132)
dseeley
pushed a commit
to dseeley/community.libvirt
that referenced
this pull request
Oct 17, 2022
# By Chris Smart (6) and others # Via Chris Smart * main: Improved domain definition handling Parse incoming XML instead of using regex to get name Refactor define command handling into separate function CI: add 2.14 tests, ignore-2.15 to avoid CI failing doc: set booleans to true/false for consistency Combine REVIEW_CHECKLIST.md and CONTRIBUTING.md and fix links CI: remove f35 from devel fix up failing pylint test, use before assignment Fix virt module to undefine a domain with nvram or other metadata (ansible-collections#136) Replace discouraged function listVolumes (ansible-collections#135) Replace functions listStoragePools and listDefinedStoragePools (ansible-collections#134) Update galaxy to next expected release (ansible-collections#133) Release 1.2.0 commit (ansible-collections#132)
dseeley
pushed a commit
to dseeley/community.libvirt
that referenced
this pull request
Oct 17, 2022
# By Chris Smart (6) and others # Via Chris Smart * main: Improved domain definition handling Parse incoming XML instead of using regex to get name Refactor define command handling into separate function CI: add 2.14 tests, ignore-2.15 to avoid CI failing doc: set booleans to true/false for consistency Combine REVIEW_CHECKLIST.md and CONTRIBUTING.md and fix links CI: remove f35 from devel fix up failing pylint test, use before assignment Fix virt module to undefine a domain with nvram or other metadata (ansible-collections#136) Replace discouraged function listVolumes (ansible-collections#135) Replace functions listStoragePools and listDefinedStoragePools (ansible-collections#134) Update galaxy to next expected release (ansible-collections#133) Release 1.2.0 commit (ansible-collections#132)
dseeley
added a commit
to dseeley/community.libvirt
that referenced
this pull request
Oct 17, 2022
* modules_virt_additions: Improved domain definition handling Parse incoming XML instead of using regex to get name Refactor define command handling into separate function CI: add 2.14 tests, ignore-2.15 to avoid CI failing doc: set booleans to true/false for consistency Combine REVIEW_CHECKLIST.md and CONTRIBUTING.md and fix links CI: remove f35 from devel fix up failing pylint test, use before assignment Fix virt module to undefine a domain with nvram or other metadata (ansible-collections#136) Replace discouraged function listVolumes (ansible-collections#135) Replace functions listStoragePools and listDefinedStoragePools (ansible-collections#134) Update galaxy to next expected release (ansible-collections#133) Release 1.2.0 commit (ansible-collections#132)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is similar to #134.
SUMMARY
According to the libvirt storage API reference, the function
should not be used anymore: "The use of this
function is discouraged. Instead, use virStoragePoolListAllVolumes()."
Source:
https://libvirt.org/html/libvirt-libvirt-storage.html#virStoragePoolListVolumes
Compatibility / Risk:
The function "virStoragePoolListAllVolumes()" appeared in version
0.10.2 which was released in 2012. It seems rather unlikely that
somebody is still using an older unsupported libvirt version, so the
risk should be rather low.
Source:
https://libvirt.org/hvsupport.html#virStorageDriver
ISSUE TYPE
COMPONENT NAME
libvirt_pool
ADDITIONAL INFORMATION
My tests confirm that the bugfix works as expected. It does not change the output of virt_pool with facts and info compared to the old function.