provider/slack: add new alert integration

Author: adamdecaf

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/gorilla/mux v1.8.1
 	github.com/moov-io/base v0.53.0
+	github.com/slack-go/slack v0.15.0
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.10.0
 )
@@ -19,6 +20,7 @@ require (
 	github.com/go-kit/log v0.2.1 // indirect
 	github.com/go-logfmt/logfmt v0.6.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect

go.sum

@@ -11,7 +11,10 @@ github.com/go-kit/log v0.2.1 h1:MRVx0/zhvdseW+Gza6N9rVzU/IVzaeE1SFI4raAhmBU=
 github.com/go-kit/log v0.2.1/go.mod h1:NwTd00d/i8cPZ3xOwwiv2PO5MOcx78fFErGNcVmBjv0=
 github.com/go-logfmt/logfmt v0.6.0 h1:wGYYu3uicYdqXVgoYbvnkrPVXkuLM1p1ifugDMEdRi4=
 github.com/go-logfmt/logfmt v0.6.0/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs=
+github.com/go-test/deep v1.0.4 h1:u2CU3YKy9I2pmu9pX0eq50wCgjfGIt539SqR7FbHiho=
+github.com/go-test/deep v1.0.4/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
@@ -20,6 +23,8 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
 github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
+github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
+github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
@@ -34,6 +39,7 @@ github.com/moov-io/base v0.53.0 h1:rpPWEbd/NTWApLzFq2AYbCZUlIv99OtvQcan7yArJVE=
 github.com/moov-io/base v0.53.0/go.mod h1:F2cdACBgJHNemPrOxvc88ezIqFL6ymErB4hOuPR+axg=
 github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M=
 github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rickar/cal/v2 v2.1.19 h1:rhWU/LGZnBwsEiJXMRAM9JooLH/8OHN8wWZ9qq13XJk=
@@ -44,6 +50,8 @@ github.com/sagikazarmark/locafero v0.6.0 h1:ON7AQg37yzcRPU69mt7gwhFEBwxI6P9T4Qu3
 github.com/sagikazarmark/locafero v0.6.0/go.mod h1:77OmuIc6VTraTXKXIs/uvUxKGUXjE1GbemJYHqdNjX0=
 github.com/sagikazarmark/slog-shim v0.1.0 h1:diDBnUNK9N/354PgrxMywXnAwEr1QZcOr6gto+ugjYE=
 github.com/sagikazarmark/slog-shim v0.1.0/go.mod h1:SrcSrq8aKtyuqEI1uvTDTK1arOWRIczQRv+GVI1AkeQ=
+github.com/slack-go/slack v0.15.0 h1:LE2lj2y9vqqiOf+qIIy0GvEoxgF1N5yLGZffmEZykt0=
+github.com/slack-go/slack v0.15.0/go.mod h1:hlGi5oXA+Gt+yWTPP0plCdRKmjsDxecdHxYQdlMQKOw=
 github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo=
 github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0=
 github.com/spf13/afero v1.11.0 h1:WJQKhtpdm3v2IzqG8VMqrr6Rf3UYpEF239Jy9wNepM8=
@@ -54,8 +62,7 @@ github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/spf13/viper v1.19.0 h1:RWq5SEjt8o25SROyN3z2OrDB9l7RPd3lwTWU8EcEdcI=
 github.com/spf13/viper v1.19.0/go.mod h1:GQUN9bilAbhU/jgc1bKs99f/suXKeUMct8Adx5+Ntkg=
-github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
-github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=

internal/check/checks.go

@@ -100,5 +100,16 @@ func mergeAlertConfigs(local, global config.Alert) config.Alert {
 		}
 	}
 
+	// Slack config merging
+	out.Slack = cmp.Or(local.Slack, global.Slack)
+
+	if local.Slack != nil && global.Slack != nil {
+		// Prefer the local config over the global config
+		out.Slack = &config.Slack{
+			ApiToken:  cmp.Or(local.Slack.ApiToken, global.Slack.ApiToken),
+			ChannelID: cmp.Or(local.Slack.ChannelID, global.Slack.ChannelID),
+		}
+	}
+
 	return out
 }

internal/config/config.go

@@ -43,6 +43,9 @@ func Load(path string) (*Config, error) {
 	if pd := ReadPagerDutyFromEnv(); pd != nil {
 		cfg.Alert.PagerDuty = pd
 	}
+	if sk := ReadSlackFromEnv(); sk != nil {
+		cfg.Alert.Slack = sk
+	}
 
 	return &cfg, nil
 }
