Merge pull request #16 from EladLeev/add-golangci-lint

feat: add lint file, fix and fix errors

.github/workflows/build.yml

@@ -1,8 +1,7 @@
 name: Build Package
 on:
   push:
-    branches:
-      - main
+    branches: [main]
   pull_request:
     branches:
       - main

.github/workflows/golangci-lint.yml

@@ -1,5 +1,6 @@
 name: golangci-lint
 on:
+  branches: [main]
   pull_request:
 
 permissions:

.gitignore

@@ -11,6 +11,9 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# IDEs
+.idea
+
 # Dependency directories (remove the comment below to include it)
 # vendor/
 

.golangci.yml

@@ -0,0 +1,19 @@
+run:
+  timeout: 5m
+
+linters:
+  enable:
+    - errcheck
+    - goimports
+    - govet
+    - staticcheck
+    - durationcheck
+    - revive
+
+issues:
+  exclude-use-default: false
+  max-issues-per-linter: 0
+  max-same-issues: 0
+
+output:
+  sort-results: true

Makefile

@@ -2,32 +2,40 @@ SHELL := /bin/bash
 export GOBIN := $(CWD)/.bin
 NAME=schema-registry-statistics
 
+.PHONY: build
 build:
 	GOARCH=amd64 GOOS=darwin go build -o ${NAME}-darwin main.go
 	GOARCH=amd64 GOOS=linux go build -o ${NAME}-linux main.go
 
+.PHONY: clean
 clean:
 	go clean
 	rm ${NAME}-darwin
 	rm ${NAME}-linux
 
+.PHONY: test
 test:
 	go test -v ./...
 
+.PHONY: test_coverage
 test_coverage:
 	go test -v ./... -coverprofile=coverage.out
 
+.PHONY: dep
 dep:
 	go mod download
 
+.PHONY: tidy
 tidy:
 	go mod tidy
 
+.PHONY: safe
 safe:
 	go vet
 	go test -race .
 	go build -race .
 
+.PHONY: test_race
 test_race:
 	go run -race . --bootstrap "localhost:9092" \
 	--topic "payments-topic" \
@@ -36,3 +44,7 @@ test_race:
 	--user "USERNAME" \
 	--password "PASSWORD" \
 	--oldest --verbose
+
+.PHONY: lint
+lint:
+	golangci-lint run

config.go

