crosstests

README

Cross-tests for PF

This package provides cross-testing for Plugin Framework based Terraform providers, bridged into Pulumi with pf.

It does not contain cross-tests. It just provides a library for writing cross-tests.

An example usage looks like this:

func TestConfigure(t *testing.T) {
	t.Parallel()

    schema := schema.Schema{Attributes: map[string]schema.Attribute{
		"k": schema.StringAttribute{Optional: true},
	}}

    tfInput := map[string]cty.Value{"k": cty.StringVal("foo")}

    puInput := resource.PropertyMap{"k": resource.MakeSecret(resource.NewProperty("foo"))}

	crosstests.Configure(schema, tfInput, puInput)
}

Here, the cross-test will assert that a provider whose configuration is described by schema will observe the same inputs when configured in via HCL with the inputs tfInputs and when bridged and configured with Pulumi and puInputs.

The idea is that the "Configured Provider" should not be able to tell if it was configured via HCL or Pulumi YAML:

    +--------------------+                      +---------------------+
    | Terraform Provider |--------------------->| Configure(tfInputs) |
    +--------------------+                      +---------------------+
              |                                                        \
              |                                                         \
              |                                                          \
              |                                                      +---------------------+
              | tfbridge.ShimProvider                                | Configured Provider |
              |                                                      +---------------------+
              |                                                          /
              |                                                         /
              V                                                        /
    +--------------------+                      +---------------------+
    |   Pulumi Provider  |--------------------->| Configure(puInputs) |
    +--------------------+                      +---------------------+

Documentation

Index

• func Configure(t *testing.T, schema schema.Schema, tfConfig map[string]cty.Value, ...)
• func MakeConfigure(schema schema.Schema, tfConfig map[string]cty.Value, ...) func(t *testing.T)

Functions

func Configure

func Configure(t *testing.T, schema schema.Schema, tfConfig map[string]cty.Value, puConfig resource.PropertyMap)

Configure will assert that a provider who's configuration is described by schema will observe the same inputs when configured in via HCL with the inputs tfInputs and when bridged and configured with Pulumi and puInputs.

The idea is that the "Configured Provider" should not be able to tell if it was configured via HCL or Pulumi YAML:

+--------------------+                      +---------------------+
| Terraform Provider |--------------------->| Configure(tfInputs) |
+--------------------+                      +---------------------+
          |                                                        \
          |                                                         \
          |                                                          \
          |                                                      +---------------------+
          | tfbridge.ShimProvider                                | Configured Provider |
          |                                                      +---------------------+
          |                                                          /
          |                                                         /
          V                                                        /
+--------------------+                      +---------------------+
|   Pulumi Provider  |--------------------->| Configure(puInputs) |
+--------------------+                      +---------------------+

Configure should be safe to run in parallel.

func MakeConfigure

func MakeConfigure(schema schema.Schema, tfConfig map[string]cty.Value, puConfig resource.PropertyMap) func(t *testing.T)

MakeConfigure returns a testing subtest of Configure.

func TestMyProperty(t *testing.T) {
	t.Run("my-subtest", crosstests.MakeConfigure(schema, tfConfig, puConfig))
}

For details on the test itself, see Configure.