feat: check ovftool version by tenthirtyam · Pull Request #201 · vmware/packer-plugin-vmware

tenthirtyam · 2024-06-25T23:41:53Z

Description

Checks the minimum recommended version of VMware Open Virtualization Format Tool ('ovftool').

Sets the minimum recommended to 4.6.0 to support vSphere 8.0 and earlier.

Also improves the documentation for Export Configuration that uses ovftool.

Testing

✅ Basic Tests

packer-plugin-vmware on  feat/check-ovftool-version
✦ ➜ go fmt ./...

packer-plugin-vmware on  feat/check-ovftool-version
✦ ➜ make generate
2024/08/08 18:43:42 Copying "docs" to ".docs/"
2024/08/08 18:43:42 Replacing @include '...' calls in .docs/
Compiling MDX docs in '.docs' to Markdown in '.web-docs'...

packer-plugin-vmware on  feat/check-ovftool-version
✦ ➜ make build

packer-plugin-vmware on  feat/check-ovftool-version
✦ ➜ make test
?       github.com/hashicorp/packer-plugin-vmware       [no test files]
?       github.com/hashicorp/packer-plugin-vmware/version       [no test files]
ok      github.com/hashicorp/packer-plugin-vmware/builder/vmware/common 7.199s
ok      github.com/hashicorp/packer-plugin-vmware/builder/vmware/iso    3.096s
ok      github.com/hashicorp/packer-plugin-vmware/builder/vmware/vmx    4.169s

✅ Unit Tests

OVFTool not installed.

✦4 ➜ PACKER_LOG=1 PACKER_LOG_PATH=packer.log packer build --force -var-file=photon-4.0-R2.pkrvars.hcl .
vmware-iso.vagrant-vmw: output will be in this color.

Build 'vmware-iso.vagrant-vmw' errored after 179 milliseconds 114 microseconds: ovftool not found; install and include it in your PATH

==> Wait completed after 179 milliseconds 223 microseconds

==> Some builds didn't complete successfully and had errors:
--> vmware-iso.vagrant-vmw: ovftool not found; install and include it in your PATH

OVFTool < 4.6.0

2024/08/08 18:40:36 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:40:36 Verifying that ovftool exists...
2024/08/08 18:40:36 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:40:36 Checking ovftool version...
2024/08/08 18:40:38 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:40:38 Returned ovftool version: VMware ovftool 4.5.0 (build-20459872)
2024/08/08 18:40:38 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: .
2024/08/08 18:40:38 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:40:38 [WARN] The version of ovftool (4.5.0) is below the minimum recommended version (4.6.0). Please download the latest version from https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest.

OVFTool >= 4.6.0

