add support for golangci-lint (dmachard#139)

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Build
+name: go build
 
 on:
   push:

.github/workflows/golint.yml

@@ -0,0 +1,26 @@
+name: go lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  linter:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-go@v3
+      with:
+        go-version: '1.19'
+
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+        version: v1.50.1
+

.github/workflows/releaser.yml → .github/workflows/goreleaser.yml

@@ -1,4 +1,4 @@
-name: GoReleaser
+name: go releaser
 on:
   push:
     tags:

.github/workflows/testing-dnstap.yml

@@ -1,4 +1,4 @@
-name: dnstap tests
+name: tests dnstap
 
 on:
   push:

.github/workflows/testing-go.yml

@@ -1,4 +1,4 @@
-name: go testing
+name: tests go
 
 on:
   push:

.github/workflows/testing-powerdns.yml

@@ -1,4 +1,4 @@
-name: powerdns tests
+name: tests powerdns
 
 on:
   push:

.golangci.yml

@@ -0,0 +1,22 @@
+# https://golangci-lint.run/usage/linters/
+linters:
+  disable-all: true
+  enable:
+  # gofmt checks whether code was gofmt-ed.
+  - gofmt
+  # bet examines Go source code and reports suspicious constructs
+  - govet
+  # finds repeated strings that could be replaced by a constant
+  - goconst
+  # checks Go code for unused constants, variables, functions and types
+  - unused
+  # remove unnecessary type conversions
+  - unconvert
+  # check errors wrapping scheme
+  - errorlint
+
+  # list of linters to use in the future:
+  #- stylecheck
+  #- gocritic
+  #- gosec
+  #- staticcheck

README.md

@@ -132,6 +132,25 @@ Run from source
 go run .
 ```
 
+Install linter
+
+```
+sudo apt install build-essential
+go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+```
+
+List linters enabled
+
+```
+$GOPATH/golangci-lint linters
+```
+
+Execute linter before to commit
+
+```
+$GOPATH/go/bin/golangci-lint run
+```
+
 Execute testunits
 
 ```

collectors/dnssniffer.go

@@ -179,7 +179,6 @@ func (c *DnsSniffer) Stop() {
 }
 
 func (c *DnsSniffer) Listen() error {
-
 	// raw socket
 	fd, err := syscall.Socket(syscall.AF_PACKET, syscall.SOCK_RAW, Htons(syscall.ETH_P_ALL))
 	if err != nil {
@@ -288,22 +287,22 @@ func (c *DnsSniffer) Run() {
 			for _, layertyp := range decodedLayers {
 				switch layertyp {
 				case layers.LayerTypeIPv4:
-					dm.NetworkInfo.Family = "INET"
+					dm.NetworkInfo.Family = dnsutils.PROTO_IPV4
 					dm.NetworkInfo.QueryIp = ip4.SrcIP.String()
 					dm.NetworkInfo.ResponseIp = ip4.DstIP.String()
 
 				case layers.LayerTypeIPv6:
 					dm.NetworkInfo.QueryIp = ip6.SrcIP.String()
 					dm.NetworkInfo.ResponseIp = ip6.DstIP.String()
-					dm.NetworkInfo.Family = "INET6"
+					dm.NetworkInfo.Family = dnsutils.PROTO_IPV6
 					fmt.Println(eth)
 
 				case layers.LayerTypeUDP:
 					dm.NetworkInfo.QueryPort = fmt.Sprint(int(udp.SrcPort))
 					dm.NetworkInfo.ResponsePort = fmt.Sprint(int(udp.DstPort))
 					dm.DNS.Payload = udp.Payload
 					dm.DNS.Length = len(udp.Payload)
-					dm.NetworkInfo.Protocol = "UDP"
+					dm.NetworkInfo.Protocol = dnsutils.PROTO_UDP
 
 				case layers.LayerTypeTCP:
 					// ignore SYN/ACK packet
@@ -322,8 +321,7 @@ func (c *DnsSniffer) Run() {
 					dm.NetworkInfo.ResponsePort = fmt.Sprint(int(tcp.DstPort))
 					dm.DNS.Payload = tcp.Payload[2:]
 					dm.DNS.Length = len(tcp.Payload[2:])
-					dm.NetworkInfo.Protocol = "TCP"
-
+					dm.NetworkInfo.Protocol = dnsutils.PROTO_TCP
 				}
 			}
 

collectors/dnssniffer_processor.go

@@ -123,7 +123,7 @@ func (d *DnsProcessor) Run(sendTo []chan dnsutils.DnsMessage) {
 			dm.NetworkInfo.ResponsePort = qport
 		} else {
 			dm.DNS.Type = dnsutils.DnsQuery
-			dm.DnsTap.Operation = "CLIENT_QUERY"
+			dm.DnsTap.Operation = dnsutils.DNSTAP_CLIENT_QUERY
 		}
 
 		if err = dnsutils.DecodePayload(&dm, &dnsHeader, d.config); err != nil {

collectors/dnssniffer_test.go

@@ -27,7 +27,7 @@ func TestDnsSnifferRun(t *testing.T) {
 	// waiting message in channel
 	for {
 		msg := <-g.Channel()
-		if msg.DnsTap.Operation == "CLIENT_QUERY" && msg.DNS.Qname == "dns.collector" {
+		if msg.DnsTap.Operation == dnsutils.DNSTAP_CLIENT_QUERY && msg.DNS.Qname == "dns.collector" {
 			break
 		}
 	}

collectors/dnstap.go

@@ -143,17 +143,16 @@ func (c *Dnstap) Listen() error {
 		config := &tls.Config{Certificates: []tls.Certificate{cer}}
 
 		if len(c.sockPath) > 0 {
-			listener, err = tls.Listen("unix", c.sockPath, config)
+			listener, err = tls.Listen(dnsutils.SOCKET_UNIX, c.sockPath, config)
 		} else {
-			listener, err = tls.Listen("tcp", addrlisten, config)
+			listener, err = tls.Listen(dnsutils.SOCKET_TCP, addrlisten, config)
 		}
-
 	} else {
 		// basic listening
 		if len(c.sockPath) > 0 {
-			listener, err = net.Listen("unix", c.sockPath)
+			listener, err = net.Listen(dnsutils.SOCKET_UNIX, c.sockPath)
 		} else {
-			listener, err = net.Listen("tcp", addrlisten)
+			listener, err = net.Listen(dnsutils.SOCKET_TCP, addrlisten)
 		}
 	}
 
@@ -182,7 +181,6 @@ func (c *Dnstap) Run() {
 
 		c.conns = append(c.conns, conn)
 		go c.HandleConn(conn)
-
 	}
 
 	c.LogInfo("run terminated")

collectors/dnstap_test.go

@@ -22,7 +22,7 @@ func TestDnstapTcpRun(t *testing.T) {
 	}
 	go c.Run()
 
-	conn, err := net.Dial("tcp", ":6000")
+	conn, err := net.Dial(dnsutils.SOCKET_TCP, ":6000")
 	if err != nil {
 		t.Error("could not connect to TCP server: ", err)
 	}
@@ -75,7 +75,7 @@ func TestDnstapUnixRun(t *testing.T) {
 	}
 	go c.Run()
 
-	conn, err := net.Dial("unix", config.Collectors.Dnstap.SockPath)
+	conn, err := net.Dial(dnsutils.SOCKET_UNIX, config.Collectors.Dnstap.SockPath)
 	if err != nil {
 		t.Error("could not connect to unix socket: ", err)
 	}
@@ -113,7 +113,7 @@ func TestDnstapUnixRun(t *testing.T) {
 
 	// waiting message in channel
 	msg := <-g.Channel()
-	if msg.DnsTap.Operation != "CLIENT_QUERY" {
+	if msg.DnsTap.Operation != dnsutils.DNSTAP_CLIENT_QUERY {
 		t.Errorf("want CLIENT_QUERY, got %s", msg.DnsTap.Operation)
 	}
 }

collectors/powerdns.go

@@ -121,9 +121,9 @@ func (c *ProtobufPowerDNS) Listen() error {
 			c.logger.Fatal("loading certificate failed:", err)
 		}
 		config := &tls.Config{Certificates: []tls.Certificate{cer}}
-		listener, err = tls.Listen("tcp", addrlisten, config)
+		listener, err = tls.Listen(dnsutils.SOCKET_TCP, addrlisten, config)
 	} else {
-		listener, err = net.Listen("tcp", addrlisten)
+		listener, err = net.Listen(dnsutils.SOCKET_TCP, addrlisten)
 	}
 	// something is wrong ?
 	if err != nil {

collectors/powerdns_test.go

@@ -18,7 +18,7 @@ func TestProbufPdnsRun(t *testing.T) {
 	}
 	go c.Run()
 
-	conn, err := net.Dial("tcp", ":6001")
+	conn, err := net.Dial(dnsutils.SOCKET_TCP, ":6001")
 	if err != nil {
 		t.Error("could not connect to TCP server: ", err)
 	}

dnsutils/cache_test.go

@@ -48,7 +48,6 @@ func BenchmarkMapSet(b *testing.B) {
 }
 
 func BenchmarkMapDelete(b *testing.B) {
-
 	mapexpire := NewDnsCache(60 * time.Second)
 
 	for i := 0; i < b.N; i++ {