Ensure Alerting Rules Not Generated for Empty Alerting Fields on TF State File (#939)

Updates Terraform Provider to ensure Alerting rules are not generated for instances where the Alerting field on the Terraform state file is not specified by the user

Author: elainevuong

internal/resources/slo/resource_slo.go

@@ -298,22 +298,29 @@ func packSloResource(d *schema.ResourceData) (gapi.Slo, error) {
 		tflabels = packLabels(labels)
 	}
 
-	alerting := d.Get("alerting").([]interface{})
-	if len(alerting) > 0 {
-		alert := alerting[0].(map[string]interface{})
-		tfalerting = packAlerting(alert)
-	}
-
 	slo := gapi.Slo{
 		UUID:        d.Id(),
 		Name:        tfname,
 		Description: tfdescription,
 		Objectives:  tfobjective,
 		Query:       tfquery,
-		Alerting:    &tfalerting,
+		Alerting:    nil,
 		Labels:      tflabels,
 	}
 
+	if alerting, ok := d.GetOk("alerting"); ok {
+		alertData := alerting.([]interface{})
+
+		// if the Alerting field is an empty block, alertData[0] has a value of nil
+		if alertData[0] != nil {
+			// only pack the Alerting TF fields if the user populates the Alerting field with blocks
+			alert := alertData[0].(map[string]interface{})
+			tfalerting = packAlerting(alert)
+		}
+
+		slo.Alerting = &tfalerting
+	}
+
 	return slo, nil
 }
 

internal/resources/slo/resource_slo_test.go

@@ -18,9 +18,11 @@ func TestAccResourceSlo(t *testing.T) {
 	var slo gapi.Slo
 	resource.ParallelTest(t, resource.TestCase{
 		ProviderFactories: testutils.ProviderFactories,
-		CheckDestroy:      testAccSloCheckDestroy(&slo),
+		// Implicitly tests destroy
+		CheckDestroy: testAccSloCheckDestroy(&slo),
 		Steps: []resource.TestStep{
 			{
+				// Tests Create
 				Config: testutils.TestAccExample(t, "resources/grafana_slo/resource.tf"),
 				Check: resource.ComposeTestCheckFunc(
 					testAccSloCheckExists("grafana_slo.test", &slo),
@@ -34,6 +36,7 @@ func TestAccResourceSlo(t *testing.T) {
 				),
 			},
 			{
+				// Tests Update
 				Config: testutils.TestAccExample(t, "resources/grafana_slo/resource_update.tf"),
 				Check: resource.ComposeTestCheckFunc(
 					testAccSloCheckExists("grafana_slo.update", &slo),
@@ -46,6 +49,26 @@ func TestAccResourceSlo(t *testing.T) {
 					resource.TestCheckResourceAttr("grafana_slo.update", "objectives.0.window", "7d"),
 				),
 			},
+			{
+				// Tests that No Alerting Rules are Generated when No Alerting Field is defined on the Terraform State File
+				Config: noAlert,
+				Check: resource.ComposeTestCheckFunc(
+					testAccSloCheckExists("grafana_slo.no_alert", &slo),
+					testAlertingExists(false, "grafana_slo.no_alert", &slo),
+					resource.TestCheckResourceAttrSet("grafana_slo.no_alert", "id"),
+					resource.TestCheckResourceAttr("grafana_slo.no_alert", "name", "No Alerting Check - does not generate Alerts"),
+				),
+			},
+			{
+				// Tests that Alerting Rules are Generated when an Empty Alerting Field is defined on the Terraform State File
+				Config: emptyAlert,
+				Check: resource.ComposeTestCheckFunc(
+					testAccSloCheckExists("grafana_slo.empty_alert", &slo),
+					testAlertingExists(true, "grafana_slo.empty_alert", &slo),
+					resource.TestCheckResourceAttrSet("grafana_slo.empty_alert", "id"),
+					resource.TestCheckResourceAttr("grafana_slo.empty_alert", "name", "Empty Alerting Check - generates Alerts"),
+				),
+			},
 		},
 	})
 }
@@ -74,15 +97,30 @@ func testAccSloCheckExists(rn string, slo *gapi.Slo) resource.TestCheckFunc {
 	}
 }
 
-func testAccSloCheckDestroy(slo *gapi.Slo) resource.TestCheckFunc {
+func testAlertingExists(expectation bool, rn string, slo *gapi.Slo) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
+		rs := s.RootModule().Resources[rn]
 		client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
-		err := client.DeleteSlo(slo.UUID)
+		gotSlo, _ := client.GetSlo(rs.Primary.ID)
+		*slo = gotSlo
+
+		if slo.Alerting == nil && expectation == false {
+			return nil
+		}
 
-		if err == nil {
-			return fmt.Errorf("SLO with a UUID %s still exists after destroy", slo.UUID)
+		if slo.Alerting != nil && expectation == true {
+			return nil
 		}
 
+		return fmt.Errorf("SLO Alerting expectation mismatch")
+	}
+}
+
+func testAccSloCheckDestroy(slo *gapi.Slo) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
+		client.DeleteSlo(slo.UUID)
+
 		return nil
 	}
 }
@@ -104,6 +142,41 @@ resource  "grafana_slo" "invalid" {
 }
 `
 
+const emptyAlert = `
+resource "grafana_slo" "empty_alert" {
+  description = "Empty Alerting Check - generates Alerts"
+  name        = "Empty Alerting Check - generates Alerts"
+  objectives {
+    value  = 0.995
+    window = "28d"
+  }
+  query {
+    type = "freeform"
+    freeform {
+      query = "sum(rate(apiserver_request_total{code!=\"500\"}[$__rate_interval])) / sum(rate(apiserver_request_total[$__rate_interval]))"
+    }
+  }
+  alerting {}
+}
+`
+
+const noAlert = `
+resource "grafana_slo" "no_alert" {
+  description = "No Alerting Check - does not generate Alerts"
+  name        = "No Alerting Check - does not generate Alerts"
+  objectives {
+    value  = 0.995
+    window = "28d"
+  }
+  query {
+    type = "freeform"
+    freeform {
+      query = "sum(rate(apiserver_request_total{code!=\"500\"}[$__rate_interval])) / sum(rate(apiserver_request_total[$__rate_interval]))"
+    }
+  }
+}
+`
+
 func TestAccResourceInvalidSlo(t *testing.T) {
 	testutils.CheckCloudInstanceTestsEnabled(t)