Merge pull request #37 from korotin/master

Plugin & alert rules APIs

Author: cwood

.gitignore

@@ -1,2 +1,3 @@
 vendor/
 coverage.out
+.env

alert_rule.go

@@ -0,0 +1,70 @@
+package sentry
+
+import (
+	"fmt"
+	"net/http"
+	"time"
+)
+
+type alertRuleMatchPolicy string
+
+var (
+	AlertRuleMatchAll  = alertRuleMatchPolicy("all")
+	AlertRuleMatchAny  = alertRuleMatchPolicy("any")
+	AlertRuleMatchNone = alertRuleMatchPolicy("none")
+)
+
+// AlertRuleCondition represents alert rule condition.
+// Refer to https://github.com/getsentry/sentry/tree/master/src/sentry/rules/conditions or GUI
+// to get detailed information.
+type AlertRuleCondition struct {
+	ID        string      `json:"id,omitempty"`
+	Name      string      `json:"name,omitempty"`
+	Interval  string      `json:"interval,omitempty"` // 1m, 1w, 30d etc
+	Value     interface{} `json:"value,omitempty"`
+	Attribute string      `json:"attribute,omitempty"`
+	Key       string      `json:"key,omitempty"`
+}
+
+// AlertRuleAction represents alert rule action.
+// Refer to https://github.com/getsentry/sentry/tree/master/src/sentry/rules/actions or GUI
+// to get detailed information.
+type AlertRuleAction struct {
+	ID      string `json:"id,omitempty"`
+	Name    string `json:"name,omitempty"`
+	Service string `json:"service,omitempty"`
+}
+
+type AlertRule struct {
+	ID          string               `json:"id,omitempty"`
+	Name        string               `json:"name,omitempty"`
+	DateCreated *time.Time           `json:"dateCreated,omitempty"`
+	Environment *string              `json:"environment,omitempty"`
+	ActionMatch alertRuleMatchPolicy `json:"actionMatch,omitempty"`
+	Frequency   uint                 `json:"frequency,omitempty"` // run actions at most once every Frequency minutes
+	Conditions  []AlertRuleCondition `json:"conditions,omitempty"`
+	Actions     []AlertRuleAction    `json:"actions,omitempty"`
+}
+
+func (c *Client) GetAlertRules(o Organization, p Project) ([]AlertRule, *Link, error) {
+	var rules []AlertRule
+	link, err := c.doWithPagination(http.MethodGet, fmt.Sprintf("projects/%s/%s/rules/", *o.Slug, *p.Slug), &rules, nil)
+
+	return rules, link, err
+}
+
+func (c *Client) AddAlertRule(o Organization, p Project, r AlertRule) (AlertRule, error) {
+	err := c.do(http.MethodPost, fmt.Sprintf("projects/%s/%s/rules/", *o.Slug, *p.Slug), &r, r)
+
+	return r, err
+}
+
+func (c *Client) UpdateAlertRule(o Organization, p Project, r AlertRule) (AlertRule, error) {
+	err := c.do(http.MethodPut, fmt.Sprintf("projects/%s/%s/rules/%s/", *o.Slug, *p.Slug, r.ID), &r, r)
+
+	return r, err
+}
+
+func (c *Client) DeleteAlertRule(o Organization, p Project, r AlertRule) error {
+	return c.do(http.MethodDelete, fmt.Sprintf("projects/%s/%s/rules/%s/", *o.Slug, *p.Slug, r.ID), nil, nil)
+}

alert_rule_test.go

