Add Rocket.Chat notifier (crazy-max#44)

Apizr · Mar 1, 2020 · 08cd3d9 · 08cd3d9
1 parent 8a49f41
commit 08cd3d9
Show file tree

Hide file tree

Showing 17 changed files with 321 additions and 82 deletions.
diff --git a/.res/notif-rocketchat.png b/.res/notif-rocketchat.png
diff --git a/cmd/main.go b/cmd/main.go
@@ -28,7 +28,7 @@ func main() {
 	kingpin.Flag("config", "Diun configuration file.").Envar("CONFIG").Required().StringVar(&flags.Cfgfile)
 	kingpin.Flag("timezone", "Timezone assigned to Diun.").Envar("TZ").Default("UTC").StringVar(&flags.Timezone)
 	kingpin.Flag("log-level", "Set log level.").Envar("LOG_LEVEL").Default("info").StringVar(&flags.LogLevel)
-	kingpin.Flag("log-json", "Enable JSON logging output.").Envar("LOG_JSON").Default("false").BoolVar(&flags.LogJson)
+	kingpin.Flag("log-json", "Enable JSON logging output.").Envar("LOG_JSON").Default("false").BoolVar(&flags.LogJSON)
 	kingpin.Flag("log-caller", "Enable to add file:line of the caller.").Envar("LOG_CALLER").Default("false").BoolVar(&flags.LogCaller)
 	kingpin.UsageTemplate(kingpin.CompactUsageTemplate).Version(version).Author("CrazyMax")
 	kingpin.CommandLine.Name = "diun"

diff --git a/doc/configuration.md b/doc/configuration.md
@@ -22,6 +22,12 @@ watch:
   first_check_notif: false
 
 notif:
+  gotify:
+    enable: false
+    endpoint: http://gotify.foo.com
+    token: Token123456
+    priority: 1
+    timeout: 10
   mail:
     enable: false
     host: localhost
@@ -32,6 +38,13 @@ notif:
     password:
     from:
     to:
+  rocketchat:
+    enable: false
+    endpoint: http://rocket.foo.com:3000
+    channel: "#general"
+    user_id: abcdEFGH012345678
+    token: Token123456
+    timeout: 10
   slack:
     enable: false
     webhook_url: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
@@ -49,12 +62,6 @@ notif:
       Content-Type: application/json
       Authorization: Token123456
     timeout: 10
-  gotify:
-    enable: false
-    endpoint: http://gotify.foo.com
-    token: Token123456
-    priority: 1
-    timeout: 10
 
 regopts:
   someregistryoptions:
@@ -123,6 +130,13 @@ providers:
 
 ### notif
 
+* `gotify`
+  * `enable`: Enable gotify notification (default: `false`).
+  * `endpoint`: Gotify base URL (e.g. `http://gotify.foo.com`). **required**
+  * `token`: Application token. **required**
+  * `priority`: The priority of the message.
+  * `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
+
 * `mail`
   * `enable`: Enable email reports (default: `false`).
   * `host`: SMTP server host (default: `localhost`). **required**
@@ -136,6 +150,14 @@ providers:
   * `from`: Sender email address. **required**
   * `to`: Recipient email address. **required**
 
+* `rocketchat`
+  * `enable`: Enable Rocket.Chat notification (default: `false`).
+  * `endpoint`: Rocket.Chat base URL (e.g. `http://rocket.foo.com:3000`). **required**
+  * `channel`: Channel name with the prefix in front of it. **required**
+  * `user_id`: User ID. **required**
+  * `token`: Authentication token. **required**
+  * `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
+
 * `slack`
   * `enable`: Enable slack notification (default: `false`).
   * `webhook_url`: Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks). **required**
@@ -152,13 +174,6 @@ providers:
   * `headers`: Map of additional headers to be sent.
   * `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
 
-* `gotify`
-  * `enable`: Enable gotify notification (default: `false`).
-  * `endpoint`: Gotify base URL (e.g. `http://gotify.foo.com`). **required**
-  * `token`: Application token. **required**
-  * `priority`: The priority of the message.
-  * `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
-
 ### regopts
 
 * `username`: Registry username.

diff --git a/doc/notifications.md b/doc/notifications.md
@@ -2,6 +2,7 @@
 
 * [Gotify](#gotify)
 * [Mail](#mail)
+* [Rocket.Chat](#rocketchat)
 * [Slack](#slack)
 * [Telegram](#telegram)
 * [Webhook](#webhook)
@@ -18,9 +19,15 @@ Here is an email sample if you add `mail` notification:
 
 ![](../.res/notif-mail.png)
 
+## Rocket.Chat
+
+To be able to send notifications to your Rocket.Chat channel, you must first create a Personal Access Token through your account settings:
+
+![](../.res/notif-rocketchat.png)
+
 ## Slack
 
-You can send notifications to your slack channel using an [incoming webhook URL](https://api.slack.com/messaging/webhooks):
+You can send notifications to your Slack channel using an [incoming webhook URL](https://api.slack.com/messaging/webhooks):
 
 ![](../.res/notif-slack.png)
 

diff --git a/internal/config/config.go b/internal/config/config.go
@@ -49,13 +49,21 @@ func Load(flags model.Flags, version string) (*Config, error) {
 			FirstCheckNotif: false,
 		},
 		Notif: model.Notif{
+			Gotify: model.NotifGotify{
+				Enable:  false,
+				Timeout: 10,
+			},
 			Mail: model.NotifMail{
 				Enable:             false,
 				Host:               "localhost",
 				Port:               25,
 				SSL:                false,
 				InsecureSkipVerify: false,
 			},
+			RocketChat: model.NotifRocketChat{
+				Enable:  false,
+				Timeout: 10,
+			},
 			Slack: model.NotifSlack{
 				Enable: false,
 			},
@@ -67,10 +75,6 @@ func Load(flags model.Flags, version string) (*Config, error) {
 				Method:  "GET",
 				Timeout: 10,
 			},
-			Gotify: model.NotifGotify{
-				Enable:  false,
-				Timeout: 10,
-			},
 		},
 	}
 

diff --git a/internal/config/config.test.yml b/internal/config/config.test.yml
@@ -7,6 +7,12 @@ watch:
   first_check_notif: false
 
 notif:
+  gotify:
+    enable: false
+    endpoint: http://gotify.foo.com
+    token: Token123456
+    priority: 1
+    timeout: 10
   mail:
     enable: false
     host: localhost
@@ -19,6 +25,13 @@ notif:
     password_file:
     from:
     to:
+  rocketchat:
+    enable: false
+    endpoint: http://rocket.foo.com:3000
+    channel: "#general"
+    user_id: abcdEFGH012345678
+    token: Token123456
+    timeout: 10
   slack:
     enable: false
     webhook_url: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
@@ -36,12 +49,6 @@ notif:
       Content-Type: application/json
       Authorization: Token123456
     timeout: 10
-  gotify:
-    enable: false
-    endpoint: http://gotify.foo.com
-    token: Token123456
-    priority: 1
-    timeout: 10
 
 regopts:
   someregopts:

diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -52,13 +52,28 @@ func TestLoad(t *testing.T) {
 					Schedule: "*/30 * * * *",
 				},
 				Notif: model.Notif{
+					Gotify: model.NotifGotify{
+						Enable:   false,
+						Endpoint: "http://gotify.foo.com",
+						Token:    "Token123456",
+						Priority: 1,
+						Timeout:  10,
+					},
 					Mail: model.NotifMail{
 						Enable:             false,
 						Host:               "localhost",
 						Port:               25,
 						SSL:                false,
 						InsecureSkipVerify: false,
 					},
+					RocketChat: model.NotifRocketChat{
+						Enable:   false,
+						Endpoint: "http://rocket.foo.com:3000",
+						Channel:  "#general",
+						UserID:   "abcdEFGH012345678",
+						Token:    "Token123456",
+						Timeout:  10,
+					},
 					Slack: model.NotifSlack{
 						Enable:     false,
 						WebhookURL: "https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij",
@@ -78,13 +93,6 @@ func TestLoad(t *testing.T) {
 						},
 						Timeout: 10,
 					},
-					Gotify: model.NotifGotify{
-						Enable:   false,
-						Endpoint: "http://gotify.foo.com",
-						Token:    "Token123456",
-						Priority: 1,
-						Timeout:  10,
-					},
 				},
 				RegOpts: map[string]model.RegOpts{
 					"someregopts": {

diff --git a/internal/logging/logger.go b/internal/logging/logger.go
@@ -21,7 +21,7 @@ func Configure(fl *model.Flags, location *time.Location) {
 		return time.Now().In(location)
 	}
 
-	if !fl.LogJson {
+	if !fl.LogJSON {
 		w = zerolog.ConsoleWriter{
 			Out:        os.Stdout,
 			TimeFormat: time.RFC1123,

diff --git a/internal/model/flags.go b/internal/model/flags.go
@@ -5,6 +5,6 @@ type Flags struct {
 	Cfgfile   string
 	Timezone  string
 	LogLevel  string
-	LogJson   bool
+	LogJSON   bool
 	LogCaller bool
 }
diff --git a/internal/model/notif.go b/internal/model/notif.go
@@ -14,11 +14,21 @@ type NotifEntry struct {
 
 // Notif holds data necessary for notification configuration
 type Notif struct {
-	Mail     NotifMail     `yaml:"mail,omitempty"`
-	Slack    NotifSlack    `yaml:"slack,omitempty"`
-	Telegram NotifTelegram `yaml:"telegram,omitempty"`
-	Webhook  NotifWebhook  `yaml:"webhook,omitempty"`
-	Gotify   NotifGotify   `yaml:"gotify,omitempty"`
+	Gotify     NotifGotify     `yaml:"gotify,omitempty"`
+	Mail       NotifMail       `yaml:"mail,omitempty"`
+	RocketChat NotifRocketChat `yaml:"rocketchat,omitempty"`
+	Slack      NotifSlack      `yaml:"slack,omitempty"`
+	Telegram   NotifTelegram   `yaml:"telegram,omitempty"`
+	Webhook    NotifWebhook    `yaml:"webhook,omitempty"`
+}
+
+// NotifGotify holds gotify notification configuration details
+type NotifGotify struct {
+	Enable   bool   `yaml:"enable,omitempty"`
+	Endpoint string `yaml:"endpoint,omitempty"`
+	Token    string `yaml:"token,omitempty"`
+	Priority int    `yaml:"priority,omitempty"`
+	Timeout  int    `yaml:"timeout,omitempty"`
 }
 
 // NotifMail holds mail notification configuration details
@@ -36,6 +46,16 @@ type NotifMail struct {
 	To                 string `yaml:"to,omitempty"`
 }
 
+// NotifRocketChat holds Rocket.Chat notification configuration details
+type NotifRocketChat struct {
+	Enable   bool   `yaml:"enable,omitempty"`
+	Endpoint string `yaml:"endpoint,omitempty"`
+	Channel  string `yaml:"channel,omitempty"`
+	UserID   string `yaml:"user_id,omitempty"`
+	Token    string `yaml:"token,omitempty"`
+	Timeout  int    `yaml:"timeout,omitempty"`
+}
+
 // NotifSlack holds slack notification configuration details
 type NotifSlack struct {
 	Enable     bool   `yaml:"enable,omitempty"`
@@ -57,12 +77,3 @@ type NotifWebhook struct {
 	Headers  map[string]string `yaml:"headers,omitempty"`
 	Timeout  int               `yaml:"timeout,omitempty"`
 }
-
-// NotifGotify holds gotify notification configuration details
-type NotifGotify struct {
-	Enable   bool   `yaml:"enable,omitempty"`
-	Endpoint string `yaml:"endpoint,omitempty"`
-	Token    string `yaml:"token,omitempty"`
-	Priority int    `yaml:"priority,omitempty"`
-	Timeout  int    `yaml:"timeout,omitempty"`
-}
diff --git a/internal/notif/client.go b/internal/notif/client.go
@@ -5,6 +5,7 @@ import (
 	"github.com/crazy-max/diun/internal/notif/gotify"
 	"github.com/crazy-max/diun/internal/notif/mail"
 	"github.com/crazy-max/diun/internal/notif/notifier"
+	"github.com/crazy-max/diun/internal/notif/rocketchat"
 	"github.com/crazy-max/diun/internal/notif/slack"
 	"github.com/crazy-max/diun/internal/notif/telegram"
 	"github.com/crazy-max/diun/internal/notif/webhook"
@@ -27,9 +28,15 @@ func New(config model.Notif, app model.App, userAgent string) (*Client, error) {
 	}
 
 	// Add notifiers
+	if config.Gotify.Enable {
+		c.notifiers = append(c.notifiers, gotify.New(config.Gotify, app, userAgent))
+	}
 	if config.Mail.Enable {
 		c.notifiers = append(c.notifiers, mail.New(config.Mail, app))
 	}
+	if config.RocketChat.Enable {
+		c.notifiers = append(c.notifiers, rocketchat.New(config.RocketChat, app, userAgent))
+	}
 	if config.Slack.Enable {
 		c.notifiers = append(c.notifiers, slack.New(config.Slack, app))
 	}
@@ -39,9 +46,6 @@ func New(config model.Notif, app model.App, userAgent string) (*Client, error) {
 	if config.Webhook.Enable {
 		c.notifiers = append(c.notifiers, webhook.New(config.Webhook, app, userAgent))
 	}
-	if config.Gotify.Enable {
-		c.notifiers = append(c.notifiers, gotify.New(config.Gotify, app, userAgent))
-	}
 
 	log.Debug().Msgf("%d notifier(s) created", len(c.notifiers))
 	return c, nil