Add notify_next_on_call_from_schedule escalation type (#2645)

* Add notify_next_on_call_from_schedule escalation type

Support the newly exposed STEP_NOTIFY_SCHEDULE_NEXT public API step
(notify_next_on_call_from_schedule) in the grafana_oncall_escalation
resource. This type notifies the next person on-call from a schedule
rather than the current one, and reuses the existing
notify_on_call_from_schedule field to reference the schedule ID.

Author: musculman

docs/resources/oncall_escalation.md

@@ -51,6 +51,14 @@ resource "grafana_oncall_escalation" "example_notify_step" {
   ]
   position = 0
 }
+
+// Notify next on-call from schedule step
+resource "grafana_oncall_escalation" "example_notify_next_on_call_step" {
+  escalation_chain_id          = grafana_oncall_escalation_chain.default.id
+  type                         = "notify_next_on_call_from_schedule"
+  notify_on_call_from_schedule = grafana_oncall_schedule.example_schedule.id
+  position                     = 1
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -60,17 +68,17 @@ resource "grafana_oncall_escalation" "example_notify_step" {
 
 - `escalation_chain_id` (String) The ID of the escalation chain.
 - `position` (Number) The position of the escalation step (starts from 0).
-- `type` (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, notify_if_num_alerts_in_window, repeat_escalation, notify_team_members, declare_incident
+- `type` (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, notify_next_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, notify_if_num_alerts_in_window, repeat_escalation, notify_team_members, declare_incident
 
 ### Optional
 
 - `action_to_trigger` (String) The ID of an Action for trigger_webhook type step.
 - `duration` (Number) The duration of delay for wait type step. (60-86400) seconds
 - `group_to_notify` (String) The ID of a User Group for notify_user_group type step.
-- `important` (Boolean) Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, notify_user_group and notify_team_members
+- `important` (Boolean) Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, notify_next_on_call_from_schedule, notify_user_group and notify_team_members
 - `notify_if_time_from` (String) The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
 - `notify_if_time_to` (String) The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
-- `notify_on_call_from_schedule` (String) ID of a Schedule for notify_on_call_from_schedule type step.
+- `notify_on_call_from_schedule` (String) ID of a Schedule for notify_on_call_from_schedule or notify_next_on_call_from_schedule type step.
 - `notify_to_team_members` (String) The ID of a Team for a notify_team_members type step.
 - `num_alerts_in_window` (Number) Number of alerts that must occur within the time window to continue escalation for notify_if_num_alerts_in_window type step.
 - `num_minutes_in_window` (Number) Time window in minutes to count alerts for notify_if_num_alerts_in_window type step.

examples/resources/grafana_oncall_escalation/resource.tf

@@ -35,3 +35,11 @@ resource "grafana_oncall_escalation" "example_notify_step" {
   ]
   position = 0
 }
+
+// Notify next on-call from schedule step
+resource "grafana_oncall_escalation" "example_notify_next_on_call_step" {
+  escalation_chain_id          = grafana_oncall_escalation_chain.default.id
+  type                         = "notify_next_on_call_from_schedule"
+  notify_on_call_from_schedule = grafana_oncall_schedule.example_schedule.id
+  position                     = 1
+}

internal/resources/oncall/resource_escalation.go

@@ -18,6 +18,7 @@ var escalationOptions = []string{
 	"notify_persons",
 	"notify_person_next_each_time",
 	"notify_on_call_from_schedule",
+	"notify_next_on_call_from_schedule",
 	"trigger_webhook",
 	"notify_user_group",
 	"resolve",
@@ -66,7 +67,7 @@ func resourceEscalation() *common.Resource {
 			"important": {
 				Type:        schema.TypeBool,
 				Optional:    true,
-				Description: "Will activate \"important\" personal notification rules. Actual for steps: notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, notify_user_group and notify_team_members",
+				Description: "Will activate \"important\" personal notification rules. Actual for steps: notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, notify_next_on_call_from_schedule, notify_user_group and notify_team_members",
 			},
 			"duration": {
 				Type:     schema.TypeInt,
@@ -101,7 +102,7 @@ func resourceEscalation() *common.Resource {
 					"num_alerts_in_window",
 					"num_minutes_in_window",
 				},
-				Description: "ID of a Schedule for notify_on_call_from_schedule type step.",
+				Description: "ID of a Schedule for notify_on_call_from_schedule or notify_next_on_call_from_schedule type step.",
 			},
 			"persons_to_notify": {
 				Type: schema.TypeSet,
@@ -335,7 +336,7 @@ func resourceEscalationCreate(ctx context.Context, d *schema.ResourceData, clien
 
 	notifyOnCallFromScheduleData, notifyOnCallFromScheduleDataOk := d.GetOk("notify_on_call_from_schedule")
 	if notifyOnCallFromScheduleDataOk {
-		if typeData == "notify_on_call_from_schedule" {
+		if typeData == "notify_on_call_from_schedule" || typeData == "notify_next_on_call_from_schedule" {
 			createOptions.NotifyOnCallFromSchedule = notifyOnCallFromScheduleData.(string)
 		} else {
 			return diag.Errorf("notify_on_call_from_schedule can not be set with type: %s", typeData)
@@ -519,7 +520,7 @@ func resourceEscalationUpdate(ctx context.Context, d *schema.ResourceData, clien
 
 	notifyOnCallFromScheduleData, notifyOnCallFromScheduleDataOk := d.GetOk("notify_on_call_from_schedule")
 	if notifyOnCallFromScheduleDataOk {
-		if typeData == "notify_on_call_from_schedule" {
+		if typeData == "notify_on_call_from_schedule" || typeData == "notify_next_on_call_from_schedule" {
 			updateOptions.NotifyOnCallFromSchedule = notifyOnCallFromScheduleData.(string)
 		}
 	}

internal/resources/oncall/resource_escalation_test.go

@@ -50,6 +50,11 @@ func TestAccOnCallEscalation_basic(t *testing.T) {
 					resource.TestCheckResourceAttr("grafana_oncall_escalation.test-acc-escalation-policy-num-alerts", "position", "4"),
 					resource.TestCheckResourceAttr("grafana_oncall_escalation.test-acc-escalation-policy-num-alerts", "num_alerts_in_window", "3"),
 					resource.TestCheckResourceAttr("grafana_oncall_escalation.test-acc-escalation-policy-num-alerts", "num_minutes_in_window", "5"),
+
+					testAccCheckOnCallEscalationResourceExists("grafana_oncall_escalation.test-acc-escalation-policy-notify-next"),
+					resource.TestCheckResourceAttr("grafana_oncall_escalation.test-acc-escalation-policy-notify-next", "type", "notify_next_on_call_from_schedule"),
+					resource.TestCheckResourceAttr("grafana_oncall_escalation.test-acc-escalation-policy-notify-next", "position", "5"),
+					resource.TestCheckResourceAttrSet("grafana_oncall_escalation.test-acc-escalation-policy-notify-next", "notify_on_call_from_schedule"),
 				),
 			},
 			{
@@ -72,6 +77,11 @@ func TestAccOnCallEscalation_basic(t *testing.T) {
 				ResourceName:      "grafana_oncall_escalation.test-acc-escalation-policy-num-alerts",
 				ImportStateVerify: true,
 			},
+			{
+				ImportState:       true,
+				ResourceName:      "grafana_oncall_escalation.test-acc-escalation-policy-notify-next",
+				ImportStateVerify: true,
+			},
 		},
 	})
 }
@@ -145,7 +155,20 @@ resource "grafana_oncall_escalation" "test-acc-escalation-policy-num-alerts" {
 	num_minutes_in_window = 5
 	position = 4
 }
-`, riName, riName, riName, reType, reDuration)
+
+resource "grafana_oncall_schedule" "test-acc-schedule" {
+	name = "acc-test-schedule-%s"
+	type = "calendar"
+	time_zone = "America/New_York"
+}
+
+resource "grafana_oncall_escalation" "test-acc-escalation-policy-notify-next" {
+	escalation_chain_id = grafana_oncall_escalation_chain.test-acc-escalation-chain.id
+	type = "notify_next_on_call_from_schedule"
+	notify_on_call_from_schedule = grafana_oncall_schedule.test-acc-schedule.id
+	position = 5
+}
+`, riName, riName, riName, reType, reDuration, riName)
 }
 
 func TestAccOnCallEscalation_notifyIfNumAlertsInWindow_wrongType(t *testing.T) {

pkg/generate/postprocessing/replace_references.go

@@ -103,6 +103,7 @@ var knownReferences = []string{
 	"grafana_notification_policy.mute_timings=grafana_mute_timing.name",
 	"grafana_notification_policy.org_id=grafana_organization.id",
 	"grafana_oncall_escalation.escalation_chain_id=grafana_oncall_escalation_chain.id",
+	"grafana_oncall_escalation.notify_on_call_from_schedule=grafana_oncall_schedule.id",
 	"grafana_oncall_integration.escalation_chain_id=grafana_oncall_escalation_chain.id",
 	"grafana_oncall_route.escalation_chain_id=grafana_oncall_escalation_chain.id",
 	"grafana_oncall_route.integration_id=grafana_oncall_integration.id",