@@ -105,6 +108,7 @@ func (t PartialDay) GetTimes() ([]time.Time, error) {
 
 type Alert struct {
 	PagerDuty *PagerDuty `yaml:"pagerduty"`
+	Slack     *Slack
 }
 
 type PagerDuty struct {
@@ -134,3 +138,22 @@ func ReadPagerDutyFromEnv() *PagerDuty {
 	}
 	return nil
 }
+
+type Slack struct {
+	ApiToken  string
+	ChannelID string
+}
+
+func ReadSlackFromEnv() *Slack {
+	apiToken := os.Getenv("DEADCHECK_SLACK_API_TOKEN")
+	channelID := os.Getenv("DEADCHECK_SLACK_CHANNEL_ID")
+
+	if apiToken != "" && channelID != "" {
+		return &Slack{
+			ApiToken:  apiToken,
+			ChannelID: channelID,
+		}
+	}
+
+	return nil
+}

internal/config/tolerance.go

@@ -0,0 +1,47 @@
+package config
+
+import (
+	"fmt"
+	"time"
+)
+
+func GetTolerance(schedule ScheduleConfig) time.Duration {
+	var input string
+	if schedule.Weekdays != nil {
+		input = schedule.Weekdays.Tolerance
+	}
+	if schedule.BankingDays != nil {
+		input = schedule.BankingDays.Tolerance
+	}
+
+	dur, _ := time.ParseDuration(input)
+	return dur
+}
+
+func WithinTolerance(now, scheduleTime time.Time, schedule ScheduleConfig) error {
+	tolerance := GetTolerance(schedule)
+
+	if tolerance > time.Duration(0) {
+		// Allow checkins before the scheduled check-in time according to the tolerance
+		switch {
+		case now.Before(scheduleTime):
+			// We are early to check-in
+			diff := scheduleTime.Sub(now)
+			if diff > tolerance {
+				return fmt.Errorf("%v check-in not allowed for %v", scheduleTime.Format("15:04"), diff)
+			}
+		case now.Equal(scheduleTime):
+			// do nothing, we're on time
+			return nil
+
+		case scheduleTime.Before(now):
+			// We are late to check-in
+			diff := now.Sub(scheduleTime)
+			if diff > tolerance {
+				return fmt.Errorf("%v check-in is late by %v", scheduleTime.Format("15:04"), diff-tolerance)
+			}
+		}
+	}
+
+	return nil
+}

internal/provider/pd/client.go

@@ -138,31 +138,9 @@ func (c *client) CheckIn(ctx context.Context, check config.Check) (time.Time, er
 	// Only allow check-ins with the tolerance specified.
 	//  e.g. If the tolerance is 5mins for a check-in expected at 4pm then only between 3:55pm and 4:05pm
 	//       would check-ins be allowed.
-	tolerance := getTolerance(check.Schedule)
-
-	if tolerance > time.Duration(0) {
-		// Allow checkins before the scheduled check-in time according to the tolerance
-		switch {
-		case now.Before(scheduleTime):
-			// We are early to check-in
-			diff := scheduleTime.Sub(now)
-			if diff > tolerance {
-				err = fmt.Errorf("%v check-in not allowed for %v", scheduleTime.Format("15:04"), diff)
-				logger.Warn().Log(err.Error())
-				return time.Time{}, err
-			}
-		case now.Equal(scheduleTime):
-			// do nothing, we're on time
-
-		case scheduleTime.Before(now):
-			// We are late to check-in
-			diff := now.Sub(scheduleTime)
-			if diff > tolerance {
-				err = fmt.Errorf("%v check-in is late by %v", scheduleTime.Format("15:04"), diff-tolerance)
-				logger.Warn().Log(err.Error())
-				return time.Time{}, err
-			}
-		}
+	err = config.WithinTolerance(now, scheduleTime, check.Schedule)
+	if err != nil {
+		return time.Time{}, logger.Error().LogError(err).Err()
 	}
 
 	// future := now.Add(wait)
@@ -181,16 +159,3 @@ func (c *client) CheckIn(ctx context.Context, check config.Check) (time.Time, er
 
 	return future, nil
 }
-
-func getTolerance(schedule config.ScheduleConfig) time.Duration {
-	var input string
-	if schedule.Weekdays != nil {
-		input = schedule.Weekdays.Tolerance
-	}
-	if schedule.BankingDays != nil {
-		input = schedule.BankingDays.Tolerance
-	}
-
-	dur, _ := time.ParseDuration(input)
-	return dur
-}

internal/provider/provider.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/adamdecaf/deadcheck/internal/config"
 	"github.com/adamdecaf/deadcheck/internal/provider/pd"
+	"github.com/adamdecaf/deadcheck/internal/provider/slack"
 
 	"github.com/moov-io/base/log"
 	"github.com/moov-io/base/stime"
@@ -23,6 +24,8 @@ func NewClient(logger log.Logger, conf config.Alert) (Client, error) {
 	switch {
 	case conf.PagerDuty != nil:
 		return pd.NewClient(logger, conf.PagerDuty, timeService)
+	case conf.Slack != nil:
+		return slack.NewClient(logger, conf.Slack, timeService)
 	}
 	return nil, errors.New("no provider configured")
 }