add notification in root level (#125)

* fix step notifications

* generate pipeline with top level notify

* parse pipeline notification from config

* update plugin definition

Author: adikari

.buildkite/pipeline.yml

@@ -9,9 +9,7 @@ steps:
               config:
                 trigger: "foo-service"
                 notify:
-                  - email: [email protected]
-                  - slack: "@monebag"
-                  - webhook: "https://webhook.com"
+                  - slack: "#alerts"
             - path: "hello-service/"
               config:
                 trigger: "this-pipeline-does-not-exists"
@@ -23,13 +21,13 @@ steps:
     plugins:
       - monebag/monorepo-diff:
           diff: "cat ./e2e/multiple-paths"
+          notify:
+            - email: [email protected]
           watch:
             - path:
                 - "user-service/infrastructure/"
               config:
                 command: "echo i-am-running-in-a-group"
-                notify:
-                  - email: [email protected]
 
   - label: ":bomb: Testing groups"
     plugins:

pipeline.go

@@ -24,6 +24,21 @@ func (WaitStep) MarshalYAML() (interface{}, error) {
 	}, nil
 }
 
+func (s Step) MarshalYAML() (interface{}, error) {
+	if s.Group == "" {
+		type Alias Step
+		return (Alias)(s), nil
+	}
+
+	label := s.Group
+	s.Group = ""
+	return Group{Label: label, Steps: []Step{s}}, nil
+}
+
+func (n PluginNotify) MarshalYAML() (interface{}, error) {
+	return n, nil
+}
+
 // PipelineGenerator generates pipeline file
 type PipelineGenerator func(steps []Step, plugin Plugin) (*os.File, error)
 
@@ -151,6 +166,7 @@ func generatePipeline(steps []Step, plugin Plugin) (*os.File, error) {
 	}
 
 	yamlSteps := make([]yaml.Marshaler, len(steps))
+
 	for i, step := range steps {
 		yamlSteps[i] = step
 	}
@@ -163,10 +179,19 @@ func generatePipeline(steps []Step, plugin Plugin) (*os.File, error) {
 		yamlSteps = append(yamlSteps, Step{Command: cmd.Command})
 	}
 
+	yamlNotify := make([]yaml.Marshaler, len(plugin.Notify))
+	for i, n := range plugin.Notify {
+		yamlNotify[i] = n
+	}
+
 	pipeline := map[string][]yaml.Marshaler{
 		"steps": yamlSteps,
 	}
 
