Option to render fields (#480)

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
crazy-max · Sep 4, 2021 · fc64b13 · fc64b13
1 parent fe84829
commit fc64b13
Show file tree

Hide file tree

Showing 19 changed files with 202 additions and 164 deletions.
diff --git a/.res/screenshot.png b/.res/screenshot.png
diff --git a/docs/assets/notif/discord-2.png b/docs/assets/notif/discord-2.png
diff --git a/docs/assets/notif/slack.png b/docs/assets/notif/slack.png
diff --git a/docs/notif/discord.md b/docs/notif/discord.md
@@ -15,8 +15,8 @@ Allow to send notifications to your Discord channel.
           - "<@124>"
           - "<@125>"
           - "<@&200>"
+        renderFields: true
         timeout: 10s
-        templateTitle: "{{ .Entry.Image }} released"
         templateBody: |
           Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
     ```
@@ -25,23 +25,17 @@ Allow to send notifications to your Discord channel.
 |---------------------|---------------------------------------|---------------|
 | `webhookURL`[^1]    |                                       | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
 | `mentions`          |                                       | List of users or roles to notify |
+| `renderFields`      | `true`                                | Render [field objects](https://discordjs.guide/popular-topics/embeds.html) |
 | `timeout`           | `10s`                                 | Timeout specifies a time limit for the request to be made |
-| `templateTitle`[^1] | See [below](#default-templatetitle)   | [Notification template](../faq.md#notification-template) for message title |
 | `templateBody`[^1]  | See [below](#default-templatebody)    | [Notification template](../faq.md#notification-template) for message body |
 
 !!! abstract "Environment variables"
     * `DIUN_NOTIF_DISCORD_WEBHOOKURL`
     * `DIUN_NOTIF_DISCORD_MENTIONS` (comma separated)
+    * `DIUN_NOTIF_DISCORD_RENDERFIELDS`
     * `DIUN_NOTIF_DISCORD_TIMEOUT`
-    * `DIUN_NOTIF_DISCORD_TEMPLATETITLE`
     * `DIUN_NOTIF_DISCORD_TEMPLATEBODY`
 
-### Default `templateTitle`
-
-```
-[[ config.extra.template.defaultTitle ]]
-```
-
 ### Default `templateBody`
 
 ```

diff --git a/docs/notif/rocketchat.md b/docs/notif/rocketchat.md
@@ -12,6 +12,7 @@ Allow to send notifications to your Rocket.Chat channel.
         channel: "#general"
         userID: abcdEFGH012345678
         token: Token123456
+        renderAttachment: true
         timeout: 10s
         templateTitle: "{{ .Entry.Image }} released"
         templateBody: |
@@ -25,6 +26,7 @@ Allow to send notifications to your Rocket.Chat channel.
 | `userID`[^1]        |                                            | User ID |
 | `token`             |                                            | Authentication token |
 | `tokenFile`         |                                            | Use content of secret file as authentication token if `token` not defined |
+| `renderAttachment`  | `true`                                     | Render [attachment object](https://docs.rocket.chat/guides/user-guides/messaging#send-attachments) |
 | `timeout`           | `10s`                                      | Timeout specifies a time limit for the request to be made |
 | `templateTitle`[^1] | See [below](#default-templatetitle)        | [Notification template](../faq.md#notification-template) for message title |
 | `templateBody`[^1]  | See [below](#default-templatebody)         | [Notification template](../faq.md#notification-template) for message body |
@@ -38,6 +40,7 @@ Allow to send notifications to your Rocket.Chat channel.
     * `DIUN_NOTIF_ROCKETCHAT_USERID`
     * `DIUN_NOTIF_ROCKETCHAT_TOKEN`
     * `DIUN_NOTIF_ROCKETCHAT_TOKENFILE`
+    * `DIUN_NOTIF_ROCKETCHAT_RENDERATTACHMENT`
     * `DIUN_NOTIF_ROCKETCHAT_TIMEOUT`
     * `DIUN_NOTIF_ROCKETCHAT_TEMPLATETITLE`
     * `DIUN_NOTIF_ROCKETCHAT_TEMPLATEBODY`

diff --git a/docs/notif/slack.md b/docs/notif/slack.md
@@ -12,23 +12,26 @@ You can send notifications to your Slack channel using an [incoming webhook URL]
     notif:
       slack:
         webhookURL: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
+        renderFields: true
         templateBody: |
           Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
     ```
 
 | Name               | Default                                    | Description   |
 |--------------------|--------------------------------------------|---------------|
 | `webhookURL`[^1]   |                                            | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) |
+| `renderFields`     | `true`                                     | Render [field objects](https://api.slack.com/messaging/composing/layouts#stack_of_blocks) |
 | `templateBody`[^1] | See [below](#default-templatebody)         | [Notification template](../faq.md#notification-template) for message body |
 
 !!! abstract "Environment variables"
     * `DIUN_NOTIF_SLACK_WEBHOOKURL`
+    * `DIUN_NOTIF_SLACK_RENDERFIELDS`
     * `DIUN_NOTIF_SLACK_TEMPLATEBODY`
 
 ### Default `templateBody`
 
 ```
-<!channel> Docker tag `{{ .Entry.Image }}` {{ if (eq .Entry.Status "new") }}newly added{{ else }}updated{{ end }}.
+<!channel> Docker tag {{ if .Entry.Image.HubLink }}<{{ .Entry.Image.HubLink }}|`{{ .Entry.Image }}`>{{ else }}`{{ .Entry.Image }}`{{ end }}  {{ if (eq .Entry.Status "new") }}available{{ else }}updated{{ end }}.
 ```
 
 ## Sample

diff --git a/docs/notif/teams.md b/docs/notif/teams.md
@@ -9,17 +9,20 @@ You can send notifications to your Teams team-channel using an [incoming webhook
     notif:
       teams:
         webhookURL: https://outlook.office.com/webhook/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
+        renderFacts: true
         templateBody: |
           Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
     ```
 
 | Name               | Default                                    | Description   |
 |--------------------|--------------------------------------------|---------------|
 | `webhookURL`[^1]   |                                            | Teams [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/what-are-webhooks-and-connectors) |
+| `renderFacts`      | `true`                                     | Render fact objects |
 | `templateBody`[^1] | See [below](#default-templatebody)         | [Notification template](../faq.md#notification-template) for message body |
 
 !!! abstract "Environment variables"
     * `DIUN_NOTIF_TEAMS_WEBHOOKURL`
+    * `DIUN_NOTIF_TEAMS_RENDERFACTS`
     * `DIUN_NOTIF_TEAMS_TEMPLATEBODY`
 
 ### Default `templateBody`

diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -76,9 +76,9 @@ func TestLoadFile(t *testing.T) {
 							"<@125>",
 							"<@&200>",
 						},
-						Timeout:       utl.NewDuration(10 * time.Second),
-						TemplateTitle: model.NotifDefaultTemplateTitle,
-						TemplateBody:  model.NotifDefaultTemplateBody,
+						RenderFields: utl.NewTrue(),
+						Timeout:      utl.NewDuration(10 * time.Second),
+						TemplateBody: model.NotifDefaultTemplateBody,
 					},
 					Gotify: &model.NotifGotify{
 						Endpoint:      "http://gotify.foo.com",
@@ -133,13 +133,14 @@ for <code>{{ .Entry.Manifest.Platform }}</code> platform.
 						TemplateBody:  model.NotifDefaultTemplateBody,
 					},
 					RocketChat: &model.NotifRocketChat{
-						Endpoint:      "http://rocket.foo.com:3000",
-						Channel:       "#general",
-						UserID:        "abcdEFGH012345678",
-						Token:         "Token123456",
-						Timeout:       utl.NewDuration(10 * time.Second),
-						TemplateTitle: model.NotifDefaultTemplateTitle,
-						TemplateBody:  model.NotifRocketChatDefaultTemplateBody,
+						Endpoint:         "http://rocket.foo.com:3000",
+						Channel:          "#general",
+						UserID:           "abcdEFGH012345678",
+						Token:            "Token123456",
+						RenderAttachment: utl.NewTrue(),
+						Timeout:          utl.NewDuration(10 * time.Second),
+						TemplateTitle:    model.NotifDefaultTemplateTitle,
+						TemplateBody:     model.NotifRocketChatDefaultTemplateBody,
 					},
 					Script: &model.NotifScript{
 						Cmd: "uname",
@@ -149,10 +150,12 @@ for <code>{{ .Entry.Manifest.Platform }}</code> platform.
 					},
 					Slack: &model.NotifSlack{
 						WebhookURL:   "https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij",
+						RenderFields: utl.NewFalse(),
 						TemplateBody: model.NotifSlackDefaultTemplateBody,
 					},
 					Teams: &model.NotifTeams{
 						WebhookURL:   "https://outlook.office.com/webhook/ABCD12EFG/HIJK34LMN/01234567890abcdefghij",
+						RenderFacts:  utl.NewFalse(),
 						TemplateBody: model.NotifTeamsDefaultTemplateBody,
 					},
 					Telegram: &model.NotifTelegram{

diff --git a/internal/config/fixtures/config.test.yml b/internal/config/fixtures/config.test.yml
@@ -25,6 +25,7 @@ notif:
       - "<@124>"
       - "<@125>"
       - "<@&200>"
+    renderFields: true
     timeout: 10s
   gotify:
     endpoint: http://gotify.foo.com
@@ -69,15 +70,18 @@ notif:
     channel: "#general"
     userID: abcdEFGH012345678
     token: Token123456
+    renderAttachment: true
     timeout: 10s
   script:
     cmd: "uname"
     args:
       - "-a"
   slack:
     webhookURL: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
+    renderFields: false
   teams:
     webhookURL: https://outlook.office.com/webhook/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
+    renderFacts: false
   telegram:
     token: abcdef123456
     chatIDs:

diff --git a/internal/config/fixtures/config.validate.yml b/internal/config/fixtures/config.validate.yml
@@ -25,6 +25,7 @@ notif:
       - "<@124>"
       - "<@125>"
       - "<@&200>"
+    renderFields: true
     timeout: 10s
   gotify:
     endpoint: http://gotify.foo.com
@@ -67,15 +68,18 @@ notif:
     channel: "#general"
     userID: abcdEFGH012345678
     token: Token123456
+    renderAttachment: false
     timeout: 10s
   script:
     cmd: "uname"
     args:
       - "-a"
   slack:
     webhookURL: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
+    renderFields: false
   teams:
     webhookURL: https://outlook.office.com/webhook/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
+    renderFacts: true
   telegram:
     token: abcdef123456
     chatIDs:

diff --git a/internal/model/notif_discord.go b/internal/model/notif_discord.go
@@ -8,11 +8,11 @@ import (
 
 // NotifDiscord holds Discord notification configuration details
 type NotifDiscord struct {
-	WebhookURL    string         `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"`
-	Mentions      []string       `yaml:"mentions,omitempty" json:"mentions,omitempty"`
-	Timeout       *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"`
-	TemplateTitle string         `yaml:"templateTitle,omitempty" json:"templateTitle,omitempty" validate:"required"`
-	TemplateBody  string         `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
+	WebhookURL   string         `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"`
+	Mentions     []string       `yaml:"mentions,omitempty" json:"mentions,omitempty"`
+	RenderFields *bool          `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"`
+	Timeout      *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"`
+	TemplateBody string         `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
 }
 
 // GetDefaults gets the default values
@@ -24,7 +24,7 @@ func (s *NotifDiscord) GetDefaults() *NotifDiscord {
 
 // SetDefaults sets the default values
 func (s *NotifDiscord) SetDefaults() {
+	s.RenderFields = utl.NewTrue()
 	s.Timeout = utl.NewDuration(10 * time.Second)
-	s.TemplateTitle = NotifDefaultTemplateTitle
 	s.TemplateBody = NotifDefaultTemplateBody
 }
diff --git a/internal/model/notif_rocketchat.go b/internal/model/notif_rocketchat.go
@@ -11,14 +11,15 @@ const NotifRocketChatDefaultTemplateBody = `Docker tag {{ .Entry.Image }} which
 
 // NotifRocketChat holds Rocket.Chat notification configuration details
 type NotifRocketChat struct {
-	Endpoint      string         `yaml:"endpoint,omitempty" json:"endpoint,omitempty" validate:"required"`
-	Channel       string         `yaml:"channel,omitempty" json:"channel,omitempty" validate:"required"`
-	UserID        string         `yaml:"userID,omitempty" json:"userID,omitempty" validate:"required"`
-	Token         string         `yaml:"token,omitempty" json:"token,omitempty" validate:"omitempty"`
-	TokenFile     string         `yaml:"tokenFile,omitempty" json:"tokenFile,omitempty" validate:"omitempty,file"`
-	Timeout       *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"`
-	TemplateTitle string         `yaml:"templateTitle,omitempty" json:"templateTitle,omitempty" validate:"required"`
-	TemplateBody  string         `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
+	Endpoint         string         `yaml:"endpoint,omitempty" json:"endpoint,omitempty" validate:"required"`
+	Channel          string         `yaml:"channel,omitempty" json:"channel,omitempty" validate:"required"`
+	UserID           string         `yaml:"userID,omitempty" json:"userID,omitempty" validate:"required"`
+	Token            string         `yaml:"token,omitempty" json:"token,omitempty" validate:"omitempty"`
+	TokenFile        string         `yaml:"tokenFile,omitempty" json:"tokenFile,omitempty" validate:"omitempty,file"`
+	RenderAttachment *bool          `yaml:"renderAttachment,omitempty" json:"renderAttachment,omitempty" validate:"required"`
+	Timeout          *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"`
+	TemplateTitle    string         `yaml:"templateTitle,omitempty" json:"templateTitle,omitempty" validate:"required"`
+	TemplateBody     string         `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
 }
 
 // GetDefaults gets the default values
@@ -30,6 +31,7 @@ func (s *NotifRocketChat) GetDefaults() *NotifRocketChat {
 
 // SetDefaults sets the default values
 func (s *NotifRocketChat) SetDefaults() {
+	s.RenderAttachment = utl.NewTrue()
 	s.Timeout = utl.NewDuration(10 * time.Second)
 	s.TemplateTitle = NotifDefaultTemplateTitle
 	s.TemplateBody = NotifRocketChatDefaultTemplateBody

diff --git a/internal/model/notif_slack.go b/internal/model/notif_slack.go
@@ -1,11 +1,14 @@
 package model
 
+import "github.com/crazy-max/diun/v4/pkg/utl"
+
 // NotifSlackDefaultTemplateBody ...
-const NotifSlackDefaultTemplateBody = "<!channel> Docker tag `{{ .Entry.Image }}` {{ if (eq .Entry.Status \"new\") }}available{{ else }}updated{{ end }}."
+const NotifSlackDefaultTemplateBody = "<!channel> Docker tag {{ if .Entry.Image.HubLink }}<{{ .Entry.Image.HubLink }}|`{{ .Entry.Image }}`>{{ else }}`{{ .Entry.Image }}`{{ end }}  {{ if (eq .Entry.Status \"new\") }}available{{ else }}updated{{ end }}."
 
 // NotifSlack holds slack notification configuration details
 type NotifSlack struct {
 	WebhookURL   string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"`
+	RenderFields *bool  `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"`
 	TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
 }
 
@@ -18,5 +21,6 @@ func (s *NotifSlack) GetDefaults() *NotifSlack {
 
 // SetDefaults sets the default values
 func (s *NotifSlack) SetDefaults() {
+	s.RenderFields = utl.NewTrue()
 	s.TemplateBody = NotifSlackDefaultTemplateBody
 }
diff --git a/internal/model/notif_teams.go b/internal/model/notif_teams.go
@@ -1,11 +1,14 @@
 package model
 
+import "github.com/crazy-max/diun/v4/pkg/utl"
+
 // NotifTeamsDefaultTemplateBody ...
 const NotifTeamsDefaultTemplateBody = "Docker tag {{ if .Entry.Image.HubLink }}[`{{ .Entry.Image }}`]({{ .Entry.Image.HubLink }}){{ else }}`{{ .Entry.Image }}`{{ end }} {{ if (eq .Entry.Status \"new\") }}available{{ else }}updated{{ end }}."
 
 // NotifTeams holds Teams notification configuration details
 type NotifTeams struct {
 	WebhookURL   string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"`
+	RenderFacts  *bool  `yaml:"renderFacts,omitempty" json:"renderFacts,omitempty" validate:"required"`
 	TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
 }
 
@@ -18,5 +21,6 @@ func (s *NotifTeams) GetDefaults() *NotifTeams {
 
 // SetDefaults sets the default values
 func (s *NotifTeams) SetDefaults() {
+	s.RenderFacts = utl.NewTrue()
 	s.TemplateBody = NotifTeamsDefaultTemplateBody
 }