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.

Sign up for GitHub

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

Return no error when deleting expired silence #2817

Merged
merged 14 commits into from
Feb 22, 2022
Merged

Return no error when deleting expired silence #2817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d389091
Changed Silences.expire(id) to not return error for already expired s…
soonping-amzn Jan 12, 2022
342fef5
Added comment explaining idempotency change for Silences.expire()
soonping-amzn Jan 17, 2022
3ddd3e6
Trigger build
soonping-amzn Jan 18, 2022
1e7879f
Trigger build
soonping-amzn Jan 18, 2022
2a7ef46
Fixed typo in comment
soonping-amzn Jan 18, 2022
53a300e
Trigger build
soonping-amzn Jan 18, 2022
cc0283c
Trigger build
soonping-amzn Jan 18, 2022
e3f9f46
Fixed another typo in comment
soonping-amzn Jan 19, 2022
8e605a4
Promoted comment to function-level
soonping-amzn Jan 20, 2022
4b776b9
Added API v2 test for DeleteSilence, PostSilence
soonping-amzn Jan 26, 2022
5d0d557
Fixed lint errors
soonping-amzn Jan 26, 2022
619b390
Trigger build
soonping-amzn Jan 26, 2022
451452d
Trigger build
soonping-amzn Jan 26, 2022
4c36579
Trigger build
soonping-amzn Jan 26, 2022
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
182 changes: 182 additions & 0 deletions api/v2/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,31 @@
package v2

import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/http/httptest"
"strconv"
"testing"
"time"

"github.com/go-openapi/runtime"
"github.com/go-openapi/strfmt"
"github.com/prometheus/common/model"
"github.com/stretchr/testify/require"

open_api_models "github.com/prometheus/alertmanager/api/v2/models"
general_ops "github.com/prometheus/alertmanager/api/v2/restapi/operations/general"
silence_ops "github.com/prometheus/alertmanager/api/v2/restapi/operations/silence"
"github.com/prometheus/alertmanager/config"
"github.com/prometheus/alertmanager/pkg/labels"
"github.com/prometheus/alertmanager/silence"
"github.com/prometheus/alertmanager/silence/silencepb"
"github.com/prometheus/alertmanager/types"

"github.com/go-kit/log"
)

// If api.peers == nil, Alertmanager cluster feature is disabled. Make sure to
Expand Down Expand Up @@ -72,6 +83,13 @@ var (
createdBy = "test"
)

func newSilences(t *testing.T) *silence.Silences {
silences, err := silence.New(silence.Options{})
require.NoError(t, err)

return silences
}

func gettableSilence(id string, state string,
updatedAt string, start string, end string,
) *open_api_models.GettableSilence {
Expand Down Expand Up @@ -131,6 +149,170 @@ func TestGetSilencesHandler(t *testing.T) {
}
}

func TestDeleteSilenceHandler(t *testing.T) {
now := time.Now()
silences := newSilences(t)

m := &silencepb.Matcher{Type: silencepb.Matcher_EQUAL, Name: "a", Pattern: "b"}

unexpiredSil := &silencepb.Silence{
Matchers: []*silencepb.Matcher{m},
StartsAt: now,
EndsAt: now.Add(time.Hour),
UpdatedAt: now,
}
unexpiredSid, err := silences.Set(unexpiredSil)
require.NoError(t, err)

expiredSil := &silencepb.Silence{
Matchers: []*silencepb.Matcher{m},
StartsAt: now.Add(-time.Hour),
EndsAt: now.Add(time.Hour),
UpdatedAt: now,
}
expiredSid, err := silences.Set(expiredSil)
require.NoError(t, err)
require.NoError(t, silences.Expire(expiredSid))

for i, tc := range []struct {
sid string
expectedCode int
}{
{
"unknownSid",
500,
},
{
unexpiredSid,
200,
},
{
expiredSid,
200,
},
} {
api := API{
uptime: time.Now(),
silences: silences,
logger: log.NewNopLogger(),
}

r, err := http.NewRequest("DELETE", "/api/v2/silence/${tc.sid}", nil)
require.NoError(t, err)

w := httptest.NewRecorder()
p := runtime.TextProducer()
responder := api.deleteSilenceHandler(silence_ops.DeleteSilenceParams{
SilenceID: strfmt.UUID(tc.sid),
HTTPRequest: r,
})
responder.WriteResponse(w, p)
body, _ := ioutil.ReadAll(w.Result().Body)

require.Equal(t, tc.expectedCode, w.Code, fmt.Sprintf("test case: %d, response: %s", i, string(body)))
}
}

