Add unit tests and golangci lint CI check

Author: amuraru

.github/workflows/ci.yaml

@@ -0,0 +1,83 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  GO_VERSION: '1.25'
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+          cache: true
+
+      - name: Download dependencies
+        run: go mod download
+
+      - name: Verify dependencies
+        run: go mod verify
+
+      - name: Run tests
+        run: go test -v -race -coverprofile=coverage.out -covermode=atomic ./...
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.out
+          flags: unittests
+          fail_ci_if_error: false
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+          cache: true
+
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: latest
+          args: --timeout=5m
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+          cache: true
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Build binary
+        run: go build -v -o kminion .
+

config.go

@@ -87,8 +87,7 @@ func newConfig(logger *zap.Logger) (Config, error) {
 	}
 
 	err = k.Load(env.ProviderWithValue("", ".", func(s string, v string) (string, interface{}) {
-		// key := strings.Replace(strings.ToLower(s), "_", ".", -1)
-		key := strings.Replace(strings.ToLower(s), "_", ".", -1)
+		key := strings.ReplaceAll(strings.ToLower(s), "_", ".")
 		// Check to exist if we have a configuration option already and see if it's a slice
 		// If there is a comma in the value, split the value into a slice by the comma.
 		if strings.Contains(v, ",") {

e2e/message_tracker.go

@@ -28,7 +28,7 @@ type messageTracker struct {
 func newMessageTracker(svc *Service) *messageTracker {
 	defaultExpirationDuration := svc.config.Consumer.RoundtripSla
 	cache := ttlcache.NewCache()
-	cache.SetTTL(defaultExpirationDuration)
+	_ = cache.SetTTL(defaultExpirationDuration)
 
 	t := &messageTracker{
 		svc:    svc,
@@ -43,12 +43,14 @@ func newMessageTracker(svc *Service) *messageTracker {
 }
 
 func (t *messageTracker) addToTracker(msg *EndToEndMessage) {
-	t.cache.Set(msg.MessageID, msg)
+	_ = t.cache.Set(msg.MessageID, msg)
 }
 
 // updateItemIfExists only updates a message if it still exists in the cache. The remaining time to live will not
 // be refreshed.
 // If it doesn't exist an ttlcache.ErrNotFound error will be returned.
+//
+//nolint:unused
 func (t *messageTracker) updateItemIfExists(msg *EndToEndMessage) error {
 	_, ttl, err := t.cache.GetWithTTL(msg.MessageID)
 	if err != nil {
@@ -59,9 +61,9 @@ func (t *messageTracker) updateItemIfExists(msg *EndToEndMessage) error {
 	}
 
 	// Because the returned TTL is set to the original TTL duration (and not the remaining TTL) we have to calculate
-	// the remaining TTL now as we want to updat the existing cache item without changing the remaining time to live.
+	// the remaining TTL now as we want to update the existing cache item without changing the remaining time to live.
 	expiryTimestamp := msg.creationTime().Add(ttl)
-	remainingTTL := expiryTimestamp.Sub(time.Now())
+	remainingTTL := time.Until(expiryTimestamp)
 	if remainingTTL < 0 {
 		// This entry should have been deleted already. Race condition.
 		return ttlcache.ErrNotFound
@@ -96,7 +98,7 @@ func (t *messageTracker) onMessageArrived(arrivedMessage *EndToEndMessage) {
 
 	expireTime := msg.creationTime().Add(t.svc.config.Consumer.RoundtripSla)
 	isExpired := time.Now().Before(expireTime)
-	latency := time.Now().Sub(msg.creationTime())
+	latency := time.Since(msg.creationTime())
 
 	if !isExpired {
 		// Message arrived late, but was still in cache. We don't increment the lost counter here because eventually
@@ -114,7 +116,7 @@ func (t *messageTracker) onMessageArrived(arrivedMessage *EndToEndMessage) {
 	t.svc.roundtripLatency.WithLabelValues(pID).Observe(latency.Seconds())
 
 	// Remove message from cache, so that we don't track it any longer and won't mark it as lost when the entry expires.
-	t.cache.Remove(msg.MessageID)
+	_ = t.cache.Remove(msg.MessageID)
 }
 
 func (t *messageTracker) onMessageExpired(_ string, reason ttlcache.EvictionReason, value interface{}) {

e2e/topic.go

@@ -332,6 +332,7 @@ func (s *Service) getTopicMetadata(ctx context.Context) (*kmsg.MetadataResponse,
 	return req.RequestWith(ctx, s.client)
 }
 
+//nolint:unused
 func (s *Service) getTopicsConfigs(ctx context.Context, configNames []string) (*kmsg.DescribeConfigsResponse, error) {
 	req := kmsg.NewDescribeConfigsRequest()
 	req.IncludeDocumentation = false

e2e/topic_test.go

@@ -67,6 +67,8 @@ func (s *Service) logCommitErrors(r *kmsg.OffsetCommitResponse, err error) strin
 }
 
 // brokerMetadataByBrokerID returns a map of all broker metadata keyed by their BrokerID
+//
+//nolint:unused
 func brokerMetadataByBrokerID(meta []kmsg.MetadataResponseBroker) map[int32]kmsg.MetadataResponseBroker {
 	res := make(map[int32]kmsg.MetadataResponseBroker)
 	for _, broker := range meta {
@@ -76,6 +78,8 @@ func brokerMetadataByBrokerID(meta []kmsg.MetadataResponseBroker) map[int32]kmsg
 }
 
 // brokerMetadataByRackID returns a map of all broker metadata keyed by their Rack identifier
+//
+//nolint:unused
 func brokerMetadataByRackID(meta []kmsg.MetadataResponseBroker) map[string][]kmsg.MetadataResponseBroker {
 	res := make(map[string][]kmsg.MetadataResponseBroker)
 	for _, broker := range meta {
@@ -95,6 +99,7 @@ func pointerStrToStr(str *string) string {
 	return *str
 }
 
+//nolint:unused
 func safeUnwrap(err error) string {
 	if err == nil {
 		return "<nil>"