influxdb/notification/endpoint/testing/service.go

1710 lines
45 KiB
Go

package testing
import (
"context"
"fmt"
"net/http"
"sort"
"strings"
"testing"
"time"
"github.com/google/go-cmp/cmp"
influxdb "github.com/influxdata/influxdb/v2"
"github.com/influxdata/influxdb/v2/mock"
"github.com/influxdata/influxdb/v2/notification/endpoint"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
const (
oneID = influxdb.ID(iota + 1)
twoID
threeID
fourID
fiveID
sixID
)
var (
fakeDate = time.Date(2006, 5, 4, 1, 2, 3, 0, time.UTC)
fakeGenerator = mock.TimeGenerator{FakeValue: fakeDate}
timeGen1 = mock.TimeGenerator{FakeValue: time.Date(2006, time.July, 13, 4, 19, 10, 0, time.UTC)}
timeGen2 = mock.TimeGenerator{FakeValue: time.Date(2006, time.July, 14, 5, 23, 53, 10, time.UTC)}
)
// NotificationEndpointFields includes prepopulated data for mapping tests.
type NotificationEndpointFields struct {
IDGenerator influxdb.IDGenerator
TimeGenerator influxdb.TimeGenerator
NotificationEndpoints []influxdb.NotificationEndpoint
Orgs []*influxdb.Organization
}
var notificationEndpointCmpOptions = cmp.Options{
cmp.Transformer("Sort", func(in []influxdb.NotificationEndpoint) []influxdb.NotificationEndpoint {
out := append([]influxdb.NotificationEndpoint(nil), in...)
sort.Slice(out, func(i, j int) bool {
return out[i].GetID() > out[j].GetID()
})
return out
}),
}
// NotificationEndpointService tests all the service functions.
func NotificationEndpointService(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()), t *testing.T,
) {
tests := []struct {
name string
fn func(init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T)
}{
{
name: "CreateNotificationEndpoint",
fn: CreateNotificationEndpoint,
},
{
name: "FindNotificationEndpointByID",
fn: FindNotificationEndpointByID,
},
{
name: "FindNotificationEndpoints",
fn: FindNotificationEndpoints,
},
{
name: "UpdateNotificationEndpoint",
fn: UpdateNotificationEndpoint,
},
{
name: "PatchNotificationEndpoint",
fn: PatchNotificationEndpoint,
},
{
name: "DeleteNotificationEndpoint",
fn: DeleteNotificationEndpoint,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt := tt
t.Parallel()
tt.fn(init, t)
})
}
}
// CreateNotificationEndpoint testing.
func CreateNotificationEndpoint(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T,
) {
type args struct {
notificationEndpoint influxdb.NotificationEndpoint
userID influxdb.ID
}
type wants struct {
err error
notificationEndpoints []influxdb.NotificationEndpoint
}
tests := []struct {
name string
fields NotificationEndpointFields
args args
wants wants
}{
{
name: "basic create notification endpoint",
fields: NotificationEndpointFields{
IDGenerator: mock.NewStaticIDGenerator(twoID),
TimeGenerator: fakeGenerator,
Orgs: []*influxdb.Organization{
{ID: fourID, Name: "org1"},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{},
},
args: args{
userID: sixID,
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{
Value: strPtr("pagerduty secret2"),
},
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: fakeDate,
UpdatedAt: fakeDate,
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{
Key: fmt.Sprintf("%s-routing-key", twoID),
},
},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s, secretSVC, done := init(tt.fields, t)
defer done()
ctx := context.Background()
err := s.CreateNotificationEndpoint(ctx, tt.args.notificationEndpoint, tt.args.userID)
ErrorsEqual(t, err, tt.wants.err)
filter := influxdb.NotificationEndpointFilter{}
edps, _, err := s.FindNotificationEndpoints(ctx, filter)
if err != nil {
t.Fatalf("failed to retrieve notification endpoints: %v", err)
}
if diff := cmp.Diff(edps, tt.wants.notificationEndpoints, notificationEndpointCmpOptions...); diff != "" {
t.Errorf("notificationEndpoints are different -got/+want\ndiff %s", diff)
}
for _, edp := range tt.wants.notificationEndpoints {
secrets, err := secretSVC.GetSecretKeys(ctx, edp.GetOrgID())
if err != nil {
t.Errorf("failed to retrieve secrets for endpoint: %v", err)
}
for _, expected := range edp.SecretFields() {
assert.Contains(t, secrets, expected.Key)
}
}
})
}
}
// FindNotificationEndpointByID testing.
func FindNotificationEndpointByID(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T,
) {
type args struct {
id influxdb.ID
}
type wants struct {
err *influxdb.Error
notificationEndpoint influxdb.NotificationEndpoint
}
tests := []struct {
name string
fields NotificationEndpointFields
args args
wants wants
}{
{
name: "bad id",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{
Key: fmt.Sprintf("%s-token", oneID),
},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{
Key: fmt.Sprintf("%s-routing-key", twoID),
},
},
},
},
args: args{
id: influxdb.ID(0),
},
wants: wants{
err: &influxdb.Error{
Code: influxdb.EInvalid,
Msg: "no key was provided for notification endpoint",
},
},
},
{
name: "not found",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: threeID,
},
wants: wants{
err: &influxdb.Error{
Code: influxdb.ENotFound,
Msg: "notification endpoint not found",
},
},
},
{
name: "basic find telegraf config by id",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: twoID,
},
wants: wants{
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s, _, done := init(tt.fields, t)
defer done()
ctx := context.Background()
edp, err := s.FindNotificationEndpointByID(ctx, tt.args.id)
influxErrsEqual(t, tt.wants.err, err)
if diff := cmp.Diff(edp, tt.wants.notificationEndpoint, notificationEndpointCmpOptions...); diff != "" {
t.Errorf("notification endpoint is different -got/+want\ndiff %s", diff)
}
})
}
}
// FindNotificationEndpoints testing
func FindNotificationEndpoints(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T,
) {
type args struct {
filter influxdb.NotificationEndpointFilter
opts influxdb.FindOptions
}
type wants struct {
notificationEndpoints []influxdb.NotificationEndpoint
err error
}
tests := []struct {
name string
fields NotificationEndpointFields
args args
wants wants
}{
{
name: "find nothing (empty set)",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{},
},
args: args{
filter: influxdb.NotificationEndpointFilter{},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{},
},
},
{
name: "find all notification endpoints",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
},
{
name: "filter by organization id only",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(oneID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty2.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
OrgID: idPtr(oneID),
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(oneID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty2.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
},
{
name: "find options limit",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fiveID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp4",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
Org: strPtr("org4"),
},
opts: influxdb.FindOptions{
Limit: 2,
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
},
},
},
{
name: "find options offset",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
Org: strPtr("org4"),
},
opts: influxdb.FindOptions{
Offset: 1,
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
},
{
name: "find options offset",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
Org: strPtr("org4"),
},
opts: influxdb.FindOptions{
Limit: 1,
Offset: 1,
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
},
},
},
{
name: "find by id",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(oneID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
ID: idPtr(fourID),
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(fourID),
OrgID: idPtr(oneID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", fourID)},
},
},
},
},
{
name: "look for organization not bound to any notification endpoint",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(threeID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", threeID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
OrgID: idPtr(oneID),
},
},
wants: wants{
notificationEndpoints: []influxdb.NotificationEndpoint{},
},
},
{
name: "find nothing",
fields: NotificationEndpointFields{
Orgs: []*influxdb.Organization{
{
ID: oneID,
Name: "org1",
},
{
ID: fourID,
Name: "org4",
},
},
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp1",
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.HTTP{
Base: endpoint.Base{
ID: idPtr(twoID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp2",
},
URL: "example-webhook.com",
Method: http.MethodGet,
AuthMethod: "none",
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(threeID),
OrgID: idPtr(fourID),
Status: influxdb.Active,
Name: "edp3",
},
ClientURL: "example-pagerduty.com", RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", threeID)},
},
},
},
args: args{
filter: influxdb.NotificationEndpointFilter{
ID: idPtr(fiveID),
},
},
wants: wants{},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s, _, done := init(tt.fields, t)
defer done()
ctx := context.Background()
edps, n, err := s.FindNotificationEndpoints(ctx, tt.args.filter, tt.args.opts)
ErrorsEqual(t, err, tt.wants.err)
if n != len(tt.wants.notificationEndpoints) {
t.Fatalf("notification endpoints length is different got %d, want %d", n, len(tt.wants.notificationEndpoints))
}
if diff := cmp.Diff(edps, tt.wants.notificationEndpoints, notificationEndpointCmpOptions...); diff != "" {
t.Errorf("notification endpoints are different -got/+want\ndiff %s", diff)
}
})
}
}
// UpdateNotificationEndpoint testing.
func UpdateNotificationEndpoint(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T,
) {
type args struct {
userID influxdb.ID
orgID influxdb.ID
id influxdb.ID
notificationEndpoint influxdb.NotificationEndpoint
}
type wants struct {
notificationEndpoint influxdb.NotificationEndpoint
err *influxdb.Error
}
tests := []struct {
name string
fields NotificationEndpointFields
args args
wants wants
}{
{
name: "can't find the id",
fields: NotificationEndpointFields{
TimeGenerator: fakeGenerator,
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com", RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
userID: sixID,
id: fourID,
orgID: fourID,
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Inactive,
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: "pager-duty-routing-key-2"},
},
},
wants: wants{
err: &influxdb.Error{
Code: influxdb.ENotFound,
Msg: `notification endpoint not found for key "0000000000000004"`,
},
},
},
{
name: "regular update",
fields: NotificationEndpointFields{
TimeGenerator: fakeGenerator,
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com", RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
userID: sixID,
id: twoID,
orgID: fourID,
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name3",
OrgID: idPtr(fourID),
Status: influxdb.Inactive,
},
ClientURL: "example-pagerduty2.com",
RoutingKey: influxdb.SecretField{Value: strPtr("secret value")},
},
},
wants: wants{
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name3",
OrgID: idPtr(fourID),
Status: influxdb.Inactive,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: fakeDate,
},
},
ClientURL: "example-pagerduty2.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
{
name: "update secret",
fields: NotificationEndpointFields{
TimeGenerator: fakeGenerator,
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
userID: sixID,
id: twoID,
orgID: fourID,
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name3",
OrgID: idPtr(fourID),
Status: influxdb.Inactive,
},
ClientURL: "example-pagerduty2.com",
RoutingKey: influxdb.SecretField{
Value: strPtr("pager-duty-value2"),
},
},
},
wants: wants{
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name3",
OrgID: idPtr(fourID),
Status: influxdb.Inactive,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: fakeDate,
},
},
ClientURL: "example-pagerduty2.com",
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s, secretSVC, done := init(tt.fields, t)
defer done()
ctx := context.Background()
edp, err := s.UpdateNotificationEndpoint(ctx, tt.args.id, tt.args.notificationEndpoint, tt.args.userID)
if err != nil {
require.Equal(t, tt.wants.err, err)
return
}
if tt.wants.notificationEndpoint != nil {
secrets, err := secretSVC.GetSecretKeys(ctx, edp.GetOrgID())
if err != nil {
t.Errorf("failed to retrieve secrets for endpoint: %v", err)
}
for _, actual := range edp.SecretFields() {
assert.Contains(t, secrets, actual.Key)
}
actual, ok := edp.(*endpoint.PagerDuty)
require.Truef(t, ok, "did not get a pager duty endpoint; got: %#v", edp)
wanted := tt.wants.notificationEndpoint.(*endpoint.PagerDuty)
wb, ab := wanted.Base, actual.Base
require.NotZero(t, ab.CRUDLog)
wb.CRUDLog, ab.CRUDLog = influxdb.CRUDLog{}, influxdb.CRUDLog{} // zero out times
assert.Equal(t, wb, ab)
assert.Equal(t, wanted.ClientURL, actual.ClientURL)
assert.NotEqual(t, wanted.RoutingKey, actual.RoutingKey)
}
})
}
}
// PatchNotificationEndpoint testing.
func PatchNotificationEndpoint(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T,
) {
name3 := "name2"
status3 := influxdb.Inactive
type args struct {
//userID influxdb.ID
id influxdb.ID
upd influxdb.NotificationEndpointUpdate
}
type wants struct {
notificationEndpoint influxdb.NotificationEndpoint
err *influxdb.Error
}
tests := []struct {
name string
fields NotificationEndpointFields
args args
wants wants
}{
{
name: "can't find the id",
fields: NotificationEndpointFields{
TimeGenerator: fakeGenerator,
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: fourID,
upd: influxdb.NotificationEndpointUpdate{
Name: &name3,
Status: &status3,
},
},
wants: wants{
err: &influxdb.Error{
Code: influxdb.ENotFound,
Msg: "notification endpoint not found",
},
},
},
{
name: "regular update",
fields: NotificationEndpointFields{
TimeGenerator: fakeGenerator,
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
Status: influxdb.Active,
OrgID: idPtr(fourID),
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
Status: influxdb.Active,
OrgID: idPtr(fourID),
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: twoID,
upd: influxdb.NotificationEndpointUpdate{
Name: &name3,
Status: &status3,
},
},
wants: wants{
notificationEndpoint: &endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: name3,
Status: status3,
OrgID: idPtr(fourID),
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: fakeDate,
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s, _, done := init(tt.fields, t)
defer done()
ctx := context.Background()
edp, err := s.PatchNotificationEndpoint(ctx, tt.args.id, tt.args.upd)
if err != nil {
if tt.wants.err == nil {
require.NoError(t, err)
}
iErr, ok := err.(*influxdb.Error)
require.True(t, ok, err)
assert.Equal(t, tt.wants.err.Code, iErr.Code)
return
}
if diff := cmp.Diff(edp, tt.wants.notificationEndpoint, notificationEndpointCmpOptions...); tt.wants.err == nil && diff != "" {
t.Errorf("notificationEndpoints are different -got/+want\ndiff %s", diff)
}
})
}
}
// DeleteNotificationEndpoint testing.
func DeleteNotificationEndpoint(
init func(NotificationEndpointFields, *testing.T) (influxdb.NotificationEndpointService, influxdb.SecretService, func()),
t *testing.T,
) {
type args struct {
id influxdb.ID
orgID influxdb.ID
userID influxdb.ID
}
type wants struct {
notificationEndpoints []influxdb.NotificationEndpoint
secretFlds []influxdb.SecretField
orgID influxdb.ID
err *influxdb.Error
}
tests := []struct {
name string
fields NotificationEndpointFields
args args
wants wants
}{
{
name: "bad id",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: influxdb.ID(0),
orgID: fourID,
userID: sixID,
},
wants: wants{
err: &influxdb.Error{
Code: influxdb.EInvalid,
Msg: "no key was provided for notification endpoint",
},
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com", RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
},
{
name: "none existing endpoint",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com", RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: fourID,
orgID: fourID,
userID: sixID,
},
wants: wants{
err: &influxdb.Error{
Code: influxdb.ENotFound,
Msg: "notification endpoint not found",
},
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
},
{
name: "regular delete",
fields: NotificationEndpointFields{
NotificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
&endpoint.PagerDuty{
Base: endpoint.Base{
ID: idPtr(twoID),
Name: "name2",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
ClientURL: "example-pagerduty.com",
RoutingKey: influxdb.SecretField{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
},
},
args: args{
id: twoID,
orgID: fourID,
userID: sixID,
},
wants: wants{
secretFlds: []influxdb.SecretField{
{Key: fmt.Sprintf("%s-routing-key", twoID)},
},
orgID: fourID,
notificationEndpoints: []influxdb.NotificationEndpoint{
&endpoint.Slack{
Base: endpoint.Base{
ID: idPtr(oneID),
Name: "name1",
OrgID: idPtr(fourID),
Status: influxdb.Active,
CRUDLog: influxdb.CRUDLog{
CreatedAt: timeGen1.Now(),
UpdatedAt: timeGen2.Now(),
},
},
URL: "example-slack.com",
Token: influxdb.SecretField{Key: fmt.Sprintf("%s-token", oneID)},
},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
s, secretSVC, done := init(tt.fields, t)
defer done()
ctx := context.Background()
flds, orgID, err := s.DeleteNotificationEndpoint(ctx, tt.args.id)
influxErrsEqual(t, tt.wants.err, err)
if diff := cmp.Diff(flds, tt.wants.secretFlds); diff != "" {
t.Errorf("delete notification endpoint secret fields are different -got/+want\ndiff %s", diff)
}
if diff := cmp.Diff(orgID, tt.wants.orgID); diff != "" {
t.Errorf("delete notification endpoint org id is different -got/+want\ndiff %s", diff)
}
filter := influxdb.NotificationEndpointFilter{}
edps, n, err := s.FindNotificationEndpoints(ctx, filter)
if err != nil && tt.wants.err == nil {
t.Fatalf("expected errors to be nil got '%v'", err)
}
if n != len(tt.wants.notificationEndpoints) {
t.Fatalf("notification endpoints length is different got %d, want %d", n, len(tt.wants.notificationEndpoints))
}
if diff := cmp.Diff(edps, tt.wants.notificationEndpoints, notificationEndpointCmpOptions...); diff != "" {
t.Errorf("notification endpoints are different -got/+want\ndiff %s", diff)
}
var deletedEndpoint influxdb.NotificationEndpoint
for _, ne := range tt.fields.NotificationEndpoints {
if ne.GetID() == tt.args.id {
deletedEndpoint = ne
break
}
}
if deletedEndpoint == nil {
return
}
secrets, err := secretSVC.GetSecretKeys(ctx, deletedEndpoint.GetOrgID())
require.NoError(t, err)
for _, deleted := range deletedEndpoint.SecretFields() {
assert.NotContains(t, secrets, deleted.Key)
}
})
}
}
func influxErrsEqual(t *testing.T, expected *influxdb.Error, actual error) {
t.Helper()
if expected != nil {
require.Error(t, actual)
}
if actual == nil {
return
}
if expected == nil {
require.NoError(t, actual)
return
}
iErr, ok := actual.(*influxdb.Error)
require.True(t, ok)
assert.Equal(t, expected.Code, iErr.Code)
assert.Truef(t, strings.HasPrefix(iErr.Error(), expected.Error()), "expected: %s got err: %s", expected.Error(), actual.Error())
}
func idPtr(id influxdb.ID) *influxdb.ID {
return &id
}
func strPtr(s string) *string { return &s }
// ErrorsEqual checks to see if the provided errors are equivalent.
func ErrorsEqual(t *testing.T, actual, expected error) {
t.Helper()
if expected == nil && actual == nil {
return
}
if expected == nil && actual != nil {
t.Errorf("unexpected error %s", actual.Error())
}
if expected != nil && actual == nil {
t.Errorf("expected error %s but received nil", expected.Error())
}
if influxdb.ErrorCode(expected) != influxdb.ErrorCode(actual) {
t.Logf("\nexpected: %v\nactual: %v\n\n", expected, actual)
t.Errorf("expected error code %q but received %q", influxdb.ErrorCode(expected), influxdb.ErrorCode(actual))
}
if influxdb.ErrorMessage(expected) != influxdb.ErrorMessage(actual) {
t.Logf("\nexpected: %v\nactual: %v\n\n", expected, actual)
t.Errorf("expected error message %q but received %q", influxdb.ErrorMessage(expected), influxdb.ErrorMessage(actual))
}
}