NETOBSERV-1565: review & fix some nolints; mostly renaming things for revive (#1046)

Author: jotak

pkg/confgen/confgen_test.go

@@ -98,7 +98,7 @@ func Test_RunShortConfGen(t *testing.T) {
 	// Unmarshal output
 	destCfgBytes, err := os.ReadFile(configOut)
 	require.NoError(t, err)
-	var out config.ConfigFileStruct
+	var out config.Root
 	err = yaml.UnmarshalStrict(destCfgBytes, &out)
 	require.NoError(t, err)
 	require.Len(t, out.Pipeline, 4)
@@ -191,7 +191,7 @@ func Test_RunConfGenNoAgg(t *testing.T) {
 	// Unmarshal output
 	destCfgBytes, err := os.ReadFile(configOut)
 	require.NoError(t, err)
-	var out config.ConfigFileStruct
+	var out config.Root
 	err = yaml.Unmarshal(destCfgBytes, &out)
 	require.NoError(t, err)
 	require.Len(t, out.Pipeline, 3)
@@ -276,7 +276,7 @@ func Test_RunLongConfGen(t *testing.T) {
 	// Unmarshal output
 	destCfgBytes, err := os.ReadFile(configOut)
 	require.NoError(t, err)
-	var out config.ConfigFileStruct
+	var out config.Root
 	err = yaml.UnmarshalStrict(destCfgBytes, &out)
 	require.NoError(t, err)
 	require.Len(t, out.Parameters, 6)

pkg/confgen/flowlogs2metrics_config.go

@@ -27,7 +27,7 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
-func (cg *ConfGen) GenerateFlowlogs2PipelineConfig() *config.ConfigFileStruct {
+func (cg *ConfGen) GenerateFlowlogs2PipelineConfig() *config.Root {
 	pipeline, _ := config.NewPipeline("ingest_collector", &cg.config.Ingest)
 	forkedNode := pipeline
 	if cg.config.Transform.Generic != nil {
@@ -63,7 +63,7 @@ func (cg *ConfGen) GenerateFlowlogs2PipelineConfig() *config.ConfigFileStruct {
 	if cg.config.Write.Loki != nil {
 		forkedNode.WriteLoki("write_loki", *cg.config.Write.Loki)
 	}
-	return pipeline.IntoConfigFileStruct(&config.ConfigFileStruct{
+	return pipeline.IntoRootConfig(&config.Root{
 		LogLevel: "error",
 		MetricsSettings: config.MetricsSettings{
 			PromConnectionInfo: api.PromConnectionInfo{Port: 9102},

pkg/config/config.go

@@ -35,10 +35,7 @@ type Options struct {
 	Profile           Profile
 }
 
-// (nolint => needs refactoring)
-//
-//nolint:revive
-type ConfigFileStruct struct {
+type Root struct {
 	LogLevel          string            `yaml:"log-level,omitempty" json:"log-level,omitempty"`
 	MetricsSettings   MetricsSettings   `yaml:"metricsSettings,omitempty" json:"metricsSettings,omitempty"`
 	Pipeline          []Stage           `yaml:"pipeline,omitempty" json:"pipeline,omitempty"`
@@ -150,8 +147,8 @@ type Write struct {
 }
 
 // ParseConfig creates the internal unmarshalled representation from the Pipeline and Parameters json
-func ParseConfig(opts *Options) (ConfigFileStruct, error) {
-	out := ConfigFileStruct{}
+func ParseConfig(opts *Options) (Root, error) {
+	out := Root{}
 
 	logrus.Debugf("opts.PipeLine = %v ", opts.PipeLine)
 	err := JSONUnmarshalStrict([]byte(opts.PipeLine), &out.Pipeline)

pkg/config/config_test.go

@@ -47,7 +47,7 @@ func TestJSONUnmarshalStrict(t *testing.T) {
 
 func TestUnmarshalInline(t *testing.T) {
 	cfg := `{"metricsSettings":{"port":9102,"prefix":"netobserv_"}}`
-	var cfs ConfigFileStruct
+	var cfs Root
 	err := yaml.Unmarshal([]byte(cfg), &cfs)
 	require.NoError(t, err)
 	require.Equal(t, "netobserv_", cfs.MetricsSettings.Prefix)

pkg/config/pipeline_builder.go

@@ -235,14 +235,14 @@ func (b *PipelineBuilderStage) GetDynamicStageParams() []StageParam {
 	return res
 }
 
-// IntoConfigFileStruct injects the current pipeline and params in the provided ConfigFileStruct object.
-func (b *PipelineBuilderStage) IntoConfigFileStruct(cfs *ConfigFileStruct) *ConfigFileStruct {
+// IntoRootConfig injects the current pipeline and params in the provided config.Root object.
+func (b *PipelineBuilderStage) IntoRootConfig(cfs *Root) *Root {
 	cfs.Pipeline = b.GetStages()
 	cfs.Parameters = b.GetStageParams()
 	return cfs
 }
 
-// ToConfigFileStruct returns the current pipeline and params as a new ConfigFileStruct object.
-func (b *PipelineBuilderStage) ToConfigFileStruct() *ConfigFileStruct {
-	return b.IntoConfigFileStruct(&ConfigFileStruct{})
+// ToRootConfig returns the current pipeline and params as a new config.Root object.
+func (b *PipelineBuilderStage) ToRootConfig() *Root {
+	return b.IntoRootConfig(&Root{})
 }

pkg/pipeline/aggregate_prom_test.go

@@ -177,7 +177,7 @@ parameters:
 			for _, aa := range actualAggs {
 				promEncode.Encode(aa)
 			}
-			exposed := test.ReadExposedMetrics(t, promEncode.(*encode.EncodeProm).Gatherer())
+			exposed := test.ReadExposedMetrics(t, promEncode.(*encode.Prometheus).Gatherer())
 
 			for _, expected := range tt.expectedEncode {
 				require.Contains(t, exposed, expected)

pkg/pipeline/conntrack_integ_test.go

@@ -167,7 +167,7 @@ func ingestFile(t *testing.T, in chan<- config.GenericMap, filepath string) int
 		lines = append(lines, []byte(text))
 	}
 	submittedLines := 0
-	decoder, err := decode.NewDecodeJSON()
+	decoder, err := decode.NewJSON()
 	require.NoError(t, err)
 	for _, line := range lines {
 		line, err := decoder.Decode(line)

pkg/pipeline/decode/decode.go

@@ -32,7 +32,7 @@ type Decoder interface {
 func GetDecoder(params api.Decoder) (Decoder, error) {
 	switch params.Type {
 	case api.DecoderJSON:
-		return NewDecodeJSON()
+		return NewJSON()
 	case api.DecoderProtobuf:
 		return decode.NewProtobuf()
 	}

pkg/pipeline/decode/decode_json.go

@@ -25,12 +25,11 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-//nolint:revive
-type DecodeJSON struct {
+type JSON struct {
 }
 
 // Decode decodes input strings to a list of flow entries
-func (c *DecodeJSON) Decode(line []byte) (config.GenericMap, error) {
+func (c *JSON) Decode(line []byte) (config.GenericMap, error) {
 
 	if log.IsLevelEnabled(log.DebugLevel) {
 		log.Debugf("decodeJSON: line = %v", string(line))
@@ -52,8 +51,8 @@ func (c *DecodeJSON) Decode(line []byte) (config.GenericMap, error) {
 	return decodedLine2, nil
 }
 
-// NewDecodeJSON create a new decode
-func NewDecodeJSON() (Decoder, error) {
-	log.Debugf("entering NewDecodeJSON")
-	return &DecodeJSON{}, nil
+// NewJSON create a new JSON decoder
+func NewJSON() (Decoder, error) {
+	log.Debugf("entering decode.NewJSON")
+	return &JSON{}, nil
 }

pkg/pipeline/decode/decode_json_test.go

@@ -24,14 +24,14 @@ import (
 )
 
 func initNewDecodeJSON(t *testing.T) Decoder {
-	newDecode, err := NewDecodeJSON()
+	newDecode, err := NewJSON()
 	require.Equal(t, nil, err)
 	return newDecode
 }
 
 func TestDecodeJSON(t *testing.T) {
 	newDecode := initNewDecodeJSON(t)
-	decodeJSON := newDecode.(*DecodeJSON)
+	decodeJSON := newDecode.(*JSON)
 
 	out, err := decodeJSON.Decode([]byte(
 		"{\"varInt\": 12, \"varString\":\"testString\", \"varBool\":false}"))
@@ -53,7 +53,7 @@ func TestDecodeJSON(t *testing.T) {
 
 func TestDecodeJSONTimestamps(t *testing.T) {
 	newDecode := initNewDecodeJSON(t)
-	decodeJSON := newDecode.(*DecodeJSON)
+	decodeJSON := newDecode.(*JSON)
 	out, err := decodeJSON.Decode([]byte("{\"unixTime\": 1645104030 }"))
 	require.NoError(t, err)
 	require.Equal(t, float64(1645104030), out["unixTime"])