Added Pre-commit and Makefile

precommit and makefile for setup

pre-commit run --all-files

Readme and cyclo 30

No lint

pre-commit run --all-files

fix many of go-critic comments

Adding workflow

matrix and setup go

go 1.18>

go 1.18>

oss

update golanci instead of pre-commit

golangci fixes

Hard to fix fast linters are out

Config that can work for current code

Updated Makefile

Removed Makefile

Author: Mizaro

.golangci.yaml

@@ -0,0 +1,88 @@
+linters-settings:
+  dupl:
+    threshold: 100
+  goconst:
+    min-len: 2
+    min-occurrences: 1
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+    disabled-checks:
+      - dupImport # https://github.com/go-critic/go-critic/issues/845
+      - ifElseChain
+  gocyclo:
+    min-complexity: 30 # Recommended between 10-20
+  gofmt:
+    rewrite-rules:
+      - pattern: 'interface{}'
+        replacement: 'any'
+  goimports:
+    local-prefixes: github.com/tsaikd/gogstash
+  gomnd:
+    # don't include the "operation" and "assign"
+    checks:
+      - argument
+      - case
+      - condition
+      - return
+    ignored-numbers:
+      - '0'
+      - '1'
+      - '2'
+      - '3'
+    ignored-functions:
+      - strings.SplitN
+
+  lll:
+    line-length: 110
+  misspell:
+    locale: US
+  nolintlint:
+    allow-unused: false # report any unused nolint directives
+    require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+  revive:
+    rules:
+      - name: unexported-return
+        disabled: true
+      - name: unused-parameter
+
+linters:
+  disable-all: true
+  enable:
+      #- bodyclose
+    - dogsled
+      #- dupl
+    - errcheck
+    - exportloopref
+      #- gochecknoinits
+      #- goconst
+      #- gocritic
+    - gocyclo
+    - gofmt
+    - goimports
+      #- gomnd
+    - goprintffuncname
+      #- gosec
+    - gosimple
+    - govet
+    - ineffassign
+      #- lll
+    - misspell
+      #- nakedret
+      #- noctx
+    - nolintlint
+      #- revive
+    - staticcheck
+      #- stylecheck
+    - typecheck
+      #- unconvert
+      #- unparam
+    - unused
+    - whitespace
+
+run:
+  timeout: 5m

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/dnephin/pre-commit-golang
+  rev: v0.5.1
+  hooks:
+    - id: validate-toml
+    - id: golangci-lint
+      args: ["--fix"]
+    - id: go-build
+    - id: go-mod-tidy

README.md

@@ -276,4 +276,11 @@ See [output modules](output) for more information
 * [report](output/report)
 * [socket](output/socket)
 * [stdout](output/stdout)
-* [loki](output/loki)
+* [loki](output/loki)
+
+## Development
+
+To setup the local machine, run `make setup` to install all tools for pre-commit.
+
+If any of the installations fail or the pre-commit cannot find the go tools, ensure they are accessable though adding their's `bin` folder to your path.
+

cmd/gogstash.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/sirupsen/logrus"
 	"github.com/tsaikd/KDGoLib/futil"
+
 	"github.com/tsaikd/gogstash/config"
 	"github.com/tsaikd/gogstash/config/goglog"
 

cmd/worker_unix.go

