terraform test: allow computed/mocked values override during planning #36227

dsa0x · 2024-12-17T14:37:15Z

This PR enables users to use mocked or overridden values when running a plan command. The attribute override_during can be set to plan or apply. This attribute can be set in the blocks for override_*, and mock_provider.

Target Release

1.11.0

Draft CHANGELOG entry

NEW FEATURES | UPGRADE NOTES | ENHANCEMENTS | BUG FIXES | EXPERIMENTS

liamcervante

I think the implementation looks good, just not super happy with the chosen name. I'd be interested to know your thoughts!

internal/configs/mock_provider.go

liamcervante · 2025-01-06T14:47:12Z

internal/configs/mock_provider.go

+	// When this attribute is set to true, the values specified in the override
+	// block will be used for computed attributes even when planning. Otherwise,
+	// the computed values will be set to unknown, just like in a real plan.
+	overrideComputed = "override_computed"


We have the command attribute available in the run blocks: https://developer.hashicorp.com/terraform/language/tests#run-blocks

I wonder if like compute_command that maps to a keyword of either plan or apply might be more clear about what is happening here? We can make it default to apply.

I think that makes it a bit more clear about what the attribute is actually doing. What do you think?

Thanks for the suggestion. I contemplated quite a bit on the right name to communicate what's going on here, and you are right that override_computed seems a bit unclear. However, I have similar thoughts about compute_command, especially the compute part. That may be confusing. What about override_command/override_target/override_target_command = plan/apply? From a user POV, they have defined the override, and want it to be applied. That it is a computed attribute is more subtle.

I like override_command, I think that could work. Another idea I had was override_during - as an attribute it doesn't make much sense on it's own, but when coupled with apply or plan then it brings a lot of context eg. override_during = plan.

But, override_command is also good I think 👍

internal/moduletest/mocking/values.go

liamcervante

Sorry, I just noticed a couple of places where you have pointers and I don't think you need them. This doesn't affect the behaviour of anything though, but I think makes every thing look a bit neater.

Also, since we just merged the changes to the CHANGELOG process you should add a CHANGELOG entry in this PR now.

liamcervante · 2025-01-07T12:46:26Z

internal/configs/mock_provider.go

+	// of a real plan. This attribute indicates that the computed values
+	// should be overridden with the values specified in the override block,
+	// even when planning.
+	useForPlan *bool


sorry, I didn't notice this before - I don't think this needs to be a pointer. You can just make it a normal bool, and public so callers can read it directly.

We don't need to distinguish between "not set" and explicitly set to false right?

liamcervante · 2025-01-07T12:51:16Z

internal/configs/mock_provider.go

@@ -65,12 +72,39 @@ func decodeMockProviderBlock(block *hcl.Block) (*Provider, hcl.Diagnostics) {
 	return provider, diags
 }

