refactor: enable gofmt linter

.github/workflows/go.yml

@@ -11,6 +11,20 @@ on:
 
 jobs:
 
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-go@v5
+      with:
+        go-version: 1.22.x
+
+    - name: Run golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: v1.61.0
+
   build-for-linux:
     runs-on: ubuntu-latest
     steps:

.golangci.yaml

@@ -0,0 +1,92 @@
+# todo: this should match the configuration of osv-scanner for the most part
+#   currently it does not because using that config raises type errors,
+#   in addition to some of the rules having violations that need addressing,
+#   so the current focus is on getting as many linters as possible running
+
+output:
+  sort-results: true
+linters:
+  # todo: currently linting raises a type error, so until that's resolved we've got to be very selective in what we enable
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - canonicalheader
+#    - containedctx
+#    - contextcheck
+#    - copyloopvar
+    - decorder
+#    - depguard
+    - dogsled
+#    - dupl
+#    - dupword
+    - durationcheck
+#    - errcheck
+#    - errchkjson
+#    - errname
+#    - errorlint
+#    - exhaustive
+#    - fatcontext
+#    - forbidigo
+    - ginkgolinter
+    - gocheckcompilerdirectives
+#    - gochecknoinits
+    - gochecksumtype
+#    - gocritic
+    - gofmt
+    - goheader
+#    - goimports
+    - gomoddirectives
+    - gomodguard
+    - goprintffuncname
+#    - gosec
+#    - gosimple
+    - gosmopolitan
+#    - govet
+    - grouper
+    - importas
+#    - inamedparam
+#    - ineffassign
+    - interfacebloat
+#    - intrange
+    - loggercheck
+    - makezero
+    - mirror
+#    - misspell
+#    - musttag
+    - nakedret
+#    - nilerr
+#    - nilnil
+#    - nlreturn
+#    - noctx
+    - nolintlint
+#    - nosprintfhostport
+#    - paralleltest
+#    - perfsprint
+#    - prealloc
+#    - predeclared
+    - promlinter
+#    - protogetter
+    - reassign
+#    - revive
+    - rowserrcheck
+    - sloglint
+    - spancheck
+    - sqlclosecheck
+#    - staticcheck
+#    - stylecheck
+    - tagalign
+    - tenv
+    - testableexamples
+    - testifylint
+#    - thelper
+#    - tparallel
+#    - unconvert
+#    - unparam
+#    - unused
+#    - usestdlibvars
+#    - wastedassign
+#    - whitespace
+    - zerologlint
+  disable-all: true

Makefile

@@ -5,6 +5,9 @@ scalibr:
 	# go-sqlite3 used by the RPM extractor.
 	CGO_ENABLED=1 go build binary/scalibr/scalibr.go
 
+lint:
+	go run github.com/golangci/golangci-lint/cmd/[email protected] run ./... --max-same-issues 0
+
 test:
 	CGO_ENABLED=1 go test ./...
 

artifact/image/symlink/symlink_test.go

@@ -21,8 +21,6 @@ import (
 	"github.com/google/osv-scalibr/artifact/image/symlink"
 )
 