@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package cmd
@@ -7,8 +8,9 @@ import (
 	"os"
 	"syscall"
 
-	"github.com/tsaikd/gogstash/config/goglog"
 	"golang.org/x/sync/errgroup"
+
+	"github.com/tsaikd/gogstash/config/goglog"
 )
 
 func startWorker(args []string, attr *syscall.ProcAttr) (pid int, err error) {

cmd/worker_windows.go

@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package cmd

codec/azureeventhubjson/codecazureeventhubjson.go

@@ -5,6 +5,7 @@ import (
 	"time"
 
 	jsoniter "github.com/json-iterator/go"
+
 	"github.com/tsaikd/gogstash/config"
 	"github.com/tsaikd/gogstash/config/goglog"
 	"github.com/tsaikd/gogstash/config/logevent"
@@ -33,11 +34,10 @@ func InitHandler(context.Context, config.ConfigRaw) (config.TypeCodecConfig, err
 }
 
 // Decode returns an event from 'data' as JSON format, adding provided 'eventExtra'
-func (c *Codec) Decode(ctx context.Context, data interface{},
-	eventExtra map[string]interface{}, tags []string,
+func (c *Codec) Decode(ctx context.Context, data any,
+	eventExtra map[string]any, tags []string,
 	msgChan chan<- logevent.LogEvent) (ok bool, err error) {
-
-	clonedEventExtras := make(map[string]interface{}, len(eventExtra))
+	clonedEventExtras := make(map[string]any, len(eventExtra))
 	for k, v := range eventExtra {
 		clonedEventExtras[k] = v
 	}
@@ -53,7 +53,7 @@ func (c *Codec) Decode(ctx context.Context, data interface{},
 		err = c.DecodeEvent([]byte(v), &event)
 	case []byte:
 		err = c.DecodeEvent(v, &event)
-	case map[string]interface{}:
+	case map[string]any:
 		if event.Extra != nil {
 			for k, val := range v {
 				event.Extra[k] = val
@@ -71,7 +71,7 @@ func (c *Codec) Decode(ctx context.Context, data interface{},
 	}
 
 	if records, rok := event.Extra["records"]; rok && len(event.Message) == 0 {
-		for _, record := range records.([]interface{}) {
+		for _, record := range records.([]any) {
 			if _, err = c.Decode(ctx, record, eventExtra, tags, msgChan); err != nil {
 				event.AddTag(ErrorTag)
 				goglog.Logger.Error(err)
@@ -114,7 +114,6 @@ func (c *Codec) DecodeEvent(data []byte, event *logevent.LogEvent) (err error) {
 
 // Encode encodes the event to a JSON encoded message
 func (c *Codec) Encode(_ context.Context, event logevent.LogEvent, dataChan chan<- []byte) (ok bool, err error) {
-
 	output, err := event.MarshalJSON()
 	if err != nil {
 		return false, err

codec/azureeventhubjson/codecazureeventhubjson_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
 	"github.com/tsaikd/gogstash/config/goglog"
 	"github.com/tsaikd/gogstash/config/logevent"
 )
@@ -34,7 +35,7 @@ func TestDecode(t *testing.T) {
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event := <-msgChan
-	assert.Equal(map[string]interface{}{"foo": "bar"}, event.Extra)
+	assert.Equal(map[string]any{"foo": "bar"}, event.Extra)
 	assert.Equal("", event.Message)
 
 	// string should be ok
@@ -43,16 +44,16 @@ func TestDecode(t *testing.T) {
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event = <-msgChan
-	assert.Equal(map[string]interface{}{"foo": "bar"}, event.Extra)
+	assert.Equal(map[string]any{"foo": "bar"}, event.Extra)
 	assert.Equal("", event.Message)
 
 	// map[string]interface{} should be ok
-	ok, err = codec.Decode(ctx, map[string]interface{}{"foo": "bar"}, nil, emptyTags, msgChan)
+	ok, err = codec.Decode(ctx, map[string]any{"foo": "bar"}, nil, emptyTags, msgChan)
 	require.NoError(err)
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event = <-msgChan
-	assert.Equal(map[string]interface{}{"foo": "bar"}, event.Extra)
+	assert.Equal(map[string]any{"foo": "bar"}, event.Extra)
 	assert.Equal("", event.Message)
 
 	// ok will be true, as message sent
@@ -90,15 +91,15 @@ func TestDecode(t *testing.T) {
 	assert.Equal([]string{"foo", "bar"}, event.Tags)
 
 	// merge & override extra
-	ok, err = codec.Decode(ctx, []byte(`{"foo":"bar2"}`), map[string]interface{}{
+	ok, err = codec.Decode(ctx, []byte(`{"foo":"bar2"}`), map[string]any{
 		"foo": "bar",
 		"one": "more thing",
 	}, emptyTags, msgChan)
 	require.NoError(err)
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event = <-msgChan
-	assert.Equal(map[string]interface{}{
+	assert.Equal(map[string]any{
 		"foo": "bar2",
 		"one": "more thing",
 	}, event.Extra)
@@ -112,5 +113,4 @@ func TestDecode(t *testing.T) {
 	assert.Equal("hello1", event.Message)
 	event = <-msgChan
 	assert.Equal("hello2", event.Message)
-
 }

codec/json/codecjson.go

@@ -5,6 +5,7 @@ import (
 	"time"
 
 	jsoniter "github.com/json-iterator/go"
+
 	"github.com/tsaikd/gogstash/config"
 	"github.com/tsaikd/gogstash/config/goglog"
 	"github.com/tsaikd/gogstash/config/logevent"
@@ -33,10 +34,9 @@ func InitHandler(context.Context, config.ConfigRaw) (config.TypeCodecConfig, err
 }
 
 // Decode returns an event from 'data' as JSON format, adding provided 'eventExtra'
-func (c *Codec) Decode(ctx context.Context, data interface{},
-	eventExtra map[string]interface{}, tags []string,
+func (c *Codec) Decode(ctx context.Context, data any,
+	eventExtra map[string]any, tags []string,
 	msgChan chan<- logevent.LogEvent) (ok bool, err error) {
-
 	event := logevent.LogEvent{
 		Timestamp: time.Now(),
 		Extra:     eventExtra,
@@ -48,7 +48,7 @@ func (c *Codec) Decode(ctx context.Context, data interface{},
 		err = c.DecodeEvent([]byte(v), &event)
 	case []byte:
 		err = c.DecodeEvent(v, &event)
-	case map[string]interface{}:
+	case map[string]any:
 		if event.Extra != nil {
 			for k, val := range v {
 				event.Extra[k] = val

codec/json/codecjson_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
 	"github.com/tsaikd/gogstash/config/goglog"
 	"github.com/tsaikd/gogstash/config/logevent"
 )
@@ -34,7 +35,7 @@ func TestDecode(t *testing.T) {
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event := <-msgChan
-	assert.Equal(map[string]interface{}{"foo": "bar"}, event.Extra)
+	assert.Equal(map[string]any{"foo": "bar"}, event.Extra)
 	assert.Equal("", event.Message)
 
 	// string should be ok
@@ -43,16 +44,16 @@ func TestDecode(t *testing.T) {
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event = <-msgChan
-	assert.Equal(map[string]interface{}{"foo": "bar"}, event.Extra)
+	assert.Equal(map[string]any{"foo": "bar"}, event.Extra)
 	assert.Equal("", event.Message)
 
 	// map[string]interface{} should be ok
-	ok, err = codec.Decode(ctx, map[string]interface{}{"foo": "bar"}, nil, emptyTags, msgChan)
+	ok, err = codec.Decode(ctx, map[string]any{"foo": "bar"}, nil, emptyTags, msgChan)
 	require.NoError(err)
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event = <-msgChan
-	assert.Equal(map[string]interface{}{"foo": "bar"}, event.Extra)
+	assert.Equal(map[string]any{"foo": "bar"}, event.Extra)
 	assert.Equal("", event.Message)
 
 	// ok will be true, as message sent
@@ -90,15 +91,15 @@ func TestDecode(t *testing.T) {
 	assert.Equal([]string{"foo", "bar"}, event.Tags)
 
 	// merge & override extra
-	ok, err = codec.Decode(ctx, []byte(`{"foo":"bar2"}`), map[string]interface{}{
+	ok, err = codec.Decode(ctx, []byte(`{"foo":"bar2"}`), map[string]any{
 		"foo": "bar",
 		"one": "more thing",
 	}, emptyTags, msgChan)
 	require.NoError(err)
 	assert.True(ok)
 	require.Len(msgChan, 1)
 	event = <-msgChan
-	assert.Equal(map[string]interface{}{
+	assert.Equal(map[string]any{
 		"foo": "bar2",
 		"one": "more thing",
 	}, event.Extra)

config/codec.go

@@ -6,6 +6,7 @@ import (
 	"time"
 
 	"github.com/tsaikd/KDGoLib/errutil"
+
 	"github.com/tsaikd/gogstash/config/goglog"
 	"github.com/tsaikd/gogstash/config/logevent"
 )
@@ -24,7 +25,7 @@ type TypeCodecConfig interface {
 	// Decode - The codec’s decode method is where data coming in from an input is transformed into an event.
 	//  'ok' returns a boolean indicating if an event was created and sent to a provided 'msgChan' channel
 	//  'error' is returned in case of any failure handling input 'data', but 'ok' == false DOES NOT indicate an error
-	Decode(ctx context.Context, data interface{}, extra map[string]interface{}, tags []string, msgChan chan<- logevent.LogEvent) (ok bool, err error)
+	Decode(ctx context.Context, data any, extra map[string]any, tags []string, msgChan chan<- logevent.LogEvent) (ok bool, err error)
 	// DecodeEvent decodes 'data' to 'event' pointer, creating new current timestamp if IsZero
 	//  'error' is returned in case of any failure handling input 'data'
 	DecodeEvent(data []byte, event *logevent.LogEvent) error
@@ -53,23 +54,23 @@ func RegistCodecHandler(name string, handler CodecHandler) {
 	mapCodecHandler[name] = handler
 }
 
-func GetCodecOrDefault(ctx context.Context, raw interface{}) (TypeCodecConfig, error) {
+func GetCodecOrDefault(ctx context.Context, raw any) (TypeCodecConfig, error) {
 	return GetCodec(ctx, raw, DefaultCodecName)
 }
 
 // GetCodec returns a codec based on the 'codec' configuration from provided 'ConfigRaw' input
 // defaults to 'defaultType'
 func GetCodec(
 	ctx context.Context,
-	raw interface{},
+	raw any,
 	defaultType string,
 ) (codec TypeCodecConfig, err error) {
 	switch cfg := raw.(type) {
 	case ConfigRaw:
 		if codecConfig, ok := cfg["codec"]; ok {
 			return GetCodec(ctx, codecConfig, defaultType)
 		}
-	case map[string]interface{}:
+	case map[string]any:
 		if codecConfig, ok := cfg["codec"]; ok {
 			return GetCodec(ctx, codecConfig, defaultType)
 		}
@@ -136,11 +137,10 @@ func DefaultCodecInitHandler(context.Context, ConfigRaw) (TypeCodecConfig, error
 }
 
 // Decode returns an event based on current timestamp and converting 'data' to 'string', adding provided 'eventExtra'
-func (c *DefaultCodec) Decode(ctx context.Context, data interface{},
-	eventExtra map[string]interface{},
+func (c *DefaultCodec) Decode(ctx context.Context, data any,
+	eventExtra map[string]any,
 	tags []string,
 	msgChan chan<- logevent.LogEvent) (ok bool, err error) {
-
 	event := logevent.LogEvent{
 		Timestamp: time.Now(),
 		Extra:     eventExtra,