Fix typechecking booleans (#2310)

The type-checking pass had a bug where it failed to flag passing a string to a slot of type boolean. This is now fixed so that appropriate warnings are generated. Fixes pulumi/pulumi-aws#4342 P1
pulumi · Aug 13, 2024 · e468215 · e468215
1 parent 5548bd6
commit e468215
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 4 deletions.
diff --git a/pkg/tfbridge/tests/provider_test.go b/pkg/tfbridge/tests/provider_test.go
@@ -16,6 +16,7 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge"
+	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge/info"
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfgen"
 	shimv2 "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2"
 )
@@ -777,6 +778,80 @@ func TestValidateConfig(t *testing.T) {
 	})
 }
 
+// Assert that passing strings into fields of boolean type triggers a type-checking error message, even if some of the
+// resource inputs are unknown. See also: https://github.com/pulumi/pulumi-aws/issues/4342
+func TestTypeCheckingMistypedBooleansWithUnknowns(t *testing.T) {
+	t.Setenv("PULUMI_ERROR_TYPE_CHECKER", "true")
+	ctx := context.Background()
+	resourceID := "aws_ecs_service"
+	resourceSchema := map[string]*schema.Schema{
+		"network_configuration": {
+			Type:     schema.TypeList,
+			Optional: true,
+			MaxItems: 1,
+			Elem: &schema.Resource{
+				Schema: map[string]*schema.Schema{
+					"assign_public_ip": {
+						Type:     schema.TypeBool,
+						Optional: true,
+						Default:  false,
+					},
+					"subnets": {
+						Type:     schema.TypeSet,
+						Required: true,
+						Elem:     &schema.Schema{Type: schema.TypeString},
+					},
+				},
+			},
+		},
+	}
+
+	res := &schema.Resource{
+		Schema: resourceSchema,
+	}
+
+	resMap := map[string]*schema.Resource{resourceID: res}
+
+	schemaProvider := &schema.Provider{ResourcesMap: resMap}
+
+	p := newTestProvider(ctx, tfbridge.ProviderInfo{
+		P:              shimv2.NewProvider(schemaProvider),
+		Name:           "aws",
+		ResourcePrefix: "aws",
+		Resources: map[string]*info.Resource{
+			resourceID: {
+				Tok: "aws:ecs/service:Service",
+			},
+		},
+	}, newTestProviderOptions{})
+
+	reason := "expected boolean type, got string type. " +
+		"Examine values at 'my-ecs-service.networkConfiguration.assignPublicIp'."
+
+	// networkConfiguration.assignPublicIp has the wrong type intentionally.
+	replay.ReplaySequence(t, p, fmt.Sprintf(`
+	[
+	  {
+	    "method": "/pulumirpc.ResourceProvider/Check",
+	    "request": {
+	      "urn": "urn:pulumi:dev::aws-4342::aws:ecs/service:Service::my-ecs-service",
+	      "olds": {},
+	      "news": {
+		"networkConfiguration": {
+		  "assignPublicIp": "DISABLED",
+		  "subnets": "04da6b54-80e4-46f7-96ec-b56ff0331ba9"
+		}
+	      },
+	      "randomSeed": "7WaseITzLnMm7TGBDCYIbSUvAatQKt0rkmDuHUXxR9U="
+	    },
+	    "response": {
+              "inputs": "*",
+              "failures": [{"reason": "%s"}]
+	    }
+	  }
+	]`, reason))
+}
+
 func nilSink() diag.Sink {
 	nilSink := diag.DefaultSink(io.Discard, io.Discard, diag.FormatOptions{
 		Color: colors.Never,

diff --git a/pkg/tfbridge/validate_input_types.go b/pkg/tfbridge/validate_input_types.go
@@ -157,9 +157,8 @@ func (v *PulumiInputValidator) validatePropertyValue(
 	}
 
 	switch typeSpec.Type {
-	case "bool":
-		// The bridge permits coalescing strings to booleans, hence skip strings.
-		if !propertyValue.IsBool() && !propertyValue.IsString() {
+	case "boolean":
+		if !propertyValue.IsBool() {
 			return []TypeFailure{{
 				ResourcePath: propertyPath.String(),
 				Reason: fmt.Sprintf(

diff --git a/pkg/tfbridge/validate_input_types_test.go b/pkg/tfbridge/validate_input_types_test.go
@@ -1477,7 +1477,7 @@ func TestValidateInputType_toplevel(t *testing.T) {
 					TypeSpec: pschema.TypeSpec{
 						Type: "object",
 						AdditionalProperties: &pschema.TypeSpec{
-							Type: "bool",
+							Type: "boolean",
 						},
 					},
 				},