archive/crazy-max_diun
0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-04-17 08:22:40 +00:00
Code Issues Projects Releases Wiki Activity

notif: support webhook url as secret

Browse source
This commit is contained in:
CrazyMax 2024-12-16 02:28:25 +01:00
parent 503460fed9
commit 2fde6548fc
No known key found for this signature in database
GPG key ID: ADE44D8C9D44FBE4
9 changed files with 46 additions and 17 deletions

4
docs/notif/discord.md
View file

@ -23,7 +23,8 @@ Allow sending notifications to your Discord channel.
| Name | Default | Description | | Name | Default | Description |
|--------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------| |--------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) | | `webhookURL` | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
| `webhookURLFile` | | Use content of secret file as webhook URL if `webhookURL` is not defined |
| `mentions` | | List of users or roles to notify | | `mentions` | | List of users or roles to notify |
| `renderFields` | `true` | Render [field objects](https://discordjs.guide/popular-topics/embeds.html) | | `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 | | `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
@ -31,6 +32,7 @@ Allow sending notifications to your Discord channel.
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_DISCORD_WEBHOOKURL` * `DIUN_NOTIF_DISCORD_WEBHOOKURL`
* `DIUN_NOTIF_DISCORD_WEBHOOKURLFILE`
* `DIUN_NOTIF_DISCORD_MENTIONS` (comma separated) * `DIUN_NOTIF_DISCORD_MENTIONS` (comma separated)
* `DIUN_NOTIF_DISCORD_RENDERFIELDS` * `DIUN_NOTIF_DISCORD_RENDERFIELDS`
* `DIUN_NOTIF_DISCORD_TIMEOUT` * `DIUN_NOTIF_DISCORD_TIMEOUT`

4
docs/notif/slack.md
View file

@ -19,12 +19,14 @@ You can send notifications to your Slack channel using an [incoming webhook URL]
| Name | Default | Description | | Name | Default | Description |
|--------------------|------------------------------------|-------------------------------------------------------------------------------------------| |--------------------|------------------------------------|-------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) | | `webhookURL` | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) |
| `webhookURLFile` | | Use content of secret file as webhook URL if `webhookURL` is not defined |
| `renderFields` | `true` | Render [field objects](https://api.slack.com/messaging/composing/layouts#stack_of_blocks) | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_SLACK_WEBHOOKURL` * `DIUN_NOTIF_SLACK_WEBHOOKURL`
* `DIUN_NOTIF_SLACK_WEBHOOKURLFILE`
* `DIUN_NOTIF_SLACK_RENDERFIELDS` * `DIUN_NOTIF_SLACK_RENDERFIELDS`
* `DIUN_NOTIF_SLACK_TEMPLATEBODY` * `DIUN_NOTIF_SLACK_TEMPLATEBODY`

4
docs/notif/teams.md
View file

@ -16,12 +16,14 @@ You can send notifications to your Teams team-channel using an [incoming webhook
| Name | Default | Description | | 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) | | `webhookURL` | | Teams [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/what-are-webhooks-and-connectors) |
| `webhookURLFile` | | Use content of secret file as webhook URL if `webhookURL` is not defined |
| `renderFacts` | `true` | Render fact objects | | `renderFacts` | `true` | Render fact objects |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_TEAMS_WEBHOOKURL` * `DIUN_NOTIF_TEAMS_WEBHOOKURL`
* `DIUN_NOTIF_TEAMS_WEBHOOKURLFILE`
* `DIUN_NOTIF_TEAMS_RENDERFACTS` * `DIUN_NOTIF_TEAMS_RENDERFACTS`
* `DIUN_NOTIF_TEAMS_TEMPLATEBODY` * `DIUN_NOTIF_TEAMS_TEMPLATEBODY`

11
internal/model/notif_discord.go
View file

@ -8,11 +8,12 @@ import (
// NotifDiscord holds Discord notification configuration details // NotifDiscord holds Discord notification configuration details
type NotifDiscord struct { type NotifDiscord struct {
WebhookURL string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"` WebhookURL string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"omitempty"`
Mentions []string `yaml:"mentions,omitempty" json:"mentions,omitempty"` WebhookURLFile string `yaml:"webhookURLFile,omitempty" json:"webhookURLFile,omitempty" validate:"omitempty,file"`
RenderFields *bool `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"` Mentions []string `yaml:"mentions,omitempty" json:"mentions,omitempty"`
Timeout *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"` RenderFields *bool `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"`
TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,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 // GetDefaults gets the default values

7
internal/model/notif_slack.go
View file

@ -7,9 +7,10 @@ const NotifSlackDefaultTemplateBody = "<!channel> Docker tag {{ if .Entry.Image.
// NotifSlack holds slack notification configuration details // NotifSlack holds slack notification configuration details
type NotifSlack struct { type NotifSlack struct {
WebhookURL string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"` WebhookURL string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"omitempty"`
RenderFields *bool `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"` WebhookURLFile string `yaml:"webhookURLFile,omitempty" json:"webhookURLFile,omitempty" validate:"omitempty,file"`
TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"` RenderFields *bool `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"`
TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
} }
// GetDefaults gets the default values // GetDefaults gets the default values

7
internal/model/notif_teams.go
View file

@ -7,9 +7,10 @@ const NotifTeamsDefaultTemplateBody = "Docker tag {{ if .Entry.Image.HubLink }}[
// NotifTeams holds Teams notification configuration details // NotifTeams holds Teams notification configuration details
type NotifTeams struct { type NotifTeams struct {
WebhookURL string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"required"` WebhookURL string `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"omitempty"`
RenderFacts *bool `yaml:"renderFacts,omitempty" json:"renderFacts,omitempty" validate:"required"` WebhookURLFile string `yaml:"webhookURLFile,omitempty" json:"webhookURLFile,omitempty" validate:"omitempty,file"`
TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"` RenderFacts *bool `yaml:"renderFacts,omitempty" json:"renderFacts,omitempty" validate:"required"`
TemplateBody string `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
} }
// GetDefaults gets the default values // GetDefaults gets the default values

8
internal/notif/discord/client.go
View file

@ -12,6 +12,7 @@ import (
"github.com/crazy-max/diun/v4/internal/model" "github.com/crazy-max/diun/v4/internal/model"
"github.com/crazy-max/diun/v4/internal/msg" "github.com/crazy-max/diun/v4/internal/msg"
"github.com/crazy-max/diun/v4/internal/notif/notifier" "github.com/crazy-max/diun/v4/internal/notif/notifier"
"github.com/crazy-max/diun/v4/pkg/utl"
"github.com/pkg/errors" "github.com/pkg/errors"
) )
@ -42,6 +43,11 @@ func (c *Client) Name() string {
func (c *Client) Send(entry model.NotifEntry) error { func (c *Client) Send(entry model.NotifEntry) error {
var content bytes.Buffer var content bytes.Buffer
webhookURL, err := utl.GetSecret(c.cfg.WebhookURL, c.cfg.WebhookURLFile)
if err != nil {
return errors.Wrap(err, "cannot retrieve webhook URL for Discord notifier")
}
message, err := msg.New(msg.Options{ message, err := msg.New(msg.Options{
Meta: c.meta, Meta: c.meta,
Entry: entry, Entry: entry,
@ -117,7 +123,7 @@ func (c *Client) Send(entry model.NotifEntry) error {
return err return err
} }
u, err := url.Parse(c.cfg.WebhookURL) u, err := url.Parse(webhookURL)
if err != nil { if err != nil {
return err return err
} }

9
internal/notif/slack/client.go
View file

@ -9,7 +9,9 @@ import (
"github.com/crazy-max/diun/v4/internal/model" "github.com/crazy-max/diun/v4/internal/model"
"github.com/crazy-max/diun/v4/internal/msg" "github.com/crazy-max/diun/v4/internal/msg"
"github.com/crazy-max/diun/v4/internal/notif/notifier" "github.com/crazy-max/diun/v4/internal/notif/notifier"
"github.com/crazy-max/diun/v4/pkg/utl"
"github.com/nlopes/slack" "github.com/nlopes/slack"
"github.com/pkg/errors"
) )
// Client represents an active slack notification object // Client represents an active slack notification object
@ -36,6 +38,11 @@ func (c *Client) Name() string {
// Send creates and sends a slack notification with an entry // Send creates and sends a slack notification with an entry
func (c *Client) Send(entry model.NotifEntry) error { func (c *Client) Send(entry model.NotifEntry) error {
webhookURL, err := utl.GetSecret(c.cfg.WebhookURL, c.cfg.WebhookURLFile)
if err != nil {
return errors.Wrap(err, "cannot retrieve webhook URL for Slack notifier")
}
message, err := msg.New(msg.Options{ message, err := msg.New(msg.Options{
Meta: c.meta, Meta: c.meta,
Entry: entry, Entry: entry,
@ -93,7 +100,7 @@ func (c *Client) Send(entry model.NotifEntry) error {
color = "#0054ca" color = "#0054ca"
} }
return slack.PostWebhook(c.cfg.WebhookURL, &slack.WebhookMessage{ return slack.PostWebhook(webhookURL, &slack.WebhookMessage{
Attachments: []slack.Attachment{ Attachments: []slack.Attachment{
{ {
Color: color, Color: color,

9
internal/notif/teams/client.go
View file

@ -11,6 +11,8 @@ import (
"github.com/crazy-max/diun/v4/internal/model" "github.com/crazy-max/diun/v4/internal/model"
"github.com/crazy-max/diun/v4/internal/msg" "github.com/crazy-max/diun/v4/internal/msg"
"github.com/crazy-max/diun/v4/internal/notif/notifier" "github.com/crazy-max/diun/v4/internal/notif/notifier"
"github.com/crazy-max/diun/v4/pkg/utl"
"github.com/pkg/errors"
) )
// Client represents an active webhook notification object // Client represents an active webhook notification object
@ -50,6 +52,11 @@ type Fact struct {
// Send creates and sends a webhook notification with an entry // Send creates and sends a webhook notification with an entry
func (c *Client) Send(entry model.NotifEntry) error { func (c *Client) Send(entry model.NotifEntry) error {
webhookURL, err := utl.GetSecret(c.cfg.WebhookURL, c.cfg.WebhookURLFile)
if err != nil {
return errors.Wrap(err, "cannot retrieve webhook URL for Teams notifier")
}
message, err := msg.New(msg.Options{ message, err := msg.New(msg.Options{
Meta: c.meta, Meta: c.meta,
Entry: entry, Entry: entry,
@ -107,7 +114,7 @@ func (c *Client) Send(entry model.NotifEntry) error {
ctx, cancel := context.WithTimeout(context.Background(), time.Duration(10)*time.Second) ctx, cancel := context.WithTimeout(context.Background(), time.Duration(10)*time.Second)
defer cancel() defer cancel()
req, err := http.NewRequestWithContext(ctx, "POST", c.cfg.WebhookURL, bytes.NewBuffer(jsonBody)) req, err := http.NewRequestWithContext(ctx, "POST", webhookURL, bytes.NewBuffer(jsonBody))
if err != nil { if err != nil {
return err return err
} }