Add validator for https urls to framework code

Author: acwest

internal/framework/validation/validation.go

@@ -0,0 +1,66 @@
+package validation
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+
+	"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
+)
+
+// isURLWithHTTPSorEmptyStringValidator validates that a string Attribute is an https URL or is an empty string.
+type isURLWithHTTPSorEmptyStringValidator struct {
+}
+
+// Description describes the validation in plain text formatting.
+func (v isURLWithHTTPSorEmptyStringValidator) Description(_ context.Context) string {
+	return fmt.Sprintf("string must be a valid https URL or empty")
+}
+
+// MarkdownDescription describes the validation in Markdown formatting.
+func (v isURLWithHTTPSorEmptyStringValidator) MarkdownDescription(ctx context.Context) string {
+	return v.Description(ctx)
+}
+
+// Validate performs the validation.
+func (v isURLWithHTTPSorEmptyStringValidator) ValidateString(ctx context.Context, request validator.StringRequest, response *validator.StringResponse) {
+	if request.ConfigValue.IsNull() || request.ConfigValue.IsUnknown() {
+		return
+	}
+
+	urlString := request.ConfigValue.ValueString()
+
+	if urlString == "" {
+		return
+	}
+
+	parsedURL, err := url.Parse(urlString)
+	if err != nil {
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
+			request.Path,
+			fmt.Sprintf("invalid URL: %+v", err),
+			urlString,
+		))
+	} else if parsedURL.Host == "" {
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
+			request.Path,
+			fmt.Sprintf("invalid URL, missing host"),
+			urlString,
+		))
+	} else if parsedURL.Scheme != "https" {
+		response.Diagnostics.Append(validatordiag.InvalidAttributeValueDiagnostic(
+			request.Path,
+			fmt.Sprintf("invalid URL, expected protocol scheme %q", "https"),
+			urlString,
+		))
+	}
+}
+
+// IsURLWithHTTPSorEmptyString returns a validator which ensures
+// that the given rawURL is a https url or is an empty string.
+// Null (unconfigured) and unknown (known after apply)
+// values are skipped.
+func IsURLWithHTTPSorEmptyString() validator.String {
+	return isURLWithHTTPSorEmptyStringValidator{}
+}

internal/framework/validation/validation_test.go

@@ -0,0 +1,87 @@
+package validation
+
+import (
+	"context"
+	"fmt"
+	"regexp"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestFrameworkIsURLWithHTTPSorEmptyString(t *testing.T) {
+	var testCases = []struct {
+		inputURL       interface{}
+		expectedErrors []string
+	}{
+		{
+			inputURL: "http://example.com",
+			expectedErrors: []string{
+				"Attribute theTestURLPath invalid URL, expected protocol scheme \"https\", got: http://example.com",
+			},
+		},
+		{
+			inputURL: "http://example.com/foo",
+			expectedErrors: []string{
+				"Attribute theTestURLPath invalid URL, expected protocol scheme \"https\", got: http://example.com/foo",
+			},
+		},
+		{
+			inputURL: "http://example.com#foo",
+			expectedErrors: []string{
+				"Attribute theTestURLPath invalid URL, expected protocol scheme \"https\", got: http://example.com#foo",
+			},
+		},
+		{
+			inputURL:       "https://example.com/foo",
+			expectedErrors: nil,
+		},
+		{
+			inputURL:       "https://example.com#foo",
+			expectedErrors: nil,
+		},
+		{
+			inputURL:       "",
+			expectedErrors: nil,
+		},
+		{
+			inputURL: "broken/url",
+			expectedErrors: []string{
+				"Attribute theTestURLPath invalid URL, missing host, got: broken/url",
+			},
+		},
+		{
+			inputURL: nil,
+			expectedErrors: nil,
+		},
+		{
+			inputURL: "://example.com",
+			expectedErrors: []string{
+				"Attribute theTestURLPath invalid URL: parse \"://example.com\": missing protocol scheme, got: ://example.com",
+			},
+		},
+	}
+	urlValidator := IsURLWithHTTPSorEmptyString()
+
+	for i, testCase := range testCases {
+		t.Run(fmt.Sprintf("test case #%d", i), func(t *testing.T) {
+			response := validator.StringResponse{}
+			request := validator.StringRequest{
+				Path: path.Root("theTestURLPath"),
+			}
+			if testCase.inputURL == nil {
+				request.ConfigValue = types.StringNull()
+			} else {
+				request.ConfigValue = types.StringValue(testCase.inputURL.(string))
+			}
+			urlValidator.ValidateString(context.Background(), request, &response)
+			assert.Equal(t, len(testCase.expectedErrors), len(response.Diagnostics))
+			for i, diagnostic := range response.Diagnostics {
+				assert.Regexp(t, regexp.MustCompile(testCase.expectedErrors[i]), diagnostic.Detail())
+			}
+		})
+	}
+}