func TestPostSilencesHandler(t *testing.T) {
now := time.Now()
silences := newSilences(t)

m := &silencepb.Matcher{Type: silencepb.Matcher_EQUAL, Name: "a", Pattern: "b"}

unexpiredSil := &silencepb.Silence{
Matchers: []*silencepb.Matcher{m},
StartsAt: now,
EndsAt: now.Add(time.Hour),
UpdatedAt: now,
}
unexpiredSid, err := silences.Set(unexpiredSil)
require.NoError(t, err)

expiredSil := &silencepb.Silence{
Matchers: []*silencepb.Matcher{m},
StartsAt: now.Add(-time.Hour),
EndsAt: now.Add(time.Hour),
UpdatedAt: now,
}
expiredSid, err := silences.Set(expiredSil)
require.NoError(t, err)
require.NoError(t, silences.Expire(expiredSid))

for i, tc := range []struct {
sid string
start, end time.Time
expectedCode int
}{
{
"unknownSid",
now.Add(time.Hour),
now.Add(time.Hour * 2),
404,
},
{
"",
now.Add(time.Hour),
now.Add(time.Hour * 2),
200,
},
{
unexpiredSid,
now.Add(time.Hour),
now.Add(time.Hour * 2),
200,
},
{
expiredSid,
now.Add(time.Hour),
now.Add(time.Hour * 2),
200,
},
} {
createdBy := "silenceCreator"
comment := "test"
matcherName := "a"
matcherValue := "b"
isRegex := false
startsAt := strfmt.DateTime(tc.start)
endsAt := strfmt.DateTime(tc.end)

sil := open_api_models.PostableSilence{
ID: tc.sid,
Silence: open_api_models.Silence{
Matchers: open_api_models.Matchers{&open_api_models.Matcher{Name: &matcherName, Value: &matcherValue, IsRegex: &isRegex}},
StartsAt: &startsAt,
EndsAt: &endsAt,
CreatedBy: &createdBy,
Comment: &comment,
},
}
b, err := json.Marshal(&sil)
if err != nil {
t.Errorf("Unexpected error %v", err)
}

api := API{
uptime: time.Now(),
silences: silences,
logger: log.NewNopLogger(),
}

r, err := http.NewRequest("POST", "/api/v2/silence/${tc.sid}", bytes.NewReader(b))
require.NoError(t, err)

w := httptest.NewRecorder()
p := runtime.TextProducer()
responder := api.postSilencesHandler(silence_ops.PostSilencesParams{
HTTPRequest: r,
Silence: &sil,
})
responder.WriteResponse(w, p)
body, _ := ioutil.ReadAll(w.Result().Body)

require.Equal(t, tc.expectedCode, w.Code, fmt.Sprintf("test case: %d, response: %s", i, string(body)))
}
}

func createSilenceMatcher(name string, pattern string, matcherType silencepb.Matcher_Type) *silencepb.Matcher {
return &silencepb.Matcher{
Name: name,
Expand Down
4 changes: 3 additions & 1 deletion silence/silence.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,8 @@ func (s *Silences) Expire(id string) error {
}

// Expire the silence with the given ID immediately.
// It is idempotent, nil is returned if the silence already expired before it is GC'd.
// If the silence is not found an error is returned.
func (s *Silences) expire(id string) error {
sil, ok := s.getSilence(id)
if !ok {
Expand All @@ -622,7 +624,7 @@ func (s *Silences) expire(id string) error {

switch getState(sil, now) {
case types.SilenceStateExpired:
return errors.Errorf("silence %s already expired", id)
Copy link
Member

@gotjosh gotjosh Jan 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for coming in late - I feel that this kind of comment about the semantics of the function is best put as part of the function description.

How do you feel about changing the top-level comment from:

// Expire the silence with the given ID immediately.

to

// Expire the silence with the given ID immediately. It is idempotent, nil is returned if the silence already expired before it is GC'd.
// If the silence is not found an error is returned.

and removing the comment on the body.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. I'll make the change.

return nil
case types.SilenceStateActive:
sil.EndsAt = now
case types.SilenceStatePending:
Expand Down
8 changes: 2 additions & 6 deletions silence/silence_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -835,9 +835,7 @@ func TestSilenceExpire(t *testing.T) {
require.NoError(t, s.Expire("pending"))
require.NoError(t, s.Expire("active"))

err = s.Expire("expired")
require.Error(t, err)
require.Contains(t, err.Error(), "already expired")
require.NoError(t, s.Expire("expired"))

sil, err := s.QueryOne(QIDs("pending"))
require.NoError(t, err)
Expand Down Expand Up @@ -935,9 +933,7 @@ func TestSilenceExpireWithZeroRetention(t *testing.T) {
require.NoError(t, s.Expire("pending"))
require.NoError(t, s.Expire("active"))

err = s.Expire("expired")
require.Error(t, err)
require.Contains(t, err.Error(), "already expired")
require.NoError(t, s.Expire("expired"))

_, err = s.QueryOne(QIDs("pending"))
require.NoError(t, err)
Expand Down