Skip to content

Commit

Permalink
internal/config: add merging configuration functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
@seilagamo
seilagamo committed Sep 17, 2024
1 parent c75747c commit 2955669
Show file tree
Hide file tree
Showing 4 changed files with 322 additions and 0 deletions.
1 change: 1 addition & 0 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ module github.com/adevinta/lava
go 1.21.1

require (
dario.cat/mergo v1.0.1
github.com/adevinta/vulcan-agent v1.2.17
github.com/adevinta/vulcan-check-catalog v0.0.0-20240321120804-fe4ed05f8505
github.com/adevinta/vulcan-report v1.0.0
Expand Down
2 changes: 2 additions & 0 deletions go.sum
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ cloud.google.com/go/storage v1.5.0/go.mod h1:tpKbwo567HUNpVclU5sGELwQWBDZ8gh0Zeo
cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohlUTyfDhBk=
cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs=
cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
dario.cat/mergo v1.0.1 h1:Ra4+bf83h2ztPIQYNP99R6m+Y7KfnARDfID+a+vLl4s=
dario.cat/mergo v1.0.1/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk=
dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
github.com/AdaLogics/go-fuzz-headers v0.0.0-20230811130428-ced1acdcaa24 h1:bvDV9vkmnHYOMsOr4WLk+Vo07yKIzd94sVoIqshQ4bU=
github.com/AdaLogics/go-fuzz-headers v0.0.0-20230811130428-ced1acdcaa24/go.mod h1:8o94RPi1/7XTJvwPpRSzSUedZrtlirdB3r9Z20bi2f8=
Expand Down
36 changes: 36 additions & 0 deletions internal/config/merge.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Copyright 2024 Adevinta

package config

import (
"fmt"

"dario.cat/mergo"
)

// Merger has the ability to merge two configurations.
type Merger interface {
Merge(dest, src Config) (Config, error)
}

// LavaMerger represents a merger for the Lava configuration.
type LavaMerger struct{}

// Merge merges two configurations. The values of the configuration
// passed as first parameter will override those in the configuration
// passed as second parameter.
func (lm LavaMerger) Merge(dest, src Config) (Config, error) {
merged := Config{}
mergeOpts := []func(*mergo.Config){
mergo.WithOverride,
mergo.WithoutDereference,
mergo.WithAppendSlice,
}
if err := mergo.Merge(&merged, src, mergeOpts...); err != nil {
return Config{}, fmt.Errorf("merging src config into new config: %w", err)
}
if err := mergo.Merge(&merged, dest, mergeOpts...); err != nil {
return Config{}, fmt.Errorf("merging dest config into new config: %w", err)
}
return merged, nil
}
283 changes: 283 additions & 0 deletions internal/config/merge_test.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
// Copyright 2024 Adevinta

package config

import (
"testing"

agentconfig "github.com/adevinta/vulcan-agent/config"
"github.com/google/go-cmp/cmp"
)

func TestLavaMerger_Merge(t *testing.T) {
tests := []struct {
name string
cfg1 Config
cfg2 Config
want Config
wantErr bool
}{
{
name: "Two empty configurations",
cfg1: Config{},
cfg2: Config{},
want: Config{},
wantErr: false,
},
{
name: "Simple case",
cfg1: Config{
LavaVersion: ptr("1.0.0"),
},
cfg2: Config{},
want: Config{
LavaVersion: ptr("1.0.0"),
},
wantErr: false,
},
{
name: "Settings with default values won't override",
cfg1: Config{},
cfg2: Config{
LavaVersion: ptr("1.0.0"),
AgentConfig: AgentConfig{
PullPolicy: ptr(agentconfig.PullPolicyAlways),
Parallel: ptr(4),
Vars: map[string]string{
"VAR1": "value1",
"VAR2": "value2",
},
RegistryAuths: []RegistryAuth{
{
Server: "server",
Username: "username",
Password: "password",
},
},
},
ReportConfig: ReportConfig{
Severity: ptr(SeverityCritical),
ShowSeverity: ptr(SeverityLow),
Format: ptr(OutputFormatJSON),
OutputFile: ptr("outputfile.json"),
ErrorOnStaleExclusions: ptr(true),
Exclusions: []Exclusion{
{Summary: "Summary 1"},
},
Metrics: ptr("metrics.json"),
},
},
want: Config{
LavaVersion: ptr("1.0.0"),
AgentConfig: AgentConfig{
PullPolicy: ptr(agentconfig.PullPolicyAlways),
Parallel: ptr(4),
Vars: map[string]string{
"VAR1": "value1",
"VAR2": "value2",
},
RegistryAuths: []RegistryAuth{
{
Server: "server",
Username: "username",
Password: "password",
},
},
},
ReportConfig: ReportConfig{
Severity: ptr(SeverityCritical),
ShowSeverity: ptr(SeverityLow),
Format: ptr(OutputFormatJSON),
OutputFile: ptr("outputfile.json"),
ErrorOnStaleExclusions: ptr(true),
Exclusions: []Exclusion{
{
Summary: "Summary 1",
},
},
Metrics: ptr("metrics.json"),
},
},
wantErr: false,
},
{
name: "Override value",
cfg1: Config{
LavaVersion: ptr("1.0.1"),
AgentConfig: AgentConfig{
PullPolicy: ptr(agentconfig.PullPolicyNever),
Parallel: ptr(3),
Vars: map[string]string{
"VAR1": "value1",
"VAR2": "value2",
},
RegistryAuths: []RegistryAuth{
{
Server: "server",
Username: "username",
Password: "password",
},
},
},
ReportConfig: ReportConfig{
Severity: ptr(SeverityCritical),
ShowSeverity: ptr(SeverityLow),
Format: ptr(OutputFormatJSON),
OutputFile: ptr("outputfile1.json"),
ErrorOnStaleExclusions: ptr(false),
Exclusions: []Exclusion{
{
Summary: "Summary 1",
},
},
Metrics: ptr("metrics2.json"),
},
},
cfg2: Config{
LavaVersion: ptr("1.0.0"),
AgentConfig: AgentConfig{
PullPolicy: ptr(agentconfig.PullPolicyAlways),
Parallel: ptr(4),
Vars: map[string]string{
"VAR3": "value3",
"VAR4": "value4",
},
RegistryAuths: []RegistryAuth{
{
Server: "server2",
Username: "username2",
Password: "password2",
},
},
},
ReportConfig: ReportConfig{
Severity: ptr(SeverityCritical),
ShowSeverity: ptr(SeverityLow),
Format: ptr(OutputFormatJSON),
OutputFile: ptr("outputfile2.json"),
ErrorOnStaleExclusions: ptr(true),
Exclusions: []Exclusion{
{
Summary: "Summary 2",
},
},
Metrics: ptr("metrics2.json"),
},
},
want: Config{
LavaVersion: ptr("1.0.1"),
AgentConfig: AgentConfig{
PullPolicy: ptr(agentconfig.PullPolicyNever),
Parallel: ptr(3),
Vars: map[string]string{
"VAR1": "value1",
"VAR2": "value2",
"VAR3": "value3",
"VAR4": "value4",
},
RegistryAuths: []RegistryAuth{
{
Server: "server2",
Username: "username2",
Password: "password2",
},
{
Server: "server",
Username: "username",
Password: "password",
},
},
},
ReportConfig: ReportConfig{
Severity: ptr(SeverityCritical),
ShowSeverity: ptr(SeverityLow),
Format: ptr(OutputFormatJSON),
OutputFile: ptr("outputfile1.json"),
ErrorOnStaleExclusions: ptr(false),
Exclusions: []Exclusion{
{Summary: "Summary 2"},
{Summary: "Summary 1"},
},
Metrics: ptr("metrics2.json"),
},
},
wantErr: false,
},
{
name: "Append Exclusions",
cfg1: Config{
ReportConfig: ReportConfig{
Exclusions: []Exclusion{
{
Summary: "Summary 1",
},
},
},
},
cfg2: Config{
ReportConfig: ReportConfig{
Exclusions: []Exclusion{
{
Summary: "Summary 2",
},
},
},
},
want: Config{
ReportConfig: ReportConfig{
Exclusions: []Exclusion{
{
Summary: "Summary 2",
},
{
Summary: "Summary 1",
},
},
},
},
wantErr: false,
},
{
name: "Duplicated Exclusions",
cfg1: Config{
ReportConfig: ReportConfig{
Exclusions: []Exclusion{
{
Summary: "Summary 1",
},
},
},
},
cfg2: Config{
ReportConfig: ReportConfig{
Exclusions: []Exclusion{
{
Summary: "Summary 1",
},
},
},
},
want: Config{
ReportConfig: ReportConfig{
Exclusions: []Exclusion{
{Summary: "Summary 1"},
{Summary: "Summary 1"},
},
},
},
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
lm := LavaMerger{}
got, err := lm.Merge(tt.cfg1, tt.cfg2)
if (err != nil) != tt.wantErr {
t.Errorf("unexpected error: want: %v, got: %v", tt.wantErr, err)
}
if diff := cmp.Diff(tt.want, got); diff != "" {
t.Errorf("configs mismatch (-want +got):\n%v", diff)
}
})
}
}

0 comments on commit 2955669

Please sign in to comment.