Default to inferring pulumi values (#2512)

This API change has been recommended by Venelin and Anton.

Author: iwahbe

pkg/internal/tests/cross-tests/README.md

@@ -49,7 +49,7 @@ Currently, SDKv2 cross-testing supports:
 - [Configure](./configure.go)
 
 Cross-tests can be written **either by** specify both the Terraform value *and* the Pulumi value **or** by
-specifying *only* the Terraform value and specifying `crosstests.InferPulumiValue()` for the Pulumi value.
+specifying *only* the Terraform value and letting the framework infer an equivalent Pulumi value.
 
 ``` go
 // A cross-test that infers the Pulumi value.
@@ -60,7 +60,6 @@ crosstests.Create(t,
 	cty.ObjectVal(map[string]cty.Value{
        	"f0": cty.BoolVal(true),
     }),
-	crosstests.InferPulumiValue(),
 )
 ```
 
@@ -73,9 +72,9 @@ crosstests.Create(t,
 	cty.ObjectVal(map[string]cty.Value{
        	"f0": cty.BoolVal(true),
     }),
-	resource.PropertyMap{
+	crosstests.CreatePulumiConfig(resource.PropertyMap{
        	"f0": resource.NewProperty(true),
-    },
+    }),
 )
 ```
 

pkg/internal/tests/cross-tests/adapt.go

@@ -33,27 +33,9 @@ import (
 	"github.com/pulumi/pulumi-terraform-bridge/v3/unstable/logging"
 )
 
-// InferPulumiValue is a special marker value that tells cross-tests to infer the Pulumi
-// value from the TF value.
-func InferPulumiValue() resource.PropertyMap {
-	return resource.PropertyMap{
-		inferPulumiValueKey: resource.NewProperty(&inferPulumiValueSecret),
-	}
-}
-
-const inferPulumiValueKey = "inferPulumiValue"
-
-var inferPulumiValueSecret = resource.Secret{}
-
-func isInferPulumiMarker(m resource.PropertyMap) bool {
-	v, ok := m[inferPulumiValueKey]
-	return ok && v.IsSecret() && v.SecretValue() == &inferPulumiValueSecret
-}
-
 // inferPulumiValue generates a Pulumi value that is semantically equivalent to v.
 //
-// inferPulumiValue takes into account schema information. [InferPulumiValue] is the
-// marker value that instructs [crosstests] to invoke [inferPulumiValue].
+// inferPulumiValue takes into account schema information.
 func inferPulumiValue(t T, schema shim.SchemaMap, infos map[string]*info.Schema, v cty.Value) resource.PropertyMap {
 	if v.IsNull() {
 		return nil

pkg/internal/tests/cross-tests/configure.go

@@ -32,12 +32,12 @@ import (
 )
 
 func MakeConfigure(
-	provider map[string]*schema.Schema, tfConfig cty.Value, puConfig resource.PropertyMap,
+	provider map[string]*schema.Schema, tfConfig cty.Value,
 	options ...ConfigureOption,
 ) func(*testing.T) {
 	return func(t *testing.T) {
 		t.Parallel()
-		Configure(t, provider, tfConfig, puConfig, options...)
+		Configure(t, provider, tfConfig, options...)
 	}
 }
 
@@ -49,7 +49,7 @@ func MakeConfigure(
 // on Plugin Framework based resources, see
 // github.com/pulumi/pulumi-terraform-bridge/pkg/pf/tests/internal/cross-tests.
 func Configure(
-	t T, provider map[string]*schema.Schema, tfConfig cty.Value, puConfig resource.PropertyMap,
+	t T, provider map[string]*schema.Schema, tfConfig cty.Value,
 	options ...ConfigureOption,
 ) {
 
@@ -58,7 +58,10 @@ func Configure(
 		f(&opts)
 	}
 
-	if isInferPulumiMarker(puConfig) {
+	var puConfig resource.PropertyMap
+	if opts.puConfig != nil {
+		puConfig = *opts.puConfig
+	} else {
 		puConfig = inferPulumiValue(t,
 			shimv2.NewSchemaMap(provider),
 			opts.resourceInfo.GetFields(),
@@ -146,13 +149,19 @@ func Configure(
 
 type configureOpts struct {
 	resourceInfo *info.Resource
+	puConfig     *resource.PropertyMap
 }
 
-// An option that can be used to customize [Create].
+// An option that can be used to customize [Configure].
 type ConfigureOption func(*configureOpts)
 
 // CreateResourceInfo specifies an [info.Resource] to apply to the resource under test.
 func ConfigureProviderInfo(info info.Resource) ConfigureOption {
 	contract.Assertf(info.Tok == "", "cannot set info.Tok, it will not be respected")
 	return func(o *configureOpts) { o.resourceInfo = &info }
 }
+
+// ConfigurePulumiConfig specifies an explicit pulumi value for the configure call.
+func ConfigurePulumiConfig(config resource.PropertyMap) ConfigureOption {
+	return func(o *configureOpts) { o.puConfig = &config }
+}

pkg/internal/tests/cross-tests/create.go

@@ -32,12 +32,12 @@ import (
 
 // MakeCreate is a helper function for calling [Create] in [testing.T.Run] subcases.
 func MakeCreate(
-	resource map[string]*schema.Schema, tfConfig cty.Value, puConfig resource.PropertyMap,
+	resource map[string]*schema.Schema, tfConfig cty.Value,
 	options ...CreateOption,
 ) func(t *testing.T) {
 	return func(t *testing.T) {
 		t.Parallel()
-		Create(t, resource, tfConfig, puConfig, options...)
+		Create(t, resource, tfConfig, options...)
 	}
 }
 
@@ -51,7 +51,7 @@ func MakeCreate(
 //
 // Create *does not* verify the outputs of the resource, only that the provider witnessed the same inputs.
 func Create(
-	t T, resource map[string]*schema.Schema, tfConfig cty.Value, puConfig resource.PropertyMap,
+	t T, resourceSchema map[string]*schema.Schema, tfConfig cty.Value,
 	options ...CreateOption,
 ) {
 
@@ -60,9 +60,12 @@ func Create(
 		f(&opts)
 	}
 
-	if isInferPulumiMarker(puConfig) {
+	var puConfig resource.PropertyMap
+	if opts.puConfig != nil {
+		puConfig = *opts.puConfig
+	} else {
 		puConfig = inferPulumiValue(t,
-			shimv2.NewSchemaMap(resource),
+			shimv2.NewSchemaMap(resourceSchema),
 			opts.resourceInfo.GetFields(),
 			tfConfig,
 		)
@@ -77,7 +80,7 @@ func Create(
 
 	makeResource := func(writeTo *result) *schema.Resource {
 		return &schema.Resource{
-			Schema:         resource,
+			Schema:         resourceSchema,
 			SchemaVersion:  opts.stateUpgrader.schemaVersion,
 			StateUpgraders: opts.stateUpgrader.stateUpgraders,
 			Timeouts:       opts.timeouts,
@@ -91,7 +94,7 @@ func Create(
 
 	tfwd := t.TempDir()
 	tfd := newTFResDriver(t, tfwd, defProviderShortName, defRtype, makeResource(&tfResult))
-	tfd.writePlanApply(t, resource, defRtype, "example", tfConfig, lifecycleArgs{})
+	tfd.writePlanApply(t, resourceSchema, defRtype, "example", tfConfig, lifecycleArgs{})
 
 	require.True(t, tfResult.wasSet, "terraform test result was not set")
 
@@ -119,13 +122,14 @@ func Create(
 	assert.Equal(t, tfResult.meta, puResult.meta,
 		"assert that both providers were configured with the same provider metadata")
 
-	assertResourceDataEqual(t, resource, tfResult.data, puResult.data)
+	assertResourceDataEqual(t, resourceSchema, tfResult.data, puResult.data)
 }
 
 type createOpts struct {
 	resourceInfo  *info.Resource
 	stateUpgrader createOptsUpgraders
 	timeouts      *schema.ResourceTimeout
+	puConfig      *resource.PropertyMap
 }
 
 type createOptsUpgraders struct {
@@ -153,3 +157,8 @@ func CreateStateUpgrader(schemaVersion int, upgraders []schema.StateUpgrader) Cr
 func CreateTimeout(timeouts *schema.ResourceTimeout) CreateOption {
 	return func(o *createOpts) { o.timeouts = timeouts }
 }
+
+// CreatePulumiConfig specifies an explicit config value in Pulumi's value space.
+func CreatePulumiConfig(config resource.PropertyMap) CreateOption {
+	return func(o *createOpts) { o.puConfig = &config }
+}

pkg/internal/tests/cross-tests/rapid_test.go

@@ -87,7 +87,6 @@ func TestCreateInputsConvergence(outerT *testing.T) {
 		Create(rT,
 			tv.schemaMap,
 			coalesceInputs(rT, tv.schemaMap, config),
-			InferPulumiValue(),
 		)
 	})
 }

pkg/tfbridge/tests/provider_configure_test.go

@@ -28,29 +28,29 @@ func TestConfigureSimpleValues(t *testing.T) {
 		"f0": {Type: schema.TypeString, Required: true},
 	}, cty.ObjectVal(map[string]cty.Value{
 		"f0": cty.StringVal("v0"),
-	}), crosstests.InferPulumiValue()))
+	})))
 
 	t.Run("bool", crosstests.MakeConfigure(map[string]*schema.Schema{
 		"f0": {Type: schema.TypeBool, Required: true},
 		"f1": {Type: schema.TypeBool, Required: true},
 	}, cty.ObjectVal(map[string]cty.Value{
 		"f0": cty.BoolVal(false),
 		"f1": cty.BoolVal(true),
-	}), crosstests.InferPulumiValue()))
+	})))
 
 	t.Run("int", crosstests.MakeConfigure(map[string]*schema.Schema{
 		"f0": {Type: schema.TypeInt, Required: true},
 	}, cty.ObjectVal(map[string]cty.Value{
 		"f0": cty.NumberIntVal(123456),
-	}), crosstests.InferPulumiValue()))
+	})))
 
 	t.Run("float64", func(t *testing.T) {
 		t.Skip("TODO: Float64 does not pass cross-tests")
 		crosstests.Configure(t, map[string]*schema.Schema{
 			"f0": {Type: schema.TypeFloat, Required: true},
 		}, cty.ObjectVal(map[string]cty.Value{
 			"f0": cty.NumberFloatVal(123.456),
-		}), crosstests.InferPulumiValue())
+		}))
 	})
 }
 
@@ -59,7 +59,7 @@ func TestConfigureSimpleSecretValues(t *testing.T) {
 		"f0": {Type: schema.TypeString, Required: true},
 	}, cty.ObjectVal(map[string]cty.Value{
 		"f0": cty.StringVal("v0"),
-	}), resource.PropertyMap{
+	}), crosstests.ConfigurePulumiConfig(resource.PropertyMap{
 		"f0": resource.MakeSecret(resource.NewProperty("v0")),
-	}))
+	})))
 }

pkg/tfbridge/tests/provider_test.go

@@ -51,9 +51,9 @@ func TestIntToStringOverride(t *testing.T) {
 		cty.ObjectVal(map[string]cty.Value{
 			"f0": cty.NumberIntVal(largeInt),
 		}),
-		resource.PropertyMap{
+		crosstests.CreatePulumiConfig(resource.PropertyMap{
 			"f0": resource.NewProperty(strconv.FormatInt(largeInt, 10)),
-		},
+		}),
 		crosstests.CreateResourceInfo(info.Resource{Fields: map[string]*info.Schema{
 			"f0": {Type: "string"},
 		}}),
@@ -124,7 +124,6 @@ func TestInputsConfigModeEqual(t *testing.T) {
 					},
 				},
 				tc.config,
-				crosstests.InferPulumiValue(),
 			)
 		})
 	}
@@ -151,7 +150,6 @@ func TestStateFunc(t *testing.T) {
 		cty.ObjectVal(map[string]cty.Value{
 			"test": cty.StringVal("hello"),
 		}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -172,7 +170,6 @@ func TestInputsUnspecifiedMaxItemsOne(t *testing.T) {
 			},
 		},
 		cty.ObjectVal(map[string]cty.Value{}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -192,7 +189,6 @@ func TestOptionalSetNotSpecified(t *testing.T) {
 			},
 		},
 		cty.ObjectVal(map[string]cty.Value{}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -217,7 +213,6 @@ func TestInputsEqualEmptyList(t *testing.T) {
 				cty.ObjectVal(map[string]cty.Value{
 					"f0": cty.ListValEmpty(cty.String),
 				}),
-				crosstests.InferPulumiValue(),
 			)
 		})
 	}
@@ -245,7 +240,6 @@ func TestCreateDoesNotInvokeStateUpgraders(t *testing.T) {
 		cty.ObjectVal(map[string]cty.Value{
 			"f0": cty.StringVal("default"),
 		}),
-		crosstests.InferPulumiValue(),
 		crosstests.CreateStateUpgrader(1, []schema.StateUpgrader{
 			{
 				Type:    resource().CoreConfigSchema().ImpliedType(),
@@ -270,7 +264,6 @@ func TestTimeouts(t *testing.T) {
 			},
 		},
 		cty.EmptyObjectVal,
-		crosstests.InferPulumiValue(),
 		crosstests.CreateTimeout(&schema.ResourceTimeout{
 			Create: schema.DefaultTimeout(time.Duration(120)),
 		}),
@@ -297,7 +290,6 @@ func TestMap(t *testing.T) {
 				"key2": cty.StringVal("val2"),
 			}),
 		}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -315,7 +307,6 @@ func TestEmptySetOfEmptyObjects(t *testing.T) {
 		cty.ObjectVal(map[string]cty.Value{
 			"d3f0": cty.SetValEmpty(cty.EmptyObject),
 		}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -332,7 +323,6 @@ func TestInputsEmptyString(t *testing.T) {
 		cty.ObjectVal(map[string]cty.Value{
 			"f0": cty.StringVal(""),
 		}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -384,7 +374,6 @@ func TestInputsNestedBlocksEmpty(t *testing.T) {
 				},
 			},
 			tc.config,
-			crosstests.InferPulumiValue(),
 		))
 	}
 }
@@ -410,7 +399,6 @@ func TestExplicitNilList(t *testing.T) {
 			},
 		},
 		cty.ObjectVal(map[string]cty.Value{"f0": cty.NullVal(cty.List(cty.Map(cty.Number)))}),
-		crosstests.InferPulumiValue(),
 	)
 }
 
@@ -466,7 +454,6 @@ func TestInputsEmptyCollections(t *testing.T) {
 				},
 			},
 			cty.EmptyObjectVal,
-			crosstests.InferPulumiValue(),
 		))
 	}
 }