Add component_type optional argument

[smaeda-ks]

to support specifying the exact build image when multiple images exist in the same provider and region for a given iteration

🛠️ Description

Currently, there's a limitation in the hcp_packer_image data source:
https://registry.terraform.io/providers/hashicorp/hcp/latest/docs/data-sources/packer_image

This data source only returns the first found image's metadata filtered by the given schema values, from the returned list of images associated with the specified iteration. Therefore, if multiple images exist in the same region, it will only pick one of them. If that's the case, you may consider separating your builds into different buckets.

🚢 Release Note

Release note for CHANGELOG:

* datasource/hcp_packer_image: Add `component_type` optional argument [GH-347]

🏗️ Acceptance tests

• Are there any feature flags that are required to use this functionality?
• Have you added an acceptance test for the functionality being added?
• Have you run the acceptance tests on this branch?

Output from acceptance testing:

make testacc TESTARGS=-run="TestAcc_dataSourcePackerImage"
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/... -v -run=TestAcc_dataSourcePackerImage -timeout 210m
?   	github.com/hashicorp/terraform-provider-hcp/internal/clients	[no test files]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/consul	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/input	(cached) [no tests to run]
=== RUN   TestAcc_dataSourcePackerImage
--- PASS: TestAcc_dataSourcePackerImage (17.49s)
=== RUN   TestAcc_dataSourcePackerImage_revokedIteration
--- PASS: TestAcc_dataSourcePackerImage_revokedIteration (16.24s)
=== RUN   TestAcc_dataSourcePackerImage_channelAndIterationIDReject
--- PASS: TestAcc_dataSourcePackerImage_channelAndIterationIDReject (7.25s)
=== RUN   TestAcc_dataSourcePackerImage_channelAccept
--- PASS: TestAcc_dataSourcePackerImage_channelAccept (12.05s)
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider	53.669s

[bcmdarroch]

Looks good to me, but I'm wondering how this fits with the latest change, adding the optional channel. Is this a truly optional filter? Or is it validated like channel and iteration id, where one or the other must be provided?

[smaeda-ks]

Hi @bcmdarroch, thanks for asking! My idea is to bring this new component_type argument as a truly optional filter. If this argument is not specified, the value fallback to the default string value which is "" and we passthrough in this case (works exactly the same as it is today):
https://github.com/hashicorp/terraform-provider-hcp/pull/347/files#diff-75b83f67aad514969dfcdf9ffe45fd2a651b5dbea3d7996c5e94794a555b8726R208-R211

and because channel and iteration_id are checked separately before this for block, they don't interact with this new component_type optional argument.

[sylviamoss]

This looks good and it's a simple way to solve the problem with two images in the same region + iteration. Thanks for taking care of that!

I think the Packer team still needs to take the time to think about other possible ways to solve this. One where the consumer doesn't need to know the source build identifier in the Packer template.

[sylviamoss]

We will port over this change to the equivalent Packer data source. Let me know in case you are interested in doing it.

[smaeda-ks]

@sylviamoss Thank you! As for the Packer data source, it seems straightforward to apply this change there so I might be interested in that work for sure! I'll make a PR there later.

[bcmdarroch]

Gotcha, makes sense. Once Packer team approves I'll go ahead and get this merged.

[sylviamoss]

@bcmdarroch already approved from our side! 🎉 I will merge it