@@ -0,0 +1,125 @@
+package sentry
+
+import (
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+func TestClient_GetAlertRules(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	rules, _, err := client.GetAlertRules(org, project)
+	require.NoError(t, err, "unable to get alert rules")
+
+	require.Greater(t, len(rules), 0, "no alert rules defined")
+	require.Greater(t, len(rules[0].Conditions), 0, "no conditions for rule")
+	require.Greater(t, len(rules[0].Actions), 0, "no actions for rule")
+}
+
+func TestClient_AddAlertRule(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	rule, err := client.AddAlertRule(org, project, AlertRule{
+		Name:        "Test alert rule",
+		ActionMatch: AlertRuleMatchAll,
+		Frequency:   30,
+		Conditions: []AlertRuleCondition{
+			{ID: "sentry.rules.conditions.regression_event.RegressionEventCondition"},
+		},
+		Actions: []AlertRuleAction{
+			{ID: "sentry.rules.actions.notify_event_service.NotifyEventServiceAction", Service: "mail"},
+		},
+	})
+	require.NoError(t, err, "unable to create rule")
+	require.NotEqual(t, 0, rule.ID, "missing rule ID")
+	require.Equal(t, 1, len(rule.Conditions), "wrong condition count")
+	require.Equal(t, 1, len(rule.Actions), "wrong action count")
+
+	rules, _, err := client.GetAlertRules(org, project)
+	require.NoError(t, err, "unable to get alert rules")
+	require.Equal(t, len(rules), 2, "rule wasn't created")
+	for _, r := range rules {
+		if r.ID == rule.ID {
+			require.Equal(t, rule, r, "rules do not match")
+			break
+		}
+	}
+}
+
+func TestClient_UpdateAlertRule(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	rules, _, err := client.GetAlertRules(org, project)
+	require.NoError(t, err, "unable to get alert rules")
+
+	require.Greater(t, len(rules), 0, "no alert rules defined")
+
+	rule := rules[0]
+	require.Equal(t, 1, len(rule.Conditions), "unexpected condition count for rule")
+
+	rule.Conditions = append(
+		rule.Conditions,
+		AlertRuleCondition{ID: "sentry.rules.conditions.regression_event.RegressionEventCondition"},
+	)
+
+	rule, err = client.UpdateAlertRule(org, project, rule)
+	require.NoError(t, err, "unable to get update rule")
+	require.Equal(t, 2, len(rule.Conditions), "conditions weren't updated")
+}
+
+func TestClient_DeleteAlertRule(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	rules, _, err := client.GetAlertRules(org, project)
+	require.NoError(t, err, "unable to get alert rules")
+
+	require.Greater(t, len(rules), 0, "no alert rules defined")
+
+	err = client.DeleteAlertRule(org, project, rules[0])
+	require.NoError(t, err, "unable to get delete rule")
+
+	rules, _, err = client.GetAlertRules(org, project)
+	require.NoError(t, err, "unable to get alert rules")
+	require.Equal(t, 0, len(rules), "rule wasn't deleted")
+
+}

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/go-errors/errors v1.1.1 // indirect
 	github.com/google/go-cmp v0.5.4 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/stretchr/testify v1.7.0
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
 )
 

go.sum

@@ -13,6 +13,7 @@ github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8Nz
 github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
 github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dgraph-io/badger v1.6.0/go.mod h1:zwt7syl517jmP8s94KqSxTlM6IMsdhYy6psNgSztDR4=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
@@ -29,7 +30,6 @@ github.com/getsentry/sentry-go v0.9.0/go.mod h1:kELm/9iCblqUYh+ZRML7PNdCvEuw24wB
 github.com/gin-contrib/sse v0.0.0-20190301062529-5545eab6dad3/go.mod h1:VJ0WA2NBN22VlZ2dKZQPAPnyWw5XTlK1KymzLKsr59s=
 github.com/gin-gonic/gin v1.4.0/go.mod h1:OW2EZn3DO8Ln9oIKOvM++LBO+5UPHJJDH72/q/3rZdM=
 github.com/go-check/check v0.0.0-20180628173108-788fd7840127/go.mod h1:9ES+weclKsC9YodN5RgxqK/VD9HM9JsCSh7rNhMZE98=
-github.com/go-errors/errors v1.0.1 h1:LUHzmkK3GUKUrL/1gfBUxAHzcev3apQlezX/+O7ma6w=
 github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q=
 github.com/go-errors/errors v1.1.1 h1:ljK/pL5ltg3qoN+OtN6yCv9HWSfMwxSx90GJCZQxYNg=
 github.com/go-errors/errors v1.1.1/go.mod h1:psDX2osz5VnTOnFWbDeWwS7yejl+uV3FEWEp4lssFEs=
@@ -104,6 +104,7 @@ github.com/pingcap/errors v0.11.4/go.mod h1:Oi8TUi2kEtXXLMJk9l1cGmz20kV3TaQ0usTw
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
@@ -122,6 +123,8 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc=
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
@@ -176,10 +179,10 @@ golang.org/x/tools v0.0.0-20181221001348-537d06c36207/go.mod h1:n7NCudcB/nEzxVGm
 golang.org/x/tools v0.0.0-20190327201419-c70d86f8b7cf/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
 gopkg.in/go-playground/assert.v1 v1.2.1/go.mod h1:9RXL0bg/zibRAgZUYszZSwO/z8Y/a8bDuhia5mkpMnE=
