added notification support for discord

core/config/config.go

@@ -87,8 +87,8 @@ type BeastConfig struct {
 	GitRemote          GitRemote `toml:"remote"`
 	JWTSecret          string    `toml:"jwt_secret"`
 	SlackWebHookURL    string    `toml:"slack_webhook"`
-
-	TickerFrequency int `toml:"ticker_frequency"`
+	DiscordWebHookURL  string    `toml:"discord_webhook"`
+	TickerFrequency    int       `toml:"ticker_frequency"`
 
 	RemoteSyncPeriod time.Duration `toml:"-"`
 	Rsp              string        `toml:"remote_sync_period"`

core/manager/challenge.go

@@ -523,11 +523,11 @@ func StartUndeployChallenge(challengeName string, purge bool) error {
 	if err != nil {
 		msg := fmt.Sprintf("UNDEPLOY ERROR: %s : %s", challengeName, err)
 		log.Error(msg)
-		notify.SendNotificationToSlack(notify.Error, msg)
+		notify.SendNotification(notify.Error, msg)
 	} else {
 		msg := fmt.Sprintf("UNDEPLOY SUCCESSFUL: %s", challengeName)
 		log.Info(msg)
-		notify.SendNotificationToSlack(notify.Success, msg)
+		notify.SendNotification(notify.Success, msg)
 	}
 
 	log.Infof("Notification for the event sent to slack.")

core/manager/health_check.go

@@ -53,7 +53,7 @@ func ChallengesHealthProber(waitTime int) {
 					log.WithFields(log.Fields{
 						"ChallName": chall.Name,
 					}).Error(msg)
-					notify.SendNotificationToSlack(notify.Error, msg)
+					notify.SendNotification(notify.Error, msg)
 				} else {
 					log.WithFields(log.Fields{
 						"ChallName": chall.Name,

core/manager/pipeline.go

@@ -406,10 +406,10 @@ func StartDeployPipeline(challengeDir string, skipStage bool, skipCommit bool) {
 
 	err := bootstrapDeployPipeline(challengeDir, skipStage, skipCommit)
 	if err != nil {
-		notify.SendNotificationToSlack(notify.Error, err.Error())
+		notify.SendNotification(notify.Error, err.Error())
 	} else {
 		msg := fmt.Sprintf("DEPLOY SUCCESS : %s : Challenge deployment pipeline successful.", challengeName)
-		notify.SendNotificationToSlack(notify.Success, msg)
+		notify.SendNotification(notify.Success, msg)
 	}
 
 	log.Debugf("%s: Notification sent to slack", challengeName)

pkg/notify/discord.go

@@ -0,0 +1,68 @@
+package notify
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"time"
+)
+
+type DiscordNotificationProvider struct {
+	Request
+}
+
+func (d *DiscordNotificationProvider) SendNotification(nType NotificationType, msg string) error {
+	if d.Request.WebHookURL == "" {
+		return fmt.Errorf("Need a WebHookURL to send notification.")
+	}
+
+	d.Request.FillReqParams()
+
+	nAttachment := Attachment{
+		AuthorName: "Beast Notifier",
+		AuthorLink: "https://backdoor.sdslabs.co",
+		Footer:     "Beast Discord API",
+		FooterIcon: "https://discordapp.com/assets/e05ead6e6ebc08df9291738d0aa6986d.png",
+		Timestamp:  time.Now().Unix(),
+		Text:       msg,
+	}
+
+	switch nType {
+	case Success:
+		nAttachment.Color = SuccessColor
+		nAttachment.Title = "Beast Deployment Success"
+		break
+	case Error:
+		nAttachment.Color = ErrorColor
+		nAttachment.Title = "Beast Deployment Error"
+		break
+	}
+
+	d.Request.PostPayload.Attachments = []Attachment{nAttachment}
+
+	if d.Request.PostPayload.Channel == "" || d.Request.PostPayload.Username == "" {
+		return fmt.Errorf("Username and Channel required to send the notification.")
+	}
+
+	payload, err := json.Marshal(d.PostPayload)
+	if err != nil {
+		return fmt.Errorf("Error while converting payload to JSON : %s", err)
+	}
+
+	payloadReader := bytes.NewReader(payload)
+	req, err := http.NewRequest("POST", d.Request.WebHookURL, payloadReader)
+	if err != nil {
+		return fmt.Errorf("Error while connecting to webhook url host : %s", err)
+	}
+
+	req.Header.Set("Content-Type", "application/json")
+	client := http.Client{}
+	_, err = client.Do(req)
+
+	if err != nil {
+		return fmt.Errorf("Error while posting payload for notification : %s", err)
+	}
+
+	return nil
+}

pkg/notify/main.go

@@ -0,0 +1,116 @@
+package notify
+
+import (
+	"fmt"
+
+	"github.com/sdslabs/beastv4/core/config"
+	log "github.com/sirupsen/logrus"
+)
+
+type Attachment struct {
+	Fallback     string            `json:"fallback,omitempty"`
+	Color        NotificationColor `json:"color,omitempty"`
+	PreText      string            `json:"pretext,omitempty"`
+	AuthorName   string            `json:"author_name,omitempty"`
+	AuthorLink   string            `json:"author_link,omitempty"`
+	AuthorIcon   string            `json:"author_icon,omitempty"`
+	Title        string            `json:"title,omitempty"`
+	TitleLink    string            `json:"title_link,omitempty"`
+	Text         string            `json:"text,omitempty"`
+	ImageUrl     string            `json:"image_url,omitempty"`
+	Footer       string            `json:"footer,omitempty"`
+	FooterIcon   string            `json:"footer_icon,omitempty"`
+	Timestamp    int64             `json:"ts,omitempty"`
+	MarkdownIn   []string          `json:"mrkdwn_in,omitempty"`
+	CallbackID   string            `json:"callback_id,omitempty"`
+	ThumbnailUrl string            `json:"thumb_url,omitempty"`
+}
+
+type PostPayload struct {
+	Parse       string       `json:"parse,omitempty"`
+	Username    string       `json:"username,omitempty"`
+	IconUrl     string       `json:"icon_url,omitempty"`
+	IconEmoji   string       `json:"icon_emoji,omitempty"`
+	Channel     string       `json:"channel,omitempty"`
+	Text        string       `json:"text,omitempty"`
+	Attachments []Attachment `json:"attachments,omitempty"`
+	Markdown    bool         `json:"mrkdwn,omitempty"`
+}
+
+type Notifier interface {
+	SendNotification(nType NotificationType, msg string) error
+}
+
+type Request struct {
+	WebHookURL string
+	PostPayload
+}
+
+type ProviderTypeEnum int
+
+const (
+	DiscordProvider ProviderTypeEnum = 1 + iota
+	SlackProvider
+)
+
+//In the Discord notification provider it was using the same payload which was used for slack.
+//By writing "/slack" in the discord WebHookURL, it execute Slack-Compatible Webhook
+func NewNotifier(URL string, ProviderType ProviderTypeEnum) Notifier {
+	switch ProviderType {
+	case SlackProvider:
+		return &SlackNotificationProvider{
+			Request{
+				WebHookURL: URL,
+			},
+		}
+	case DiscordProvider:
+		return &DiscordNotificationProvider{
+			Request{
+				WebHookURL: URL + "/slack",
+			},
+		}
+	}
+	return nil
+}
+
+func (req *Request) FillReqParams() error {
+	req.PostPayload = PostPayload{
+		Username: "Beast",
+		IconUrl:  "https://i.ibb.co/sjC5dRY/beast-eye-39371.png",
+		Channel:  "#beast",
+	}
+	return nil
+}
+
+func SendNotification(nType NotificationType, message string) error {
+	if config.Cfg.SlackWebHookURL != "" {
+		slackNotifier := NewNotifier(config.Cfg.SlackWebHookURL, SlackProvider)
+
+		err := slackNotifier.SendNotification(nType, message)
+		if err != nil {
+			log.Errorf("Error while sending notification to slack : %s", err)
+			fmt.Errorf("NOTIFICATION_SEND_ERROR: %s", err)
+		}
+
+		log.Infof("Notfication sent to slack.")
+	} else {
+		log.Warnf("No slack webhook url provided in beast config, cannot send notification.")
+		fmt.Errorf("No webhook URL in beast config.")
+	}
+
+	if config.Cfg.DiscordWebHookURL != "" {
+		discordNotifier := NewNotifier(config.Cfg.DiscordWebHookURL, DiscordProvider)
+
+		err := discordNotifier.SendNotification(nType, message)
+		if err != nil {
+			log.Errorf("Error while sending notification to discord : %s", err)
+			return fmt.Errorf("NOTIFICATION_SEND_ERROR: %s", err)
+		}
+
+		log.Infof("Notfication sent to discord.")
+		return nil
+	} else {
+		log.Warnf("No discord webhook url provided in beast config, cannot send notification.")
+		return fmt.Errorf("No webhook URL in beast config.")
+	}
+}

pkg/notify/slack.go

@@ -6,95 +6,18 @@ import (
 	"fmt"
 	"net/http"
 	"time"
-
-	"github.com/sdslabs/beastv4/core/config"
-	log "github.com/sirupsen/logrus"
 )
 
-type Attachment struct {
-	Fallback     string            `json:"fallback,omitempty"`
-	Color        NotificationColor `json:"color,omitempty"`
-	PreText      string            `json:"pretext,omitempty"`
-	AuthorName   string            `json:"author_name,omitempty"`
-	AuthorLink   string            `json:"author_link,omitempty"`
-	AuthorIcon   string            `json:"author_icon,omitempty"`
-	Title        string            `json:"title,omitempty"`
-	TitleLink    string            `json:"title_link,omitempty"`
-	Text         string            `json:"text,omitempty"`
-	ImageUrl     string            `json:"image_url,omitempty"`
-	Footer       string            `json:"footer,omitempty"`
-	FooterIcon   string            `json:"footer_icon,omitempty"`
-	Timestamp    int64             `json:"ts,omitempty"`
-	MarkdownIn   []string          `json:"mrkdwn_in,omitempty"`
-	CallbackID   string            `json:"callback_id,omitempty"`
-	ThumbnailUrl string            `json:"thumb_url,omitempty"`
-}
-
-type SlackPostPayload struct {
-	Parse       string       `json:"parse,omitempty"`
-	Username    string       `json:"username,omitempty"`
-	IconUrl     string       `json:"icon_url,omitempty"`
-	IconEmoji   string       `json:"icon_emoji,omitempty"`
-	Channel     string       `json:"channel,omitempty"`
-	Text        string       `json:"text,omitempty"`
-	Attachments []Attachment `json:"attachments,omitempty"`
-	Markdown    bool         `json:"mrkdwn,omitempty"`
+type SlackNotificationProvider struct {
+	Request
 }
 
-type SlackNotifier struct {
-	WebHookURL       string
-	SlackPostPayload SlackPostPayload
-}
-
-func NewSlackNotifier(webhookUrl string) *SlackNotifier {
-	return &SlackNotifier{
-		WebHookURL: webhookUrl,
-	}
-}
-
-func (notifier *SlackNotifier) SendNotification() error {
-	if notifier.WebHookURL == "" {
+func (s *SlackNotificationProvider) SendNotification(nType NotificationType, msg string) error {
+	if s.Request.WebHookURL == "" {
 		return fmt.Errorf("Need a WebHookURL to send notification.")
 	}
 
-	if notifier.SlackPostPayload.Channel == "" || notifier.SlackPostPayload.Username == "" {
-		return fmt.Errorf("Username and Channel required to send the notification.")
-	}
-
-	payload, err := json.Marshal(notifier.SlackPostPayload)
-	if err != nil {
-		return fmt.Errorf("Error while converting payload to JSON : %s", err)
-	}
-
-	payloadReader := bytes.NewReader(payload)
-	req, err := http.NewRequest("POST", notifier.WebHookURL, payloadReader)
-	if err != nil {
-		return fmt.Errorf("Error while connecting to webhook url host : %s", err)
-	}
-
-	req.Header.Set("Content-Type", "application/json")
-	client := http.Client{}
-	_, err = client.Do(req)
-
-	if err != nil {
-		return fmt.Errorf("Error while posting payload for notification : %s", err)
-	}
-
-	return nil
-}
-
-func SendNotificationToSlack(nType NotificationType, msg string) error {
-	if config.Cfg.SlackWebHookURL == "" {
-		log.Warnf("No slack webhook url provided in beast config, cannot send notification.")
-		return fmt.Errorf("No webhook URL in beast config.")
-	}
-
-	slackNotifier := NewSlackNotifier(config.Cfg.SlackWebHookURL)
-	slackNotifier.SlackPostPayload = SlackPostPayload{
-		Username: "Beast",
-		IconUrl:  "https://i.ibb.co/sjC5dRY/beast-eye-39371.png",
-		Channel:  "#beast",
-	}
+	s.Request.FillReqParams()
 
 	nAttachment := Attachment{
 		AuthorName: "Beast Notifier",
@@ -115,14 +38,30 @@ func SendNotificationToSlack(nType NotificationType, msg string) error {
 		nAttachment.Title = "Beast Deployment Error"
 		break
 	}
+	s.Request.PostPayload.Attachments = []Attachment{nAttachment}
+
+	if s.Request.PostPayload.Channel == "" || s.Request.PostPayload.Username == "" {
+		return fmt.Errorf("Username and Channel required to send the notification.")
+	}
 
-	slackNotifier.SlackPostPayload.Attachments = []Attachment{nAttachment}
-	err := slackNotifier.SendNotification()
+	payload, err := json.Marshal(s.PostPayload)
 	if err != nil {
-		log.Errorf("Error while sending notification to slack : %s", err)
-		return fmt.Errorf("NOTIFICATION_SEND_ERROR: %s", err)
+		return fmt.Errorf("Error while converting payload to JSON : %s", err)
+	}
+
+	payloadReader := bytes.NewReader(payload)
+	req, err := http.NewRequest("POST", s.Request.WebHookURL, payloadReader)
+	if err != nil {
+		return fmt.Errorf("Error while connecting to webhook url host : %s", err)
+	}
+
+	req.Header.Set("Content-Type", "application/json")
+	client := http.Client{}
+	_, err = client.Do(req)
+
+	if err != nil {
+		return fmt.Errorf("Error while posting payload for notification : %s", err)
 	}
 
-	log.Infof("Notfication sent to slack.")
 	return nil
 }