Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ServiceNow extension resource #348

Merged
merged 1 commit into from
Jul 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions pagerduty/import_pagerduty_extension_servicenow_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package pagerduty

import (
"fmt"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
)

func TestAccPagerDutyExtensionServicenow_import(t *testing.T) {
extension_name := fmt.Sprintf("tf-%s", acctest.RandString(5))
name := fmt.Sprintf("tf-%s", acctest.RandString(5))
url := "https://example.com/receive_a_pagerduty_webhook"

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
CheckDestroy: testAccCheckPagerDutyExtensionServicenowDestroy,
Steps: []resource.TestStep{
{
Config: testAccCheckPagerDutyExtensionServicenowConfig(name, extension_name, url, "false", "any"),
},

{
ResourceName: "pagerduty_extension_servicenow.foo",
ImportState: true,
ImportStateVerify: true,
},
},
})
}
1 change: 1 addition & 0 deletions pagerduty/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ func Provider() terraform.ResourceProvider {
"pagerduty_user_contact_method": resourcePagerDutyUserContactMethod(),
"pagerduty_user_notification_rule": resourcePagerDutyUserNotificationRule(),
"pagerduty_extension": resourcePagerDutyExtension(),
"pagerduty_extension_servicenow": resourcePagerDutyExtensionServicenow(),
"pagerduty_event_rule": resourcePagerDutyEventRule(),
"pagerduty_ruleset": resourcePagerDutyRuleset(),
"pagerduty_ruleset_rule": resourcePagerDutyRulesetRule(),
Expand Down
248 changes: 248 additions & 0 deletions pagerduty/resource_pagerduty_extension_servicenow.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
package pagerduty

import (
"encoding/json"
"fmt"
"log"
"time"

"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
"github.com/heimweh/go-pagerduty/pagerduty"
)

type PagerDutyExtensionServicenowConfig struct {
User string `json:"snow_user"`
Password string `json:"snow_password"`
SyncOptions string `json:"sync_options"`
Target string `json:"target"`
TaskType string `json:"task_type"`
Referer string `json:"referer"`
}

func resourcePagerDutyExtensionServicenow() *schema.Resource {
return &schema.Resource{
Create: resourcePagerDutyExtensionServicenowCreate,
Read: resourcePagerDutyExtensionServicenowRead,
Update: resourcePagerDutyExtensionServicenowUpdate,
Delete: resourcePagerDutyExtensionServicenowDelete,
Importer: &schema.ResourceImporter{
State: resourcePagerDutyExtensionServicenowImport,
},
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Optional: true,
Computed: true,
},
"html_url": {
Type: schema.TypeString,
Computed: true,
},
"type": {
Type: schema.TypeString,
Optional: true,
Computed: true,
},
"endpoint_url": {
Type: schema.TypeString,
Optional: true,
Sensitive: true,
},
"extension_objects": {
Type: schema.TypeSet,
Required: true,
ForceNew: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"extension_schema": {
Type: schema.TypeString,
ForceNew: true,
Required: true,
},
"snow_user": {
Type: schema.TypeString,
Required: true,
},
"snow_password": {
Type: schema.TypeString,
Required: true,
Sensitive: true,
},
"sync_options": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"manual_sync", "sync_all"}, false),
},
"target": {
Type: schema.TypeString,
Required: true,
},
"task_type": {
Type: schema.TypeString,
Required: true,
},
"referer": {
Type: schema.TypeString,
Required: true,
},
},
}
}

func buildExtensionServicenowStruct(d *schema.ResourceData) *pagerduty.Extension {
Extension := &pagerduty.Extension{
Name: d.Get("name").(string),
Type: "extension",
EndpointURL: d.Get("endpoint_url").(string),
ExtensionSchema: &pagerduty.ExtensionSchemaReference{
Type: "extension_schema_reference",
ID: d.Get("extension_schema").(string),
},
ExtensionObjects: expandServiceNowServiceObjects(d.Get("extension_objects")),
}

var config = &PagerDutyExtensionServicenowConfig{
User: d.Get("snow_user").(string),
Password: d.Get("snow_password").(string),
SyncOptions: d.Get("sync_options").(string),
Target: d.Get("target").(string),
TaskType: d.Get("task_type").(string),
Referer: d.Get("referer").(string),
}
Extension.Config = config

return Extension
}

