Fix: panic and crash when size parameter of a disk is not parseable into a Quantity
#111
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
Fix crash if the disk block in the virtualmachine resource does not contain a `size` parameter and also doesn't contain either of the `existing_volume_name` or the `container_image_name` parameters. The Terraform provider relied on the `builder` package always behaving nicely, but the `builder` package relied on all users checking inputs before and only giving valid inputs. Therefore error handling in case a non-parsable size has been given for a disk was not done, causing a crash. The size parameter is not mandatory in all cases and defaults to an empty string, which is not parsable into a `resource.Quantity` object. The fix here is to differentiate better when the `size` parameter is taken into account at all. In case it is not taken into account, it is completely ignored. If it is taken into account, a check is performed that ensures it's parsable. If it isn't parsable, the Terraform provider will return an error directly, indicating to the user where the problem is. related-to: harvester/harvester#7139 Signed-off-by: Moritz Röhrich <[email protected]>
Add test to ensure that a non-parseable `size` parameter in a `disk` subresource of a `virtualmachine` resource generates an appropriate error message. The `size` parameter is not mandatory in all configurations, but when it is, it must be a parseable `resource.Quantity`, otherwise a panic and crash would ensue. Signed-off-by: Moritz Röhrich <[email protected]>
FrankYang0529
approved these changes
Dec 30, 2024
bk201
approved these changes
Dec 30, 2024
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.
Description
The
harvester_virtualmachineand its subresources are parsed and converted into akubevirtv1.VirtualMachineobject using aVMBuilderfactory. ThisVMBuilderassumes that parameters given to it have some semblance of sanity. This means amongst other things that thesizeparameter of a volume must be a parseable into aresource.Quantityusingresource.MustParse, e.g."10Gi".The
sizeparameter isn't always required, but when it is required, if a user omits it the Terraform provider will just fill it with a default value.Since the
sizeparameter of adisksubresource of aharvester_virtualmachineis user input, it must be sanitized before being passed on to theVMBuilder. In case it isn't parseable, a sensible error must be emitted and further processing of the virtual machine resource must be stopped.To do this, the parsing function of the
disksubresource ofharvester_virtualmachineresources is re-ordered such that the different cases where thesizeparameter matters and where it is ignored are more clearly defined.When it matters, the
sizeparameter is checked before being passed on to theVMBuilder.This also allows a default value to be used when the
sizeparameter isn't given, but is required.Related Issues: