Skip to content

Commit

Permalink
Refactored to match PR #241 style
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sjeanpierre
Sjeanpierre committed Oct 19, 2020
1 parent 6c5deba commit ee63a20
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 66 deletions.
68 changes: 34 additions & 34 deletions change_events.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,73 +3,73 @@ package pagerduty
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"strings"
"time"
"errors"
)

const EventsEndPoint = "https://events.pagerduty.com"
const ChangeEventPath = "v2/change/enqueue"
const ChangeEventPath = "/v2/change/enqueue"

// ChangeEvent represents a ChangeEvent's request parameters
// https://developer.pagerduty.com/docs/events-api-v2/send-change-events/#parameters
type ChangeEvent struct {
RoutingKey string `json:"routing_key"`
Payload Payload `json:"payload"`
Links []Link `json:"links"`
}

// Payload ChangeEvent Payload
// https://developer.pagerduty.com/docs/events-api-v2/send-change-events/#example-request-payload
type Payload struct {
Source string `json:"source"`
Summary string `json:"summary"`
Timestamp time.Time `json:"time"`
TimestampString string `json:"timestamp"`
CustomDetails map[string]string `json:"custom_details"`
Source string `json:"source"`
Summary string `json:"summary"`
Timestamp string `json:"timestamp"`
CustomDetails map[string]string `json:"custom_details"`
}

// Link represents a single link in a ChangeEvent
// https://developer.pagerduty.com/docs/events-api-v2/send-change-events/#the-links-property
type Link struct {
Href string `json:"href"`
Text string `json:"text"`
}

// Response is the json response body for an event
// ChangeEventResponse is the json response body for an event
type ChangeEventResponse struct {
Status string `json:"status,omitempty"`
Message string `json:"message,omitempty"`
Errors []string `json:"errors,omitempty"`
}

// ManageEvent handles the trigger, acknowledge, and resolve methods for an event
func (c *Client) SendChangeEvent(e ChangeEvent) (*ChangeEventResponse, error) {
//PagerDuty expects RFC3339 formatted timestamp so we do the conversion here
e.Payload.TimestampString = e.Payload.Timestamp.Format(time.RFC3339)
// CreateChangeEvent Sends PagerDuty a single ChangeEvent to record
// The v2EventsAPIEndpoint parameter must be set on the client
// Documentation can be found at https://developer.pagerduty.com/docs/events-api-v2/send-change-events
func (c *Client) CreateChangeEvent(e ChangeEvent) (*ChangeEventResponse, error) {
if c.v2EventsAPIEndpoint == "" {
return nil, errors.New("v2EventsAPIEndpoint field must be set on Client")
}

headers := make(map[string]string)

data, err := json.Marshal(e)
if err != nil {
return nil, err
}
//Allows custom endpoints to be passed in from the http client for testing and future customer needs
endPoint := strings.Join([]string{EventsEndPoint, ChangeEventPath}, "/")
if c.apiEndpoint != "https://api.pagerduty.com" {
endPoint = strings.Join([]string{c.apiEndpoint, ChangeEventPath}, "/")
}
req, _ := http.NewRequest("POST", endPoint, bytes.NewBuffer(data))
req.Header.Set("User-Agent", "go-pagerduty/"+Version)
req.Header.Set("Content-Type", "application/json")
resp, err := c.HTTPClient.Do(req)

resp, err := c.doWithEndpoint(
c.v2EventsAPIEndpoint,
"POST",
ChangeEventPath,
false,
bytes.NewBuffer(data),
&headers,
)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusAccepted {
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("HTTP Status Code: %d", resp.StatusCode)
}
return nil, fmt.Errorf("HTTP Status Code: %d, Message: %s", resp.StatusCode, string(b))
}

var eventResponse ChangeEventResponse
if err := json.NewDecoder(resp.Body).Decode(&eventResponse); err != nil {
return nil, err
}

return &eventResponse, nil
}
88 changes: 56 additions & 32 deletions change_events_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,34 @@ import (
"io/ioutil"
"net/http"
"testing"
"time"
)

var reqBody = `{"routing_key":"a0000000aa0000a0a000aa0a0a0aa000","payload":{"source":"Test runner",` +
`"summary":"Summary can't be blank","time":"2020-10-09T18:53:40.635779-04:00",` +
`"timestamp":"2020-10-09T18:53:40-04:00","custom_details":{"DetailKey1":"DetailValue1",` +
`"DetailKey2":"DetailValue2"}},"links":[{"href":"https://acme.pagerduty.dev/build/2",` +
`"text":"View more details in Acme!"},{"href":"https://acme2.pagerduty.dev/build/2",` +
`"text":"View more details in Acme2!"}]}`
const (
expectedChangeCreatePayload = `{"routing_key":"a0000000aa0000a0a000aa0a0a0aa000","payload":{"source":"Test runner",` +
`"summary":"Summary can't be blank","timestamp":"2020-10-19T03:06:16.318Z",` +
`"custom_details":{"DetailKey1":"DetailValue1","DetailKey2":"DetailValue2"}},` +
`"links":[{"href":"https://acme.pagerduty.dev/build/2","text":"View more details in Acme!"},` +
`{"href":"https://acme2.pagerduty.dev/build/2","text":"View more details in Acme2!"}]}`
)

