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

fix: adding guard condition for empty notification list in notify fun… #182

Merged
merged 2 commits into from
Oct 8, 2024
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
3 changes: 3 additions & 0 deletions plugins/notifiers/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ type NotifyManager struct {

func (m *NotifyManager) Notify(ctx context.Context, notification []domain.Notification) []error {
var errs []error
if len(notification) == 0 {
return errs
}
for i, client := range m.clients {
// evaluate criteria
config := m.configs[i]
Expand Down
104 changes: 104 additions & 0 deletions plugins/notifiers/client_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package notifiers

import (
"context"
"fmt"
"reflect"
"testing"

Expand Down Expand Up @@ -215,3 +217,105 @@ func TestNewSlackLarkConfig(t *testing.T) {
})
}
}
func TestNotify(t *testing.T) {
var errs []error
type fields struct {
clients []Client
configs []Config
}
type args struct {
ctx context.Context
notification []domain.Notification
}
tests := []struct {
name string
fields fields
args args
want []error
}{
{
name: "should return no errors when notifications are empty",
fields: fields{
clients: []Client{},
configs: []Config{},
},
args: args{
ctx: context.Background(),
notification: []domain.Notification{},
},
want: errs,
},
{
name: "should return error when criteria does not evaluate to boolean",
fields: fields{
clients: []Client{&mockClient{}},
configs: []Config{
{
Criteria: "1 + 1",
},
},
},
args: args{
ctx: context.Background(),
notification: []domain.Notification{
{User: "[email protected]"},
},
},
want: []error{fmt.Errorf("notifier expression did not evaluate to a boolean: 1 + 1")},
},
{
name: "should notify client when criteria evaluates to true",
fields: fields{
clients: []Client{&mockClient{}},
configs: []Config{
{
Criteria: "1 == 1",
},
},
},
args: args{
ctx: context.Background(),
notification: []domain.Notification{
{User: "[email protected]"},
},
},
want: errs,
},
{
name: "should not notify client when criteria evaluates to false",
fields: fields{
clients: []Client{&mockClient{}},
configs: []Config{
{
Criteria: "1 == 2",
},
},
},
args: args{
ctx: context.Background(),
notification: []domain.Notification{
{User: "[email protected]"},
},
},
want: errs,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
m := &NotifyManager{
clients: tt.fields.clients,
configs: tt.fields.configs,
}
fmt.Println()
if got := m.Notify(tt.args.ctx, tt.args.notification); !reflect.DeepEqual(got, tt.want) {
t.Errorf("Notify() = %v, want %v", got, tt.want)
}
})
}
}

type mockClient struct{}

func (m *mockClient) Notify(ctx context.Context, notifications []domain.Notification) []error {
return nil
}
Loading