Merge pull request #26 from skoef/cleanup

some linting and small fixes

Author: skoef

.goreleaser.yaml

@@ -1,7 +1,14 @@
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+version: 2
+
 before:
   hooks:
     - go mod tidy
+
 dist: build
+
 builds:
   - env:
       - CGO_ENABLED=0
@@ -10,12 +17,20 @@ builds:
     goarch:
       - amd64
       - arm64
+
 archives:
-  - format: binary
-checksum:
-  name_template: 'checksums.txt'
-snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  - formats:
+      - binary
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+      - '^Merge pull request'
+      - '^Merge branch'
+
 nfpms:
   - package_name: birdwatcher
     homepage: https://github.com/skoef/birdwatcher
@@ -55,11 +70,3 @@ nfpms:
       rpm:
         dependencies:
         - glibc
-changelog:
-  sort: asc
-  filters:
-    exclude:
-      - '^docs:'
-      - '^test:'
-      - '^Merge pull request'
-      - '^Merge branch'

birdwatcher/bird_test.go

@@ -17,7 +17,7 @@ func TestWriteBirdConfig(t *testing.T) {
 		t.Parallel()
 
 		// open tempfile
-		tmpFile, err := os.CreateTemp("", "bird_test")
+		tmpFile, err := os.CreateTemp(t.TempDir(), "bird_test")
 		require.NoError(t, err)
 		defer os.Remove(tmpFile.Name())
 
@@ -42,7 +42,7 @@ func TestWriteBirdConfig(t *testing.T) {
 		t.Parallel()
 
 		// open tempfile
-		tmpFile, err := os.CreateTemp("", "bird_test")
+		tmpFile, err := os.CreateTemp(t.TempDir(), "bird_test")
 		require.NoError(t, err)
 		defer os.Remove(tmpFile.Name())
 
@@ -72,7 +72,7 @@ func TestWriteBirdConfig(t *testing.T) {
 		t.Parallel()
 
 		// open tempfile
-		tmpFile, err := os.CreateTemp("", "bird_test")
+		tmpFile, err := os.CreateTemp(t.TempDir(), "bird_test")
 		require.NoError(t, err)
 		defer os.Remove(tmpFile.Name())
 
@@ -117,11 +117,11 @@ func TestBirdCompareFiles(t *testing.T) {
 	t.Parallel()
 
 	// open 2 tempfiles
-	tmpFileA, err := os.CreateTemp("", "bird_test")
+	tmpFileA, err := os.CreateTemp(t.TempDir(), "bird_test")
 	require.NoError(t, err)
 	defer os.Remove(tmpFileA.Name())
 
-	tmpFileB, err := os.CreateTemp("", "bird_test")
+	tmpFileB, err := os.CreateTemp(t.TempDir(), "bird_test")
 	require.NoError(t, err)
 	defer os.Remove(tmpFileB.Name())
 

birdwatcher/healthcheck.go

@@ -49,7 +49,7 @@ func NewHealthCheck(c Config) HealthCheck {
 
 // Start starts the process of health checking the services and handling
 // Actions that come from them
-func (h *HealthCheck) Start(services []*ServiceCheck, ready chan<- bool, status *chan string) {
+func (h *HealthCheck) Start(services []*ServiceCheck, ready chan<- bool, status chan string) {
 	// copy reference to services
 	h.services = services
 	// create channel for service check to push there events on
@@ -91,7 +91,7 @@ func (h *HealthCheck) didReloadBefore() bool {
 	return h.reloadedBefore
 }
 
-func (h *HealthCheck) handleAction(action *Action, status *chan string) {
+func (h *HealthCheck) handleAction(action *Action, status chan string) {
 	for _, p := range action.Prefixes {
 		switch action.State {
 		case ServiceStateUp:
@@ -111,10 +111,8 @@ func (h *HealthCheck) handleAction(action *Action, status *chan string) {
 	// gather data for a status update
 	su := h.statusUpdate()
 	log.WithField("status", su).Debug("status update")
-	// if status channel is given, send update on it
-	if status != nil {
-		*status <- su
-	}
+	// send update over channel
+	status <- su
 
 	if err := h.applyConfig(h.Config, h.prefixes); err != nil {
 		log.WithError(err).Error("could not apply BIRD config")

birdwatcher/healthcheck_test.go

@@ -101,8 +101,15 @@ func TestHealthCheck_handleAction(t *testing.T) {
 	action.Service = &ServiceCheck{
 		FunctionName: "test",
 	}
+
+	sc := make(chan string)
+	go func() {
+		// make sure to read the status channel to prevent blocking handleAction
+		<-sc
+	}()
+
 	// handle service state up
-	hc.handleAction(action, nil)
+	hc.handleAction(action, sc)
 
 	if assert.Contains(t, hc.prefixes, "test") {
 		assert.Len(t, hc.prefixes["test"].prefixes, 2)
@@ -111,7 +118,11 @@ func TestHealthCheck_handleAction(t *testing.T) {
 	// action switches to down for one of the prefixes
 	action.State = ServiceStateDown
 	action.Prefixes = action.Prefixes[1:]
-	hc.handleAction(action, nil)
+	go func() {
+		// make sure to read the status channel to prevent blocking handleAction
+		<-sc
+	}()
+	hc.handleAction(action, sc)
 
 	if assert.Contains(t, hc.prefixes, "test") {
 		assert.Len(t, hc.prefixes["test"].prefixes, 1)

dist/birdwatcher.conf

@@ -12,7 +12,7 @@ enabled = false
 # TCP port to expose the prometheus exporter on
 port = 9091
 # HTTP path to expose the prometheus exporter on
-path = /metrics
+path = "/metrics"
 
 [services]
   # example service
@@ -21,7 +21,7 @@ path = /metrics
   # command = "/usr/bin/my_check.sh"
   # functionname = "match_route"
   # interval = 1
-  # timeout = 10s
+  # timeout = "10s"
   # fail = 1
   # rise = 1
   # prefixes = ["192.168.0.0/24", "fc00::/7"]

main.go

@@ -3,13 +3,11 @@ package main
 
 import (
 	"encoding/json"
-	"errors"
 	"flag"
 	"fmt"
 	"net/http"
 	"os"
 	"os/signal"
-	"runtime/debug"
 	"syscall"
 	"time"
 
@@ -24,6 +22,13 @@ const (
 	systemdStatusBufferSize = 32
 )
 
+// variables filled in by goreleaser during release
+var (
+	version = "devel"
+	commit  = "none"
+	// date    = "unknown"
+)
+
 //nolint:funlen // we should refactor this a bit
 func main() {
 	// initialize logging
@@ -35,23 +40,18 @@ func main() {
 		checkConfig = flag.Bool("check-config", false, "check config file and exit")
 		debugFlag   = flag.Bool("debug", false, "increase loglevel to debug")
 		useSystemd  = flag.Bool("systemd", false, "optimize behavior for running under systemd")
-		version     = flag.Bool("version", false, "show version and exit")
+		versionFlag = flag.Bool("version", false, "show version and exit")
 	)
 
 	flag.Parse()
 
-	versionString := "(devel)"
-	if vcs, ok := debug.ReadBuildInfo(); ok {
-		versionString = vcs.Main.Version
-	}
-
-	if *version {
-		fmt.Printf("birdwatcher, %s\n", versionString)
+	if *versionFlag {
+		fmt.Printf("birdwatcher, %s (%s)\n", version, commit)
 
 		return
 	}
 
-	log.Infof("starting birdwatcher, %s", versionString)
+	log.Infof("starting birdwatcher, %s (%s)", version, commit)
 
 	if *debugFlag {
 		log.SetLevel(log.DebugLevel)
@@ -71,7 +71,7 @@ func main() {
 	if err := birdwatcher.ReadConfig(&config, *configFile); err != nil {
 		// return slightly different message when birdwatcher was invoked with -check-config
 		if *checkConfig {
-			fmt.Printf("Configuration file %s not OK: %s\n", *configFile, errors.Unwrap(err))
+			fmt.Printf("Configuration file %s not OK: %s\n", *configFile, err)
 			os.Exit(1)
 		}
 
@@ -107,24 +107,22 @@ func main() {
 	hc := birdwatcher.NewHealthCheck(config)
 	ready := make(chan bool)
 
-	var status *chan string
-
-	if *useSystemd {
-		// create status update channel for systemd
-		// give it a little buffer so the chances of it blocking the health check
-		// is low
-		s := make(chan string, systemdStatusBufferSize)
-		status = &s
-
-		go func() {
-			for update := range *status {
+	// create status update channel for systemd
+	// give it a little buffer so the chances of it blocking the health check
+	// is low
+	sdStatus := make(chan string, systemdStatusBufferSize)
+	go func() {
+		// make sure we read from the sdStatus channel, regardless if we use
+		// systemd integration or not to prevent the channel from blocking
+		for update := range sdStatus {
+			if *useSystemd {
 				log.Debug("notifying systemd of new status")
 				sdnotify("STATUS=" + update)
 			}
-		}()
-	}
+		}
+	}()
 
-	go hc.Start(config.GetServices(), ready, status)
+	go hc.Start(config.GetServices(), ready, sdStatus)
 	// wait for all health services to have started
 	<-ready