Merge pull request #14 from m-lab/sandbox-soltesz-noop

Add an "in memory" option so non-production deployments can still run

Author: stephen-soltesz

cmd/github_receiver/main.go

@@ -26,6 +26,7 @@ import (
 
 	"github.com/m-lab/alertmanager-github-receiver/alerts"
 	"github.com/m-lab/alertmanager-github-receiver/issues"
+	"github.com/m-lab/alertmanager-github-receiver/issues/local"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
@@ -35,6 +36,7 @@ var (
 	githubOrg       = flag.String("org", "", "The github user or organization name where all repos are found.")
 	githubRepo      = flag.String("repo", "", "The default repository for creating issues when alerts do not include a repo label.")
 	enableAutoClose = flag.Bool("enable-auto-close", false, "Once an alert stops firing, automatically close open issues.")
+	enableInMemory  = flag.Bool("enable-inmemory", false, "Perform all operations in memory, without using github API.")
 	receiverPort    = flag.String("port", "9393", "The port for accepting alertmanager webhook messages.")
 )
 
@@ -66,7 +68,7 @@ func init() {
 	}
 }
 
-func serveReceiverHandler(client *issues.Client) {
+func serveReceiverHandler(client alerts.ReceiverClient) {
 	receiverHandler := &alerts.ReceiverHandler{
 		Client:      client,
 		DefaultRepo: *githubRepo,
@@ -84,6 +86,11 @@ func main() {
 		flag.Usage()
 		os.Exit(1)
 	}
-	client := issues.NewClient(*githubOrg, *authtoken)
+	var client alerts.ReceiverClient
+	if *enableInMemory {
+		client = local.NewClient()
+	} else {
+		client = issues.NewClient(*githubOrg, *authtoken)
+	}
 	serveReceiverHandler(client)
 }

issues/local/local.go

@@ -0,0 +1,64 @@
+// Copyright 2017 alertmanager-github-receiver 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 memory provides in memory operations on GitHub issues.
+package local
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/google/go-github/github"
+)
+
+// Client manages operations on the in memory store.
+type Client struct {
+	issues map[string]*github.Issue
+}
+
+// NewClient creates a Client.
+func NewClient() *Client {
+	return &Client{
+		issues: make(map[string]*github.Issue),
+	}
+}
+
+// CreateIssue adds a new issue to the in memory store.
+func (c *Client) CreateIssue(repo, title, body string) (*github.Issue, error) {
+	c.issues[title] = &github.Issue{
+		Title: &title,
+		Body:  &body,
+	}
+	return c.issues[title], nil
+}
+
+// ListOpenIssues returns all issues in the memory store.
+func (c *Client) ListOpenIssues() ([]*github.Issue, error) {
+	var allIssues []*github.Issue
+	for title := range c.issues {
+		log.Println("ListOpenIssues:", title)
+		allIssues = append(allIssues, c.issues[title])
+	}
+	return allIssues, nil
+}
+
+// CloseIssue removes the issue from the in memory store.
+func (c *Client) CloseIssue(issue *github.Issue) (*github.Issue, error) {
+	if _, ok := c.issues[issue.GetTitle()]; !ok {
+		return nil, fmt.Errorf("Unknown issue:%s", issue.GetTitle())
+	}
+	delete(c.issues, issue.GetTitle())
+	return issue, nil
+}

issues/local/local_test.go

@@ -0,0 +1,77 @@
+// Copyright 2017 alertmanager-github-receiver 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 local
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/google/go-github/github"
+)
+
+func TestMemoryClient(t *testing.T) {
+	tests := []struct {
+		name    string
+		title   string
+		body    string
+		wantErr bool
+	}{
+		{
+			name:  "success",
+			title: "alert name",
+			body:  "foobar",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c := NewClient()
+			got, err := c.CreateIssue("fake-repo", tt.title, tt.body)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("Client.CreateIssue() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			wantIssue := &github.Issue{
+				Title: &tt.title,
+				Body:  &tt.body,
+			}
+			if !reflect.DeepEqual(got, wantIssue) {
+				t.Errorf("Client.CreateIssue() = %v, want %v", got, wantIssue)
+			}
+			list, err := c.ListOpenIssues()
+			if (err != nil) != tt.wantErr {
+				t.Errorf("Client.ListOpenIssues() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			wantList := []*github.Issue{
+				&github.Issue{
+					Title: &tt.title,
+					Body:  &tt.body,
+				},
+			}
+			if !reflect.DeepEqual(list, wantList) {
+				t.Errorf("Client.ListOpenIssues() = %v, want %v", list, wantList)
+			}
+			closed, err := c.CloseIssue(got)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("Client.CloseIssue() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(closed, got) {
+				t.Errorf("Client.CloseIssue() = %v, want %v", closed, got)
+			}
+		})
+	}
+}