+	if len(yamlNotify) > 0 {
+		pipeline["notify"] = yamlNotify
+	}
+
 	data, err := yaml.Marshal(&pipeline)
 	if err != nil {
 		return nil, fmt.Errorf("could not serialize the pipeline: %v", err)

pipeline_test.go

@@ -228,19 +228,15 @@ func TestGeneratePipeline(t *testing.T) {
 			Trigger:  "foo-service-pipeline",
 			Build:    Build{Message: "build message"},
 			SoftFail: true,
-			Notify: []Notify{
-				{Email: "[email protected]"},
-				{Email: "[email protected]"},
+			Notify: []StepNotify{
+				{Slack: "@adikari"},
 			},
 		},
 		{
 			Trigger: "notification-test",
 			Command: "command-to-run",
-			Notify: []Notify{
-				{Email: "[email protected]"},
+			Notify: []StepNotify{
 				{Basecamp: "https://basecamp-url"},
-				{Webhook: "https://webhook-url"},
-				{PagerDuty: "636d22Yourc0418Key3b49eee3e8"},
 				{GithubStatus: GithubStatusNotification{Context: "my-custom-status"}},
 				{Slack: "@someuser", Condition: "build.state === \"passed\""},
 			},
@@ -252,22 +248,50 @@ func TestGeneratePipeline(t *testing.T) {
 		},
 	}
 
+	plugin := Plugin{
+		Wait: true,
+		Notify: []PluginNotify{
+			{Email: "[email protected]"},
+			{Email: "[email protected]"},
+			{Basecamp: "https://basecamp"},
+			{Webhook: "https://webhook"},
+			{Slack: "@adikari"},
+			{GithubStatus: GithubStatusNotification{Context: "github-context"}},
+		},
+		Hooks: []HookConfig{
+			{Command: "echo \"hello world\""},
+			{Command: "cat ./file.txt"},
+		},
+	}
+
+	pipeline, err := generatePipeline(steps, plugin)
+
+	require.NoError(t, err)
+	defer os.Remove(pipeline.Name())
+
+	got, err := ioutil.ReadFile(pipeline.Name())
+	require.NoError(t, err)
+
 	want :=
-		`steps:
+		`notify:
+- email: [email protected]
+- email: [email protected]
+- basecamp_campfire: https://basecamp
+- webhook: https://webhook
+- slack: '@adikari'
+- github_commit_status:
+    context: github-context
+steps:
 - trigger: foo-service-pipeline
   build:
     message: build message
   soft_fail: true
   notify:
-  - email: [email protected]
-  - email: [email protected]
+  - slack: '@adikari'
 - trigger: notification-test
   command: command-to-run
   notify:
-  - email: [email protected]
   - basecamp_campfire: https://basecamp-url
-  - webhook: https://webhook-url
-  - pagerduty_change_event: 636d22Yourc0418Key3b49eee3e8
   - github_commit_status:
       context: my-custom-status
   - slack: '@someuser'
@@ -282,21 +306,6 @@ func TestGeneratePipeline(t *testing.T) {
 - command: cat ./file.txt
 `
 
-	plugin := Plugin{
-		Wait: true,
-		Hooks: []HookConfig{
-			{Command: "echo \"hello world\""},
-			{Command: "cat ./file.txt"},
-		},
-	}
-
-	pipeline, err := generatePipeline(steps, plugin)
-	require.NoError(t, err)
-	defer os.Remove(pipeline.Name())
-
-	got, err := ioutil.ReadFile(pipeline.Name())
-	require.NoError(t, err)
-
 	assert.Equal(t, want, string(got))
 }
 

plugin.go

@@ -20,6 +20,8 @@ type Plugin struct {
 	Watch         []WatchConfig
 	RawEnv        interface{} `json:"env"`
 	Env           map[string]string
+	RawNotify     []map[string]interface{} `json:"notify" yaml:",omitempty"`
+	Notify        []PluginNotify           `yaml:"notify,omitempty"`
 }
 
 // HookConfig Plugin hook configuration
@@ -39,19 +41,28 @@ type Group struct {
 	Steps []Step `yaml:"steps"`
 }
 
+// GithubStatusNotification is notification config for github_commit_status
 type GithubStatusNotification struct {
 	Context string `yaml:"context,omitempty"`
 }
 
-// Notify is Buildkite notification definition
-type Notify struct {
-	Email        string                   `yaml:"email,omitempty"`
-	Basecamp     string                   `yaml:"basecamp_campfire,omitempty"`
+// PluginNotify is notify configuration for pipeline
+type PluginNotify struct {
 	Slack        string                   `yaml:"slack,omitempty"`
-	Webhook      string                   `yaml:"webhook,omitempty"`
+	Email        string                   `yaml:"email,omitempty"`
 	PagerDuty    string                   `yaml:"pagerduty_change_event,omitempty"`
+	Webhook      string                   `yaml:"webhook,omitempty"`
+	Basecamp     string                   `yaml:"basecamp_campfire,omitempty"`
+	GithubStatus GithubStatusNotification `yaml:"github_commit_status,omitempty"`
 	Condition    string                   `yaml:"if,omitempty"`
+}
+
+// Notify is Buildkite notification definition
+type StepNotify struct {
+	Slack        string                   `yaml:"slack,omitempty"`
+	Basecamp     string                   `yaml:"basecamp_campfire,omitempty"`
 	GithubStatus GithubStatusNotification `yaml:"github_commit_status,omitempty"`
+	Condition    string                   `yaml:"if,omitempty"`
 }
 
 // Step is buildkite pipeline definition
@@ -69,7 +80,7 @@ type Step struct {
 	Async     bool                     `yaml:"async,omitempty"`
 	SoftFail  interface{}              `json:"soft_fail" yaml:"soft_fail,omitempty"`
 	RawNotify []map[string]interface{} `json:"notify" yaml:",omitempty"`
-	Notify    []Notify                 `yaml:"notify,omitempty"`
+	Notify    []StepNotify             `yaml:"notify,omitempty"`
 }
 
 // Agent is Buildkite agent definition
@@ -85,45 +96,6 @@ type Build struct {
 	// Notify  []Notify          `yaml:"notify,omitempty"`
 }
 
-func (s Step) MarshalYAML() (interface{}, error) {
-	if s.Group == "" {
-		type Alias Step
-		return (Alias)(s), nil
-	}
-
-	label := s.Group
-	s.Group = ""
-	return Group{Label: label, Steps: []Step{s}}, nil
-}
-
-func initializePlugin(data string) (Plugin, error) {
-	log.Debugf("parsing plugin config: %v", data)
-
-	var pluginConfigs []map[string]json.RawMessage
-
-	if err := json.Unmarshal([]byte(data), &pluginConfigs); err != nil {
-		log.Debug(err)
-		return Plugin{}, errors.New("failed to parse plugin configuration")
-	}
-
-	for _, p := range pluginConfigs {
-		for key, pluginConfig := range p {
-			if strings.HasPrefix(key, pluginName) {
-				var plugin Plugin
-
-				if err := json.Unmarshal(pluginConfig, &plugin); err != nil {
-					log.Debug(err)
-					return Plugin{}, errors.New("failed to parse plugin configuration")
-				}
-
-				return plugin, nil
-			}
-		}
-	}
-
-	return Plugin{}, errors.New("could not initialize plugin")
-}
-
 // UnmarshalJSON set defaults properties
 func (plugin *Plugin) UnmarshalJSON(data []byte) error {
 	type plain Plugin
@@ -147,6 +119,8 @@ func (plugin *Plugin) UnmarshalJSON(data []byte) error {
 	plugin.Env = parseResult
 	plugin.RawEnv = nil
 
+	setPluginNotify(&plugin.Notify, &plugin.RawNotify)
+
 	// Path can be string or an array of strings,
 	// handle both cases and create an array of paths.
 	for i, p := range plugin.Watch {
@@ -175,9 +149,37 @@ func (plugin *Plugin) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
-func setNotify(notifications *[]Notify, rawNotify *[]map[string]interface{}) {
+func initializePlugin(data string) (Plugin, error) {
+	log.Debugf("parsing plugin config: %v", data)
+
+	var pluginConfigs []map[string]json.RawMessage
+
+	if err := json.Unmarshal([]byte(data), &pluginConfigs); err != nil {
+		log.Debug(err)
+		return Plugin{}, errors.New("failed to parse plugin configuration")
+	}
+
+	for _, p := range pluginConfigs {
+		for key, pluginConfig := range p {
+			if strings.HasPrefix(key, pluginName) {
+				var plugin Plugin
+
+				if err := json.Unmarshal(pluginConfig, &plugin); err != nil {
+					log.Debug(err)
+					return Plugin{}, errors.New("failed to parse plugin configuration")
+				}
+
+				return plugin, nil
+			}
+		}
+	}
+
+	return Plugin{}, errors.New("could not initialize plugin")
+}
+
+func setPluginNotify(notifications *[]PluginNotify, rawNotify *[]map[string]interface{}) {
 	for _, v := range *rawNotify {
-		var notify Notify
+		var notify PluginNotify
 
 		if condition, ok := isString(v["if"]); ok {
 			notify.Condition = condition
@@ -225,6 +227,38 @@ func setNotify(notifications *[]Notify, rawNotify *[]map[string]interface{}) {
 	*rawNotify = nil
 }
 
+func setNotify(notifications *[]StepNotify, rawNotify *[]map[string]interface{}) {
+	for _, v := range *rawNotify {
+		var notify StepNotify
+
+		if condition, ok := isString(v["if"]); ok {
+			notify.Condition = condition
+		}
+
+		if basecamp, ok := isString(v["basecamp_campfire"]); ok {
+			notify.Basecamp = basecamp
+			*notifications = append(*notifications, notify)
+			continue
+		}
+
+		if slack, ok := isString(v["slack"]); ok {
+			notify.Slack = slack
+			*notifications = append(*notifications, notify)
+			continue
+		}
+
+		if github, ok := v["github_commit_status"].(map[string]interface{}); ok {
+			if context, ok := isString(github["context"]); ok {
+				notify.GithubStatus = GithubStatusNotification{Context: context}
+				*notifications = append(*notifications, notify)
+			}
+			continue
+		}
+	}
+
+	*rawNotify = nil
+}
+
 func setBuild(build *Build) {
 	if build.Message == "" {
 		build.Message = env("BUILDKITE_MESSAGE", "")