feat: Add support for ServiceNow Alert custom JSON template (#78)

* feat: Add support for ServiceNow Alert custom JSON template

Signed-off-by: Darren Murray <darren.murray@lacework.net>

examples/resource_lacework_alert_channel_service_now/main.tf

@@ -5,4 +5,10 @@ resource "lacework_alert_channel_service_now" "example" {
   instance_url = "snow-lacework.com"
   username     = "snow-user"
   password     = "snow-pass"
+  custom_template_file = <<TEMPLATE
+  {
+    "description" : "Generated by Lacework:",
+    "approval" : "Approved"
+  }
+  TEMPLATE
 }

go.mod

@@ -14,7 +14,7 @@ require (
 	github.com/hashicorp/terraform-plugin-sdk v1.16.0
 	github.com/hashicorp/terraform-svchost v0.0.0-20191119180714-d2e4933b9136 // indirect
 	github.com/hashicorp/yamux v0.0.0-20200609203250-aecfd211c9ce // indirect
-	github.com/lacework/go-sdk v0.2.20-0.20210219142651-0e9f6f57e16e
+	github.com/lacework/go-sdk v0.2.21-0.20210224193400-129bc2861f7b
 	github.com/mattn/go-colorable v0.1.7 // indirect
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/mitchellh/go-testing-interface v1.14.1 // indirect

go.sum

@@ -339,6 +339,8 @@ github.com/lacework/go-sdk v0.2.20-0.20210219030740-d7242b84a525 h1:AWsfiGWpdtok
 github.com/lacework/go-sdk v0.2.20-0.20210219030740-d7242b84a525/go.mod h1:yiEjWVHT4TjkZZ1pa9eS8fIfnnoVuzj1VNTIVEIsSKE=
 github.com/lacework/go-sdk v0.2.20-0.20210219142651-0e9f6f57e16e h1:I5iMG4s/y2fgai7f6QXPJv0HqvjObYTKPO1LkgHiJQY=
 github.com/lacework/go-sdk v0.2.20-0.20210219142651-0e9f6f57e16e/go.mod h1:yiEjWVHT4TjkZZ1pa9eS8fIfnnoVuzj1VNTIVEIsSKE=
+github.com/lacework/go-sdk v0.2.21-0.20210224193400-129bc2861f7b h1:nJVvyGiuUGQmHCkdFLksxCJIio7R8aAhSCBKPgDA56A=
+github.com/lacework/go-sdk v0.2.21-0.20210224193400-129bc2861f7b/go.mod h1:yiEjWVHT4TjkZZ1pa9eS8fIfnnoVuzj1VNTIVEIsSKE=
 github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
 github.com/magiconair/properties v1.8.1/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=

lacework/resource_lacework_alert_channel_service_now.go

@@ -63,6 +63,10 @@ func resourceLaceworkAlertChannelServiceNow() *schema.Resource {
 					}
 				},
 			},
+			"custom_template_file": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
 			"created_or_updated_time": {
 				Type:     schema.TypeString,
 				Computed: true,
@@ -85,16 +89,21 @@ func resourceLaceworkAlertChannelServiceNow() *schema.Resource {
 
 func resourceLaceworkAlertChannelServiceNowCreate(d *schema.ResourceData, meta interface{}) error {
 	var (
-		lacework   = meta.(*api.Client)
-		serviceNow = api.NewServiceNowAlertChannel(d.Get("name").(string),
-			api.ServiceNowChannelData{
-				InstanceURL:   d.Get("instance_url").(string),
-				Username:      d.Get("username").(string),
-				Password:      d.Get("password").(string),
-				IssueGrouping: d.Get("issue_grouping").(string),
-			},
-		)
+		lacework           = meta.(*api.Client)
+		customTemplateJSON = d.Get("custom_template_file").(string)
+		snowData           = api.ServiceNowChannelData{
+			InstanceURL:   d.Get("instance_url").(string),
+			Username:      d.Get("username").(string),
+			Password:      d.Get("password").(string),
+			IssueGrouping: d.Get("issue_grouping").(string),
+		}
 	)
+
+	if len(customTemplateJSON) != 0 {
+		snowData.EncodeCustomTemplateFile(customTemplateJSON)
+	}
+
+	serviceNow := api.NewServiceNowAlertChannel(d.Get("name").(string), snowData)
 	if !d.Get("enabled").(bool) {
 		serviceNow.Enabled = 0
 	}
@@ -159,17 +168,21 @@ func resourceLaceworkAlertChannelServiceNowRead(d *schema.ResourceData, meta int
 
 func resourceLaceworkAlertChannelServiceNowUpdate(d *schema.ResourceData, meta interface{}) error {
 	var (
-		lacework   = meta.(*api.Client)
-		serviceNow = api.NewServiceNowAlertChannel(d.Get("name").(string),
-			api.ServiceNowChannelData{
-				InstanceURL:   d.Get("instance_url").(string),
-				Username:      d.Get("username").(string),
-				Password:      d.Get("password").(string),
-				IssueGrouping: d.Get("issue_grouping").(string),
-			},
-		)
+		lacework           = meta.(*api.Client)
+		customTemplateJSON = d.Get("custom_template_file").(string)
+		snowData           = api.ServiceNowChannelData{
+			InstanceURL:   d.Get("instance_url").(string),
+			Username:      d.Get("username").(string),
+			Password:      d.Get("password").(string),
+			IssueGrouping: d.Get("issue_grouping").(string),
+		}
 	)
 
+	if len(customTemplateJSON) != 0 {
+		snowData.EncodeCustomTemplateFile(customTemplateJSON)
+	}
+
+	serviceNow := api.NewServiceNowAlertChannel(d.Get("name").(string), snowData)
 	if !d.Get("enabled").(bool) {
 		serviceNow.Enabled = 0
 	}

vendor/modules.txt

@@ -281,7 +281,7 @@ github.com/jstemmer/go-junit-report/formatter
 github.com/jstemmer/go-junit-report/parser
 # github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd
 github.com/kevinburke/ssh_config
-# github.com/lacework/go-sdk v0.2.20-0.20210219142651-0e9f6f57e16e
+# github.com/lacework/go-sdk v0.2.21-0.20210224193400-129bc2861f7b
 ## explicit
 github.com/lacework/go-sdk/api
 github.com/lacework/go-sdk/internal/array

website/docs/r/alert_channel_service_now.html.markdown

@@ -31,7 +31,7 @@ The following arguments are supported:
 * `instance_url` - (Required) The ServiceNow instance URL.
 * `username` - (Required) The ServiceNow user name.
 * `password` - (Required) The ServiceNow password.
-* `custom_template_file` - (Optional)  Populate fields in the new ServiceNow incidents with values from a custom template JSON file.
+* `custom_template_file` - (Optional) Populate fields in the ServiceNow incident with values from a custom template JSON file.
 * `issue_grouping` - (Optional) Defines how Lacework compliance events get grouped. Must be one of `Events` or `Resources`. Defaults to `Events`.
 * `enabled` - (Optional) The state of the external integration. Defaults to `true`.