Merge pull request #466 from kolyshkin/modernize

Modernize sources, add golangci-lint

Author: Luap99

.github/workflows/go.yml

@@ -24,14 +24,24 @@ jobs:
         uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
-      - name: Go fmt
-        run: ./scripts/ci-runner.sh go_fmt
       - name: Go build (source)
         run: ./scripts/ci-runner.sh build_source
       - name: Go build (tests)
         run: ./scripts/ci-runner.sh build_tests
-      - name: Go vet
-        run: ./scripts/ci-runner.sh go_vet
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get -qq install libsystemd-dev
+      - uses: actions/checkout@v5
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - uses: golangci/golangci-lint-action@v8
+        with:
+          version: v2.3
 
   all-done:
     needs:

.golangci.yml

@@ -0,0 +1,19 @@
+version: "2"
+
+formatters:
+  enable:
+    - gofumpt
+
+linters:
+  settings:
+    staticcheck:
+      checks:
+        - all
+        - -ST1003 # https://staticcheck.dev/docs/checks/#ST1003 Should not use underscores in Go names.
+        - -ST1005 # https://staticcheck.dev/docs/checks/#ST1005 Error strings should not be capitalized.
+    govet:
+      enable:
+        - nilness
+  exclusions:
+    presets:
+      - std-error-handling

activation/files_test.go

