input validation

Author: jsirianni

internal/component/route.go

@@ -0,0 +1,53 @@
+package component
+
+import (
+	"fmt"
+	"strings"
+)
+
+const (
+	// Logs route type
+	RouteTypeLogs = "logs"
+
+	// Metrics route type
+	RouteTypeMetrics = "metrics"
+
+	// Traces route type
+	RouteTypeTraces = "traces"
+
+	// Logs + Metrics route type
+	RouteTypeLogsMetrics = "logs+metrics"
+
+	// Logs + Traces route type
+	RouteTypeLogsTraces = "logs+traces"
+
+	// Metrics + Traces route type
+	RouteTypeMetricsTraces = "metrics+traces"
+
+	// Logs + Metrics + Traces route type
+	RouteTypeLogsMetricsTraces = "logs+metrics+traces"
+)
+
+// ValidateRouteType returns an error if the route type is invalid
+func ValidateRouteType(routeType string) error {
+	switch routeType {
+	case RouteTypeLogs, RouteTypeMetrics, RouteTypeTraces, RouteTypeLogsMetrics, RouteTypeLogsTraces, RouteTypeMetricsTraces, RouteTypeLogsMetricsTraces:
+		return nil
+	}
+	return fmt.Errorf("invalid route type: %s", routeType)
+}
+
+// ValidateRouteComponents returns an error if the route components are invalid
+func ValidateRouteComponents(components []string) []error {
+	var errs []error
+	for _, c := range components {
+		prefix := strings.Split(c, "/")[0]
+		switch prefix {
+		case "destinations", "processors", "connectors":
+			continue
+		default:
+			errs = append(errs, fmt.Errorf("invalid route component: %s", c))
+		}
+	}
+	return errs
+}

internal/component/route_test.go

@@ -0,0 +1,52 @@
+package component
+
+import (
+	"errors"
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestValidateRouteType(t *testing.T) {
+	cases := []struct {
+		routeType string
+		expected  error
+	}{
+		{"logs", nil},
+		{"metrics", nil},
+		{"traces", nil},
+		{"logs+metrics", nil},
+		{"logs+traces", nil},
+		{"metrics+traces", nil},
+		{"logs+metrics+traces", nil},
+		{"invalid", errors.New("invalid route type: invalid")},
+	}
+
+	for _, c := range cases {
+		err := ValidateRouteType(c.routeType)
+		if c.expected != nil {
+			require.Error(t, err)
+		} else {
+			require.NoError(t, err)
+		}
+	}
+}
+
+func TestValidateRouteComponents(t *testing.T) {
+	cases := []struct {
+		components []string
+		expected   []error
+	}{
+		{[]string{"destinations", "processors", "connectors"}, nil},
+		{[]string{"destinations", "processors", "invalid"}, []error{fmt.Errorf("invalid route component: invalid")}},
+	}
+
+	for _, c := range cases {
+		errs := ValidateRouteComponents(c.components)
+		if len(c.expected) == 0 {
+			require.Equal(t, c.expected, errs)
+		}
+		require.Len(t, errs, len(c.expected))
+	}
+}

provider/resource_configuration_v2.go

@@ -23,6 +23,7 @@ import (
 
 	"github.com/observiq/bindplane-op-enterprise/model"
 	"github.com/observiq/terraform-provider-bindplane/client"
+	"github.com/observiq/terraform-provider-bindplane/internal/component"
 	"github.com/observiq/terraform-provider-bindplane/internal/configuration"
 	"github.com/observiq/terraform-provider-bindplane/internal/maputil"
 	"github.com/observiq/terraform-provider-bindplane/internal/resource"
@@ -101,19 +102,15 @@ func resourceConfigurationV2() *schema.Resource {
 							ForceNew: false,
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
-									// TODO(jsirianni): Could be plural with
-									// list or array. Provider would handle combining
-									// them into string.
 									"telemetry_type": {
 										Type:        schema.TypeString,
 										Required:    true,
 										ForceNew:    false,
-										Description: "The telemetry type to route, such as 'logs', 'metrics', or 'traces'.",
+										Description: "The telemetry type to route. Valid route types include 'logs', 'metrics', or 'traces' 'logs+metrics', 'logs+traces', 'metrics+traces', 'logs+metrics+traces'.",
 										ValidateFunc: func(val any, _ string) (warns []string, errs []error) {
-											// Ensure one of logs, metrics, traces
 											telemetryType := val.(string)
-											if telemetryType != "logs" && telemetryType != "metrics" && telemetryType != "traces" {
-												errs = append(errs, errors.New("telemetry_type must be one of 'logs', 'metrics', or 'traces'"))
+											if err := component.ValidateRouteType(telemetryType); err != nil {
+												errs = append(errs, err)
 											}
 											return
 										},
@@ -124,6 +121,18 @@ func resourceConfigurationV2() *schema.Resource {
 										ForceNew:    false,
 										Elem:        &schema.Schema{Type: schema.TypeString},
 										Description: "List of component names to route.",
+										ValidateFunc: func(val any, _ string) (warns []string, errs []error) {
+											rawComponents := val.([]any)
+											components := []string{}
+											for _, c := range rawComponents {
+												components = append(components, c.(string))
+											}
+											validationErrors := component.ValidateRouteComponents(components)
+											if len(validationErrors) > 0 {
+												errs = append(errs, validationErrors...)
+											}
+											return
+										},
 									},
 								},
 							},
@@ -321,6 +330,22 @@ func resourceConfigurationV2Create(d *schema.ResourceData, meta any) error {
 						routes.Traces = append(routes.Traces, model.Route{
 							Components: components,
 						})
+					case "logs+metrics":
+						routes.LogsMetrics = append(routes.LogsMetrics, model.Route{
+							Components: components,
+						})
+					case "logs+traces":
+						routes.LogsTraces = append(routes.LogsTraces, model.Route{
+							Components: components,
+						})
+					case "metrics+traces":
+						routes.MetricsTraces = append(routes.MetricsTraces, model.Route{
+							Components: components,
+						})
+					case "logs+metrics+traces":
+						routes.LogsMetricsTraces = append(routes.LogsMetricsTraces, model.Route{
+							Components: components,
+						})
 					}
 				}
 			}