Merge pull request #176 from LWJ/sentry_provider

Add support for Sentry provider

api/v1beta1/provider_types.go

@@ -28,7 +28,7 @@ const (
 // ProviderSpec defines the desired state of Provider
 type ProviderSpec struct {
 	// Type of provider
-	// +kubebuilder:validation:Enum=slack;discord;msteams;rocket;generic;github;gitlab;bitbucket;azuredevops;googlechat;webex
+	// +kubebuilder:validation:Enum=slack;discord;msteams;rocket;generic;github;gitlab;bitbucket;azuredevops;googlechat;webex;sentry
 	// +required
 	Type string `json:"type"`
 
@@ -70,6 +70,7 @@ const (
 	AzureDevOpsProvider string = "azuredevops"
 	GoogleChatProvider  string = "googlechat"
 	WebexProvider       string = "webex"
+	SentryProvider      string = "sentry"
 )
 
 // ProviderStatus defines the observed state of Provider

config/crd/bases/notification.toolkit.fluxcd.io_providers.yaml

@@ -81,6 +81,7 @@ spec:
                 - azuredevops
                 - googlechat
                 - webex
+                - sentry
                 type: string
               username:
                 description: Bot username for this provider

docs/spec/v1beta1/provider.md

@@ -45,6 +45,7 @@ Notification providers:
 * Rocket
 * Google Chat
 * Webex
+* Sentry
 * Generic webhook
 
 Git commit status providers:
@@ -105,7 +106,7 @@ kubectl create secret generic webhook-url \
 
 Note that the secret must contain an `address` field.
 
-The provider type can be: `slack`, `msteams`, `rocket`, `discord`, `googlechat`, `webex`, `github`, `gitlab`, `bitbucket`, `azuredevops` or `generic`.
+The provider type can be: `slack`, `msteams`, `rocket`, `discord`, `googlechat`, `webex`, `sentry`, `github`, `gitlab`, `bitbucket`, `azuredevops` or `generic`.
 
 When type `generic` is specified, the notification controller will post the
 incoming [event](event.md) in JSON format to the webhook address.

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/fluxcd/notification-controller/api v0.11.0
 	github.com/fluxcd/pkg/apis/meta v0.8.0
 	github.com/fluxcd/pkg/runtime v0.10.1
+	github.com/getsentry/sentry-go v0.10.0
 	github.com/go-logr/logr v0.3.0
 	github.com/google/go-github/v32 v32.1.0
 	github.com/hashicorp/go-retryablehttp v0.6.8

internal/notifier/factory.go

@@ -70,6 +70,8 @@ func (f Factory) Notifier(provider string) (Interface, error) {
 		n, err = NewGoogleChat(f.URL, f.ProxyURL)
 	case v1beta1.WebexProvider:
 		n, err = NewWebex(f.URL, f.ProxyURL)
+	case v1beta1.SentryProvider:
+		n, err = NewSentry(f.URL)
 	default:
 		err = fmt.Errorf("provider %s not supported", provider)
 	}

internal/notifier/sentry.go

@@ -0,0 +1,74 @@
+/*
+Copyright 2020 The Flux authors
+
+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 notifier
+
+import (
+	"fmt"
+	"github.com/fluxcd/pkg/runtime/events"
+	"github.com/getsentry/sentry-go"
+)
+
+// Sentry holds the client instance
+type Sentry struct {
+	Client *sentry.Client
+}
+
+// NewSentry creates a Sentry client from the provided Data Source Name (DSN)
+func NewSentry(dsn string) (*Sentry, error) {
+	client, err := sentry.NewClient(sentry.ClientOptions{
+		Dsn: dsn,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return &Sentry{
+		Client: client,
+	}, nil
+}
+
+// Post event to Sentry
+func (s *Sentry) Post(event events.Event) error {
+	// Skip any update events
+	if isCommitStatus(event.Metadata, "update") {
+		return nil
+	}
+
+	// Send event to Sentry
+	s.Client.CaptureEvent(toSentryEvent(event), nil, nil)
+	return nil
+}
+
+// Maps a controller-issued event to a Sentry event
+func toSentryEvent(event events.Event) *sentry.Event {
+	// Prepare Metadata
+	extra := make(map[string]interface{}, len(event.Metadata))
+	for k, v := range event.Metadata {
+		extra[k] = v
+	}
+
+	// Construct event
+	obj := event.InvolvedObject
+	return &sentry.Event{
+		Timestamp:   event.Timestamp.Time,
+		Level:       sentry.Level(event.Severity),
+		ServerName:  event.ReportingController,
+		Transaction: fmt.Sprintf("%s: %s/%s", obj.Kind, obj.Namespace, obj.Name),
+		Extra:       extra,
+		Message:     event.Message,
+	}
+}

internal/notifier/sentry_test.go

@@ -0,0 +1,68 @@
+/*
+Copyright 2020 The Flux authors
+
+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 notifier
+
+import (
+	"github.com/fluxcd/pkg/runtime/events"
+	"github.com/getsentry/sentry-go"
+	"github.com/stretchr/testify/assert"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewSentry(t *testing.T) {
+	s, err := NewSentry("https://test@localhost/1")
+	require.NoError(t, err)
+	assert.Equal(t, s.Client.Options().Dsn, "https://test@localhost/1")
+}
+
+func TestToSentryEvent(t *testing.T) {
+	// Construct test event
+	e := events.Event{
+		InvolvedObject: corev1.ObjectReference{
+			Kind:      "GitRepository",
+			Namespace: "flux-system",
+			Name:      "test-app",
+		},
+		Severity:  "info",
+		Timestamp: metav1.Date(2020, 01, 01, 0, 0, 0, 0, time.UTC),
+		Message:   "message",
+		Metadata: map[string]string{
+			"key1": "val1",
+			"key2": "val2",
+		},
+		ReportingController: "source-controller",
+	}
+
+	// Map to Sentry event
+	s := toSentryEvent(e)
+
+	// Assertions
+	assert.Equal(t, time.Date(2020, 01, 01, 0, 0, 0, 0, time.UTC), s.Timestamp)
+	assert.Equal(t, sentry.LevelInfo, s.Level)
+	assert.Equal(t, "source-controller", s.ServerName)
+	assert.Equal(t, "GitRepository: flux-system/test-app", s.Transaction)
+	assert.Equal(t, map[string]interface{}{
+		"key1": "val1",
+		"key2": "val2",
+	}, s.Extra)
+	assert.Equal(t, "message", s.Message)
+}