Merge pull request #250 from SumoLogic/rohit-servicenow-support

SUMO-170407: initial support for new ServiceNow connection

Author: rsanbhad

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## 2.9.8 (Unreleased)
 
+FEATURES:
+
+* Add support for ServiceNow Incident and Event webhook connection (GH-250)
+
 ## 2.9.7 (July 22, 2021)
 
 ENHANCEMENTS:

sumologic/resource_sumologic_connection.go

@@ -77,9 +77,14 @@ func resourceSumologicConnection() *schema.Resource {
 			"webhook_type": {
 				Type:         schema.TypeString,
 				Optional:     true,
-				ValidateFunc: validation.StringInSlice([]string{"AWSLambda", "Azure", "Datadog", "HipChat", "PagerDuty", "Slack", "Webhook", "NewRelic", "Jira", "Opsgenie", "MicrosoftTeams"}, false),
+				ValidateFunc: validation.StringInSlice([]string{"AWSLambda", "Azure", "Datadog", "HipChat", "PagerDuty", "Slack", "Webhook", "NewRelic", "Jira", "Opsgenie", "MicrosoftTeams", "ServiceNow"}, false),
 				Default:      "Webhook",
 			},
+			"connection_subtype": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				ValidateFunc: validation.StringInSlice([]string{"Incident", "Event"}, false),
+			},
 		},
 	}
 }
@@ -136,6 +141,7 @@ func resourceSumologicConnectionRead(d *schema.ResourceData, meta interface{}) e
 	}
 	d.Set("default_payload", connection.DefaultPayload)
 	d.Set("webhook_type", connection.WebhookType)
+	d.Set("connection_subtype", connection.ConnectionSubtype)
 	d.SetId(connection.ID)
 
 	log.Println("====End Connection Read====")
@@ -201,6 +207,7 @@ func resourceToConnection(d *schema.ResourceData) Connection {
 	connection.CustomHeaders = mapToHeaders(d.Get("custom_headers").(map[string]interface{}))
 	connection.DefaultPayload = d.Get("default_payload").(string)
 	connection.WebhookType = d.Get("webhook_type").(string)
+	connection.ConnectionSubtype = d.Get("connection_subtype").(string)
 
 	return connection
 }
@@ -233,4 +240,5 @@ func printConnection(connection Connection) {
 	log.Printf("CustomHeaders: %s", connection.CustomHeaders)
 	log.Printf("DefaultPayload: %s", connection.DefaultPayload)
 	log.Printf("WebhookType: %s", connection.WebhookType)
+	log.Printf("ConnectionSubtype: %s", connection.ConnectionSubtype)
 }

sumologic/resource_sumologic_connection_test.go

@@ -42,6 +42,40 @@ func TestAccConnection_create(t *testing.T) {
 	})
 }
 