2024/08/08 18:42:21 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:42:21 Verifying that ovftool exists...
2024/08/08 18:42:21 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:42:21 Checking ovftool version...
2024/08/08 18:42:23 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: 2024/08/08 18:42:23 Returned ovftool version: VMware ovftool 4.6.3 (build-24031167)
2024/08/08 18:42:23 packer-plugin-vmware_v1.0.12-dev_x5.0_darwin_amd64 plugin: .
2024/08/08 18:42:23 ui: �[1;32m==> vmware-iso.vagrant-vmw: Retrieving ISO�[0m

Reference

Closes #135

nywilken · 2024-07-01T13:51:07Z

I don't enough about this change yet. But the fact that we are not enforcing a minimum version feels like it will break user workflows. Should this be a minor bump instead?

tenthirtyam · 2024-07-01T14:22:34Z

A minor bump would make sense, yes.
There is a related issue from the Terraform provider history i can link.

builder/vmware/common/driver.go

lbajolet-hashicorp

Thanks for the reroll @tenthirtyam!

Looking at the CheckOVFToolVersion function, I think we can iterate on it a bit more to make it more robust/simple, but aside from those comments, the code looks good!

I'll come back for another round of review when you've had a chance to address my comments.

builder/vmware/common/driver.go

tenthirtyam · 2024-07-26T23:50:50Z

I've refactored. Let me know what you think. I still need to run some additional tests prior to a merge and will report back.

lbajolet-hashicorp

Left a couple more suggestions regarding the check function, in the end, given the usage for both the bool and the error, it seems that error alone would make more sense as the two point to the same thing: we cannot proceed as either we couldn't detect the version, or the installed one is too old.

builder/vmware/common/driver.go

lbajolet-hashicorp

Left a few more suggestions on the code, having a warning regarding the version of OVFTool sounds good to me, we can continue with this approach, no problem here!

builder/vmware/common/driver.go

Checks the minimum recommended version of VMware Open Virtualization Format Tool ('ovftool'). Ref: #135 Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>

lbajolet-hashicorp

LGTM! Thanks for the many rerolls @tenthirtyam, will merge ASAP

github-actions · 2026-02-01T01:05:20Z

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

tenthirtyam added documentation Documentation enhancement Enhancement labels Jun 25, 2024

tenthirtyam added this to the v1.0.12 milestone Jun 25, 2024

tenthirtyam requested a review from nywilken June 25, 2024 23:41

tenthirtyam requested a review from a team as a code owner June 25, 2024 23:41

tenthirtyam force-pushed the feat/check-ovftool-version branch from e2599bb to 843025f Compare June 25, 2024 23:58

tenthirtyam self-assigned this Jun 25, 2024

tenthirtyam force-pushed the feat/check-ovftool-version branch from 843025f to dabfdf6 Compare June 29, 2024 02:58

tenthirtyam requested a review from lbajolet-hashicorp July 18, 2024 22:16

tenthirtyam commented Jul 23, 2024

View reviewed changes

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

tenthirtyam commented Jul 23, 2024

View reviewed changes

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

lbajolet-hashicorp reviewed Jul 23, 2024

View reviewed changes

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

tenthirtyam force-pushed the feat/check-ovftool-version branch from dabfdf6 to 76fe0fc Compare July 24, 2024 17:33

lbajolet-hashicorp suggested changes Jul 26, 2024

View reviewed changes

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

tenthirtyam force-pushed the feat/check-ovftool-version branch 3 times, most recently from 939a252 to 082fb4b Compare July 26, 2024 23:42

tenthirtyam requested a review from lbajolet-hashicorp July 26, 2024 23:49

lbajolet-hashicorp suggested changes Jul 29, 2024

View reviewed changes

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

tenthirtyam force-pushed the feat/check-ovftool-version branch 6 times, most recently from 0b49707 to e6aec7a Compare August 6, 2024 21:38

tenthirtyam requested a review from lbajolet-hashicorp August 6, 2024 21:39

lbajolet-hashicorp reviewed Aug 8, 2024

View reviewed changes

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

builder/vmware/common/driver.go Outdated Show resolved Hide resolved

feat: check ovftool version

6f50269

Checks the minimum recommended version of VMware Open Virtualization Format Tool ('ovftool'). Ref: #135 Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>

tenthirtyam force-pushed the feat/check-ovftool-version branch from e6aec7a to 6f50269 Compare August 8, 2024 22:45

tenthirtyam requested a review from lbajolet-hashicorp August 8, 2024 22:46

lbajolet-hashicorp approved these changes Aug 8, 2024

View reviewed changes

lbajolet-hashicorp merged commit f7d9a84 into main Aug 8, 2024

lbajolet-hashicorp deleted the feat/check-ovftool-version branch August 8, 2024 22:55

github-actions bot locked as resolved and limited conversation to collaborators Feb 1, 2026

Conversation

tenthirtyam commented Jun 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Reference

Uh oh!

nywilken commented Jul 1, 2024

Uh oh!

tenthirtyam commented Jul 1, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tenthirtyam commented Jul 26, 2024

Uh oh!

lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lbajolet-hashicorp left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tenthirtyam commented Jun 25, 2024 •

edited

Loading