Merge pull request 'golang-1-26' (#27) from golang-1-26 into main

Reviewed-on: https://git.iamthefij.com/iamthefij/minitor-go/pulls/27

.drone.yml

@@ -4,7 +4,7 @@ name: test
 
 steps:
   - name: test
-    image: golang:1.21
+    image: golang:1.26
     environment:
       VERSION: ${DRONE_TAG:-${DRONE_COMMIT}}
     commands:
@@ -30,7 +30,7 @@ trigger:
 
 steps:
   - name: build all binaries
-    image: golang:1.21
+    image: golang:1.26
     environment:
       VERSION: ${DRONE_TAG:-${DRONE_COMMIT}}
     commands:

.gitea/workflows/build.yml

@@ -3,19 +3,17 @@ on:
   push:
     branches:
       - main
-      - master
     tags:
       - "v*"
   pull_request:
     branches:
       - main
-      - master
 
 jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Go
         uses: actions/setup-go@v6
@@ -28,7 +26,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Go
         uses: actions/setup-go@v6
@@ -39,14 +37,14 @@ jobs:
         uses: actions/setup-python@v6
 
       - name: Run pre-commit
-        uses: https://git.iamthefij.com/iamthefij/pre-commit-action@v3.0.2
+        uses: https://git.iamthefij.com/iamthefij/pre-commit-action@v3.1.0
 
   release:
     runs-on: ubuntu-latest
     needs: test
     if: "${{ github.event_name != 'pull_request' }}"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Go
         uses: actions/setup-go@v6
@@ -55,17 +53,17 @@ jobs:
 
       - name: Build binaries
         env:
-          VERSION: "${{ vars.REF_NAME }}"
+          VERSION: "${{ github.REF_NAME }}"
         run: make all
 
       # Package binaries and create release if this is a tagged build
       - name: Compress binaries
-        if: "${{ github.event_name == 'tag' }}"
+        if: "${{ github.ref_type == 'tag' }}"
         run: find ./dist -type f -executable -execdir tar -czvf {}.tar.gz {} \;
 
       - name: Upload release
         uses: https://gitea.com/actions/gitea-release-action@v1
-        if: "${{ github.event_name == 'tag' }}"
+        if: "${{ github.ref_type == 'tag' }}"
         with:
           files: |-
             dist/*.tar.gz
@@ -89,6 +87,7 @@ jobs:
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3
+        if: "${{ github.event_name != 'pull_request' }}"
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
@@ -108,6 +107,6 @@ jobs:
           platforms: |
             linux/amd64
             linux/arm64
-            linux/arm
+            linux/arm/v7
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -14,6 +14,7 @@
 
 # User configuration
 config.yml
+config.hcl
 
 # Output binary
 minitor

.golangci.yml

@@ -1,52 +1,34 @@
 version: "2"
 linters:
   enable:
+    - errcheck
     - errname
     - errorlint
     - exhaustive
-    - goprintffuncname
+    - gosec
+    - govet
+    - ineffassign
     - misspell
     - mnd
-    - tagliatelle
+    - modernize
+    - staticcheck
+    - tagalign
     - testpackage
     - thelper
     - tparallel
     - unconvert
+    - unused
     - wrapcheck
-    - wsl
+    - wsl_v5
-  disable:
-    - gochecknoglobals
-  settings:
-    gosec:
-      excludes:
-        - G204
-    tagliatelle:
-      case:
-        rules:
-          json: snake
-          yaml: snake
   exclusions:
     generated: lax
     presets:
-      - comments
       - common-false-positives
-      - legacy
-      - std-error-handling
     rules:
       - linters:
           - gosec
         path: _test\.go
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
 formatters:
   enable:
     - gofumpt
     - goimports
-  exclusions:
-    generated: lax
-    paths:
-      - third_party$
-      - builtin$
-      - examples$

.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
       - id: end-of-file-fixer
       - id: check-merge-conflict
   - repo: https://github.com/golangci/golangci-lint
-    rev: v2.7.2
+    rev: v2.10.1
     hooks:
       - id: golangci-lint
   - repo: https://github.com/hadolint/hadolint

Dockerfile.multi-stage

@@ -1,4 +1,4 @@
-FROM golang:1.25 AS builder
+FROM golang:1.26 AS builder
 
 WORKDIR /app
 

Makefile

@@ -69,8 +69,8 @@ docker-run: docker-build
 $(TARGETS): $(GOFILES)
 	mkdir -p ./dist
 	GOOS=$(word 2, $(subst -, ,$(@))) GOARCH=$(word 3, $(subst -, ,$(@))) CGO_ENABLED=0 \
-		 go build -ldflags '-X "main.version=${VERSION}"' -a -installsuffix nocgo \
+		go build -ldflags '-X "main.version=${VERSION}"' -a -installsuffix nocgo \
-		 -o $@
+		-o $@
 
 .PHONY: $(TARGET_ALIAS)
 $(TARGET_ALIAS):

README.md

@@ -17,7 +17,7 @@ I'm running a few small services and found Sensu, Consul, Nagios, etc. to all be
 Install and execute with:
 
 ```bash
-go install github.com/iamthefij/minitor-go@latest
+go install github.com/iamthefij/minitor-go/v2@latest
 minitor
 ```
 
@@ -50,15 +50,17 @@ You can configure the timezone for the container by passing a `TZ` env variable.
 
 ## Configuring
 
-In this repo, you can explore the `sample-config.hcl` file for an example, but the general structure is as follows. It should be noted that environment variable interpolation happens on load of the HCL file.
+In this repo, you can explore the `sample-config.hcl` file for an example, but the general structure is as follows. If you are passing environment variables to your commands or alerts, you should be aware that `${VAR}` syntax is reserved for HCL variable interpolation. To avoid issues, you can use `$${VAR}` syntax to escape the `$` character, simply use `$VAR`.
+
+```hcl
 
 The global configurations are:
 
 |key|value|
 |---|---|
 |`check_interval`|Maximum frequency to run checks for each monitor as duration, eg. 1m2s.|
-|`default_alert_after`|A default value used as an `alert_after` value for a monitor if not specified or 0.|
+|`default_alert_after`|A default value used as an `alert_after` value for a monitor if not specified. Defaults 1, which will alert immediately.|
-|`default_alert_every`|A default value used as an `alert_every` value for a monitor if not specified.|
+|`default_alert_every`|A default value used as an `alert_every` value for a monitor if not specified. Defaults to -1, which will re-alert exponentially.|
 |`default_alert_down`|Default down alerts to used by a monitor in case none are provided.|
 |`default_alert_up`|Default up alerts to used by a monitor in case none are provided.|
 |`monitor`|block listing monitors. Detailed description below|
@@ -167,6 +169,48 @@ minitor -metrics
 minitor -metrics -metrics-port 3000
 ```
 
+## Migrating from v1 to v2
+
+Minitor v2 introduces some breaking changes from v1. The most notable changes are:
+  - The configuration file is now in HCL format instead of YAML.
+  - The the Python formatting backwards compatability is removed.
+  - The Command and ShellCommand fields are now mutually exclusive.
+  - The check_interval is now strictly a duration string value. Eg. "30s" rather than `30`.
+  - Default alert_every is now -1 (exponential backoff) rather than 0 (no re-alerting).
+
+For the configuration, a confic that looked like this in v1:
+
+```yaml
+check_interval: 60
+
+monitors:
+  - name: example
+    command: "false"
+    alert_down: ["log"]
+
+alerts:
+  log:
+    command: ["echo", "Minitor up={{.IsUp}} for {{.MonitorName}}"]
+```
+
+Would now look like this in v2:
+
+```hcl
+check_interval = "1m"
+
+monitor "example" {
+  # example showing string to shell command migration
+  shell_command = "false"
+  alert_down = ["log"]
+  check_interval = "1m"
+}
+
+alert "log" {
+  # example showing list to exec command migration
+  command = ["echo", "Minitor up={{.IsUp}} for {{.MonitorName}}"]
+}
+```
+
 ## Contributing
 
 Whether you're looking to submit a patch or tell me I broke something, you can contribute through the Github mirror and I can merge PRs back to the source repository.
@@ -174,11 +218,3 @@ Whether you're looking to submit a patch or tell me I broke something, you can c
 Primary Repo: https://git.iamthefij.com/iamthefij/minitor.git
 
 Github Mirror: https://github.com/IamTheFij/minitor.git
-
-## Original Minitor
-
-This is a reimplementation of [Minitor](https://git.iamthefij.com/iamthefij/minitor) in Go
-
-Minitor is already a minimal monitoring tool. Python 3 was a quick way to get something live, but Python itself comes with a large footprint. Thus Go feels like a better fit for the project, longer term.
-
-Initial target is meant to be roughly compatible requiring only minor changes to configuration. Future iterations may diverge to take advantage of Go specific features.

alert.go

@@ -8,7 +8,7 @@ import (
 	"text/template"
 	"time"
 
-	"git.iamthefij.com/iamthefij/slog"
+	"git.iamthefij.com/iamthefij/slog/v2"
 )
 
 var (

alert_test.go

@@ -4,7 +4,7 @@ import (
 	"errors"
 	"testing"
 
-	m "git.iamthefij.com/iamthefij/minitor-go"
+	m "git.iamthefij.com/iamthefij/minitor-go/v2"
 )
 
 func TestAlertValidate(t *testing.T) {
@@ -22,7 +22,6 @@ func TestAlertValidate(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -77,7 +76,6 @@ func TestAlertSend(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -123,7 +121,6 @@ func TestAlertBuildTemplate(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()

config.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"time"
 
-	"git.iamthefij.com/iamthefij/slog"
+	"git.iamthefij.com/iamthefij/slog/v2"
 	"github.com/hashicorp/hcl/v2/hclsimple"
 )
 

config_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	m "git.iamthefij.com/iamthefij/minitor-go"
+	m "git.iamthefij.com/iamthefij/minitor-go/v2"
 )
 
 func TestLoadConfig(t *testing.T) {
@@ -24,7 +24,6 @@ func TestLoadConfig(t *testing.T) {
 		{"./test/valid-config.hcl", nil, "Valid config file"},
 	}
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -51,7 +50,7 @@ func TestDefaultConfig(t *testing.T) {
 			m.Config{
 				CheckInterval:     1 * time.Second,
 				DefaultAlertAfter: 2,
-				DefaultAlertEvery: Ptr(0),
+				DefaultAlertEvery: new(0),
 				DefaultAlertDown:  []string{"log_command"},
 			},
 			"override defaults",
@@ -61,7 +60,7 @@ func TestDefaultConfig(t *testing.T) {
 			m.Config{
 				CheckInterval:     30 * time.Second,
 				DefaultAlertAfter: 1,
-				DefaultAlertEvery: Ptr(-1),
+				DefaultAlertEvery: new(-1),
 				DefaultAlertDown:  []string{},
 			},
 			"default defaults",
@@ -69,7 +68,6 @@ func TestDefaultConfig(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()

go.mod

@@ -1,9 +1,9 @@
-module git.iamthefij.com/iamthefij/minitor-go
+module git.iamthefij.com/iamthefij/minitor-go/v2
 
-go 1.23.0
+go 1.26.0
 
 require (
-	git.iamthefij.com/iamthefij/slog v1.3.0
+	git.iamthefij.com/iamthefij/slog/v2 v2.0.1
 	github.com/hashicorp/hcl/v2 v2.11.1
 	github.com/prometheus/client_golang v1.23.2
 )

go.sum

@@ -1,5 +1,5 @@
-git.iamthefij.com/iamthefij/slog v1.3.0 h1:4Hu5PQvDrW5e3FrTS3q2iIXW0iPvhNY/9qJsqDR3K3I=
+git.iamthefij.com/iamthefij/slog/v2 v2.0.1 h1:eXf3ga0aMTkm0l6EMYOQpg34S+dQw7cN8o+W1Cg/0C0=
-git.iamthefij.com/iamthefij/slog v1.3.0/go.mod h1:1RUj4hcCompZkAxXCRfUX786tb3cM/Zpkn97dGfUfbg=
+git.iamthefij.com/iamthefij/slog/v2 v2.0.1/go.mod h1:VFjX1e1tfHADyQr2wJBAz0JUQT+K/5FBjzSHgUKOuu8=
 github.com/agext/levenshtein v1.2.1 h1:QmvMAjj2aEICytGiWzmxoE0x2KZvE0fvmqMOfy2tjT8=
 github.com/agext/levenshtein v1.2.1/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558=
 github.com/apparentlymart/go-dump v0.0.0-20180507223929-23540a00eaa3/go.mod h1:oL81AME2rN47vu18xqj1S1jPIPuN7afo62yKTNn3XMM=

main.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 	"time"
 
-	"git.iamthefij.com/iamthefij/slog"
+	"git.iamthefij.com/iamthefij/slog/v2"
 )
 
 var (
@@ -119,7 +119,7 @@ func SendStartupAlerts(config *Config, alertNames []string) error {
 
 func main() {
 	showVersion := flag.Bool("version", false, "Display the version of minitor and exit")
-	configPath := flag.String("config", "config.yml", "Alternate configuration path (default: config.yml)")
+	configPath := flag.String("config", "config.hcl", "Alternate configuration path (default: config.hcl)")
 	startupAlerts := flag.String("startup-alerts", "", "List of alerts to run on startup. This can help determine unhealthy alerts early on. (default \"\")")
 
 	flag.BoolVar(&slog.DebugLevel, "debug", false, "Enables debug logs (default: false)")

main_test.go

@@ -3,13 +3,9 @@ package main_test
 import (
 	"testing"
 
-	m "git.iamthefij.com/iamthefij/minitor-go"
+	m "git.iamthefij.com/iamthefij/minitor-go/v2"
 )
 
-func Ptr[T any](v T) *T {
-	return &v
-}
-
 // TestCheckConfig tests the checkConfig function
 // It also tests results for potentially invalid configuration. For example, no alerts
 func TestCheckMonitors(t *testing.T) {
@@ -91,7 +87,6 @@ func TestCheckMonitors(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -171,7 +166,6 @@ func TestFirstRunAlerts(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()

monitor.go

@@ -7,7 +7,7 @@ import (
 	"os/exec"
 	"time"
 
-	"git.iamthefij.com/iamthefij/slog"
+	"git.iamthefij.com/iamthefij/slog/v2"
 )
 
 // Monitor represents a particular periodic check of a command

monitor_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 	"time"
 
-	m "git.iamthefij.com/iamthefij/minitor-go"
+	m "git.iamthefij.com/iamthefij/minitor-go/v2"
 )
 
 func TestMonitorValidate(t *testing.T) {
@@ -25,7 +25,6 @@ func TestMonitorValidate(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -103,7 +102,6 @@ func TestMonitorGetAlertNames(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -175,7 +173,6 @@ func TestMonitorFailureAlertAfter(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -204,15 +201,14 @@ func TestMonitorFailureAlertEvery(t *testing.T) {
 	}{
 		{m.Monitor{ShellCommand: "false", AlertAfter: 1}, []bool{true}, "No AlertEvery set"}, // Defaults to true because AlertAfter and AlertEvery default to nil
 		// Alert first time only, after 1
-		{m.Monitor{ShellCommand: "false", AlertAfter: 1, AlertEvery: Ptr(0)}, []bool{true, false, false}, "Alert first time only after 1"},
+		{m.Monitor{ShellCommand: "false", AlertAfter: 1, AlertEvery: new(0)}, []bool{true, false, false}, "Alert first time only after 1"},
 		// Alert every time, after 1
-		{m.Monitor{ShellCommand: "false", AlertAfter: 1, AlertEvery: Ptr(1)}, []bool{true, true, true}, "Alert every time after 1"},
+		{m.Monitor{ShellCommand: "false", AlertAfter: 1, AlertEvery: new(1)}, []bool{true, true, true}, "Alert every time after 1"},
 		// Alert every other time, after 1
-		{m.Monitor{ShellCommand: "false", AlertAfter: 1, AlertEvery: Ptr(2)}, []bool{true, false, true, false}, "Alert every other time after 1"},
+		{m.Monitor{ShellCommand: "false", AlertAfter: 1, AlertEvery: new(2)}, []bool{true, false, true, false}, "Alert every other time after 1"},
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()
@@ -301,7 +297,6 @@ func TestMonitorCheck(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(c.name, func(t *testing.T) {
 			t.Parallel()

sample-config.hcl

@@ -38,15 +38,15 @@ alert "mailgun_down" {
     -F to=me@minitor.mon \
     -F text="Our monitor failed" \
     https://api.mailgun.net/v3/minitor.mon/messages \
-    -u "api:${MAILGUN_API_KEY}"
+    -u "api:$${MAILGUN_API_KEY}"
   EOF
 }
 
 alert "sms_down" {
   shell_command = <<-EOF
   curl -s -X POST -F "Body=Failure! {{.MonitorName}} has failed" \
-    -F "From=${AVAILABLE_NUMBER}" -F "To=${MY_PHONE}" \
+    -F "From=$${AVAILABLE_NUMBER}" -F "To=$${MY_PHONE}" \
-    "https://api.twilio.com/2010-04-01/Accounts/${ACCOUNT_SID}/Messages" \
+    "https://api.twilio.com/2010-04-01/Accounts/$${ACCOUNT_SID}/Messages" \
-    -u "${ACCOUNT_SID}:${AUTH_TOKEN}"
+    -u "$${ACCOUNT_SID}:$${AUTH_TOKEN}"
   EOF
 }

util_test.go

@@ -24,7 +24,6 @@ func TestUtilEqualSliceString(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		c := c
 
 		t.Run(fmt.Sprintf("%v %v", c.a, c.b), func(t *testing.T) {
 			t.Parallel()