feat: check ovftool version

[tenthirtyam]

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

1. 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

2. 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.

3. 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]

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]

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

[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.

[tenthirtyam]

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.

[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!

[lbajolet-hashicorp]

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