Merge pull request #125 from walter-cd/suppress-notification

Suppress notification messages
walter-cd · Jul 29, 2015 · 2831ecf · 2831ecf
2 parents b5a7198 + 63fa075
commit 2831ecf
Show file tree

Hide file tree

Showing 10 changed files with 97 additions and 26 deletions.
diff --git a/build b/build
@@ -21,7 +21,7 @@ REPO_PATH="${ORG_PATH}/walter"
 
 export GOBIN=${PWD}/bin
 export GOPATH=${PWD}/gopath
-export GOFMTPATH=" ./stages ./engine ./config ./pipelines ./walter ./version"
+export GOFMTPATH="./stages ./engine ./config ./messengers ./pipelines ./walter ./version"
 
 rm -f ${GOPATH}/src/${REPO_PATH}
 mkdir -p ${GOPATH}/src/${ORG_PATH}

diff --git a/config/parser.go b/config/parser.go
@@ -177,6 +177,13 @@ func (self *Parser) mapMessenger(messengerMap map[interface{}]interface{}) (mess
 				fieldVal := newMessengerValue.Field(i)
 				if fieldVal.Type() == reflect.ValueOf("string").Type() {
 					fieldVal.SetString(self.EnvVariables.Replace(messengerOptVal.(string)))
+				} else if fieldVal.Type().String() == "messengers.BaseMessenger" {
+					elements := messengerOptVal.([]interface{})
+					suppressor := fieldVal.Interface().(messengers.BaseMessenger)
+					for _, element := range elements {
+						suppressor.SuppressFields = append(suppressor.SuppressFields, element.(string))
+					}
+					fieldVal.Set(reflect.ValueOf(suppressor))
 				}
 			}
 		}

diff --git a/config/parser_test.go b/config/parser_test.go
@@ -160,6 +160,34 @@ func TestParseConfWithMessengerBlock(t *testing.T) {
 	assert.Equal(t, "yyyy", messenger.From)
 }
 