+func extractOverrideDuring(content *hcl.BodyContent) (*string, hcl.Diagnostics) {


I think you could also make this return a string without a pointer -> just return "apply" if the attribute isn't set.

In this section internal/configs/mock_provider.go#L317-L325, the field needs to be a pointer. This is necessary because, if the override_* block does not explicitly set a value for override_during, the global value should be applied. However, if the override_* block does set a value, it should take precedence over the global value. Using a pointer allows us to differentiate between an explicitly set value and a zero value.

ah nice! Makes sense!

liamcervante · 2025-01-08T09:27:34Z

internal/configs/mock_provider.go

@@ -65,12 +72,39 @@ func decodeMockProviderBlock(block *hcl.Block) (*Provider, hcl.Diagnostics) {
 	return provider, diags
 }

+func extractOverrideDuring(content *hcl.BodyContent) (*string, hcl.Diagnostics) {


ah nice! Makes sense!

liamcervante · 2025-01-08T10:47:53Z

There's a lot of commits here, so I'd make sure to squash and merge this - you might do that be default already but just wanted to make sure.

vercel bot deployed to Preview December 17, 2024 14:50 View deployment

dsa0x force-pushed the sams/allow-mocked-values-planning branch from 6bfae8e to aea2a5a Compare December 17, 2024 17:16

vercel bot deployed to Preview December 17, 2024 17:27 View deployment

vercel bot deployed to Preview December 18, 2024 11:37 View deployment

vercel bot deployed to Preview December 18, 2024 12:45 View deployment

vercel bot deployed to Preview December 18, 2024 12:54 View deployment

dsa0x changed the title ~~allow mocked values override during planning~~ terraform test: allow mocked values override during planning Dec 18, 2024

dsa0x changed the title ~~terraform test: allow mocked values override during planning~~ terraform test: allow computed values override during planning Dec 18, 2024

dsa0x force-pushed the sams/allow-mocked-values-planning branch from 23ce4ef to 5031c9d Compare December 18, 2024 16:02

vercel bot deployed to Preview December 18, 2024 16:07 View deployment

vercel bot deployed to Preview December 19, 2024 08:42 View deployment

dsa0x force-pushed the sams/allow-mocked-values-planning branch 2 times, most recently from d724364 to 3cdb84a Compare December 19, 2024 10:09

vercel bot deployed to Preview December 19, 2024 10:19 View deployment

dsa0x changed the title ~~terraform test: allow computed values override during planning~~ terraform test: allow computed/mocked values override during planning Dec 19, 2024

vercel bot deployed to Preview December 19, 2024 11:23 View deployment

vercel bot deployed to Preview December 19, 2024 11:48 View deployment

vercel bot deployed to Preview December 19, 2024 15:53 View deployment

liamcervante reviewed Jan 6, 2025

View reviewed changes

vercel bot deployed to Preview January 7, 2025 11:08 View deployment

dsa0x force-pushed the sams/allow-mocked-values-planning branch 2 times, most recently from 694d10b to dd3f791 Compare January 7, 2025 11:28

vercel bot deployed to Preview January 7, 2025 11:35 View deployment

dsa0x force-pushed the sams/allow-mocked-values-planning branch 2 times, most recently from 2be1048 to 0cdeaa9 Compare January 7, 2025 11:44

vercel bot deployed to Preview January 7, 2025 11:52 View deployment

dsa0x requested a review from liamcervante January 7, 2025 11:57

liamcervante reviewed Jan 7, 2025

View reviewed changes

dsa0x added 2 commits January 8, 2025 09:54

allow mocked values override during planning

f9f3105

change param to pointer

8ad8dda

dsa0x added 16 commits January 8, 2025 09:54

change pointer param

c01d6dd

add tests to show that plan needs flag to use overrides

52c46f5

some clarity improvement

6c066c7

fix tests

6f7146a

change flag name

c462f8f

change flag name (2)

c253382

support provider_level override_computed flag

1a822fe

more tests

029e24d

minor improvements

014dd2d

minor improvements (2)

7bb8e4b

allow mocked values override during planning

75ae697

minor improvements (3)

1346592

fix tests

42a2904

address comments, change attr name

4b3c093

rename to override_during

12ace9d

address comments

d29ae92

dsa0x force-pushed the sams/allow-mocked-values-planning branch from 0cdeaa9 to d29ae92 Compare January 8, 2025 09:14

vercel bot deployed to Preview January 8, 2025 09:20 View deployment

liamcervante previously approved these changes Jan 8, 2025

View reviewed changes

dsa0x marked this pull request as ready for review January 8, 2025 09:36

dsa0x requested a review from a team as a code owner January 8, 2025 09:36

Update changelog

2d1b8ef

dsa0x dismissed liamcervante’s stale review via 2d1b8ef January 8, 2025 09:43

vercel bot deployed to Preview January 8, 2025 09:48 View deployment

replace manual changelog edit with changie entry

e2f213f

vercel bot deployed to Preview January 8, 2025 10:40 View deployment

liamcervante approved these changes Jan 8, 2025

View reviewed changes

dsa0x merged commit aec7c3c into main Jan 8, 2025
7 checks passed

dsa0x deleted the sams/allow-mocked-values-planning branch January 8, 2025 11:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

terraform test: allow computed/mocked values override during planning #36227

terraform test: allow computed/mocked values override during planning #36227

dsa0x commented Dec 17, 2024 •

edited

Loading

liamcervante left a comment

liamcervante Jan 6, 2025

dsa0x Jan 7, 2025 •

edited

Loading

liamcervante Jan 7, 2025

liamcervante left a comment

liamcervante Jan 7, 2025

liamcervante Jan 7, 2025

dsa0x Jan 8, 2025

liamcervante Jan 8, 2025

liamcervante Jan 8, 2025

liamcervante commented Jan 8, 2025

terraform test: allow computed/mocked values override during planning #36227

terraform test: allow computed/mocked values override during planning #36227

Conversation

dsa0x commented Dec 17, 2024 • edited Loading

Target Release

Draft CHANGELOG entry

NEW FEATURES | UPGRADE NOTES | ENHANCEMENTS | BUG FIXES | EXPERIMENTS

liamcervante left a comment

Choose a reason for hiding this comment

liamcervante Jan 6, 2025

Choose a reason for hiding this comment

dsa0x Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

liamcervante Jan 7, 2025

Choose a reason for hiding this comment

liamcervante left a comment

Choose a reason for hiding this comment

liamcervante Jan 7, 2025

Choose a reason for hiding this comment

liamcervante Jan 7, 2025

Choose a reason for hiding this comment

dsa0x Jan 8, 2025

Choose a reason for hiding this comment

liamcervante Jan 8, 2025

Choose a reason for hiding this comment

liamcervante Jan 8, 2025

Choose a reason for hiding this comment

liamcervante commented Jan 8, 2025

dsa0x commented Dec 17, 2024 •

edited

Loading

dsa0x Jan 7, 2025 •

edited

Loading