@@ -24,15 +24,18 @@ import (
 
 // correctStringWritten fails the text if the correct string wasn't written
 // to the other side of the pipe.
-func correctStringWritten(t *testing.T, r *os.File, expected string) bool {
+func correctStringWritten(t *testing.T, r io.Reader, expected string) {
+	t.Helper()
+
 	bytes := make([]byte, len(expected))
-	io.ReadAtLeast(r, bytes, len(expected))
+	_, err := io.ReadAtLeast(r, bytes, len(expected))
+	if err != nil {
+		t.Fatal(err)
+	}
 
 	if string(bytes) != expected {
 		t.Fatalf("Unexpected string %s", string(bytes))
 	}
-
-	return true
 }
 
 // TestActivation forks out a copy of activation.go example and reads back two
@@ -53,7 +56,7 @@ func TestActivation(t *testing.T) {
 
 	err := cmd.Run()
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
 	}
 
 	correctStringWritten(t, r1, "Hello world: fd1")
@@ -68,7 +71,7 @@ func TestActivationNoFix(t *testing.T) {
 
 	out, _ := cmd.CombinedOutput()
 	if !bytes.Contains(out, []byte("No files")) {
-		t.Fatalf("Child didn't error out as expected")
+		t.Fatal("Child didn't error out as expected")
 	}
 }
 
@@ -80,6 +83,6 @@ func TestActivationNoFiles(t *testing.T) {
 
 	out, _ := cmd.CombinedOutput()
 	if !bytes.Contains(out, []byte("No files")) {
-		t.Fatalf("Child didn't error out as expected")
+		t.Fatal("Child didn't error out as expected")
 	}
 }

activation/files_unix.go

@@ -13,7 +13,6 @@
 // limitations under the License.
 
 //go:build !windows
-// +build !windows
 
 // Package activation implements primitives for systemd socket activation.
 package activation
@@ -38,9 +37,12 @@ const (
 // fd usage and to avoid leaking environment flags to child processes.
 func Files(unsetEnv bool) []*os.File {
 	if unsetEnv {
-		defer os.Unsetenv("LISTEN_PID")
-		defer os.Unsetenv("LISTEN_FDS")
-		defer os.Unsetenv("LISTEN_FDNAMES")
+		defer func() {
+			// Unsetenv implementation for unix never returns an error.
+			_ = os.Unsetenv("LISTEN_PID")
+			_ = os.Unsetenv("LISTEN_FDS")
+			_ = os.Unsetenv("LISTEN_FDNAMES")
+		}()
 	}
 
 	pid, err := strconv.Atoi(os.Getenv("LISTEN_PID"))

activation/listeners_test.go

@@ -15,26 +15,12 @@
 package activation
 
 import (
-	"io"
 	"net"
 	"os"
 	"os/exec"
 	"testing"
 )
 
-// correctStringWritten fails the text if the correct string wasn't written
-// to the other side of the pipe.
-func correctStringWrittenNet(t *testing.T, r net.Conn, expected string) bool {
-	bytes := make([]byte, len(expected))
-	io.ReadAtLeast(r, bytes, len(expected))
-
-	if string(bytes) != expected {
-		t.Fatalf("Unexpected string %s", string(bytes))
-	}
-
-	return true
-}
-
 // TestActivation forks out a copy of activation.go example and reads back two
 // strings from the pipes that are passed in.
 func TestListeners(t *testing.T) {
@@ -43,11 +29,11 @@ func TestListeners(t *testing.T) {
 
 	l1, err := net.Listen("tcp", ":9999")
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
 	}
 	l2, err := net.Listen("tcp", ":1234")
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
 	}
 
 	t1 := l1.(*net.TCPListener)
@@ -63,25 +49,28 @@ func TestListeners(t *testing.T) {
 
 	r1, err := net.Dial("tcp", "127.0.0.1:9999")
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
+	}
+	if _, err := r1.Write([]byte("Hi")); err != nil {
+		t.Fatal(err)
 	}
-	r1.Write([]byte("Hi"))
 
 	r2, err := net.Dial("tcp", "127.0.0.1:1234")
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
+	}
+	if _, err := r2.Write([]byte("Hi")); err != nil {
+		t.Fatal(err)
 	}
-	r2.Write([]byte("Hi"))
 
 	cmd.Env = os.Environ()
 	cmd.Env = append(cmd.Env, "LISTEN_FDS=2", "LISTEN_FDNAMES=fd1:fd2", "FIX_LISTEN_PID=1")
 
 	out, err := cmd.CombinedOutput()
 	if err != nil {
-		println(string(out))
-		t.Fatalf(err.Error())
+		t.Fatalf("Unexpected error: %v (command output: %s)", err, out)
 	}
 
-	correctStringWrittenNet(t, r1, "Hello world: fd1")
-	correctStringWrittenNet(t, r2, "Goodbye world: fd2")
+	correctStringWritten(t, r1, "Hello world: fd1")
+	correctStringWritten(t, r2, "Goodbye world: fd2")
 }

activation/packetconns_test.go

@@ -29,11 +29,11 @@ func TestPacketConns(t *testing.T) {
 
 	u1, err := net.ListenUDP("udp", &net.UDPAddr{Port: 9999})
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
 	}
 	u2, err := net.ListenUDP("udp", &net.UDPAddr{Port: 1234})
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
 	}
 
 	f1, _ := u1.File()
@@ -46,15 +46,19 @@ func TestPacketConns(t *testing.T) {
 
 	r1, err := net.Dial("udp", "127.0.0.1:9999")
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
+	}
+	if _, err := r1.Write([]byte("Hi")); err != nil {
+		t.Fatal(err)
 	}
-	r1.Write([]byte("Hi"))
 
 	r2, err := net.Dial("udp", "127.0.0.1:1234")
 	if err != nil {
-		t.Fatalf(err.Error())
+		t.Fatal(err)
+	}
+	if _, err := r2.Write([]byte("Hi")); err != nil {
+		t.Fatal(err)
 	}
-	r2.Write([]byte("Hi"))
 
 	cmd.Env = os.Environ()
 	cmd.Env = append(cmd.Env, "LISTEN_FDS=2", "LISTEN_FDNAMES=fd1:fd2", "FIX_LISTEN_PID=1")
@@ -64,6 +68,6 @@ func TestPacketConns(t *testing.T) {
 		t.Fatalf("Cmd output '%s', err: '%s'\n", out, err)
 	}
 
-	correctStringWrittenNet(t, r1, "Hello world")
-	correctStringWrittenNet(t, r2, "Goodbye world")
+	correctStringWritten(t, r1, "Hello world")
+	correctStringWritten(t, r2, "Goodbye world")
 }

daemon/sdnotify_test.go

@@ -16,29 +16,22 @@ package daemon
 
 import (
 	"fmt"
-	"io/ioutil"
 	"net"
 	"os"
 	"testing"
 )
 
