2396: Adding support for SLO TF to support Asserts SLO (#2397)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: matt-metivier

examples/resources/grafana_slo/resource_asserts.tf

@@ -0,0 +1,64 @@
+resource "grafana_slo" "asserts_example" {
+  name        = "Asserts SLO Example"
+  description = "SLO managed by Asserts for entity-centric monitoring and RCA"
+  query {
+    freeform {
+      query = "sum(rate(apiserver_request_total{code!=\"500\"}[$__rate_interval])) / sum(rate(apiserver_request_total[$__rate_interval]))"
+    }
+    type = "freeform"
+  }
+  objectives {
+    value  = 0.995
+    window = "30d"
+  }
+  destination_datasource {
+    uid = "grafanacloud-prom"
+  }
+
+  # Asserts integration labels
+  # The grafana_slo_provenance label triggers Asserts-specific behavior:
+  # - Displays "asserts" badge instead of "provisioned"
+  # - Shows "Open RCA workbench" button in the SLO UI
+  # - Enables correlation with Asserts entity-centric monitoring
+  label {
+    key   = "grafana_slo_provenance"
+    value = "asserts"
+  }
+  label {
+    key   = "service_name"
+    value = "my-service"
+  }
+  label {
+    key   = "team_name"
+    value = "platform-team"
+  }
+
+  # Search expression for Asserts RCA workbench
+  # This enables the "Open RCA workbench" button to deep-link with pre-filtered context
+  search_expression = "service=my-service"
+
+  alerting {
+    fastburn {
+      annotation {
+        key   = "name"
+        value = "SLO Burn Rate Very High"
+      }
+      annotation {
+        key   = "description"
+        value = "Error budget is burning too fast"
+      }
+    }
+
+    slowburn {
+      annotation {
+        key   = "name"
+        value = "SLO Burn Rate High"
+      }
+      annotation {
+        key   = "description"
+        value = "Error budget is burning too fast"
+      }
+    }
+  }
+}
+

internal/resources/slo/resource_slo.go

@@ -21,10 +21,51 @@ const (
 	QueryTypeRatio          string = "ratio"
 	QueryTypeThreshold      string = "threshold"
 	QueryTypeGrafanaQueries string = "grafanaQueries"
+
+	// Asserts integration constants
+	AssertsProvenanceLabel = "grafana_slo_provenance"
+	AssertsProvenanceValue = "asserts"
+	AssertsRequestHeader   = "Grafana-Asserts-Request"
 )
 
 var resourceSloID = common.NewResourceID(common.StringIDField("uuid"))
 
+// hasAssertsProvenanceLabel checks if the SLO has the grafana_slo_provenance=asserts label
+func hasAssertsProvenanceLabel(labels []slo.SloV00Label) bool {
+	for _, label := range labels {
+		if label.Key == AssertsProvenanceLabel && label.Value == AssertsProvenanceValue {
+			return true
+		}
+	}
+	return false
+}
+
+// createAssertsSLOClient creates a new SLO client with Asserts headers
+func createAssertsSLOClient(baseClient *slo.APIClient) *slo.APIClient {
+	// Create a new configuration with the Asserts header
+	config := slo.NewConfiguration()
+
+	// Copy the base client configuration
+	config.Host = baseClient.GetConfig().Host
+	config.Scheme = baseClient.GetConfig().Scheme
+	config.HTTPClient = baseClient.GetConfig().HTTPClient
+
+	// Copy existing headers BUT exclude the Terraform provider header
+	// The API checks Terraform header first, so we must remove it to allow Asserts provenance
+	config.DefaultHeader = make(map[string]string)
+	for k, v := range baseClient.GetConfig().DefaultHeader {
+		// Skip the Terraform provider header
+		if k == "Grafana-Terraform-Provider" {
+			continue
+		}
+		config.DefaultHeader[k] = v
+	}
+	// Add the Asserts header which will now be checked by the API
+	config.DefaultHeader[AssertsRequestHeader] = "true"
+
+	return slo.NewAPIClient(config)
+}
+
 func resourceSlo() *common.Resource {
 	schema := &schema.Resource{
 		Description: `
@@ -329,7 +370,13 @@ func resourceSloCreate(ctx context.Context, d *schema.ResourceData, client *slo.
 		return diags
 	}
 
-	req := client.DefaultAPI.V1SloPost(ctx).SloV00Slo(sloModel)
+	// Check if this SLO has Asserts provenance and create a custom client if needed
+	apiClient := client
+	if hasAssertsProvenanceLabel(sloModel.Labels) {
+		apiClient = createAssertsSLOClient(client)
+	}
+
+	req := apiClient.DefaultAPI.V1SloPost(ctx).SloV00Slo(sloModel)
 	response, _, err := req.Execute()
 
 	if err != nil {
@@ -377,7 +424,13 @@ func resourceSloUpdate(ctx context.Context, d *schema.ResourceData, client *slo.
 			return diags
 		}
 
-		req := client.DefaultAPI.V1SloIdPut(ctx, sloID).SloV00Slo(sloV00Slo)
+		// Check if this SLO has Asserts provenance and create a custom client if needed
+		apiClient := client
+		if hasAssertsProvenanceLabel(sloV00Slo.Labels) {
+			apiClient = createAssertsSLOClient(client)
+		}
+
+		req := apiClient.DefaultAPI.V1SloIdPut(ctx, sloID).SloV00Slo(sloV00Slo)
 		if _, err := req.Execute(); err != nil {
 			return apiError("Unable to Update SLO - API", err)
 		}

internal/resources/slo/resource_slo_test.go

@@ -142,6 +142,26 @@ func TestAccResourceSlo(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 			},
+			{
+				// Tests Asserts Integration
+				Config: testutils.TestAccExampleWithReplace(t, "resources/grafana_slo/resource_asserts.tf", map[string]string{
+					"Asserts SLO Example": randomName + " - Asserts",
+				}),
+				Check: resource.ComposeTestCheckFunc(
+					testAccSloCheckExistsWithProvenance("grafana_slo.asserts_example", &slo, "asserts"),
+					resource.TestCheckResourceAttrSet("grafana_slo.asserts_example", "id"),
+					resource.TestCheckResourceAttr("grafana_slo.asserts_example", "name", randomName+" - Asserts"),
+					// Verify Asserts integration labels
+					resource.TestCheckResourceAttr("grafana_slo.asserts_example", "label.0.key", "grafana_slo_provenance"),
+					resource.TestCheckResourceAttr("grafana_slo.asserts_example", "label.0.value", "asserts"),
+					resource.TestCheckResourceAttr("grafana_slo.asserts_example", "label.1.key", "service_name"),
+					resource.TestCheckResourceAttr("grafana_slo.asserts_example", "label.2.key", "team_name"),
+					// Verify search expression
+					resource.TestCheckResourceAttr("grafana_slo.asserts_example", "search_expression", "service=my-service"),
+					// Verify the SLO has the correct Asserts provenance
+					testAccSloCheckAssertsProvenance("grafana_slo.asserts_example"),
+				),
+			},
 		},
 	})
 }
@@ -211,6 +231,10 @@ func TestAccSLO_recreate(t *testing.T) {
 }
 
 func testAccSloCheckExists(rn string, slo *slo.SloV00Slo) resource.TestCheckFunc {
+	return testAccSloCheckExistsWithProvenance(rn, slo, "terraform")
+}
+
+func testAccSloCheckExistsWithProvenance(rn string, slo *slo.SloV00Slo, expectedProvenance string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[rn]
 		if !ok {
@@ -228,8 +252,8 @@ func testAccSloCheckExists(rn string, slo *slo.SloV00Slo) resource.TestCheckFunc
 			return fmt.Errorf("error getting SLO: %s", err)
 		}
 
-		if *gotSlo.ReadOnly.Provenance != "terraform" {
-			return fmt.Errorf("provenance header missing - verify within the Grafana Terraform Provider that the 'Grafana-Terraform-Provider' request header is set to 'true'")
+		if *gotSlo.ReadOnly.Provenance != expectedProvenance {
+			return fmt.Errorf("expected provenance to be '%s', got '%s'", expectedProvenance, *gotSlo.ReadOnly.Provenance)
 		}
 
 		*slo = *gotSlo
@@ -721,3 +745,48 @@ resource "grafana_slo" "custom_uuid_test" {
 }
 `, uuid)
 }
+
+// testAccSloCheckAssertsProvenance verifies that the SLO has the correct Asserts provenance
+func testAccSloCheckAssertsProvenance(rn string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, ok := s.RootModule().Resources[rn]
+		if !ok {
+			return fmt.Errorf("resource not found: %s", rn)
+		}
+
+		if rs.Primary.ID == "" {
+			return fmt.Errorf("resource id not set")
+		}
+
+		client := testutils.Provider.Meta().(*common.Client).SLOClient
+		req := client.DefaultAPI.V1SloIdGet(context.Background(), rs.Primary.ID)
+		gotSlo, _, err := req.Execute()
+		if err != nil {
+			return fmt.Errorf("error getting SLO: %s", err)
+		}
+
+		// Check that the SLO has the correct provenance
+		if gotSlo.ReadOnly == nil || gotSlo.ReadOnly.Provenance == nil {
+			return fmt.Errorf("SLO provenance is not set")
+		}
+
+		if *gotSlo.ReadOnly.Provenance != "asserts" {
+			return fmt.Errorf("expected SLO provenance to be 'asserts', got '%s'", *gotSlo.ReadOnly.Provenance)
+		}
+
+		// Verify the SLO has the Asserts provenance label
+		hasAssertsLabel := false
+		for _, label := range gotSlo.Labels {
+			if label.Key == "grafana_slo_provenance" && label.Value == "asserts" {
+				hasAssertsLabel = true
+				break
+			}
+		}
+
+		if !hasAssertsLabel {
+			return fmt.Errorf("SLO does not have the grafana_slo_provenance=asserts label")
+		}
+
+		return nil
+	}
+}