func resourcePagerDutyExtensionServicenowCreate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*pagerduty.Client)

extension := buildExtensionServicenowStruct(d)

log.Printf("[INFO] Creating PagerDuty extension %s", extension.Name)

extension, _, err := client.Extensions.Create(extension)
if err != nil {
return err
}

d.SetId(extension.ID)

return resourcePagerDutyExtensionServicenowRead(d, meta)
}

func resourcePagerDutyExtensionServicenowRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*pagerduty.Client)

log.Printf("[INFO] Reading PagerDuty extension %s", d.Id())

return resource.Retry(2*time.Minute, func() *resource.RetryError {
extension, _, err := client.Extensions.Get(d.Id())
if err != nil {
errResp := handleNotFoundError(err, d)
if errResp != nil {
time.Sleep(2 * time.Second)
return resource.RetryableError(errResp)
}

return nil
}

d.Set("summary", extension.Summary)
d.Set("name", extension.Name)
d.Set("endpoint_url", extension.EndpointURL)
d.Set("html_url", extension.HTMLURL)
if err := d.Set("extension_objects", flattenExtensionServicenowObjects(extension.ExtensionObjects)); err != nil {
log.Printf("[WARN] error setting extension_objects: %s", err)
}
d.Set("extension_schema", extension.ExtensionSchema)

b, _ := json.Marshal(extension.Config)
var config = new(PagerDutyExtensionServicenowConfig)
json.Unmarshal(b, config)
d.Set("snow_user", config.User)
d.Set("snow_password", config.Password)
d.Set("sync_options", config.SyncOptions)
d.Set("target", config.Target)
d.Set("task_type", config.TaskType)
d.Set("referer", config.Referer)

return nil
})
}

func resourcePagerDutyExtensionServicenowUpdate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*pagerduty.Client)

extension := buildExtensionServicenowStruct(d)

log.Printf("[INFO] Updating PagerDuty extension %s", d.Id())

if _, _, err := client.Extensions.Update(d.Id(), extension); err != nil {
return err
}

return resourcePagerDutyExtensionServicenowRead(d, meta)
}

func resourcePagerDutyExtensionServicenowDelete(d *schema.ResourceData, meta interface{}) error {
client := meta.(*pagerduty.Client)

log.Printf("[INFO] Deleting PagerDuty extension %s", d.Id())

if _, err := client.Extensions.Delete(d.Id()); err != nil {
if perr, ok := err.(*pagerduty.Error); ok && perr.Code == 5001 {
log.Printf("[WARN] Extension (%s) not found, removing from state", d.Id())
return nil
}
return err
}

d.SetId("")

return nil
}

func resourcePagerDutyExtensionServicenowImport(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
client := meta.(*pagerduty.Client)

extension, _, err := client.Extensions.Get(d.Id())

if err != nil {
return []*schema.ResourceData{}, fmt.Errorf("error importing pagerduty_extension. Expecting an importation ID for extension")
}

d.Set("endpoint_url", extension.EndpointURL)
d.Set("extension_objects", []string{extension.ExtensionObjects[0].ID})
d.Set("extension_schema", extension.ExtensionSchema.ID)

return []*schema.ResourceData{d}, err
}

func expandServiceNowServiceObjects(v interface{}) []*pagerduty.ServiceReference {
var services []*pagerduty.ServiceReference

for _, srv := range v.(*schema.Set).List() {
service := &pagerduty.ServiceReference{
Type: "service_reference",
ID: srv.(string),
}
services = append(services, service)
}

return services
}

func flattenExtensionServicenowObjects(serviceList []*pagerduty.ServiceReference) interface{} {
var services []interface{}
for _, s := range serviceList {
// only flatten service_reference types, because that's all we send at this
// time
if s.Type == "service_reference" {
services = append(services, s.ID)
}
}
return services
}
Loading