+func TestParseConfWithMessengerBlockWithSupress(t *testing.T) {
+	configData, err := ReadConfigBytes([]byte(`
+    messenger:
+           type: hipchat
+           room_id: foobar
+           token: xxxx
+           from: yyyy
+           suppress:
+              - stderr
+              - stdout
+
+    pipeline:
+        - name: command_stage_1
+          type: shell
+          file: ../stages/test_sample.sh
+`))
+	assert.Nil(t, err)
+	parser := &Parser{ConfigData: configData, EnvVariables: NewEnvVariables()}
+	result, err := parser.Parse()
+	messenger, ok := result.Reporter.(*messengers.HipChat)
+	assert.Nil(t, err)
+	assert.Equal(t, true, ok)
+	assert.Equal(t, "foobar", messenger.RoomId)
+	assert.Equal(t, "xxxx", messenger.Token)
+	assert.Equal(t, "yyyy", messenger.From)
+	assert.Equal(t, 2, len(messenger.SuppressFields))
+}
+
 func TestParseConfWithInvalidStage(t *testing.T) {
 	configData, err := ReadConfigBytes([]byte(`pipeline:
     - name: command_stage_1

diff --git a/messengers/fake.go b/messengers/fake.go
@@ -21,6 +21,7 @@ package messengers
 
 // FakeMessenger is a Messenger type used only for testing.
 type FakeMessenger struct {
+	BaseMessenger
 }
 
 func (self *FakeMessenger) Post(messege string) bool {

diff --git a/messengers/hipchat.go b/messengers/hipchat.go
@@ -24,9 +24,10 @@ import (
 // HipChat is a client which reports the pipeline results to the HipChat server.
 // The client uses V1 of the HipChat API.
 type HipChat struct {
-	RoomId string `config:"room_id"`
-	Token  string `config:"token"`
-	From   string `config:"from"`
+	BaseMessenger `config:"suppress"`
+	RoomId        string `config:"room_id"`
+	Token         string `config:"token"`
+	From          string `config:"from"`
 }
 
 // TODO: make hipchat api endpoint configurable for on-premises servers

diff --git a/messengers/hipchat2.go b/messengers/hipchat2.go
@@ -25,11 +25,12 @@ import (
 // HipChat2 is a client which reports the pipeline results to the HipChat server.
 // The client uses V2 of the HipChat API.
 type HipChat2 struct {
-	RoomID  string `config:"room_id"`
-	Token   string `config:"token"`
-	From    string `config:"from"`
-	BaseURL string `config:"base_url"`
-	client  *hipchat.Client
+	BaseMessenger `config:"suppress"`
+	RoomID        string `config:"room_id"`
+	Token         string `config:"token"`
+	From          string `config:"from"`
+	BaseURL       string `config:"base_url"`
+	client        *hipchat.Client
 }
 
 // Post sends a new HipChat message using V2 of the API

diff --git a/messengers/messenger.go b/messengers/messenger.go
@@ -24,6 +24,24 @@ import (
 // services such as Slack or HipChat.
 type Messenger interface {
 	Post(string) bool
+	Suppress(string) bool
+}
+
+type BaseMessenger struct {
+	SuppressFields []string `config:"suppress"`
+}
+
+func (self *BaseMessenger) Post(messege string) bool {
+	return true
+}
+
+func (self *BaseMessenger) Suppress(output_type string) bool {
+	for _, suppress := range self.SuppressFields {
+		if suppress == output_type {
+			return true
+		}
+	}
+	return false
 }
 
 // InitMessenger generates a spefified Messenger client objet.

diff --git a/messengers/slack.go b/messengers/slack.go
@@ -27,11 +27,12 @@ import (
 
 // Slack is a client which reports the pipeline results to the Slack chennel.
 type Slack struct {
-	Channel   string   `config:"channel" json:"channel"`
-	UserName  string   `config:"username" json:"username"`
-	IconEmoji string   `config:"icon" json:"icon_emoji,omitempty"`
-	IconUrl   string   `config:"icon_url" json:"icon_url,omitempty"`
-	IncomingUrl string `config:"url" json:"-"` // not map to json
+	BaseMessenger `config:"suppress"`
+	Channel       string `config:"channel" json:"channel"`
+	UserName      string `config:"username" json:"username"`
+	IconEmoji     string `config:"icon" json:"icon_emoji,omitempty"`
+	IconUrl       string `config:"icon_url" json:"icon_url,omitempty"`
+	IncomingUrl   string `config:"url" json:"-"` // not map to json
 }
 
 // To avoid the infinite recursion
@@ -46,12 +47,12 @@ func (self *Slack) Post(message string) bool {
 
 	var color string
 
-	if strings.Contains(message, ", true") {
-		color = "good"
-	} else if strings.Contains(message, ", skipped") {
-		color = "warning"
-	} else {
+	if strings.Contains(message, "[RESULT] Failed") {
 		color = "danger"
+	} else if strings.Contains(message, "[RESULT] Skipped") {
+		color = "warning"
+	} else if strings.Contains(message, "[RESULT] Succeeded") {
+		color = "good"
 	}
 
 	attachment := map[string]string{

diff --git a/pipelines/pipeline.go b/pipelines/pipeline.go
@@ -48,19 +48,29 @@ type Resources struct {
 }
 
 // ReportStageResult throw the results of specified stage to the messenger services.
-func (self *Resources) ReportStageResult(stage stages.Stage, result string) {
+func (self *Resources) ReportStageResult(stage stages.Stage, resultStr string) {
 	name := stage.GetStageName()
-	self.Reporter.Post(
-		fmt.Sprintf("Stage execution results: %+v, %+v", name, result))
+	if !self.Reporter.Suppress("result") {
+		if resultStr == "true" {
+			self.Reporter.Post(
+				fmt.Sprintf("[%s][RESULT] Succeeded", name))
+		} else if resultStr == "skipped" {
+			self.Reporter.Post(
+				fmt.Sprintf("[%s][RESULT] Skipped", name))
+		} else {
+			self.Reporter.Post(
+				fmt.Sprintf("[%s][RESULT] Failed", name))
+		}
+	}
 
 	if stage.GetStageOpts().ReportingFullOutput {
-		if out := stage.GetOutResult(); len(out) > 0 {
+		if out := stage.GetOutResult(); (len(out) > 0) && (!self.Reporter.Suppress("stdout")) {
 			self.Reporter.Post(
-				fmt.Sprintf("[%s] %s", name, stage.GetOutResult()))
+				fmt.Sprintf("[%s][STDOUT] %s", name, stage.GetOutResult()))
 		}
-		if err := stage.GetErrResult(); len(err) > 0 {
+		if err := stage.GetErrResult(); len(err) > 0 && (!self.Reporter.Suppress("stderr")) {
 			self.Reporter.Post(
-				fmt.Sprintf("[%s][ERROR] %s", name, stage.GetErrResult()))
+				fmt.Sprintf("[%s][STDERR] %s", name, stage.GetErrResult()))
 		}
 	}
 }

diff --git a/pipelines/pipeline_test.go b/pipelines/pipeline_test.go
@@ -56,6 +56,10 @@ func (mock *MockMessenger) Post(msg string) bool {
 	return true
 }
 
+func (self *MockMessenger) Suppress(output_type string) bool {
+	return false
+}
+
 func TestReportStageResult(t *testing.T) {
 	mock := &MockMessenger{}
 	p := Resources{