feat(bigTent slo): Custom Validate function for big tent SLO schema

.linkcheckerrc

@@ -3,6 +3,8 @@ checkextern=1
 ignore=
   # https://regex101.com/r/Pl0jCn/1
   \/\*\!sc\*\/
+ignorewarningsforurls=
+  ^https://jqlang\.github\.io/jq/ ^http-redirected
 
 [MarkdownCheck]
 filename_re=.*\.md

internal/resources/slo/resource_slo.go

@@ -2,12 +2,14 @@ package slo
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"regexp"
 
 	"github.com/grafana/slo-openapi-client/go/slo"
 
 	"github.com/grafana/terraform-provider-grafana/v3/internal/common"
+	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
@@ -90,9 +92,10 @@ Resource manages Grafana SLOs.
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"query": {
-										Type:        schema.TypeString,
-										Required:    true,
-										Description: "Freeform Query Field",
+										Type:             schema.TypeString,
+										Required:         true,
+										Description:      "Freeform Query Field",
+										ValidateDiagFunc: ValidateBigTent(),
 									},
 								},
 							},
@@ -104,14 +107,16 @@ Resource manages Grafana SLOs.
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"success_metric": {
-										Type:        schema.TypeString,
-										Description: `Counter metric for success events (numerator)`,
-										Required:    true,
+										Type:             schema.TypeString,
+										Description:      `Counter metric for success events (numerator)`,
+										Required:         true,
+										ValidateDiagFunc: ValidateBigTent(),
 									},
 									"total_metric": {
-										Type:        schema.TypeString,
-										Description: `Metric for total events (denominator)`,
-										Required:    true,
+										Type:             schema.TypeString,
+										Description:      `Metric for total events (denominator)`,
+										Required:         true,
+										ValidateDiagFunc: ValidateBigTent(),
 									},
 									"group_by_labels": {
 										Type:        schema.TypeList,
@@ -661,3 +666,79 @@ func apiError(action string, err error) diag.Diagnostics {
 		},
 	}
 }
+
+func ValidateBigTent() schema.SchemaValidateDiagFunc {
+	return func(i interface{}, path cty.Path) diag.Diagnostics {
+		var diags diag.Diagnostics
+
+		v, ok := i.(string)
+		if !ok {
+			diags = append(diags, diag.Diagnostic{
+				Severity:      diag.Error,
+				Summary:       "Bad Format",
+				Detail:        fmt.Sprintf("expected type of %s to be string", path),
+				AttributePath: path,
+			})
+		}
+
+		var gmrQuery []map[string]any
+		err := json.Unmarshal([]byte(v), &gmrQuery)
+		if err != nil {
+			diags = append(diags, diag.Diagnostic{
+				Severity:      diag.Warning,
+				Summary:       "Bad JSON format",
+				Detail:        "If this is a big tent query, this should be valid JSON. If this is a prometheus query, ignore this.",
+				AttributePath: path,
+			})
+			return diags
+		}
+
+		for _, queryObj := range gmrQuery {
+			currentPath := path.Copy()
+
+			refID, ok := queryObj["refId"]
+			if !ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        fmt.Sprintf("expected Big Tent Query %v to have a refId", queryObj),
+					AttributePath: append(currentPath, cty.IndexStep{Key: cty.StringVal("refId")}),
+				})
+				return diags
+			}
+
+			source := queryObj["datasource"]
+			s, ok := source.(map[string]interface{})
+			if !ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        fmt.Sprintf("expected Big Tent Query (refId:%v) to have a datasource", refID),
+					AttributePath: append(currentPath, cty.IndexStep{Key: cty.StringVal("datasource")}),
+				})
+				return diags
+			}
+
+			currentPath = append(currentPath, cty.IndexStep{Key: cty.StringVal("datasource")})
+			_, ok = s["type"]
+			if !ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        fmt.Sprintf("expected Big Tent Query (refId:%v) to have a type", refID),
+					AttributePath: append(currentPath.Copy(), cty.IndexStep{Key: cty.StringVal("type")}),
+				})
+			}
+			_, ok = s["uid"]
+			if !ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        fmt.Sprintf("expected Big Tent Query (refId:%v) to have a uid", refID),
+					AttributePath: append(currentPath.Copy(), cty.IndexStep{Key: cty.StringVal("uid")}),
+				})
+			}
+		}
+		return diags
+	}
+}

internal/resources/slo/resource_slo_test.go

@@ -2,13 +2,20 @@ package slo_test
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"regexp"
 	"strings"
 	"testing"
 	"time"
 
+	"github.com/grafana/grafana-openapi-client-go/models"
+	slo2 "github.com/grafana/terraform-provider-grafana/v3/internal/resources/slo"
+	"github.com/hashicorp/go-cty/cty"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/stretchr/testify/assert"
+
 	"github.com/grafana/slo-openapi-client/go/slo"
 	"github.com/grafana/terraform-provider-grafana/v3/internal/common"
 	"github.com/grafana/terraform-provider-grafana/v3/internal/testutils"
@@ -412,3 +419,164 @@ func TestAccResourceInvalidSlo(t *testing.T) {
 		},
 	})
 }
