Implementing Unknown() and Null() for the types.Bool type

Author: Ivan De Marino

internal/testing/types/bool.go

@@ -4,9 +4,10 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/hashicorp/terraform-plugin-go/tftypes"
+
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 var (
@@ -40,13 +41,13 @@ func (t BoolType) TerraformType(_ context.Context) tftypes.Type {
 func (t BoolType) ValueFromTerraform(ctx context.Context, in tftypes.Value) (attr.Value, error) {
 	if in.IsNull() {
 		return Bool{
-			Bool:      types.Bool{Null: true},
+			Bool:      types.NullBool(),
 			CreatedBy: t,
 		}, nil
 	}
 	if !in.IsKnown() {
 		return Bool{
-			Bool:      types.Bool{Unknown: true},
+			Bool:      types.UnknownBool(),
 			CreatedBy: t,
 		}, nil
 	}

types/bool.go

@@ -3,19 +3,20 @@ package types
 import (
 	"context"
 
-	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
+
+	"github.com/hashicorp/terraform-plugin-framework/attr"
 )
 
 func boolValueFromTerraform(ctx context.Context, in tftypes.Value) (attr.Value, error) {
 	if in.IsNull() {
 		return Bool{
-			Null: true,
+			null: true,
 		}, nil
 	}
 	if !in.IsKnown() {
 		return Bool{
-			Unknown: true,
+			unknown: true,
 		}, nil
 	}
 	var b bool
@@ -30,29 +31,44 @@ var _ attr.Value = Bool{}
 
 // Bool represents a boolean value.
 type Bool struct {
-	// Unknown will be true if the value is not yet known.
-	Unknown bool
+	// unknown will be true if the value is not yet known.
+	unknown bool
 
-	// Null will be true if the value was not set, or was explicitly set to
+	// null will be true if the value was not set, or was explicitly set to
 	// null.
-	Null bool
+	null bool
 
-	// Value contains the set value, as long as Unknown and Null are both
+	// Value contains the set value, as long as unknown and null are both
 	// false.
 	Value bool
 }
 
+// NewBool returns a Bool initialized with the given value.
+func NewBool(value bool) Bool {
+	return Bool{Value: value}
+}
+
+// UnknownBool returns a Bool where Bool.Unknown returns true.
+func UnknownBool() Bool {
+	return Bool{unknown: true}
+}
+
+// NullBool returns a Bool where Bool.Null returns true.
+func NullBool() Bool {
+	return Bool{null: true}
+}
+
 // Type returns a BoolType.
 func (b Bool) Type(_ context.Context) attr.Type {
 	return BoolType
 }
 
 // ToTerraformValue returns the data contained in the *Bool as a tftypes.Value.
 func (b Bool) ToTerraformValue(_ context.Context) (tftypes.Value, error) {
-	if b.Null {
+	if b.null {
 		return tftypes.NewValue(tftypes.Bool, nil), nil
 	}
-	if b.Unknown {
+	if b.unknown {
 		return tftypes.NewValue(tftypes.Bool, tftypes.UnknownValue), nil
 	}
 	if err := tftypes.ValidateValue(tftypes.Bool, b.Value); err != nil {
@@ -67,11 +83,19 @@ func (b Bool) Equal(other attr.Value) bool {
 	if !ok {
 		return false
 	}
-	if b.Unknown != o.Unknown {
+	if b.unknown != o.unknown {
 		return false
 	}
-	if b.Null != o.Null {
+	if b.null != o.null {
 		return false
 	}
 	return b.Value == o.Value
 }
+
+func (b Bool) Unknown() bool {
+	return b.unknown
+}
+
+func (b Bool) Null() bool {
+	return b.null
+}

types/bool_test.go

@@ -33,11 +33,11 @@ func testBoolValueFromTerraform(t *testing.T, direct bool) {
 		},
 		"unknown": {
 			input:       tftypes.NewValue(tftypes.Bool, tftypes.UnknownValue),
-			expectation: Bool{Unknown: true},
+			expectation: Bool{unknown: true},
 		},
 		"null": {
 			input:       tftypes.NewValue(tftypes.Bool, nil),
-			expectation: Bool{Null: true},
+			expectation: Bool{null: true},
 		},
 		"wrongType": {
 			input:       tftypes.NewValue(tftypes.String, "oops"),
@@ -96,11 +96,11 @@ func TestBoolToTerraformValue(t *testing.T) {
 			expectation: tftypes.NewValue(tftypes.Bool, false),
 		},
 		"unknown": {
-			input:       Bool{Unknown: true},
+			input:       Bool{unknown: true},
 			expectation: tftypes.NewValue(tftypes.Bool, tftypes.UnknownValue),
 		},
 		"null": {
-			input:       Bool{Null: true},
+			input:       Bool{null: true},
 			expectation: tftypes.NewValue(tftypes.Bool, nil),
 		},
 	}
@@ -143,12 +143,12 @@ func TestBoolEqual(t *testing.T) {
 		},
 		"true-unknown": {
 			input:       Bool{Value: true},
-			candidate:   Bool{Unknown: true},
+			candidate:   Bool{unknown: true},
 			expectation: false,
 		},
 		"true-null": {
 			input:       Bool{Value: true},
-			candidate:   Bool{Null: true},
+			candidate:   Bool{null: true},
 			expectation: false,
 		},
 		"true-wrongType": {
@@ -173,12 +173,12 @@ func TestBoolEqual(t *testing.T) {
 		},
 		"false-unknown": {
 			input:       Bool{Value: false},
-			candidate:   Bool{Unknown: true},
+			candidate:   Bool{unknown: true},
 			expectation: false,
 		},
 		"false-null": {
 			input:       Bool{Value: false},
-			candidate:   Bool{Null: true},
+			candidate:   Bool{null: true},
 			expectation: false,
 		},
 		"false-wrongType": {
@@ -192,62 +192,62 @@ func TestBoolEqual(t *testing.T) {
 			expectation: false,
 		},
 		"unknown-true": {
-			input:       Bool{Unknown: true},
+			input:       Bool{unknown: true},
 			candidate:   Bool{Value: true},
 			expectation: false,
 		},
 		"unknown-false": {
-			input:       Bool{Unknown: true},
+			input:       Bool{unknown: true},
 			candidate:   Bool{Value: false},
 			expectation: false,
 		},
 		"unknown-unknown": {
-			input:       Bool{Unknown: true},
-			candidate:   Bool{Unknown: true},
+			input:       Bool{unknown: true},
+			candidate:   Bool{unknown: true},
 			expectation: true,
 		},
 		"unknown-null": {
-			input:       Bool{Unknown: true},
-			candidate:   Bool{Null: true},
+			input:       Bool{unknown: true},
+			candidate:   Bool{null: true},
 			expectation: false,
 		},
 		"unknown-wrongType": {
-			input:       Bool{Unknown: true},
+			input:       Bool{unknown: true},
 			candidate:   &String{Value: "oops"},
 			expectation: false,
 		},
 		"unknown-nil": {
-			input:       Bool{Unknown: true},
+			input:       Bool{unknown: true},
 			candidate:   nil,
 			expectation: false,
 		},
 		"null-true": {
-			input:       Bool{Null: true},
+			input:       Bool{null: true},
 			candidate:   Bool{Value: true},
 			expectation: false,
 		},
 		"null-false": {
-			input:       Bool{Null: true},
+			input:       Bool{null: true},
 			candidate:   Bool{Value: false},
 			expectation: false,
 		},
 		"null-unknown": {
-			input:       Bool{Null: true},
-			candidate:   Bool{Unknown: true},
+			input:       Bool{null: true},
+			candidate:   Bool{unknown: true},
 			expectation: false,
 		},
 		"null-null": {
-			input:       Bool{Null: true},
-			candidate:   Bool{Null: true},
+			input:       Bool{null: true},
+			candidate:   Bool{null: true},
 			expectation: true,
 		},
 		"null-wrongType": {
-			input:       Bool{Null: true},
+			input:       Bool{null: true},
 			candidate:   &String{Value: "oops"},
 			expectation: false,
 		},
 		"null-nil": {
-			input:       Bool{Null: true},
+			input:       Bool{null: true},
 			candidate:   nil,
 			expectation: false,
 		},