Add golangci-lint

Author: lucacome

.github/workflows/lint.yml

@@ -0,0 +1,45 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+defaults:
+  run:
+    shell: bash
+
+concurrency:
+  group: ${{ github.ref_name }}-lint
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Go Lint
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Golang Environment
+        uses: actions/setup-go@v5
+        with:
+          go-version: stable
+
+      - name: Lint Go
+        uses: golangci/golangci-lint-action@v6
+
+  actionlint:
+    name: Actionlint
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Lint Actions
+        uses: reviewdog/action-actionlint@v1
+        with:
+          actionlint_flags: -shellcheck ""

.golangci.yml

@@ -0,0 +1,90 @@
+linters-settings:
+  misspell:
+    locale: US
+  revive:
+    ignore-generated-header: true
+    rules:
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: empty-block
+      - name: error-naming
+      - name: error-return
+      - name: error-strings
+      - name: errorf
+      - name: exported
+      - name: increment-decrement
+      - name: indent-error-flow
+      - name: package-comments
+      - name: range
+      - name: receiver-naming
+      - name: redefines-builtin-id
+      - name: superfluous-else
+      - name: time-naming
+      - name: unexported-return
+      - name: unreachable-code
+      - name: var-declaration
+      - name: var-naming
+  govet:
+    enable-all: true
+linters:
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - contextcheck
+    - copyloopvar
+    - dupword
+    - durationcheck
+    - errcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - fatcontext
+    - forcetypeassert
+    - gocheckcompilerdirectives
+    - gochecksumtype
+    - gocritic
+    - godot
+    - gofmt
+    - gofumpt
+    - goimports
+    - gosec
+    - gosimple
+    - gosmopolitan
+    - govet
+    - ineffassign
+    - intrange
+    - makezero
+    - misspell
+    - musttag
+    - nilerr
+    - noctx
+    - nolintlint
+    - paralleltest
+    - perfsprint
+    - prealloc
+    - predeclared
+    - reassign
+    - revive
+    - staticcheck
+    - stylecheck
+    - tagalign
+    - thelper
+    - tparallel
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - usetesting
+    - wastedassign
+    - whitespace
+    # - wrapcheck
+  disable-all: true
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+run:
+  timeout: 5m

README.md

@@ -67,7 +67,7 @@ between the producers and the consumers.
         )
         defer sp.Finish()
 
-	// Update the context with the span for the subsequent reference.
+        // Update the context with the span for the subsequent reference.
         ctx = opentracing.ContextWithSpan(ctx, sp)
 
         // Actual message processing.

amqptracer/propagation.go

@@ -4,19 +4,18 @@ package amqptracer
 //
 // Example usage for server side:
 //
-//     carrier := amqpHeadersCarrier(amqp.Table)
-//     clientContext, err := tracer.Extract(
-//         opentracing.TextMap,
-//         carrier)
+//	carrier := amqpHeadersCarrier(amqp.Table)
+//	clientContext, err := tracer.Extract(
+//	    opentracing.TextMap,
+//	    carrier)
 //
 // Example usage for client side:
 //
-//     carrier := amqpHeadersCarrier(amqp.Table)
-//     err := tracer.Inject(
-//         span.Context(),
-//         opentracing.TextMap,
-//         carrier)
-//
+//	carrier := amqpHeadersCarrier(amqp.Table)
+//	err := tracer.Inject(
+//	    span.Context(),
+//	    opentracing.TextMap,
+//	    carrier)
 type amqpHeadersCarrier map[string]interface{}
 
 // ForeachKey conforms to the TextMapReader interface.

amqptracer/propagation_test.go

