Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified	Actions
📁 ..	-	2025-05-25 12:27
📄 jira.go // Copyright 2023 Prometheus Team // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package jira import ( "bytes" "context" "encoding/json" "fmt" "io" "log/slog" "net/http" "sort" "strings" "time" commoncfg "github.com/prometheus/common/config" "github.com/prometheus/common/model" "github.com/trivago/tgo/tcontainer" "github.com/prometheus/alertmanager/config" "github.com/prometheus/alertmanager/notify" "github.com/prometheus/alertmanager/template" "github.com/prometheus/alertmanager/types" ) const ( maxSummaryLenRunes = 255 maxDescriptionLenRunes = 32767 ) // Notifier implements a Notifier for JIRA notifications. type Notifier struct { conf config.JiraConfig tmpl template.Template logger slog.Logger client http.Client retrier notify.Retrier } func New(c config.JiraConfig, t template.Template, l slog.Logger, httpOpts ...commoncfg.HTTPClientOption) (Notifier, error) { client, err := commoncfg.NewClientFromConfig(c.HTTPConfig, "jira", httpOpts...) if err != nil { return nil, err } return &Notifier{ conf: c, tmpl: t, logger: l, client: client, retrier: &notify.Retrier{RetryCodes: []int{http.StatusTooManyRequests}}, }, nil } // Notify implements the Notifier interface. func (n Notifier) Notify(ctx context.Context, as ...types.Alert) (bool, error) { key, err := notify.ExtractGroupKey(ctx) if err != nil { return false, err } logger := n.logger.With("group_key", key.String()) var ( alerts = types.Alerts(as...) tmplTextErr error data = notify.GetTemplateData(ctx, n.tmpl, as, logger) tmplText = notify.TmplText(n.tmpl, data, &tmplTextErr) tmplTextFunc = func(tmpl string) (string, error) { return tmplText(tmpl), tmplTextErr } path = "issue" method = http.MethodPost ) existingIssue, shouldRetry, err := n.searchExistingIssue(ctx, logger, key.Hash(), alerts.HasFiring(), tmplTextFunc) if err != nil { return shouldRetry, fmt.Errorf("failed to look up existing issues: %w", err) } if existingIssue == nil { // Do not create new issues for resolved alerts if alerts.Status() == model.AlertResolved { return false, nil } logger.Debug("create new issue") } else { path = "issue/" + existingIssue.Key method = http.MethodPut logger.Debug("updating existing issue", "issue_key", existingIssue.Key) } requestBody, err := n.prepareIssueRequestBody(ctx, logger, key.Hash(), tmplTextFunc) if err != nil { return false, err } _, shouldRetry, err = n.doAPIRequest(ctx, method, path, requestBody) if err != nil { return shouldRetry, fmt.Errorf("failed to %s request to %q: %w", method, path, err) } return n.transitionIssue(ctx, logger, existingIssue, alerts.HasFiring()) } func (n Notifier) prepareIssueRequestBody(ctx context.Context, logger slog.Logger, groupID string, tmplTextFunc templateFunc) (issue, error) { summary, err := tmplTextFunc(n.conf.Summary) if err != nil { return issue{}, fmt.Errorf("summary template: %w", err) } project, err := tmplTextFunc(n.conf.Project) if err != nil { return issue{}, fmt.Errorf("project template: %w", err) } issueType, err := tmplTextFunc(n.conf.IssueType) if err != nil { return issue{}, fmt.Errorf("issue_type template: %w", err) } // Recursively convert any maps to map[string]interface{}, filtering out all non-string keys, so the json encoder // doesn't blow up when marshaling JIRA requests. fieldsWithStringKeys, err := tcontainer.ConvertToMarshalMap(n.conf.Fields, func(v string) string { return v }) if err != nil { return issue{}, fmt.Errorf("convertToMarshalMap: %w", err) } summary, truncated := notify.TruncateInRunes(summary, maxSummaryLenRunes) if truncated { logger.Warn("Truncated summary", "max_runes", maxSummaryLenRunes) } requestBody := issue{Fields: &issueFields{ Project: &issueProject{Key: project}, Issuetype: &idNameValue{Name: issueType}, Summary: summary, Labels: make([]string, 0, len(n.conf.Labels)+1), Fields: fieldsWithStringKeys, }} issueDescriptionString, err := tmplTextFunc(n.conf.Description) if err != nil { return issue{}, fmt.Errorf("description template: %w", err) } issueDescriptionString, truncated = notify.TruncateInRunes(issueDescriptionString, maxDescriptionLenRunes) if truncated { logger.Warn("Truncated description", "max_runes", maxDescriptionLenRunes) } requestBody.Fields.Description = issueDescriptionString if strings.HasSuffix(n.conf.APIURL.Path, "/3") { var issueDescription any if err := json.Unmarshal([]byte(issueDescriptionString), &issueDescription); err != nil { return issue{}, fmt.Errorf("description unmarshaling: %w", err) } requestBody.Fields.Description = issueDescription } for i, label := range n.conf.Labels { label, err = tmplTextFunc(label) if err != nil { return issue{}, fmt.Errorf("labels[%d] template: %w", i, err) } requestBody.Fields.Labels = append(requestBody.Fields.Labels, label) } requestBody.Fields.Labels = append(requestBody.Fields.Labels, fmt.Sprintf("ALERT{%s}", groupID)) sort.Strings(requestBody.Fields.Labels) priority, err := tmplTextFunc(n.conf.Priority) if err != nil { return issue{}, fmt.Errorf("priority template: %w", err) } if priority != "" { requestBody.Fields.Priority = &idNameValue{Name: priority} } return requestBody, nil } func (n Notifier) searchExistingIssue(ctx context.Context, logger slog.Logger, groupID string, firing bool, tmplTextFunc templateFunc) (issue, bool, error) { jql := strings.Builder{} if n.conf.WontFixResolution != "" { jql.WriteString(fmt.Sprintf(`resolution != %q and `, n.conf.WontFixResolution)) } // If the group is firing, do not search for closed issues unless a reopen transition is defined. if firing { if n.conf.ReopenTransition == "" { jql.WriteString(`statusCategory != Done and `) } } else { reopenDuration := int64(time.Duration(n.conf.ReopenDuration).Minutes()) if reopenDuration != 0 { jql.WriteString(fmt.Sprintf(`(resolutiondate is EMPTY OR resolutiondate >= -%dm) and `, reopenDuration)) } } alertLabel := fmt.Sprintf("ALERT{%s}", groupID) project, err := tmplTextFunc(n.conf.Project) if err != nil { return nil, false, fmt.Errorf("invalid project template or value: %w", err) } jql.WriteString(fmt.Sprintf(`project=%q and labels=%q order by status ASC,resolutiondate DESC`, project, alertLabel)) requestBody := issueSearch{ JQL: jql.String(), MaxResults: 2, Fields: []string{"status"}, Expand: []string{}, } logger.Debug("search for recent issues", "jql", requestBody.JQL) responseBody, shouldRetry, err := n.doAPIRequest(ctx, http.MethodPost, "search", requestBody) if err != nil { return nil, shouldRetry, fmt.Errorf("HTTP request to JIRA API: %w", err) } var issueSearchResult issueSearchResult err = json.Unmarshal(responseBody, &issueSearchResult) if err != nil { return nil, false, err } if issueSearchResult.Total == 0 { logger.Debug("found no existing issue") return nil, false, nil } if issueSearchResult.Total > 1 { logger.Warn("more than one issue matched, selecting the most recently resolved", "selected_issue", issueSearchResult.Issues[0].Key) } return &issueSearchResult.Issues[0], false, nil } func (n Notifier) getIssueTransitionByName(ctx context.Context, issueKey, transitionName string) (string, bool, error) { path := fmt.Sprintf("issue/%s/transitions", issueKey) responseBody, shouldRetry, err := n.doAPIRequest(ctx, http.MethodGet, path, nil) if err != nil { return "", shouldRetry, err } var issueTransitions issueTransitions err = json.Unmarshal(responseBody, &issueTransitions) if err != nil { return "", false, err } for _, issueTransition := range issueTransitions.Transitions { if issueTransition.Name == transitionName { return issueTransition.ID, false, nil } } return "", false, fmt.Errorf("can't find transition %s for issue %s", transitionName, issueKey) } func (n Notifier) transitionIssue(ctx context.Context, logger slog.Logger, i issue, firing bool) (bool, error) { if i == nil \|\| i.Key == "" \|\| i.Fields == nil \|\| i.Fields.Status == nil { return false, nil } var transition string if firing { if i.Fields.Status.StatusCategory.Key != "done" { return false, nil } transition = n.conf.ReopenTransition } else { if i.Fields.Status.StatusCategory.Key == "done" { return false, nil } transition = n.conf.ResolveTransition } transitionID, shouldRetry, err := n.getIssueTransitionByName(ctx, i.Key, transition) if err != nil { return shouldRetry, err } requestBody := issue{ Transition: &idNameValue{ ID: transitionID, }, } path := fmt.Sprintf("issue/%s/transitions", i.Key) logger.Debug("transitions jira issue", "issue_key", i.Key, "transition", transition) _, shouldRetry, err = n.doAPIRequest(ctx, http.MethodPost, path, requestBody) return shouldRetry, err } func (n Notifier) doAPIRequest(ctx context.Context, method, path string, requestBody any) ([]byte, bool, error) { var body io.Reader if requestBody != nil { var buf bytes.Buffer if err := json.NewEncoder(&buf).Encode(requestBody); err != nil { return nil, false, err } body = &buf } url := n.conf.APIURL.JoinPath(path) req, err := http.NewRequestWithContext(ctx, method, url.String(), body) if err != nil { return nil, false, err } req.Header.Set("Content-Type", "application/json") req.Header.Set("Accept-Language", "en") resp, err := n.client.Do(req) if err != nil { return nil, false, err } defer notify.Drain(resp) responseBody, err := io.ReadAll(resp.Body) if err != nil { return nil, false, err } shouldRetry, err := n.retrier.Check(resp.StatusCode, bytes.NewReader(responseBody)) if err != nil { return nil, shouldRetry, notify.NewErrorWithReason(notify.GetFailureReasonFromStatusCode(resp.StatusCode), err) } return responseBody, false, nil }	10.21 KB	2025-05-25 12:27
📄 jira_test.go // Copyright 2023 Prometheus Team // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package jira import ( "context" "encoding/json" "fmt" "io" "net/http" "net/http/httptest" "net/url" "strings" "testing" "time" commoncfg "github.com/prometheus/common/config" "github.com/prometheus/common/model" "github.com/prometheus/common/promslog" "github.com/stretchr/testify/require" "github.com/prometheus/alertmanager/config" "github.com/prometheus/alertmanager/notify" "github.com/prometheus/alertmanager/notify/test" "github.com/prometheus/alertmanager/template" "github.com/prometheus/alertmanager/types" ) func TestJiraRetry(t testing.T) { notifier, err := New( &config.JiraConfig{ APIURL: &config.URL{ URL: &url.URL{ Scheme: "https", Host: "example.atlassian.net", Path: "/rest/api/2", }, }, HTTPConfig: &commoncfg.HTTPClientConfig{}, }, test.CreateTmpl(t), promslog.NewNopLogger(), ) require.NoError(t, err) retryCodes := append(test.DefaultRetryCodes(), http.StatusTooManyRequests) for statusCode, expected := range test.RetryTests(retryCodes) { actual, _ := notifier.retrier.Check(statusCode, nil) require.Equal(t, expected, actual, fmt.Sprintf("retry - error on status %d", statusCode)) } } func TestSearchExistingIssue(t testing.T) { expectedJQL := "" srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r http.Request) { switch r.URL.Path { case "/search": body, err := io.ReadAll(r.Body) if err != nil { http.Error(w, "Error reading request body", http.StatusBadRequest) return } defer r.Body.Close() // Unmarshal the JSON data into the struct var data issueSearch err = json.Unmarshal(body, &data) if err != nil { http.Error(w, "Error unmarshaling JSON", http.StatusBadRequest) return } require.Equal(t, expectedJQL, data.JQL) w.Write([]byte(`{"total": 0, "issues": []}`)) return default: dec := json.NewDecoder(r.Body) out := make(map[string]any) err := dec.Decode(&out) if err != nil { panic(err) } } })) defer srv.Close() u, _ := url.Parse(srv.URL) for _, tc := range []struct { title string cfg config.JiraConfig groupKey string expectedJQL string expectedIssue issue expectedErr bool expectedRetry bool }{ { title: "search existing issue with project template", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, Project: `{{ .CommonLabels.project }}`, }, groupKey: "1", expectedJQL: `statusCategory != Done and project="PROJ" and labels="ALERT{1}" order by status ASC,resolutiondate DESC`, }, } { tc := tc t.Run(tc.title, func(t testing.T) { expectedJQL = tc.expectedJQL tc.cfg.APIURL = &config.URL{URL: u} tc.cfg.HTTPConfig = &commoncfg.HTTPClientConfig{} as := []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "project": "PROJ", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, } pd, err := New(tc.cfg, test.CreateTmpl(t), promslog.NewNopLogger()) require.NoError(t, err) logger := pd.logger.With("group_key", tc.groupKey) ctx := notify.WithGroupKey(context.Background(), tc.groupKey) data := notify.GetTemplateData(ctx, pd.tmpl, as, logger) var tmplTextErr error tmplText := notify.TmplText(pd.tmpl, data, &tmplTextErr) tmplTextFunc := func(tmpl string) (string, error) { return tmplText(tmpl), tmplTextErr } issue, retry, err := pd.searchExistingIssue(ctx, logger, tc.groupKey, true, tmplTextFunc) if tc.expectedErr { require.Error(t, err) } else { require.NoError(t, err) } require.EqualValues(t, tc.expectedIssue, issue) require.Equal(t, tc.expectedRetry, retry) }) } } func TestJiraTemplating(t testing.T) { srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r http.Request) { switch r.URL.Path { case "/search": w.Write([]byte(`{"total": 0, "issues": []}`)) return default: dec := json.NewDecoder(r.Body) out := make(map[string]any) err := dec.Decode(&out) if err != nil { panic(err) } } })) defer srv.Close() u, _ := url.Parse(srv.URL) for _, tc := range []struct { title string cfg config.JiraConfig retry bool errMsg string }{ { title: "full-blown message", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, }, retry: false, }, { title: "template project", cfg: &config.JiraConfig{ Project: `{{ .CommonLabels.lbl1 }}`, Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, }, retry: false, }, { title: "template issue type", cfg: &config.JiraConfig{ IssueType: `{{ .CommonLabels.lbl1 }}`, Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, }, retry: false, }, { title: "summary with templating errors", cfg: &config.JiraConfig{ Summary: "{{ ", }, errMsg: "template: :1: unclosed action", }, { title: "description with templating errors", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: "{{ ", }, errMsg: "template: :1: unclosed action", }, { title: "priority with templating errors", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, Priority: "{{ ", }, errMsg: "template: :1: unclosed action", }, } { tc := tc t.Run(tc.title, func(t testing.T) { tc.cfg.APIURL = &config.URL{URL: u} tc.cfg.HTTPConfig = &commoncfg.HTTPClientConfig{} pd, err := New(tc.cfg, test.CreateTmpl(t), promslog.NewNopLogger()) require.NoError(t, err) ctx := context.Background() ctx = notify.WithGroupKey(ctx, "1") ok, err := pd.Notify(ctx, []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "lbl1": "val1", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }...) if tc.errMsg == "" { require.NoError(t, err) } else { require.Error(t, err) require.Contains(t, err.Error(), tc.errMsg) } require.Equal(t, tc.retry, ok) }) } } func TestJiraNotify(t testing.T) { for _, tc := range []struct { title string cfg config.JiraConfig alert types.Alert customFieldAssetFn func(t testing.T, issue map[string]any) searchResponse issueSearchResult issue issue errMsg string }{ { title: "create new issue", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, IssueType: "Incident", Project: "OPS", Priority: `{{ template "jira.default.priority" . }}`, Labels: []string{"alertmanager", "{{ .GroupLabels.alertname }}"}, ReopenDuration: model.Duration(1 * time.Hour), ReopenTransition: "REOPEN", ResolveTransition: "CLOSE", WontFixResolution: "WONTFIX", }, alert: &types.Alert{ Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "critical", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, searchResponse: issueSearchResult{ Total: 0, Issues: []issue{}, }, issue: issue{ Key: "", Fields: &issueFields{ Summary: "[FIRING:1] test (vm1 critical)", Description: "\n\n# Alerts Firing:\n\nLabels:\n - alertname = test\n - instance = vm1\n - severity = critical\n\nAnnotations:\n\nSource: \n\n\n\n\n", Issuetype: &idNameValue{Name: "Incident"}, Labels: []string{"ALERT{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}", "alertmanager", "test"}, Project: &issueProject{Key: "OPS"}, Priority: &idNameValue{Name: "High"}, }, }, customFieldAssetFn: func(t testing.T, issue map[string]any) {}, errMsg: "", }, { title: "create new issue with template project and issue type", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, IssueType: "{{ .CommonLabels.issue_type }}", Project: "{{ .CommonLabels.project }}", Priority: `{{ template "jira.default.priority" . }}`, Labels: []string{"alertmanager", "{{ .GroupLabels.alertname }}"}, ReopenDuration: model.Duration(1 time.Hour), ReopenTransition: "REOPEN", ResolveTransition: "CLOSE", WontFixResolution: "WONTFIX", }, alert: &types.Alert{ Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "critical", "project": "MONITORING", "issue_type": "MINOR", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, searchResponse: issueSearchResult{ Total: 0, Issues: []issue{}, }, issue: issue{ Key: "", Fields: &issueFields{ Summary: "[FIRING:1] test (vm1 MINOR MONITORING critical)", Description: "\n\n# Alerts Firing:\n\nLabels:\n - alertname = test\n - instance = vm1\n - issue_type = MINOR\n - project = MONITORING\n - severity = critical\n\nAnnotations:\n\nSource: \n\n\n\n\n", Issuetype: &idNameValue{Name: "MINOR"}, Labels: []string{"ALERT{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}", "alertmanager", "test"}, Project: &issueProject{Key: "MONITORING"}, Priority: &idNameValue{Name: "High"}, }, }, customFieldAssetFn: func(t testing.T, issue map[string]any) {}, errMsg: "", }, { title: "create new issue with custom field and too long summary", cfg: &config.JiraConfig{ Summary: strings.Repeat("A", maxSummaryLenRunes+10), Description: `{{ template "jira.default.description" . }}`, IssueType: "Incident", Project: "OPS", Priority: `{{ template "jira.default.priority" . }}`, Labels: []string{"alertmanager", "{{ .GroupLabels.alertname }}"}, Fields: map[string]any{ "components": map[any]any{"name": "Monitoring"}, "customfield_10001": "value", "customfield_10002": 0, "customfield_10003": []any{0}, "customfield_10004": map[any]any{"value": "red"}, "customfield_10005": map[any]any{"value": 0}, "customfield_10006": []map[any]any{{"value": "red"}, {"value": "blue"}, {"value": "green"}}, "customfield_10007": []map[any]any{{"value": "red"}, {"value": "blue"}, {"value": 0}}, "customfield_10008": []map[any]any{{"value": 0}, {"value": 1}, {"value": 2}}, }, ReopenDuration: model.Duration(1 time.Hour), ReopenTransition: "REOPEN", ResolveTransition: "CLOSE", WontFixResolution: "WONTFIX", }, alert: &types.Alert{ Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, searchResponse: issueSearchResult{ Total: 0, Issues: []issue{}, }, issue: issue{ Key: "", Fields: &issueFields{ Summary: strings.Repeat("A", maxSummaryLenRunes-1) + "…", Description: "\n\n# Alerts Firing:\n\nLabels:\n - alertname = test\n - instance = vm1\n\nAnnotations:\n\nSource: \n\n\n\n\n", Issuetype: &idNameValue{Name: "Incident"}, Labels: []string{"ALERT{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}", "alertmanager", "test"}, Project: &issueProject{Key: "OPS"}, }, }, customFieldAssetFn: func(t testing.T, issue map[string]any) { require.Equal(t, "value", issue["customfield_10001"]) require.Equal(t, float64(0), issue["customfield_10002"]) require.Equal(t, []any{float64(0)}, issue["customfield_10003"]) require.Equal(t, map[string]any{"value": "red"}, issue["customfield_10004"]) require.Equal(t, map[string]any{"value": float64(0)}, issue["customfield_10005"]) require.Equal(t, []any{map[string]any{"value": "red"}, map[string]any{"value": "blue"}, map[string]any{"value": "green"}}, issue["customfield_10006"]) require.Equal(t, []any{map[string]any{"value": "red"}, map[string]any{"value": "blue"}, map[string]any{"value": float64(0)}}, issue["customfield_10007"]) require.Equal(t, []any{map[string]any{"value": float64(0)}, map[string]any{"value": float64(1)}, map[string]any{"value": float64(2)}}, issue["customfield_10008"]) }, errMsg: "", }, { title: "reopen issue", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, IssueType: "Incident", Project: "OPS", Priority: `{{ template "jira.default.priority" . }}`, Labels: []string{"alertmanager", "{{ .GroupLabels.alertname }}"}, ReopenDuration: model.Duration(1 time.Hour), ReopenTransition: "REOPEN", ResolveTransition: "CLOSE", WontFixResolution: "WONTFIX", }, alert: &types.Alert{ Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, searchResponse: issueSearchResult{ Total: 1, Issues: []issue{ { Key: "OPS-1", Fields: &issueFields{ Status: &issueStatus{ Name: "Closed", StatusCategory: struct { Key string `json:"key"` }{ Key: "done", }, }, }, }, }, }, issue: issue{ Key: "", Fields: &issueFields{ Summary: "[FIRING:1] test (vm1)", Description: "\n\n# Alerts Firing:\n\nLabels:\n - alertname = test\n - instance = vm1\n\nAnnotations:\n\nSource: \n\n\n\n\n", Issuetype: &idNameValue{Name: "Incident"}, Labels: []string{"ALERT{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}", "alertmanager", "test"}, Project: &issueProject{Key: "OPS"}, Priority: &idNameValue{Name: "High"}, }, }, customFieldAssetFn: func(t testing.T, issue map[string]any) {}, errMsg: "", }, { title: "error resolve transition not found", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, IssueType: "Incident", Project: "OPS", Priority: `{{ template "jira.default.priority" . }}`, Labels: []string{"alertmanager", "{{ .GroupLabels.alertname }}"}, ReopenDuration: model.Duration(1 time.Hour), ReopenTransition: "REOPEN", ResolveTransition: "CLOSE", WontFixResolution: "WONTFIX", }, alert: &types.Alert{ Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", }, StartsAt: time.Now().Add(-time.Hour), EndsAt: time.Now().Add(-time.Hour), }, }, searchResponse: issueSearchResult{ Total: 1, Issues: []issue{ { Key: "OPS-3", Fields: &issueFields{ Status: &issueStatus{ Name: "Open", StatusCategory: struct { Key string `json:"key"` }{ Key: "open", }, }, }, }, }, }, issue: issue{ Key: "", Fields: &issueFields{ Summary: "[RESOLVED] test (vm1)", Description: "\n\n\n# Alerts Resolved:\n\nLabels:\n - alertname = test\n - instance = vm1\n\nAnnotations:\n\nSource: \n\n\n\n", Issuetype: &idNameValue{Name: "Incident"}, Labels: []string{"ALERT{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}", "alertmanager", "test"}, Project: &issueProject{Key: "OPS"}, }, }, customFieldAssetFn: func(t testing.T, issue map[string]any) {}, errMsg: "can't find transition CLOSE for issue OPS-3", }, { title: "error reopen transition not found", cfg: &config.JiraConfig{ Summary: `{{ template "jira.default.summary" . }}`, Description: `{{ template "jira.default.description" . }}`, IssueType: "Incident", Project: "OPS", Priority: `{{ template "jira.default.priority" . }}`, Labels: []string{"alertmanager", "{{ .GroupLabels.alertname }}"}, ReopenDuration: model.Duration(1 time.Hour), ReopenTransition: "REOPEN", ResolveTransition: "CLOSE", WontFixResolution: "WONTFIX", }, alert: &types.Alert{ Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, searchResponse: issueSearchResult{ Total: 1, Issues: []issue{ { Key: "OPS-3", Fields: &issueFields{ Status: &issueStatus{ Name: "Closed", StatusCategory: struct { Key string `json:"key"` }{ Key: "done", }, }, }, }, }, }, issue: issue{ Key: "", Fields: &issueFields{ Summary: "[FIRING:1] test (vm1)", Description: "\n\n# Alerts Firing:\n\nLabels:\n - alertname = test\n - instance = vm1\n\nAnnotations:\n\nSource: \n\n\n\n\n", Issuetype: &idNameValue{Name: "Incident"}, Labels: []string{"ALERT{6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b}", "alertmanager", "test"}, Project: &issueProject{Key: "OPS"}, }, }, customFieldAssetFn: func(t testing.T, issue map[string]any) {}, errMsg: "can't find transition REOPEN for issue OPS-3", }, } { tc := tc t.Run(tc.title, func(t testing.T) { srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r http.Request) { switch r.URL.Path { case "/search": enc := json.NewEncoder(w) if err := enc.Encode(tc.searchResponse); err != nil { panic(err) } return case "/issue/OPS-1/transitions": switch r.Method { case http.MethodGet: w.WriteHeader(http.StatusOK) transitions := issueTransitions{ Transitions: []idNameValue{ {ID: "12345", Name: "REOPEN"}, }, } enc := json.NewEncoder(w) if err := enc.Encode(transitions); err != nil { panic(err) } case http.MethodPost: dec := json.NewDecoder(r.Body) var out issue err := dec.Decode(&out) if err != nil { panic(err) } require.Equal(t, issue{Transition: &idNameValue{ID: "12345"}}, out) w.WriteHeader(http.StatusNoContent) default: t.Fatalf("unexpected method %s", r.Method) } return case "/issue/OPS-2/transitions": switch r.Method { case http.MethodGet: w.WriteHeader(http.StatusOK) transitions := issueTransitions{ Transitions: []idNameValue{ {ID: "54321", Name: "CLOSE"}, }, } enc := json.NewEncoder(w) if err := enc.Encode(transitions); err != nil { panic(err) } case http.MethodPost: dec := json.NewDecoder(r.Body) var out issue err := dec.Decode(&out) if err != nil { panic(err) } require.Equal(t, issue{Transition: &idNameValue{ID: "54321"}}, out) w.WriteHeader(http.StatusNoContent) default: t.Fatalf("unexpected method %s", r.Method) } return case "/issue/OPS-3/transitions": switch r.Method { case http.MethodGet: w.WriteHeader(http.StatusOK) transitions := issueTransitions{ Transitions: []idNameValue{}, } enc := json.NewEncoder(w) if err := enc.Encode(transitions); err != nil { panic(err) } default: t.Fatalf("unexpected method %s", r.Method) } return case "/issue/OPS-1": case "/issue/OPS-2": case "/issue/OPS-3": fallthrough case "/issue": body, err := io.ReadAll(r.Body) if err != nil { panic(err) } var ( issue issue raw map[string]any ) if err := json.Unmarshal(body, &issue); err != nil { panic(err) } // We don't care about the key, so copy it over. issue.Fields.Fields = tc.issue.Fields.Fields require.Equal(t, tc.issue.Key, issue.Key) require.Equal(t, tc.issue.Fields, issue.Fields) if err := json.Unmarshal(body, &raw); err != nil { panic(err) } if fields, ok := raw["fields"].(map[string]any); ok { tc.customFieldAssetFn(t, fields) } else { t.Errorf("fields should a map of string") } w.WriteHeader(http.StatusCreated) w.WriteHeader(http.StatusCreated) default: t.Fatalf("unexpected path %s", r.URL.Path) } })) defer srv.Close() u, _ := url.Parse(srv.URL) tc.cfg.APIURL = &config.URL{URL: u} tc.cfg.HTTPConfig = &commoncfg.HTTPClientConfig{} notifier, err := New(tc.cfg, test.CreateTmpl(t), promslog.NewNopLogger()) require.NoError(t, err) ctx := context.Background() ctx = notify.WithGroupKey(ctx, "1") ctx = notify.WithGroupLabels(ctx, model.LabelSet{"alertname": "test"}) _, err = notifier.Notify(ctx, tc.alert) if tc.errMsg == "" { require.NoError(t, err) } else { require.Error(t, err) require.EqualError(t, err, tc.errMsg) } }) } } func TestJiraPriority(t testing.T) { t.Parallel() for _, tc := range []struct { title string alerts []types.Alert expectedPriority string }{ { "empty", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "", }, { "critical", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "critical", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "High", }, { "warning", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "warning", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "Medium", }, { "info", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "info", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "Low", }, { "critical+warning+info", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "critical", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "warning", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "info", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "High", }, { "warning+info", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "warning", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "info", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "Medium", }, { "critical(resolved)+warning+info", []types.Alert{ { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "critical", }, StartsAt: time.Now().Add(-time.Hour), EndsAt: time.Now().Add(-time.Hour), }, }, { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "warning", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, { Alert: model.Alert{ Labels: model.LabelSet{ "alertname": "test", "instance": "vm1", "severity": "info", }, StartsAt: time.Now(), EndsAt: time.Now().Add(time.Hour), }, }, }, "Medium", }, } { tc := tc t.Run(tc.title, func(t *testing.T) { t.Parallel() u, err := url.Parse("http://example.com/") require.NoError(t, err) tmpl, err := template.FromGlobs([]string{}) require.NoError(t, err) tmpl.ExternalURL = u var ( data = tmpl.Data("jira", model.LabelSet{}, tc.alerts...) tmplTextErr error tmplText = notify.TmplText(tmpl, data, &tmplTextErr) tmplTextFunc = func(tmpl string) (string, error) { result := tmplText(tmpl) return result, tmplTextErr } ) priority, err := tmplTextFunc(`{{ template "jira.default.priority" . }}`) require.NoError(t, err) require.Equal(t, tc.expectedPriority, priority) }) } }	26.08 KB	2025-05-25 12:27
📄 types.go // Copyright 2023 Prometheus Team // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package jira import ( "encoding/json" ) type templateFunc func(string) (string, error) type issue struct { Key string `json:"key,omitempty"` Fields issueFields `json:"fields,omitempty"` Transition idNameValue `json:"transition,omitempty"` } type issueFields struct { Description any `json:"description"` Issuetype idNameValue `json:"issuetype,omitempty"` Labels []string `json:"labels,omitempty"` Priority idNameValue `json:"priority,omitempty"` Project issueProject `json:"project,omitempty"` Resolution idNameValue `json:"resolution,omitempty"` Summary string `json:"summary"` Status *issueStatus `json:"status,omitempty"` Fields map[string]any `json:"-"` } type idNameValue struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` } type issueProject struct { Key string `json:"key"` } type issueStatus struct { Name string `json:"name"` StatusCategory struct { Key string `json:"key"` } `json:"statusCategory"` } type issueSearch struct { Expand []string `json:"expand"` Fields []string `json:"fields"` JQL string `json:"jql"` MaxResults int `json:"maxResults"` StartAt int `json:"startAt"` } type issueSearchResult struct { Total int `json:"total"` Issues []issue `json:"issues"` } type issueTransitions struct { Transitions []idNameValue `json:"transitions"` } // MarshalJSON merges the struct issueFields and issueFields.CustomField together. func (i issueFields) MarshalJSON() ([]byte, error) { jsonFields := map[string]interface{}{ "description": i.Description, "summary": i.Summary, } if i.Issuetype != nil { jsonFields["issuetype"] = i.Issuetype } if i.Labels != nil { jsonFields["labels"] = i.Labels } if i.Priority != nil { jsonFields["priority"] = i.Priority } if i.Project != nil { jsonFields["project"] = i.Project } if i.Resolution != nil { jsonFields["resolution"] = i.Resolution } if i.Status != nil { jsonFields["status"] = i.Status } for key, field := range i.Fields { jsonFields[key] = field } return json.Marshal(jsonFields) }	2.7 KB	2025-05-25 12:27

Terminal