feat: datasource for virtual machines #498

castorsky · 2024-12-05T01:56:41Z

I have implemented one of datasources which was requested in #196.

This datasource searches the vSphere cluster for some VMs that matches specified filters and returns VM name for one (and only one) machine. I have chosen such behavior because it will be straightforward for vsphere-clone builder - there will be no need for user to manipulate lists in locals.

I have included some tests and documentation for datasource.

By strange coincidence issues for vSphere and Proxmox datasources share the same ID. =)

Partially closes #196

tenthirtyam · 2024-12-05T02:29:26Z

Thanks @castorsky. I’ll review this week.

datasource/virtual_machine/data_test.go

datasource/virtual_machine/driver.go

datasource/virtual_machine/filters.go

datasource/virtual_machine/testing/call_restapi.go

datasource/virtual_machine/testing/simulator.go

docs/README.md

docs/datasources/virtual_machine.mdx

datasource/virtual_machine/testing/simulator.go

datasource/virtual_machine/data.go

datasource/virtual_machine/driver.go

datasource/virtual_machine/filters.go

datasource/virtual_machine/testing/call_restapi.go

tenthirtyam

Thanks for this pull request - this is great to see and could be a basis for many additional data sources.

Added suggestions for changes along with other comments.

Let me know if you have any questions or concerns.

Ryan Johnson
Distinguished Engineer, VMware by Broadcom

castorsky · 2024-12-06T23:58:38Z

Ryan, thank you for the very detailed review of my work. I will do my best to correct the plugin in the next few days.

castorsky · 2024-12-08T15:41:53Z

@tenthirtyam, I rewrote the code as per your recommendations, with one exception: package virtual_machine was renamed to virtualmachine (not virtual-machine):

found that some other plugins use this naming style;
Go guidelines are against hyphens and underscores in package names;
to me, double hyphens in names look like two levels of nesting (in this case, they are not);

tenthirtyam · 2024-12-08T19:38:57Z

Awesome! I'll do another review early this week!

tenthirtyam

Question: Since tags can long pass more than one tag category and name, should it be represented as singular tag?

Also, it looks like a go fmt ./... is needed for the CI.

.web-docs/components/data-source/virtualmachine/README.md

datasource/virtualmachine/data.go

docs/datasources/virtualmachine.mdx

tenthirtyam · 2024-12-09T16:16:42Z

Also, it looks like a go fmt ./... is needed for the CI.

I took care of the fmt on the last commit and the CI is good now.

tenthirtyam · 2024-12-09T16:33:14Z

Hi @castorsky 👋 - I've pushed updates to your branch with the requested changes from 2024-12-08. I'll do another review today and then plan to test the functionality along with Lucas.

Ready for next round of reviews.

- Made minor changes to documentation. - Standard `errors` and `fmt` were used for custom errors. - field `Node` was renamed to `Host`. - field `VmTags` was renamed to `Tags` - package `virtual_machine` was renamed to `virtualmachine` - `driver` and `testing` were moved to `common` location

castorsky · 2024-12-09T19:56:17Z

Hi @tenthirtyam! I agree with you about tag(s) field and renamed it. It was the network_adapters in the vsphere-iso builder that confused me. =)

datasource/virtualmachine/data.go

And drop info about dynamic blocks in datasource.

castorsky requested a review from a team as a code owner December 5, 2024 01:56

tenthirtyam changed the title ~~feature: datasource for virtual machines [issue 196]~~ feat: datasource for virtual machines Dec 5, 2024

tenthirtyam added the enhancement label Dec 5, 2024

tenthirtyam assigned castorsky Dec 5, 2024

tenthirtyam self-requested a review December 5, 2024 02:27

tenthirtyam added this to the v1.5.0 milestone Dec 5, 2024