Add validation of viz objects

signalfx/resource_data_access.go

@@ -0,0 +1,14 @@
+// Copyright Splunk, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package signalfx
+
+// ResourceDataAccess is an interface designed to abstract access to resource data.
+// It is implemented by both *schema.ResourceDiff and *schema.ResourceData types,
+// allowing functions to operate on them interchangeably.
+//
+// This interface provides methods to retrieve resource properties based on a key.
+type ResourceDataAccess interface {
+	Get(key string) interface{}
+	GetOk(key string) (interface{}, bool)
+}

signalfx/resource_signalfx_dashboard.go

@@ -455,11 +455,12 @@ func dashboardResource() *schema.Resource {
 			},
 		},
 
-		Create: dashboardCreate,
-		Read:   dashboardRead,
-		Update: dashboardUpdate,
-		Delete: dashboardDelete,
-		Exists: dashboardExists,
+		CustomizeDiff: dashboardValidate,
+		Create:        dashboardCreate,
+		Read:          dashboardRead,
+		Update:        dashboardUpdate,
+		Delete:        dashboardDelete,
+		Exists:        dashboardExists,
 		Importer: &schema.ResourceImporter{
 			State: schema.ImportStatePassthrough,
 		},
@@ -469,7 +470,7 @@ func dashboardResource() *schema.Resource {
 /*
 Use Resource object to construct json payload in order to create a dashboard
 */
-func getPayloadDashboard(d *schema.ResourceData) (*dashboard.CreateUpdateDashboardRequest, error) {
+func getPayloadDashboard(d ResourceDataAccess) (*dashboard.CreateUpdateDashboardRequest, error) {
 
 	cudr := &dashboard.CreateUpdateDashboardRequest{
 		Name:              d.Get("name").(string),
@@ -567,7 +568,7 @@ func getPayloadDashboard(d *schema.ResourceData) (*dashboard.CreateUpdateDashboa
 	return cudr, nil
 }
 
-func getDashPermissions(d *schema.ResourceData) *dashboard.ObjectPermissions {
+func getDashPermissions(d ResourceDataAccess) *dashboard.ObjectPermissions {
 	permissions := &dashboard.ObjectPermissions{}
 	if val, ok := d.GetOk("permissions"); ok {
 		p := val.([]interface{})[0].(map[string]interface{})
@@ -598,7 +599,7 @@ func getDashPermissionsAcl(set *schema.Set) []*dashboard.AclEntry {
 	return nil
 }
 
-func getDashboardTime(d *schema.ResourceData) *dashboard.ChartsFiltersTime {
+func getDashboardTime(d ResourceDataAccess) *dashboard.ChartsFiltersTime {
 	var timeFilter *dashboard.ChartsFiltersTime
 	if val, ok := d.GetOk("time_range"); ok {
 		timeFilter = &dashboard.ChartsFiltersTime{
@@ -618,7 +619,7 @@ func getDashboardTime(d *schema.ResourceData) *dashboard.ChartsFiltersTime {
 	return timeFilter
 }
 
-func getDashboardCharts(d *schema.ResourceData) []*dashboard.DashboardChart {
+func getDashboardCharts(d ResourceDataAccess) []*dashboard.DashboardChart {
 	charts := d.Get("chart").(*schema.Set).List()
 	chartsList := make([]*dashboard.DashboardChart, len(charts))
 	for i, chart := range charts {
@@ -636,7 +637,7 @@ func getDashboardCharts(d *schema.ResourceData) []*dashboard.DashboardChart {
 	return chartsList
 }
 
-func getDashboardColumns(d *schema.ResourceData) []*dashboard.DashboardChart {
+func getDashboardColumns(d ResourceDataAccess) []*dashboard.DashboardChart {
 	columns := d.Get("column").([]interface{})
 	charts := make([]*dashboard.DashboardChart, 0)
 	for _, column := range columns {
@@ -660,7 +661,7 @@ func getDashboardColumns(d *schema.ResourceData) []*dashboard.DashboardChart {
 	return charts
 }
 
-func getDashboardGrids(d *schema.ResourceData) []*dashboard.DashboardChart {
+func getDashboardGrids(d ResourceDataAccess) []*dashboard.DashboardChart {
 	grids := d.Get("grid").([]interface{})
 	charts := make([]*dashboard.DashboardChart, 0)
 	// We must keep track of the row outside the loop as there might be many
@@ -692,7 +693,7 @@ func getDashboardGrids(d *schema.ResourceData) []*dashboard.DashboardChart {
 	return charts
 }
 
-func getDashboardVariables(d *schema.ResourceData) []*dashboard.ChartsWebUiFilter {
+func getDashboardVariables(d ResourceDataAccess) []*dashboard.ChartsWebUiFilter {
 	variables := d.Get("variable").(*schema.Set).List()
 	varsList := make([]*dashboard.ChartsWebUiFilter, len(variables))
 	for i, variable := range variables {
@@ -785,7 +786,7 @@ func getDashboardEventOverlayFilters(sources []interface{}) []*dashboard.EventOv
 	return sourcesList
 }
 
-func getDashboardFilters(d *schema.ResourceData) []*dashboard.ChartsSingleFilter {
+func getDashboardFilters(d ResourceDataAccess) []*dashboard.ChartsSingleFilter {
 	filters := d.Get("filter").(*schema.Set).List()
 	filterList := make([]*dashboard.ChartsSingleFilter, len(filters))
 	for i, filter := range filters {
@@ -812,6 +813,20 @@ func getDashboardFilters(d *schema.ResourceData) []*dashboard.ChartsSingleFilter
 	return filterList
 }
 
+func dashboardValidate(ctx context.Context, dashboardObject *schema.ResourceDiff, meta any) error {
+	payloadDashboard, err := getPayloadDashboard(dashboardObject)
+
+	if err != nil {
+		return err
+	}
+
+	if config, ok := meta.(*signalfxConfig); ok {
+		return config.Client.ValidateDashboard(ctx, payloadDashboard)
+	} else {
+		return fmt.Errorf("invalid type assertion: expected *signalfxConfig, got %T", meta)
+	}
+}
+
 func dashboardCreate(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*signalfxConfig)
 	payload, err := getPayloadDashboard(d)

signalfx/resource_signalfx_dashboard_group.go

@@ -199,11 +199,12 @@ func dashboardGroupResource() *schema.Resource {
 			},
 		},
 
-		Create: dashboardgroupCreate,
-		Read:   dashboardgroupRead,
-		Update: dashboardgroupUpdate,
-		Delete: dashboardgroupDelete,
-		Exists: dashboardgroupExists,
+		CustomizeDiff: dashboardgroupValidate,
+		Create:        dashboardgroupCreate,
+		Read:          dashboardgroupRead,
+		Update:        dashboardgroupUpdate,
+		Delete:        dashboardgroupDelete,
+		Exists:        dashboardgroupExists,
 		Importer: &schema.ResourceImporter{
 			State: schema.ImportStatePassthrough,
 		},
@@ -225,7 +226,7 @@ func dashboardgroupExists(d *schema.ResourceData, meta interface{}) (bool, error
 /*
 Use Resource object to construct json payload in order to create a dasboard group
 */
-func getPayloadDashboardGroup(d *schema.ResourceData) *dashboard_group.CreateUpdateDashboardGroupRequest {
+func getPayloadDashboardGroup(d ResourceDataAccess) *dashboard_group.CreateUpdateDashboardGroupRequest {
 	cudgr := &dashboard_group.CreateUpdateDashboardGroupRequest{
 		Name:              d.Get("name").(string),
 		Description:       d.Get("description").(string),
@@ -393,15 +394,15 @@ func getPayloadDashboardGroup(d *schema.ResourceData) *dashboard_group.CreateUpd
 	return cudgr
 }
 
-func getPermissions(d *schema.ResourceData) *dashboard_group.ObjectPermissions {
+func getPermissions(d ResourceDataAccess) *dashboard_group.ObjectPermissions {
 	permissions := &dashboard_group.ObjectPermissions{}
 	if val := getPermissionsAcl(d); len(val) > 0 {
 		permissions.Acl = val
 	}
 	return permissions
 }
 
-func getPermissionsAcl(d *schema.ResourceData) []*dashboard_group.AclEntry {
+func getPermissionsAcl(d ResourceDataAccess) []*dashboard_group.AclEntry {
 	acl := d.Get("permissions").(*schema.Set).List()
 	aclList := make([]*dashboard_group.AclEntry, len(acl))
 	for i, entry := range acl {
@@ -417,6 +418,14 @@ func getPermissionsAcl(d *schema.ResourceData) []*dashboard_group.AclEntry {
 	return aclList
 }
 
+func dashboardgroupValidate(ctx context.Context, d *schema.ResourceDiff, meta any) error {
+	if config, ok := meta.(*signalfxConfig); ok {
+		return config.Client.ValidateDashboardGroup(ctx, getPayloadDashboardGroup(d))
+	} else {
+		return fmt.Errorf("invalid type assertion: expected *signalfxConfig, got %T", meta)
+	}
+}
+
 func dashboardgroupCreate(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*signalfxConfig)
 	payload := getPayloadDashboardGroup(d)

signalfx/resource_signalfx_dashboard_group_test.go

@@ -4,6 +4,7 @@
 package signalfx
 
 import (
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -98,6 +99,28 @@ resource "signalfx_dashboard_group" "new_dashboard_group_2" {
 }
 `
 
+const invalidDashboardGroup = `
+resource "signalfx_dashboard_group" "invalid_dashboard_group" {
+    name = "Invalid dashboard"
+	dashboard {
+		dashboard_id = ""
+	}
+}
+`
+
+func TestAccValidateDashboardGroup(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		Providers:    testAccProviders,
+		CheckDestroy: testAccDashboardGroupDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config:      invalidDashboardGroup,
+				ExpectError: regexp.MustCompile("status code 400"),
+			},
+		},
+	})
+}
+
 func TestAccCreateDashboardGroup(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		Providers:    testAccProviders,

signalfx/resource_signalfx_dashboard_test.go

@@ -5,6 +5,7 @@ package signalfx
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -41,6 +42,26 @@ resource "signalfx_dashboard" "mydashboardX0" {
 }
 `
 
+const invalidDashboard = `
+resource "signalfx_dashboard" "invalid_dashboard" {
+  name = ""
+  dashboard_group = ""
+}
+`
+
+func TestAccValidateDashboard(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		Providers:    testAccProviders,
+		CheckDestroy: testAccDashboardGroupDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config:      invalidDashboard,
+				ExpectError: regexp.MustCompile("status code 400"),
+			},
+		},
+	})
+}
+
 func TestValidateChartsResolutionAllowed(t *testing.T) {
 	for _, value := range []string{"default", "low", "high", "highest"} {
 		_, errors := validateChartsResolution(value, "charts_resolution")

signalfx/resource_signalfx_event_feed_chart.go

@@ -57,11 +57,12 @@ func eventFeedChartResource() *schema.Resource {
 			},
 		},
 
-		Create: eventFeedChartCreate,
-		Read:   eventFeedChartRead,
-		Update: eventFeedChartUpdate,
-		Delete: eventFeedChartDelete,
-		Exists: chartExists,
+		CustomizeDiff: eventfeedchartValidate,
+		Create:        eventFeedChartCreate,
+		Read:          eventFeedChartRead,
+		Update:        eventFeedChartUpdate,
+		Delete:        eventFeedChartDelete,
+		Exists:        chartExists,
 		Importer: &schema.ResourceImporter{
 			State: schema.ImportStatePassthrough,
 		},
@@ -71,7 +72,7 @@ func eventFeedChartResource() *schema.Resource {
 /*
 Use Resource object to construct json payload in order to create an event feed chart
 */
-func getPayloadEventFeedChart(d *schema.ResourceData) *chart.CreateUpdateChartRequest {
+func getPayloadEventFeedChart(d ResourceDataAccess) (*chart.CreateUpdateChartRequest, error) {
 	var timeOptions *chart.TimeDisplayOptions
 	if val, ok := d.GetOk("time_range"); ok {
 		r := int64(val.(int) * 1000)
@@ -100,12 +101,19 @@ func getPayloadEventFeedChart(d *schema.ResourceData) *chart.CreateUpdateChartRe
 			Time: timeOptions,
 			Type: "Event",
 		},
-	}
+	}, nil
+}
+
+func eventfeedchartValidate(ctx context.Context, d *schema.ResourceDiff, meta any) error {
+	return ChartValidatorFunc(getPayloadEventFeedChart).Validate(ctx, d, meta)
 }
 
 func eventFeedChartCreate(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*signalfxConfig)
-	payload := getPayloadEventFeedChart(d)
+	payload, err := getPayloadEventFeedChart(d)
+	if err != nil {
+		return err
+	}
 
 	debugOutput, _ := json.Marshal(payload)
 	log.Printf("[DEBUG] SignalFx: Create Event Feed Chart Payload: %s", string(debugOutput))
@@ -186,7 +194,10 @@ func eventFeedChartRead(d *schema.ResourceData, meta interface{}) error {
 
 func eventFeedChartUpdate(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*signalfxConfig)
-	payload := getPayloadEventFeedChart(d)
+	payload, err := getPayloadEventFeedChart(d)
+	if err != nil {
+		return err
+	}
 	debugOutput, _ := json.Marshal(payload)
 	log.Printf("[DEBUG] SignalFx: Update Event Feed Chart Payload: %s", string(debugOutput))
 

signalfx/resource_signalfx_event_feed_chart_test.go

@@ -6,6 +6,7 @@ package signalfx
 import (
 	"context"
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -32,6 +33,26 @@ resource "signalfx_event_feed_chart" "mychartEVX" {
 }
 `
 
+const invalidEventFeedChart = `
+resource "signalfx_event_feed_chart" "mychartEVX"{
+  name = ""
+  program_text = "A = events(eventType='Fart Testing').publish(label='A')"
+}
+`
+
+func TestAccValidateEventFeedChart(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		Providers:    testAccProviders,
+		CheckDestroy: testAccEventFeedChartDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config:      invalidEventFeedChart,
+				ExpectError: regexp.MustCompile("status code 400"),
+			},
+		},
+	})
+}
+
 func TestAccCreateUpdateEventFeedChart(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:     func() { testAccPreCheck(t) },