+func TestAccConnection_createServiceNowWebhook(t *testing.T) {
+	connectionType := "WebhookConnection"
+	name := acctest.RandomWithPrefix("tf-servicenow-webhook-connection-test-name")
+	description := acctest.RandomWithPrefix("tf-servicenow-webhook-connection-test-description")
+	url := "https://example.com"
+	defaultPayload := "{\"eventType\" : \"{{Name}}\"}"
+	webhookType := "ServiceNow"
+	connectionSubtype := "Incident"
+
+	var connection Connection
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckConnectionDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: createServiceNowWebhookConnectionConfig(name, connectionType, description, url, connectionSubtype, defaultPayload),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckConnectionExists("sumologic_connection.serviceNowTest", &connection, t),
+					testAccCheckConnectionAttributes("sumologic_connection.serviceNowTest"),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "type", connectionType),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "name", name),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "description", description),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "url", url),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "default_payload", defaultPayload+"\n"),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "webhook_type", webhookType),
+					resource.TestCheckResourceAttr("sumologic_connection.serviceNowTest", "connection_subtype", connectionSubtype),
+				),
+			},
+		},
+	})
+}
+
 func TestAccConnection_update(t *testing.T) {
 	var connection Connection
 	connectionType := "WebhookConnection"
@@ -151,3 +185,19 @@ JSON
 }
 `, name, connectionType, desc, url, webhookType, defaultPayload)
 }
+
+func createServiceNowWebhookConnectionConfig(name, connectionType, desc, url, connectionSubtype, defaultPayload string) string {
+	return fmt.Sprintf(`
+resource "sumologic_connection" "serviceNowTest" {
+	name = "%s"
+	type = "%s"
+	description = "%s"
+	url = "%s"
+	webhook_type = "ServiceNow"
+	connection_subtype = "%s"
+	default_payload = <<JSON
+%s
+JSON
+}
+`, name, connectionType, desc, url, connectionSubtype, defaultPayload)
+}

sumologic/resource_sumologic_monitors_library_monitor.go

@@ -149,7 +149,7 @@ func resourceSumologicMonitorsLibraryMonitor() *schema.Resource {
 										Type:         schema.TypeString,
 										Optional:     true,
 										Computed:     true,
-										ValidateFunc: validation.StringInSlice([]string{"Email", "AWSLambda", "AzureFunctions", "Datadog", "HipChat", "Jira", "NewRelic", "Opsgenie", "PagerDuty", "Slack", "MicrosoftTeams", "Webhook"}, false),
+										ValidateFunc: validation.StringInSlice([]string{"Email", "AWSLambda", "AzureFunctions", "Datadog", "HipChat", "Jira", "NewRelic", "Opsgenie", "PagerDuty", "Slack", "MicrosoftTeams", "ServiceNow", "Webhook"}, false),
 									},
 									"subject": {
 										Type:     schema.TypeString,

sumologic/sumologic_client.go

@@ -351,15 +351,16 @@ type Content struct {
 
 // Connection is used to describe a connection.
 type Connection struct {
-	ID             string    `json:"id,omitempty"`
-	Type           string    `json:"type"`
-	Name           string    `json:"name"`
-	Description    string    `json:"description,omitempty"`
-	URL            string    `json:"url"`
-	Headers        []Headers `json:"headers,omitempty"`
-	CustomHeaders  []Headers `json:"customHeaders,omitempty"`
-	DefaultPayload string    `json:"defaultPayload"`
-	WebhookType    string    `json:"webhookType"`
+	ID                string    `json:"id,omitempty"`
+	Type              string    `json:"type"`
+	Name              string    `json:"name"`
+	Description       string    `json:"description,omitempty"`
+	URL               string    `json:"url"`
+	Headers           []Headers `json:"headers,omitempty"`
+	CustomHeaders     []Headers `json:"customHeaders,omitempty"`
+	DefaultPayload    string    `json:"defaultPayload"`
+	WebhookType       string    `json:"webhookType"`
+	ConnectionSubtype string    `json:"connectionSubtype,omitempty"`
 }
 
 // Headers is used to describe headers for http requests.

website/docs/r/connection.html.markdown

@@ -48,7 +48,8 @@ The following arguments are supported:
 - `headers` - (Optional) Map of access authorization headers.
 - `custom_headers` - (Optional) Map of custom webhook headers
 - `default_payload` - (Required) Default payload of the webhook.
-- `webhook_type` - (Optional) Type of webhook. Valid values are `AWSLambda`, `Azure`, `Datadog`, `HipChat`, `PagerDuty`, `Slack`, `Webhook`, `NewRelic`, and `MicrosoftTeams`. Default: `Webhook`
+- `connection_subtype` - (Optional) The subtype of the connection. Valid values are `Incident` and `Event`. NOTE: This is only used for the `ServiceNow` webhook type.
+- `webhook_type` - (Optional) Type of webhook. Valid values are `AWSLambda`, `Azure`, `Datadog`, `HipChat`, `PagerDuty`, `Slack`, `Webhook`, `NewRelic`, `MicrosoftTeams`, and `ServiceNow`. Default: `Webhook`
 
 Additional data provided in state