Skip to content

Commit

Permalink
fix(alerts): custom unmarshal alert channel configuration Payload and…
Browse files Browse the repository at this point in the history 
… Headers fields
  • Loading branch information
@sanderblue
sanderblue committed Jan 21, 2020
1 parent 19ef9b4 commit dcc2483
Show file tree
Hide file tree
Showing 3 changed files with 183 additions and 85 deletions.
70 changes: 51 additions & 19 deletions pkg/alerts/alerts_types.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package alerts

import (
"encoding/json"

"github.com/newrelic/newrelic-client-go/internal/serialization"
)

Expand All @@ -20,25 +22,29 @@ type ChannelLinks struct {

// ChannelConfiguration represents a Configuration type within Channels
type ChannelConfiguration struct {
Recipients string `json:"recipients,omitempty"`
IncludeJSONAttachment string `json:"include_json_attachment,omitempty"`
AuthToken string `json:"auth_token,omitempty"`
APIKey string `json:"api_key,omitempty"`
Teams string `json:"teams,omitempty"`
Tags string `json:"tags,omitempty"`
URL string `json:"url,omitempty"`
Channel string `json:"channel,omitempty"`
Key string `json:"key,omitempty"`
RouteKey string `json:"route_key,omitempty"`
ServiceKey string `json:"service_key,omitempty"`
BaseURL string `json:"base_url,omitempty"`
AuthUsername string `json:"auth_username,omitempty"`
AuthPassword string `json:"auth_password,omitempty"`
PayloadType string `json:"payload_type,omitempty"`
Region string `json:"region,omitempty"`
UserID string `json:"user_id,omitempty"`
Payload interface{} `json:"payload,omitempty"` // Note: Can be either an empty string or an object (causes marshal issues)
Headers interface{} `json:"headers,omitempty"` // Note: Can be either an empty string or an object (causes marshal issues)
Recipients string `json:"recipients,omitempty"`
IncludeJSONAttachment string `json:"include_json_attachment,omitempty"`
AuthToken string `json:"auth_token,omitempty"`
APIKey string `json:"api_key,omitempty"`
Teams string `json:"teams,omitempty"`
Tags string `json:"tags,omitempty"`
URL string `json:"url,omitempty"`
Channel string `json:"channel,omitempty"`
Key string `json:"key,omitempty"`
RouteKey string `json:"route_key,omitempty"`
ServiceKey string `json:"service_key,omitempty"`
BaseURL string `json:"base_url,omitempty"`
AuthUsername string `json:"auth_username,omitempty"`
AuthPassword string `json:"auth_password,omitempty"`
PayloadType string `json:"payload_type,omitempty"`
Region string `json:"region,omitempty"`
UserID string `json:"user_id,omitempty"`

// Payload is unmarshaled to type map[string]string
Payload MapStringString `json:"payload,omitempty"`

// Headers is unmarshaled to type map[string]string
Headers MapStringString `json:"headers,omitempty"`
}

// Condition represents a New Relic alert condition.
Expand Down Expand Up @@ -183,3 +189,29 @@ type SyntheticsCondition struct {
RunbookURL string `json:"runbook_url,omitempty"`
MonitorID string `json:"monitor_id,omitempty"`
}

// MapStringString is used for custom unmarshaling of
// fields that have potentially dynamic types.
// E.g. when a field can be a string or an object/map
type MapStringString map[string]string
type mapStringStringProxy MapStringString

// UnmarshalJSON is a custom unmarshal method to guard against
// fields that can have more than one type returned from an API.
func (c *MapStringString) UnmarshalJSON(data []byte) error {
var mapStrStr mapStringStringProxy

// Check for empty JSON string
if string(data) == `""` {
return nil
}

err := json.Unmarshal(data, &mapStrStr)
if err != nil {
return err
}

*c = MapStringString(mapStrStr)

return nil
}
114 changes: 49 additions & 65 deletions pkg/alerts/channels_integration_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
package alerts

import (
"os"
"testing"

"github.com/newrelic/newrelic-client-go/pkg/config"
"github.com/stretchr/testify/require"
)

Expand Down Expand Up @@ -68,33 +66,43 @@ func TestIntegrationChannel(t *testing.T) {
Name: "integration-test-webhook",
Type: "webhook",
Configuration: ChannelConfiguration{
BaseURL: "https://test.com",
AuthUsername: "devtoolkit",
AuthPassword: "123abc",
PayloadType: "application/json",
Payload: map[string]string{
"account_id": "$ACCOUNT_ID",
"account_name": "$ACCOUNT_NAME",
"condition_id": "$CONDITION_ID",
"condition_name": "$CONDITION_NAME",
"current_state": "$EVENT_STATE",
"details": "$EVENT_DETAILS",
"event_type": "$EVENT_TYPE",
"incident_acknowledge_url": "$INCIDENT_ACKNOWLEDGE_URL",
"incident_id": "$INCIDENT_ID",
"incident_url": "$INCIDENT_URL",
"owner": "$EVENT_OWNER",
"policy_name": "$POLICY_NAME",
"policy_url": "$POLICY_URL",
"runbook_url": "$RUNBOOK_URL",
"severity": "$SEVERITY",
"targets": "$TARGETS",
"timestamp": "$TIMESTAMP",
"violation_chart_url": "$VIOLATION_CHART_URL",
},
Headers: map[string]string{
BaseURL: "https://test.com",
PayloadType: "application/json",
Headers: MapStringString{
"x-test-header": "test-header",
},
Payload: MapStringString{
"account_id": "123",
},
},
Links: ChannelLinks{
PolicyIDs: []int{},
},
}

testChannelWebhookEmptyHeadersAndPayload = Channel{
Name: "integration-test-webhook-empty-headers-and-payload",
Type: "webhook",
Configuration: ChannelConfiguration{
BaseURL: "https://test.com",
},
Links: ChannelLinks{
PolicyIDs: []int{},
},
}

testChannelWebhookWeirdHeadersAndPayload = Channel{
Name: "integration-test-webhook-weird-headers-and-payload",
Type: "webhook",
Configuration: ChannelConfiguration{
BaseURL: "https://test.com",
Headers: MapStringString{
"": "",
},
Payload: MapStringString{
"": "",
},
PayloadType: "application/json",
},
Links: ChannelLinks{
PolicyIDs: []int{},
Expand All @@ -107,54 +115,30 @@ func TestIntegrationChannel(t *testing.T) {
testChannelSlack,
testChannelVictorops,
testChannelWebhook,
testChannelWebhookEmptyHeadersAndPayload,
testChannelWebhookWeirdHeadersAndPayload,
}
)

client := newChannelsTestClient(t)
client := newIntegrationTestClient(t)

for _, channel := range channels {
// Test: Create
createResult := testCreateChannel(t, client, channel)

// Test: Read
readResult := testReadChannel(t, client, createResult)

// Test: Delete
testDeleteChannel(t, client, readResult)
}
}

func testCreateChannel(t *testing.T, client Alerts, channel Channel) *Channel {
result, err := client.CreateChannel(channel)

require.NoError(t, err)
created, err := client.CreateChannel(channel)

return result
}

func testReadChannel(t *testing.T, client Alerts, channel *Channel) *Channel {
result, err := client.GetChannel(channel.ID)

require.NoError(t, err)

return result
}
require.NoError(t, err)
require.NotNil(t, created)

func testDeleteChannel(t *testing.T, client Alerts, channel *Channel) {
p := *channel
_, err := client.DeleteChannel(p.ID)
// Test: Read
read, err := client.GetChannel(created.ID)

require.NoError(t, err)
}
require.NoError(t, err)
require.NotNil(t, read)

func newChannelsTestClient(t *testing.T) Alerts {
apiKey := os.Getenv("NEWRELIC_API_KEY")
// Test: Delete
deleted, err := client.DeleteChannel(read.ID)

if apiKey == "" {
t.Skipf("acceptance testing requires an API key")
require.NoError(t, err)
require.NotNil(t, deleted)
}

return New(config.Config{
APIKey: apiKey,
})
}
84 changes: 83 additions & 1 deletion pkg/alerts/channels_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ var (
{
"id": 2932701,
"name": "[email protected]",
"type": "email",
"type": "webhook",
"configuration": {
"include_json_attachment": "true",
"recipients": "[email protected]"
Expand Down Expand Up @@ -75,6 +75,44 @@ var (
"channel.policy_ids": "/v2/policies/{policy_id}"
}
}`

// Tests serialization of `headers` and `payload` fields
testWebhookEmptyHeadersAndPayloadResponseJSON = `{
"channels": [
{
"id": 1,
"name": "webhook-EMPTY-headers-and-payload",
"type": "webhook",
"configuration": {
"base_url": "http://example.com",
"headers": "",
"payload": "",
"payload_type": ""
},
"links": {
"policy_ids": []
}
},
{
"id": 2,
"name": "webhook-WEIRD-headers-and-payload",
"type": "webhook",
"configuration": {
"base_url": "http://example.com",
"headers": {
"": ""
},
"payload": {
"": ""
},
"payload_type": "application/json"
},
"links": {
"policy_ids": []
}
}
]
}`
)

func TestListChannels(t *testing.T) {
Expand Down Expand Up @@ -114,6 +152,50 @@ func TestListChannels(t *testing.T) {
assert.Equal(t, expected, actual)
}

func TestListChannelsWebhookWithEmptyHeadersAndPayload(t *testing.T) {
t.Parallel()
alerts := newMockResponse(t, testWebhookEmptyHeadersAndPayloadResponseJSON, http.StatusOK)

expected := []*Channel{
{
ID: 1,
Name: "webhook-EMPTY-headers-and-payload",
Type: "webhook",
Configuration: ChannelConfiguration{
BaseURL: "http://example.com",
PayloadType: "",
},
Links: ChannelLinks{
PolicyIDs: []int{},
},
},
{
ID: 2,
Name: "webhook-WEIRD-headers-and-payload",
Type: "webhook",
Configuration: ChannelConfiguration{
BaseURL: "http://example.com",
Headers: MapStringString{
"": "",
},
Payload: MapStringString{
"": "",
},
PayloadType: "application/json",
},
Links: ChannelLinks{
PolicyIDs: []int{},
},
},
}

actual, err := alerts.ListChannels()

assert.NoError(t, err)
assert.NotNil(t, actual)
assert.Equal(t, expected, actual)
}

func TestGetChannel(t *testing.T) {
t.Parallel()
alerts := newMockResponse(t, testListChannelsResponseJSON, http.StatusOK)
Expand Down

0 comments on commit dcc2483

Please sign in to comment.