func TestClient_SendChangeEvent(t *testing.T) {
func TestChangeEvent_Create(t *testing.T) {
setup()
defer teardown()

mux.HandleFunc("/v2/change/enqueue", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "POST")
w.WriteHeader(http.StatusAccepted)
w.Write([]byte(`{"message": "Change event processed", "status": "success"}`))
})
mux.HandleFunc(
"/v2/change/enqueue", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "POST")
w.WriteHeader(http.StatusAccepted)
w.Write([]byte(`{"message": "Change event processed", "status": "success"}`))
},
)

var client = &Client{apiEndpoint: server.URL, authToken: "foo", HTTPClient: defaultHTTPClient}
var client = &Client{
v2EventsAPIEndpoint: server.URL,
apiEndpoint: server.URL,
authToken: "foo",
HTTPClient: defaultHTTPClient,
}

want := ChangeEventResponse{
Status: "success",
Expand All @@ -34,7 +41,12 @@ func TestClient_SendChangeEvent(t *testing.T) {
eventDetails := map[string]string{"DetailKey1": "DetailValue1", "DetailKey2": "DetailValue2"}
ce := ChangeEvent{
RoutingKey: "a0000000aa0000a0a000aa0a0a0aa000",
Payload: Payload{Source: "Test runner", Summary: "Summary can't be blank", Timestamp: time.Now(), CustomDetails: eventDetails},
Payload: Payload{
Source: "Test runner",
Summary: "Summary can't be blank",
Timestamp: "2020-10-19T03:06:16.318Z",
CustomDetails: eventDetails,
},
Links: []Link{
{
Href: "https://acme.pagerduty.dev/build/2",
Expand All @@ -43,38 +55,49 @@ func TestClient_SendChangeEvent(t *testing.T) {
{
Href: "https://acme2.pagerduty.dev/build/2",
Text: "View more details in Acme2!",
}},
},
},
}

res, err := client.SendChangeEvent(ce)
res, err := client.CreateChangeEvent(ce)

if err != nil {
t.Fatal(err)
}
testEqual(t, want, *res)
}

func TestClient_SendChangeEventContent(t *testing.T) {
func TestChangeEvent_CreateWithPayloadVerification(t *testing.T) {
setup()
defer teardown()

mux.HandleFunc("/v2/change/enqueue", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "POST")
body, err := ioutil.ReadAll(r.Body)
if err != nil {
t.Fatal(err)
}
testEqual(t, reqBody, string(body))
})
mux.HandleFunc(
"/v2/change/enqueue", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "POST")
body, err := ioutil.ReadAll(r.Body)
if err != nil {
t.Fatal(err)
}
testEqual(t, expectedChangeCreatePayload, string(body))
},
)

var client = &Client{apiEndpoint: server.URL, authToken: "foo", HTTPClient: defaultHTTPClient}
var client = &Client{
v2EventsAPIEndpoint: server.URL,
apiEndpoint: server.URL,
authToken: "foo",
HTTPClient: defaultHTTPClient,
}

eventDetails := map[string]string{"DetailKey1": "DetailValue1", "DetailKey2": "DetailValue2"}
ts, _ := time.Parse(time.RFC3339, "2020-10-09T18:53:40.635779-04:00")
ce := ChangeEvent{
RoutingKey: "a0000000aa0000a0a000aa0a0a0aa000",
Payload: Payload{Source: "Test runner", Summary: "Summary can't be blank",
Timestamp: ts, CustomDetails: eventDetails},
Payload: Payload{
Source: "Test runner",
Summary: "Summary can't be blank",
Timestamp: "2020-10-19T03:06:16.318Z",
CustomDetails: eventDetails,
},
Links: []Link{
{
Href: "https://acme.pagerduty.dev/build/2",
Expand All @@ -83,9 +106,10 @@ func TestClient_SendChangeEventContent(t *testing.T) {
{
Href: "https://acme2.pagerduty.dev/build/2",
Text: "View more details in Acme2!",
}},
},
},
}

_, _ = client.SendChangeEvent(ce)
_, _ = client.CreateChangeEvent(ce)

}

0 comments on commit ee63a20

Please sign in to comment.