-var ()
-
 func TestTargetOutsideRoot(t *testing.T) {
 
 	tests := []struct {

artifact/image/unpack/unpack_test.go

@@ -171,24 +171,24 @@ func TestUnpackSquashed(t *testing.T) {
 		dir:   mustMkdirTemp(t),
 		image: mustImageFromPath(t, filepath.Join("testdata", "basic.tar")),
 		want: map[string]contentAndMode{
-			"sample.txt":        contentAndMode{content: "sample text file\n", mode: fs.FileMode(0644)},
-			"larger-sample.txt": contentAndMode{content: strings.Repeat("sample text file\n", 400), mode: fs.FileMode(0644)},
+			"sample.txt":        {content: "sample text file\n", mode: fs.FileMode(0644)},
+			"larger-sample.txt": {content: strings.Repeat("sample text file\n", 400), mode: fs.FileMode(0644)},
 		},
 	}, {
 		name:  "large files are skipped",
 		cfg:   unpack.DefaultUnpackerConfig().WithMaxFileBytes(1024),
 		dir:   mustMkdirTemp(t),
 		image: mustImageFromPath(t, filepath.Join("testdata", "basic.tar")),
 		want: map[string]contentAndMode{
-			"sample.txt": contentAndMode{content: "sample text file\n", mode: fs.FileMode(0644)},
+			"sample.txt": {content: "sample text file\n", mode: fs.FileMode(0644)},
 		},
 	}, {
 		name:  "image with restricted file permissions",
 		cfg:   unpack.DefaultUnpackerConfig(),
 		dir:   mustMkdirTemp(t),
 		image: mustImageFromPath(t, filepath.Join("testdata", "permissions.tar")),
 		want: map[string]contentAndMode{
-			"sample.txt": contentAndMode{content: "sample text file\n", mode: fs.FileMode(0600)},
+			"sample.txt": {content: "sample text file\n", mode: fs.FileMode(0600)},
 		},
 	}, {
 		name: "image with symlinks",
@@ -352,12 +352,12 @@ func TestUnpackLayers(t *testing.T) {
 		want: []digestAndContent{{
 			digest: "SQUASHED",
 			content: map[string]contentAndMode{
-				"sample.txt": contentAndMode{content: "sample text file\n", mode: fs.FileMode(0600)},
+				"sample.txt": {content: "sample text file\n", mode: fs.FileMode(0600)},
 			},
 		}, {
 			digest: "sha256:854d994f7942ac6711ff410417b58270562d322a251be74df7829c15ec31e369",
 			content: map[string]contentAndMode{
-				"sample.txt": contentAndMode{content: "sample text file\n", mode: fs.FileMode(0600)},
+				"sample.txt": {content: "sample text file\n", mode: fs.FileMode(0600)},
 			},
 		}},
 	}, {
@@ -368,18 +368,18 @@ func TestUnpackLayers(t *testing.T) {
 		want: []digestAndContent{{
 			digest: "SQUASHED",
 			content: map[string]contentAndMode{
-				"sample.txt":        contentAndMode{content: "sample text file\n", mode: fs.FileMode(0644)},
-				"larger-sample.txt": contentAndMode{content: strings.Repeat("sample text file\n", 400), mode: fs.FileMode(0644)},
+				"sample.txt":        {content: "sample text file\n", mode: fs.FileMode(0644)},
+				"larger-sample.txt": {content: strings.Repeat("sample text file\n", 400), mode: fs.FileMode(0644)},
 			},
 		}, {
 			digest: "sha256:abfb541589db284238458b23f1607a184905159aa161c7325b725b4e2eaa1c2c",
 			content: map[string]contentAndMode{
-				"sample.txt": contentAndMode{content: "sample text file\n", mode: fs.FileMode(0644)},
+				"sample.txt": {content: "sample text file\n", mode: fs.FileMode(0644)},
 			},
 		}, {
 			digest: "sha256:c2df653a81c5c96005972035fa076987c9e450e54a03de57aabdadc00e4939c4",
 			content: map[string]contentAndMode{
-				"larger-sample.txt": contentAndMode{content: strings.Repeat("sample text file\n", 400), mode: fs.FileMode(0644)},
+				"larger-sample.txt": {content: strings.Repeat("sample text file\n", 400), mode: fs.FileMode(0644)},
 			},
 		}},
 	}, {

artifact/image/whiteout/whiteout_test.go

@@ -52,7 +52,7 @@ func TestWhiteout(t *testing.T) {
 			},
 			dirs: []string{},
 			want: map[string]struct{}{
-				".wh.hello_world.txt": struct{}{},
+				".wh.hello_world.txt": {},
 			},
 		},
 		{
@@ -64,8 +64,8 @@ func TestWhiteout(t *testing.T) {
 			},
 			dirs: []string{},
 			want: map[string]struct{}{
-				".wh.foo.txt": struct{}{},
-				".wh.bar.txt": struct{}{},
+				".wh.foo.txt": {},
+				".wh.bar.txt": {},
 			},
 		},
 		{
@@ -80,8 +80,8 @@ func TestWhiteout(t *testing.T) {
 				"dir2",
 			},
 			want: map[string]struct{}{
-				"dir1/.wh.foo.txt": struct{}{},
-				"dir2/.wh.bar.txt": struct{}{},
+				"dir1/.wh.foo.txt": {},
+				"dir2/.wh.bar.txt": {},
 			},
 		},
 		{
@@ -93,7 +93,7 @@ func TestWhiteout(t *testing.T) {
 				"dir1",
 			},
 			want: map[string]struct{}{
-				".wh..wh..opa.dir1": struct{}{},
+				".wh..wh..opa.dir1": {},
 			},
 		},
 		{
@@ -110,9 +110,9 @@ func TestWhiteout(t *testing.T) {
 				"dir3/dir4",
 			},
 			want: map[string]struct{}{
-				".wh..wh..opa.dir1":     struct{}{},
-				".wh..wh..opa.dir2":     struct{}{},
-				"dir3/dir4/.wh.bar.txt": struct{}{},
+				".wh..wh..opa.dir1":     {},
+				".wh..wh..opa.dir2":     {},
+				"dir3/dir4/.wh.bar.txt": {},
 			},
 		},
 	}

binary/cli/cli_test.go

@@ -187,27 +187,27 @@ func TestGetScanConfig_ScanRoots(t *testing.T) {
 		{
 			desc: "Default scan roots",
 			flags: map[string]*cli.Flags{
-				"darwin":  &cli.Flags{},
-				"linux":   &cli.Flags{},
-				"windows": &cli.Flags{},
+				"darwin":  {},
+				"linux":   {},
+				"windows": {},
 			},
 			wantScanRoots: map[string][]string{
-				"darwin":  []string{"/"},
-				"linux":   []string{"/"},
-				"windows": []string{"C:\\"},
+				"darwin":  {"/"},
+				"linux":   {"/"},
+				"windows": {"C:\\"},
 			},
 		},
 		{
 			desc: "Scan root are provided and used",
 			flags: map[string]*cli.Flags{
-				"darwin":  &cli.Flags{Root: "/root"},
-				"linux":   &cli.Flags{Root: "/root"},
-				"windows": &cli.Flags{Root: "C:\\myroot"},
+				"darwin":  {Root: "/root"},
+				"linux":   {Root: "/root"},
+				"windows": {Root: "C:\\myroot"},
 			},
 			wantScanRoots: map[string][]string{
-				"darwin":  []string{"/root"},
-				"linux":   []string{"/root"},
-				"windows": []string{"C:\\myroot"},
+				"darwin":  {"/root"},
+				"linux":   {"/root"},
+				"windows": {"C:\\myroot"},
 			},
 		},
 	} {
@@ -246,58 +246,58 @@ func TestGetScanConfig_DirsToSkip(t *testing.T) {
 		{
 			desc: "Skip default dirs",
 			flags: map[string]*cli.Flags{
-				"darwin":  &cli.Flags{Root: "/"},
-				"linux":   &cli.Flags{Root: "/"},
-				"windows": &cli.Flags{Root: "C:\\"},
+				"darwin":  {Root: "/"},
+				"linux":   {Root: "/"},
+				"windows": {Root: "C:\\"},
 			},
 			wantDirsToSkip: map[string][]string{
-				"darwin":  []string{"/dev", "/proc", "/sys"},
-				"linux":   []string{"/dev", "/proc", "/sys"},
-				"windows": []string{"C:\\Windows"},
+				"darwin":  {"/dev", "/proc", "/sys"},
+				"linux":   {"/dev", "/proc", "/sys"},
+				"windows": {"C:\\Windows"},
 			},
 		},
 		{
 			desc: "Skip additional dirs",
 			flags: map[string]*cli.Flags{
-				"darwin": &cli.Flags{
+				"darwin": {
 					Root:       "/",
 					DirsToSkip: []string{"/boot,/mnt,C:\\boot", "C:\\mnt"},
 				},
-				"linux": &cli.Flags{
+				"linux": {
 					Root:       "/",
 					DirsToSkip: []string{"/boot,/mnt", "C:\\boot,C:\\mnt"},
 				},
-				"windows": &cli.Flags{
+				"windows": {
 					Root:       "C:\\",
 					DirsToSkip: []string{"C:\\boot,C:\\mnt"},
 				},
 			},
 			wantDirsToSkip: map[string][]string{
-				"darwin":  []string{"/dev", "/proc", "/sys", "/boot", "/mnt"},
-				"linux":   []string{"/dev", "/proc", "/sys", "/boot", "/mnt"},
-				"windows": []string{"C:\\Windows", "C:\\boot", "C:\\mnt"},
+				"darwin":  {"/dev", "/proc", "/sys", "/boot", "/mnt"},
+				"linux":   {"/dev", "/proc", "/sys", "/boot", "/mnt"},
+				"windows": {"C:\\Windows", "C:\\boot", "C:\\mnt"},
 			},
 		},
 		{
 			desc: "Ignore paths outside root",
 			flags: map[string]*cli.Flags{
-				"darwin": &cli.Flags{
+				"darwin": {
 					Root:       "/root",
 					DirsToSkip: []string{"/root/dir1,/dir2"},
 				},
-				"linux": &cli.Flags{
+				"linux": {
 					Root:       "/root",
 					DirsToSkip: []string{"/root/dir1,/dir2"},
 				},
-				"windows": &cli.Flags{
+				"windows": {
 					Root:       "C:\\root",
 					DirsToSkip: []string{"C:\\root\\dir1,c:\\dir2"},
 				},
 			},
 			wantDirsToSkip: map[string][]string{
-				"darwin":  []string{"/root/dir1"},
-				"linux":   []string{"/root/dir1"},
-				"windows": []string{"C:\\root\\dir1"},
+				"darwin":  {"/root/dir1"},
+				"linux":   {"/root/dir1"},
+				"windows": {"C:\\root\\dir1"},
 			},
 		},
 	} {