@@ -8,12 +8,18 @@ import (
 )
 
 func TestAMQPHeaderInject(t *testing.T) {
+	t.Parallel()
 	h := map[string]interface{}{}
 	h["NotOT"] = "blah"
 	h["opname"] = "AlsoNotOT"
 	tracer := testTracer{}
 	span := tracer.StartSpan("someSpan")
-	fakeID := span.Context().(testSpanContext).FakeID
+
+	spanCtx, ok := span.Context().(testSpanContext)
+	if !ok {
+		t.Fatalf("Expected span.Context() to be of type testSpanContext")
+	}
+	fakeID := spanCtx.FakeID
 
 	// Use amqpHeadersCarrier to wrap around `h`.
 	carrier := amqpHeadersCarrier(h)
@@ -32,6 +38,7 @@ func TestAMQPHeaderInject(t *testing.T) {
 }
 
 func TestAMQPHeaderExtract(t *testing.T) {
+	t.Parallel()
 	h := map[string]interface{}{}
 	h["NotOT"] = "blah"
 	h["opname"] = "AlsoNotOT"
@@ -45,7 +52,11 @@ func TestAMQPHeaderExtract(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	if spanContext.(testSpanContext).FakeID != 42 {
+	testContext, ok := spanContext.(testSpanContext)
+	if !ok {
+		t.Fatalf("Expected spanContext to be of type testSpanContext")
+	}
+	if testContext.FakeID != 42 {
 		t.Errorf("Failed to read testprefix-fakeid correctly")
 	}
 }

amqptracer/testtracer_test.go

@@ -30,10 +30,10 @@ type testSpanContext struct {
 func (n testSpanContext) ForeachBaggageItem(handler func(k, v string) bool) {}
 
 type testSpan struct {
-	spanContext   testSpanContext
-	OperationName string
 	StartTime     time.Time
 	Tags          map[string]interface{}
+	OperationName string
+	spanContext   testSpanContext
 }
 
 func (n testSpan) Equal(os opentracing.Span) bool {
@@ -63,7 +63,6 @@ func (n testSpan) Equal(os opentracing.Span) bool {
 	return true
 }
 
-// testSpan:
 func (n testSpan) Context() opentracing.SpanContext                       { return n.spanContext }
 func (n testSpan) SetTag(key string, value interface{}) opentracing.Span  { return n }
 func (n testSpan) Finish()                                                {}
@@ -90,7 +89,9 @@ func (n testTracer) StartSpan(operationName string, opts ...opentracing.StartSpa
 func (n testTracer) startSpanWithOptions(name string, opts opentracing.StartSpanOptions) opentracing.Span {
 	fakeID := nextFakeID()
 	if len(opts.References) > 0 {
-		fakeID = opts.References[0].ReferencedContext.(testSpanContext).FakeID
+		if ctx, ok := opts.References[0].ReferencedContext.(testSpanContext); ok {
+			fakeID = ctx.FakeID
+		}
 	}
 
 	return testSpan{
@@ -106,25 +107,37 @@ func (n testTracer) startSpanWithOptions(name string, opts opentracing.StartSpan
 
 // Inject belongs to the Tracer interface.
 func (n testTracer) Inject(sp opentracing.SpanContext, format interface{}, carrier interface{}) error {
-	spanContext := sp.(testSpanContext)
+	spanContext, ok := sp.(testSpanContext)
+	if !ok {
+		return opentracing.ErrInvalidSpanContext
+	}
+
 	switch format {
 	case opentracing.HTTPHeaders, opentracing.TextMap:
-		carrier.(opentracing.TextMapWriter).Set(testHTTPHeaderPrefix+"fakeid", strconv.Itoa(spanContext.FakeID))
+		writer, ok := carrier.(opentracing.TextMapWriter)
+		if !ok {
+			return opentracing.ErrInvalidCarrier
+		}
+		writer.Set(testHTTPHeaderPrefix+"fakeid", strconv.Itoa(spanContext.FakeID))
 		return nil
 	}
 	return opentracing.ErrUnsupportedFormat
 }
 
 // Extract belongs to the Tracer interface.
 func (n testTracer) Extract(format interface{}, carrier interface{}) (opentracing.SpanContext, error) {
-	switch format {
-	case opentracing.HTTPHeaders, opentracing.TextMap:
+	if format == opentracing.HTTPHeaders || format == opentracing.TextMap {
 		// Just for testing purposes... generally not a worthwhile thing to
 		// propagate.
 		sm := testSpanContext{}
-		err := carrier.(opentracing.TextMapReader).ForeachKey(func(key, val string) error {
-			switch strings.ToLower(key) {
-			case testHTTPHeaderPrefix + "fakeid":
+		reader, ok := carrier.(opentracing.TextMapReader)
+		if !ok {
+			return nil, opentracing.ErrInvalidCarrier
+		}
+
+		err := reader.ForeachKey(func(key, val string) error {
+			lowerKey := strings.ToLower(key)
+			if lowerKey == testHTTPHeaderPrefix+"fakeid" {
 				i, err := strconv.Atoi(val)
 				if err != nil {
 					return err

amqptracer/tracer_test.go

@@ -8,12 +8,18 @@ import (
 )
 
 func TestInject(t *testing.T) {
+	t.Parallel()
 	h := map[string]interface{}{}
 	h["NotOT"] = "blah"
 	h["opname"] = "AlsoNotOT"
 	tracer := testTracer{}
 	sp := tracer.StartSpan("someSpan")
-	fakeID := sp.Context().(testSpanContext).FakeID
+
+	spanCtx, ok := sp.Context().(testSpanContext)
+	if !ok {
+		t.Fatalf("Expected sp.Context() to be of type testSpanContext")
+	}
+	fakeID := spanCtx.FakeID
 
 	// Inject the tracing context to the AMQP header.
 	if err := Inject(sp, h); err != nil {
@@ -31,6 +37,7 @@ func TestInject(t *testing.T) {
 }
 
 func TestExtract(t *testing.T) {
+	t.Parallel()
 	h := map[string]interface{}{}
 	h["NotOT"] = "blah"
 	h["opname"] = "AlsoNotOT"
@@ -44,7 +51,12 @@ func TestExtract(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if ctx.(testSpanContext).FakeID != 42 {
+
+	testCtx, ok := ctx.(testSpanContext)
+	if !ok {
+		t.Fatalf("Expected ctx to be of type testSpanContext")
+	}
+	if testCtx.FakeID != 42 {
 		t.Errorf("Failed to read testprefix-fakeid correctly")
 	}
 }

renovate.json

@@ -2,6 +2,6 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "github>opentracing-contrib/common",
-    "schedule:daily"
+    "schedule:weekly"
   ]
 }