docs and tests

PagerDuty · Sep 29, 2023 · 2d3dc6f · 2d3dc6f
1 parent 1f0ba92
commit 2d3dc6f
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 33 deletions.
diff --git a/pagerduty/resource_pagerduty_event_orchestration_path_global_test.go b/pagerduty/resource_pagerduty_event_orchestration_path_global_test.go
@@ -295,17 +295,17 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAutomationActionsConfig(t,
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {
 					label = "rule 1"
-					actions {							
+					actions {
 							automation_action {
 								name = "test"
 								url = "https://test.com"
 								auto_send = true
-		
+
 								header {
 									key = "foo"
 									value = "bar"
@@ -314,7 +314,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAutomationActionsConfig(t,
 									key = "baz"
 									value = "buz"
 								}
-		
+
 								parameter {
 									key = "source"
 									value = "orch"
@@ -363,16 +363,16 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAutomationActionsParamsUpd
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {
 					label = "rule 1"
-					actions {							
+					actions {
 							automation_action {
 								name = "test1"
 								url = "https://test1.com"
-		
+
 								header {
 									key = "foo1"
 									value = "bar1"
@@ -412,12 +412,12 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAutomationActionsParamsDel
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {
 					label = "rule 1"
-					actions {							
+					actions {
 							automation_action {
 								name = "test"
 								url = "https://test.com"
@@ -444,7 +444,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalInvalidExtractionsConfig(t
 		createBaseGlobalOrchConfig(t, ep, s, o),
 		fmt.Sprintf(`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-						
+
 				set {
 					id = "start"
 					rule {
@@ -467,7 +467,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAllActionsConfig(t, ep, s,
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -505,6 +505,10 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAllActionsConfig(t, ep, s,
 							source = "event.group"
 							target = "event.custom_details.message"
 						}
+						incident_custom_field_update {
+							id = "PIJ90N7"
+							value = "foo"
+						}
 					}
 				}
 				rule {
@@ -574,7 +578,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAllActionsUpdateConfig(t,
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -603,6 +607,10 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAllActionsUpdateConfig(t,
 							target = "event.custom_details.message_upd"
 							template = "[UPD] High CPU usage on {{variables.hostname}}: {{variables.cpu_val}}"
 						}
+						incident_custom_field_update {
+							id = "PIJ90N7"
+							value = "bar"
+						}
 					}
 				}
 				rule {
@@ -666,7 +674,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAllActionsUpdateConfig(t,
 						path = "event.custom_details.updated_at"
 						type = "regex"
 						value = "UPD (.*)"
-					}					
+					}
 					extraction {
 						regex = ".*"
 						source = "event.custom_details.region_upd"
@@ -682,7 +690,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalAllActionsDeleteConfig(t,
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -719,7 +727,7 @@ func testAccCheckPagerDutyEventOrchestrationPathGlobalOneSetNoActionsConfig(t, e
 	return fmt.Sprintf("%s%s", createBaseGlobalOrchConfig(t, ep, s, o),
 		`resource "pagerduty_event_orchestration_global" "my_global_orch" {
 			event_orchestration = pagerduty_event_orchestration.orch.id
-		
+
 			set {
 				id = "start"
 				rule {

diff --git a/pagerduty/resource_pagerduty_event_orchestration_path_service_test.go b/pagerduty/resource_pagerduty_event_orchestration_path_service_test.go
@@ -328,7 +328,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceDefaultConfig(ep, s strin
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 			}
@@ -344,17 +344,17 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAutomationActionsConfig(e
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
 					label = "rule 1"
-					actions {							
+					actions {
 							automation_action {
 								name = "test"
 								url = "https://test.com"
 								auto_send = true
-		
+
 								header {
 									key = "foo"
 									value = "bar"
@@ -363,7 +363,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAutomationActionsConfig(e
 									key = "baz"
 									value = "buz"
 								}
-		
+
 								parameter {
 									key = "source"
 									value = "orch"
@@ -412,16 +412,16 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAutomationActionsParamsUp
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
 					label = "rule 1"
-					actions {							
+					actions {
 							automation_action {
 								name = "test1"
 								url = "https://test1.com"
-		
+
 								header {
 									key = "foo1"
 									value = "bar1"
@@ -461,12 +461,12 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAutomationActionsParamsDe
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
 					label = "rule 1"
-					actions {							
+					actions {
 							automation_action {
 								name = "test"
 								url = "https://test.com"
@@ -493,7 +493,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceInvalidExtractionsConfig(
 		createBaseServicePathConfig(ep, s),
 		fmt.Sprintf(`resource "pagerduty_event_orchestration_service" "serviceA" {
 				service = pagerduty_service.bar.id
-						
+
 				set {
 					id = "start"
 					rule {
@@ -516,7 +516,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAllActionsConfig(ep, s st
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -557,6 +557,10 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAllActionsConfig(ep, s st
 							source = "event.group"
 							target = "event.custom_details.message"
 						}
+						incident_custom_field_update {
+							id = "PIJ90N7"
+							value = "foo"
+						}
 					}
 				}
 			}
@@ -620,7 +624,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAllActionsUpdateConfig(ep
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -652,6 +656,10 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAllActionsUpdateConfig(ep
 							target = "event.custom_details.message_upd"
 							template = "[UPD] High CPU usage on {{variables.hostname}}: {{variables.cpu_val}}"
 						}
+						incident_custom_field_update {
+							id = "PIJ90N7"
+							value = "bar"
+						}
 					}
 				}
 			}
@@ -709,7 +717,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAllActionsUpdateConfig(ep
 						path = "event.custom_details.updated_at"
 						type = "regex"
 						value = "UPD (.*)"
-					}					
+					}
 					extraction {
 						regex = ".*"
 						source = "event.custom_details.region_upd"
@@ -725,7 +733,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceAllActionsDeleteConfig(ep
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -758,7 +766,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceOneSetNoActionsConfig(ep,
 	return fmt.Sprintf("%s%s", createBaseServicePathConfig(ep, s),
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
-		
+
 			set {
 				id = "start"
 				rule {
@@ -783,7 +791,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceEnableEOForServiceEnableU
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
       enable_event_orchestration_for_service = true
-		
+
 			set {
 				id = "start"
 			}
@@ -800,7 +808,7 @@ func testAccCheckPagerDutyEventOrchestrationPathServiceEnableEOForServiceDisable
 		`resource "pagerduty_event_orchestration_service" "serviceA" {
 			service = pagerduty_service.bar.id
       enable_event_orchestration_for_service = false
-		
+
 			set {
 				id = "start"
 			}

diff --git a/website/docs/r/event_orchestration_global.html.markdown b/website/docs/r/event_orchestration_global.html.markdown
@@ -113,6 +113,9 @@ The following arguments are supported:
 * `suspend` - (Optional) The number of seconds to suspend the resulting alert before triggering. This effectively pauses incident notifications. If a `resolve` event arrives before the alert triggers then PagerDuty won't create an incident for this alert.
 * `priority` - (Optional) The ID of the priority you want to set on resulting incident. Consider using the [`pagerduty_priority`](https://registry.terraform.io/providers/PagerDuty/pagerduty/latest/docs/data-sources/priority) data source.
 * `annotate` - (Optional) Add this text as a note on the resulting incident.
+* `incident_custom_field_update` - (Optional) Assign a custom field to the resulting incident.
+  * `id` - (Required) The custom field id
+  * `value` - (Required) The value to assign this custom field
 * `automation_action` - (Optional) Create a [Webhook](https://support.pagerduty.com/docs/event-orchestration#webhooks) associated with the resulting incident.
   * `name` - (Required) Name of this Webhook.
   * `url` - (Required) The API endpoint where PagerDuty's servers will send the webhook request.

diff --git a/website/docs/r/event_orchestration_service.html.markdown b/website/docs/r/event_orchestration_service.html.markdown
@@ -186,6 +186,8 @@ The following arguments are supported:
 * `priority` - (Optional) The ID of the priority you want to set on resulting incident. Consider using the [`pagerduty_priority`](https://registry.terraform.io/providers/PagerDuty/pagerduty/latest/docs/data-sources/priority) data source.
 * `annotate` - (Optional) Add this text as a note on the resulting incident.
 * `incident_custom_field_update` - (Optional) Assign a custom field to the resulting incident.
+  * `id` - (Required) The custom field id
+  * `value` - (Required) The value to assign this custom field
 * `pagerduty_automation_action` - (Optional) Configure a [Process Automation](https://support.pagerduty.com/docs/event-orchestration#process-automation) associated with the resulting incident.
   * `action_id` - (Required) Id of the Process Automation action to be triggered.
 * `automation_action` - (Optional) Create a [Webhook](https://support.pagerduty.com/docs/event-orchestration#webhooks) associated with the resulting incident.