@@ -30,6 +30,7 @@ import (
3030 pb "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/pf/tests/internal/providerbuilder"
3131 "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/pf/tfbridge"
3232 "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/pf/tfgen"
33+ "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tests/assume"
3334 crosstests "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tests/cross-tests"
3435 "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tests/tfcheck"
3536 "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge/info"
@@ -50,10 +51,13 @@ import (
5051// }
5152//
5253// For details on the test itself, see [Configure].
53- func MakeConfigure (schema schema.Schema , tfConfig map [string ]cty.Value , puConfig resource.PropertyMap ) func (t * testing.T ) {
54+ func MakeConfigure (
55+ schema schema.Schema , tfConfig map [string ]cty.Value , puConfig resource.PropertyMap ,
56+ options ... ConfigureOption ,
57+ ) func (t * testing.T ) {
5458 return func (t * testing.T ) {
5559 t .Parallel ()
56- Configure (t , schema , tfConfig , puConfig )
60+ Configure (t , schema , tfConfig , puConfig , options ... )
5761 }
5862}
5963
@@ -81,12 +85,17 @@ func MakeConfigure(schema schema.Schema, tfConfig map[string]cty.Value, puConfig
8185// +--------------------+ +---------------------+
8286//
8387// Configure should be safe to run in parallel.
84- func Configure (t * testing.T , schema schema.Schema , tfConfig map [string ]cty.Value , puConfig resource.PropertyMap ) {
85- skipUnlessLinux (t )
88+ func Configure (
89+ t TestingT , schema schema.Schema , tfConfig map [string ]cty.Value , puConfig resource.PropertyMap ,
90+ options ... ConfigureOption ,
91+ ) {
92+ assume .TerraformCLI (t )
93+
94+ var opts configureOptions
95+ for _ , o := range options {
96+ o (& opts )
97+ }
8698
87- // By default, logs only show when they are on a failed test. By logging to
88- // topLevelT, we can log items to be shown if downstream tests fail.
89- topLevelT := t
9099 const providerName = "test"
91100
92101 prov := func (config * tfsdk.Config ) * pb.Provider {
@@ -103,8 +112,11 @@ func Configure(t *testing.T, schema schema.Schema, tfConfig map[string]cty.Value
103112 }
104113
105114 var tfOutput , puOutput tfsdk.Config
106- t .Run ("tf" , func (t * testing.T ) {
107- defer propageteSkip (topLevelT , t )
115+ var runOnFail []func (t TestingT )
116+
117+ logf := func (msg string , a ... any ) { runOnFail = append (runOnFail , func (t TestingT ) { t .Logf (msg , a ... ) }) }
118+
119+ withAugmentedT (t , func (t * augmentedT ) { // --- Run Terraform Provider ---
108120 var hcl bytes.Buffer
109121 err := crosstests .WritePF (& hcl ).Provider (schema , providerName , tfConfig )
110122 require .NoError (t , err )
@@ -120,13 +132,12 @@ resource "` + providerName + `_res" "res" {}
120132
121133 driver .Write (t , hcl .String ())
122134 plan , err := driver .Plan (t )
123- require .NoError (t , err )
135+ require .NoError (t , err , "failed to generate TF plan" )
124136 err = driver .Apply (t , plan )
125137 require .NoError (t , err )
126138 })
127139
128- t .Run ("bridged" , func (t * testing.T ) {
129- defer propageteSkip (topLevelT , t )
140+ withAugmentedT (t , func (t * augmentedT ) { // --- Run Pulumi Provider ---
130141 dir := t .TempDir ()
131142
132143 pulumiYaml := map [string ]any {
@@ -145,7 +156,7 @@ resource "` + providerName + `_res" "res" {}
145156
146157 bytes , err := yaml .Marshal (pulumiYaml )
147158 require .NoError (t , err )
148- topLevelT . Logf ("Pulumi.yaml:\n %s" , string (bytes ))
159+ logf ("Pulumi.yaml:\n %s" , string (bytes ))
149160 err = os .WriteFile (filepath .Join (dir , "Pulumi.yaml" ), bytes , 0600 )
150161 require .NoError (t , err )
151162
@@ -187,11 +198,49 @@ resource "` + providerName + `_res" "res" {}
187198 contract .Ignore (test .Up (t )) // Assert that the update succeeded, but not the result.
188199 })
189200
190- skipCompare := t .Failed () || t .Skipped ()
191- t .Run ("compare" , func (t * testing.T ) {
192- if skipCompare {
193- t .Skipf ("skipping since earlier steps did not complete" )
194- }
201+ // --- Compare results -----------------------------
202+ if opts .testEqual != nil {
203+ opts .testEqual (t , tfOutput , puOutput )
204+ } else {
195205 assert .Equal (t , tfOutput , puOutput )
196- })
206+ }
207+
208+ if t .Failed () {
209+ for _ , f := range runOnFail {
210+ f (t )
211+ }
212+ }
213+ }
214+
215+ // An option for configuring [Configure] or [MakeConfigure].
216+ //
217+ // Existing options are:
218+ // - [WithConfigureEquals]
219+ type ConfigureOption func (* configureOptions )
220+
221+ type configureOptions struct {
222+ testEqual func (t TestingT , tfOutput , puOutput tfsdk.Config )
223+ }
224+
225+ // WithConfigureEqual defines a comparison function for the cross-test.
226+ //
227+ // This function is called after both the Terraform and Pulumi portions have run, and is
228+ // responsible for asserting that the results match.
229+ //
230+ // Here are 2 examples:
231+ //
232+ // // Assert that both Terraform and Pulumi ran, but do not assert anything about their behavior.
233+ // WithConfigureEqual(func(t TestingT, tfOutput, puOutput tfsdk.Config) {})
234+ //
235+ // // Assert that the underlying provider witnessed saw could not distinguish between
236+ // // the direct and bridged call (the default behavior).
237+ // WithConfigureEqual(func(t TestingT, tfOutput, puOutput tfsdk.Config) {
238+ // assert.Equal(t, tfOutput, puOutput)
239+ // })
240+ //
241+ // WithConfigureEqual should be used only when the direct and bridged providers don't
242+ // agree, to limit the scope of the test so it can be checked in. In general, usage should
243+ // be accompanied by a bridge issue to track the discrepancy.
244+ func WithConfigureEqual (equal func (t TestingT , tfOutput , puOutput tfsdk.Config )) ConfigureOption {
245+ return func (opts * configureOptions ) { opts .testEqual = equal }
197246}
0 commit comments