-// TestSdNotify
 func TestSdNotify(t *testing.T) {
-
-	testDir, e := ioutil.TempDir("/tmp/", "test-")
-	if e != nil {
-		panic(e)
-	}
-	defer os.RemoveAll(testDir)
+	testDir := t.TempDir()
 
 	notifySocket := testDir + "/notify-socket.sock"
 	laddr := net.UnixAddr{
 		Name: notifySocket,
 		Net:  "unixgram",
 	}
-	_, e = net.ListenUnixgram("unixgram", &laddr)
-	if e != nil {
-		panic(e)
+	_, err := net.ListenUnixgram("unixgram", &laddr)
+	if err != nil {
+		t.Fatal(err)
 	}
 
 	tests := []struct {
@@ -57,10 +50,7 @@ func TestSdNotify(t *testing.T) {
 	}
 
 	for i, tt := range tests {
-		must(os.Unsetenv("NOTIFY_SOCKET"))
-		if tt.envSocket != "" {
-			must(os.Setenv("NOTIFY_SOCKET", tt.envSocket))
-		}
+		t.Setenv("NOTIFY_SOCKET", tt.envSocket)
 		sent, err := SdNotify(tt.unsetEnv, fmt.Sprintf("TestSdNotify test message #%d", i))
 
 		if sent != tt.wsent {

daemon/watchdog_test.go

@@ -21,12 +21,6 @@ import (
 	"time"
 )
 
-func must(err error) {
-	if err != nil {
-		panic(err)
-	}
-}
-
 func TestSdWatchdogEnabled(t *testing.T) {
 	mypid := strconv.Itoa(os.Getpid())
 	tests := []struct {
@@ -57,16 +51,8 @@ func TestSdWatchdogEnabled(t *testing.T) {
 	}
 
 	for i, tt := range tests {
-		if tt.usec != "" {
-			must(os.Setenv("WATCHDOG_USEC", tt.usec))
-		} else {
-			must(os.Unsetenv("WATCHDOG_USEC"))
-		}
-		if tt.pid != "" {
-			must(os.Setenv("WATCHDOG_PID", tt.pid))
-		} else {
-			must(os.Unsetenv("WATCHDOG_PID"))
-		}
+		t.Setenv("WATCHDOG_USEC", tt.usec)
+		t.Setenv("WATCHDOG_PID", tt.pid)
 
 		delay, err := SdWatchdogEnabled(tt.unsetEnv)
 

dbus/dbus.go

@@ -12,7 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Integration with the systemd D-Bus API.  See http://www.freedesktop.org/wiki/Software/systemd/dbus/
+// Package dbus provides integration with the systemd D-Bus API.
+// See http://www.freedesktop.org/wiki/Software/systemd/dbus/
 package dbus
 
 import (

dbus/dbus_test.go

@@ -21,8 +21,8 @@ import (
 func TestNeedsEscape(t *testing.T) {
 	// Anything not 0-9a-zA-Z should always be escaped
 	for want, vals := range map[bool][]byte{
-		false: []byte{'a', 'b', 'z', 'A', 'Q', '1', '4', '9'},
-		true:  []byte{'#', '%', '$', '!', '.', '_', '-', '%', '\\'},
+		false: {'a', 'b', 'z', 'A', 'Q', '1', '4', '9'},
+		true:  {'#', '%', '$', '!', '.', '_', '-', '%', '\\'},
 	} {
 		for i := 1; i < 10; i++ {
 			for _, b := range vals {
@@ -36,8 +36,8 @@ func TestNeedsEscape(t *testing.T) {
 
 	// 0-9 in position 0 should be escaped
 	for want, vals := range map[bool][]byte{
-		false: []byte{'A', 'a', 'e', 'x', 'Q', 'Z'},
-		true:  []byte{'0', '4', '5', '9'},
+		false: {'A', 'a', 'e', 'x', 'Q', 'Z'},
+		true:  {'0', '4', '5', '9'},
 	} {
 		for _, b := range vals {
 			got := needsEscape(0, b)
@@ -46,7 +46,6 @@ func TestNeedsEscape(t *testing.T) {
 			}
 		}
 	}
-
 }
 
 func TestPathBusEscape(t *testing.T) {
@@ -64,7 +63,6 @@ func TestPathBusEscape(t *testing.T) {
 			t.Errorf("bad result for PathBusEscape(%s): got %q, want %q", in, got, want)
 		}
 	}
-
 }
 
 func TestPathBusUnescape(t *testing.T) {
@@ -89,7 +87,6 @@ func TestPathBusUnescape(t *testing.T) {
 // TestNew ensures that New() works without errors.
 func TestNew(t *testing.T) {
 	_, err := New()
-
 	if err != nil {
 		t.Fatal(err)
 	}