@@ -1,3 +1,4 @@
+// main ...
 package main
 
 import (

config_test.go

@@ -11,7 +11,12 @@ func TestLoadCert(t *testing.T) {
 	if err != nil {
 		t.Fatalf("failed to create temporary file: %s", err)
 	}
-	defer os.Remove(caCertFile.Name())
+	defer func(name string) {
+		err := os.Remove(name)
+		if err != nil {
+			return
+		}
+	}(caCertFile.Name())
 
 	caCertData := []byte(`
 -----BEGIN CERTIFICATE-----

main.go

@@ -77,11 +77,13 @@ func main() {
 	}
 }
 
+// Setup is setting up a new CG session
 func (consumer *Consumer) Setup(sarama.ConsumerGroupSession) error {
 	close(consumer.ready)
 	return nil
 }
 
+// Cleanup function to clean after the CG
 func (consumer *Consumer) Cleanup(sarama.ConsumerGroupSession) error {
 	consumedMessages := consumer.stats.StatMap["TOTAL"]
 	log.Printf("Total messages consumed: %v\n", consumedMessages)
@@ -90,7 +92,7 @@ func (consumer *Consumer) Cleanup(sarama.ConsumerGroupSession) error {
 	// Print results
 	for k, v := range utils.PercentileMap {
 		c := color.New(color.FgGreen)
-		c.Printf("Schema ID %v => %v%%\n", k, v)
+		c.Sprintf("Schema ID %v => %v%%\n", k, v)
 	}
 
 	// Dump stats to file
@@ -105,6 +107,7 @@ func (consumer *Consumer) Cleanup(sarama.ConsumerGroupSession) error {
 	return nil
 }
 
+// ConsumeClaim processes Kafka messages from a given topic and partition within a consumer group.
 func (consumer *Consumer) ConsumeClaim(session sarama.ConsumerGroupSession, claim sarama.ConsumerGroupClaim) error {
 	for {
 		select {
@@ -115,10 +118,10 @@ func (consumer *Consumer) ConsumeClaim(session sarama.ConsumerGroupSession, clai
 				utils.CalcStat(consumer.stats, 4294967295, &consumer.consumerLock)
 				break
 			}
-			schemaId := binary.BigEndian.Uint32(message.Value[1:5])
-			utils.CalcStat(consumer.stats, schemaId, &consumer.consumerLock)
+			schemaID := binary.BigEndian.Uint32(message.Value[1:5])
+			utils.CalcStat(consumer.stats, schemaID, &consumer.consumerLock)
 			if consumer.config.store { // lock map, and build result for analysis
-				utils.AppendResult(consumer.stats, message.Offset, schemaId, &consumer.consumerLock)
+				utils.AppendResult(consumer.stats, message.Offset, schemaID, &consumer.consumerLock)
 			}
 			consumer.consumerLock.RLock()
 			if consumer.stats.StatMap["TOTAL"]%100 == 0 { // I'm still alive :)

types.go

@@ -19,6 +19,7 @@ type appConfig struct {
 	chart                                   bool
 }
 
+// Consumer represent a Kafka Consumer
 type Consumer struct {
 	ready        chan bool
 	stats        utils.ResultStats

types_test.go

@@ -50,7 +50,7 @@ func TestConsumerInitialization(t *testing.T) {
 	assert.Equal(t, config.chart, consumer.config.chart)
 }
 
-func TestConsumerLocking(t *testing.T) {
+func TestConsumerLocking(_ *testing.T) {
 	config := appConfig{
 		bootstrapServers: "localhost:9092",
 		version:          "2.6.0",

utils/chart.go

@@ -1,3 +1,4 @@
+// Package utils provide some common utilities
 package utils
 
 import (
@@ -11,7 +12,7 @@ import (
 	"github.com/go-echarts/go-echarts/v2/opts"
 )
 
-func generatePieItems(stat map[string]float64) []opts.PieData {
+func generatePieItems() []opts.PieData {
 	items := make([]opts.PieData, 0)
 	for k, v := range PercentileMap {
 		items = append(items, opts.PieData{
@@ -30,7 +31,7 @@ func createPieChart() *charts.Pie {
 			Subtitle: fmt.Sprintf("Snapshot: %s", time.Now().Format(time.RFC822)),
 		}),
 	)
-	pie.AddSeries("pie", generatePieItems(PercentileMap)).
+	pie.AddSeries("pie", generatePieItems()).
 		SetSeriesOptions(charts.WithLabelOpts(
 			opts.Label{
 				Show:      true,
@@ -40,6 +41,7 @@ func createPieChart() *charts.Pie {
 	return pie
 }
 
+// GenChart will generate a Pie Chart based on data
 func GenChart() {
 	page := components.NewPage()
 	page.AddCharts(

utils/stats.go

@@ -9,8 +9,10 @@ import (
 	"sync"
 )
 
+// PercentileMap ...
 var PercentileMap = map[string]float64{}
 
+// ResultStats ...
 type ResultStats struct {
 	StatMap     map[string]int
 	ResultStore map[uint32][]int
@@ -20,6 +22,7 @@ func calc(schema, total int) float64 {
 	return math.Round((float64(schema) / float64(total) * 100))
 }
 
+// BuildPercentileMap will calculate the percentile into a map
 func BuildPercentileMap(s map[string]int) {
 	for k, v := range s {
 		if k == "TOTAL" {
@@ -33,25 +36,26 @@ func BuildPercentileMap(s map[string]int) {
 }
 
 // AppendResult will map the results to a storeable map
-func AppendResult(stat ResultStats, offset int64, schemaId uint32, lock *sync.RWMutex) {
+func AppendResult(stat ResultStats, offset int64, schemaID uint32, lock *sync.RWMutex) {
 	lock.Lock()
 	defer lock.Unlock()
-	stat.ResultStore[schemaId] = append(stat.ResultStore[schemaId], int(offset))
+	stat.ResultStore[schemaID] = append(stat.ResultStore[schemaID], int(offset))
 }
 
 // CalcStat keep on track the stats
-func CalcStat(stat ResultStats, schemaId uint32, lock *sync.RWMutex) {
+func CalcStat(stat ResultStats, schemaID uint32, lock *sync.RWMutex) {
 	lock.Lock()
 	defer lock.Unlock()
 	// 4294967295 represents error
-	if schemaId == 4294967295 {
-		stat.StatMap["ERROR"] += 1
+	if schemaID == 4294967295 {
+		stat.StatMap["ERROR"]++
 		return
 	}
-	stat.StatMap[fmt.Sprint(schemaId)] += 1
-	stat.StatMap["TOTAL"] += 1
+	stat.StatMap[fmt.Sprint(schemaID)]++
+	stat.StatMap["TOTAL"]++
 }
 
+// DumpStats will print the results into a file
 func DumpStats(stat ResultStats, path string) {
 	j, err := json.Marshal(stat.ResultStore)
 	if err != nil {

utils/stats_test.go

@@ -61,7 +61,7 @@ func TestAppendResult(t *testing.T) {
 		name       string
 		stat       ResultStats
 		offset     int64
-		schemaId   uint32
+		schemaID   uint32
 		wantResult ResultStats
 	}{
 		{
@@ -72,7 +72,7 @@ func TestAppendResult(t *testing.T) {
 				},
 			},
 			offset:   4,
-			schemaId: 1,
+			schemaID: 1,
 			wantResult: ResultStats{
 				ResultStore: map[uint32][]int{
 					1: {1, 2, 3, 4},
@@ -87,7 +87,7 @@ func TestAppendResult(t *testing.T) {
 				},
 			},
 			offset:   8,
-			schemaId: 2,
+			schemaID: 2,
 			wantResult: ResultStats{
 				ResultStore: map[uint32][]int{
 					2: {5, 6, 7, 8},
@@ -102,7 +102,7 @@ func TestAppendResult(t *testing.T) {
 				},
 			},
 			offset:   12,
-			schemaId: 3,
+			schemaID: 3,
 			wantResult: ResultStats{
 				ResultStore: map[uint32][]int{
 					3: {9, 10, 11, 12},
@@ -112,7 +112,7 @@ func TestAppendResult(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			AppendResult(tc.stat, tc.offset, tc.schemaId, &l)
+			AppendResult(tc.stat, tc.offset, tc.schemaID, &l)
 			if !reflect.DeepEqual(tc.stat, tc.wantResult) {
 				t.Errorf("got %+v, want %+v", tc.stat, tc.wantResult)
 			}