+
+func TestValidateBigTent(t *testing.T) {
+	tests := map[string]struct {
+		query         string
+		expectedDiags diag.Diagnostics
+	}{
+		"prometheus": {
+			query: "sum(rate(apiserver_request_total{code!=\"500\"}[$__rate_interval])) / sum(rate(apiserver_request_total[$__rate_interval]))",
+			expectedDiags: diag.Diagnostics{
+				diag.Diagnostic{
+					Severity:      diag.Warning,
+					Summary:       "Bad JSON format",
+					Detail:        "If this is a big tent query, this should be valid JSON. If this is a prometheus query, ignore this.",
+					AttributePath: cty.IndexPath(cty.Value{}),
+				},
+			},
+		},
+		"bigTent_success": {
+			query:         createBigTent(true, []map[string]any{}),
+			expectedDiags: diag.Diagnostics{},
+		},
+		"bigTent_noRefId": {
+			query: createBigTent(false, []map[string]any{{}}),
+			expectedDiags: diag.Diagnostics{
+				diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        fmt.Sprintf("expected Big Tent Query %v to have a refId", "map[]"),
+					AttributePath: append(cty.IndexPath(cty.Value{}), cty.IndexStep{Key: cty.StringVal("refId")}),
+				},
+			},
+		},
+		"bigTent_noDatasource": {
+			query: createBigTent(false, []map[string]any{{"refId": "A"}}),
+			expectedDiags: diag.Diagnostics{
+				diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        "expected Big Tent Query (refId:A) to have a datasource",
+					AttributePath: append(cty.IndexPath(cty.Value{}), cty.IndexStep{Key: cty.StringVal("datasource")}),
+				},
+			},
+		},
+		"bigTent_missingFields": {
+			query: createBigTent(false, []map[string]any{{"refId": "A", "datasource": models.DataSource{}}}),
+			expectedDiags: diag.Diagnostics{
+				diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        "expected Big Tent Query (refId:A) to have a type",
+					AttributePath: append(cty.IndexPath(cty.Value{}), cty.IndexStep{Key: cty.StringVal("datasource")}, cty.IndexStep{Key: cty.StringVal("type")}),
+				},
+				diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Missing Required Field",
+					Detail:        "expected Big Tent Query (refId:A) to have a uid",
+					AttributePath: append(cty.IndexPath(cty.Value{}), cty.IndexStep{Key: cty.StringVal("datasource")}, cty.IndexStep{Key: cty.StringVal("uid")}),
+				},
+			},
+		},
+	}
+	testFunc := slo2.ValidateBigTent()
+
+	for name, tc := range tests {
+		t.Run(name, func(t *testing.T) {
+			diags := testFunc(tc.query, cty.IndexPath(cty.Value{}))
+
+			require.Len(t, diags, len(tc.expectedDiags))
+			for i, w := range tc.expectedDiags {
+				assert.Equal(t, w, diags[i])
+			}
+		})
+	}
+}
+
+func createBigTent(useDefault bool, input []map[string]any) string {
+	const bigTentQuery = `
+      [
+        {
+          "aggregation": "Sum",
+          "alias": "",
+          "application": "57831",
+          "applicationName": "petclinic",
+          "datasource": {
+            "type": "dlopes7-appdynamics-datasource",
+            "uid": "appdynamics_localdev"
+          },
+          "delimiter": "|",
+          "isRawQuery": false,
+          "metric": "Overall Application Performance|Calls per Minute",
+          "queryType": "metrics",
+          "refId": "total",
+          "rollUp": true,
+          "schemaVersion": "3.9.5",
+          "transformLegend": "Segments",
+          "transformLegendText": ""
+        },
+        {
+          "aggregation": "Sum",
+          "alias": "",
+          "application": "57831",
+          "applicationName": "petclinic",
+          "datasource": {
+            "type": "dlopes7-appdynamics-datasource",
+            "uid": "appdynamics_localdev"
+          },
+          "intervalMs": 1000,
+          "maxDataPoints": 43200,
+          "delimiter": "|",
+          "isRawQuery": false,
+          "metric": "Overall Application Performance|Calls per Minute",
+          "queryType": "metrics",
+          "refId": "also_total",
+          "rollUp": true,
+          "schemaVersion": "3.9.5",
+          "transformLegend": "Segments",
+          "transformLegendText": ""
+        },
+        {
+          "conditions": [
+              {
+                  "evaluator": {
+                      "params": [
+                          0,
+                          0
+                      ],
+                      "type": "gt"
+                  },
+                  "operator": {
+                      "type": "and"
+                  },
+                  "query": {
+                      "params": []
+                  },
+                  "reducer": {
+                      "params": [],
+                      "type": "avg"
+                  },
+                  "type": "query"
+              }
+          ],
+          "datasource": {
+              "name": "Expression",
+              "type": "__expr__",
+              "uid": "__expr__"
+          },
+          "expression": "($total / $also_total)",
+          "intervalMs": 1000,
+          "maxDataPoints": 43200,
+          "refId": "C",
+          "type": "math"
+        }
+      ]`
+
+	if useDefault {
+		return bigTentQuery
+	}
+
+	output, _ := json.Marshal(input)
+	return string(output)
+}