@@ -190,3 +193,5 @@ gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWD
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

plugin.go

@@ -0,0 +1,35 @@
+package sentry
+
+import (
+	"fmt"
+	"net/http"
+)
+
+func (c *Client) touchPlugin(o Organization, p Project, pluginID string, enabled bool) error {
+	method := http.MethodDelete
+	if enabled {
+		method = http.MethodPost
+	}
+
+	return c.do(method, fmt.Sprintf("projects/%s/%s/plugins/%s/", *o.Slug, *p.Slug, pluginID), nil, nil)
+}
+
+func (c *Client) EnablePlugin(o Organization, p Project, pluginID string) error {
+	return c.touchPlugin(o, p, pluginID, true)
+}
+
+func (c *Client) DisablePlugin(o Organization, p Project, pluginID string) error {
+	return c.touchPlugin(o, p, pluginID, false)
+}
+
+func (c *Client) GetPlugin(o Organization, p Project, pluginID string) (plugin Plugin, err error) {
+	err = c.do(http.MethodGet, fmt.Sprintf("projects/%s/%s/plugins/%s/", *o.Slug, *p.Slug, pluginID), &plugin, nil)
+
+	return
+}
+
+func (c *Client) SetPluginConfig(o Organization, p Project, pluginID string, config map[string]interface{}) (plugin Plugin, err error) {
+	err = c.do(http.MethodPut, fmt.Sprintf("projects/%s/%s/plugins/%s/", *o.Slug, *p.Slug, pluginID), &plugin, config)
+
+	return
+}

plugin_test.go

@@ -0,0 +1,96 @@
+package sentry
+
+import (
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+const testPlugin = "webhooks"
+
+func pluginEnabled(t *testing.T, client *Client, org Organization, project Project, pluginID string) bool {
+	project, err := client.GetProject(org, *project.Slug)
+	require.NoError(t, err, "failed to get project details")
+
+	require.NotNil(t, project.Plugins, "project details missing plugins section")
+	require.Greater(t, len(*project.Plugins), 0, "no plugins installed")
+
+	for _, p := range *project.Plugins {
+		if p.ID == pluginID {
+			return p.Enabled
+		}
+	}
+	require.Fail(t, "plugin not found")
+
+	return false
+}
+
+func TestClient_EnablePlugin(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	require.False(t, pluginEnabled(t, client, org, project, testPlugin), "plugin already enabled")
+
+	err = client.EnablePlugin(org, project, testPlugin)
+	require.NoError(t, err, "unable to enable plugin")
+
+	require.True(t, pluginEnabled(t, client, org, project, testPlugin), "plugin wasn't enabled")
+
+	err = client.EnablePlugin(org, project, testPlugin)
+	require.NoError(t, err, "unable to enable plugin")
+
+	require.True(t, pluginEnabled(t, client, org, project, testPlugin), "plugin wasn't enabled")
+
+	err = client.DisablePlugin(org, project, testPlugin)
+	require.NoError(t, err, "unable to disable plugin")
+
+	require.False(t, pluginEnabled(t, client, org, project, testPlugin), "plugin wasn't disabled")
+}
+
+func TestClient_GetPlugin(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	plugin, err := client.GetPlugin(org, project, testPlugin)
+	require.NoError(t, err, "unable to get plugin")
+
+	require.Greater(t, len(plugin.Config), 0, "plugin config is missing")
+}
+
+func TestClient_SetPluginConfig(t *testing.T) {
+	client := newTestClient(t)
+	org, err := client.GetOrganization(getDefaultOrg())
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	team, cleanup := createTeamHelper(t)
+	defer cleanup()
+
+	project, cleanupproj := createProjectHelper(t, team)
+	defer cleanupproj()
+
+	plugin, err := client.SetPluginConfig(org, project, testPlugin, map[string]interface{}{
+		"urls": "https://test.com/",
+	})
+	require.NoError(t, err, "unable to get plugin")
+	require.NotEmpty(t, plugin.Config, "unable to get plugin config")
+	require.Equal(t, "https://test.com/", plugin.Config[0].Value)
+}