internal/config: merge the includes while the graph is discovered

adevinta · Sep 19, 2024 · ceb518e · ceb518e
1 parent 3a1d9cf
commit ceb518e
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 31 deletions.
diff --git a/internal/config/include.go b/internal/config/include.go
@@ -11,12 +11,13 @@ import (
 
 // include represents every include reference in a config file.
 type include struct {
-	url      string
-	resolved bool
-	resolver *resolver
-	cfg      *Config
-	parent   *include
-	includes []include
+	url         string
+	resolved    bool
+	resolver    *resolver
+	cfg         *Config
+	resolvedCfg *Config
+	parent      *include
+	includes    []include
 }
 
 // Resolve parses the configuration of an include recursively.
@@ -39,6 +40,21 @@ func (in *include) resolve() error {
 		in.resolved = false
 		return fmt.Errorf("set includes: %w", err)
 	}
+
+	if in.parent != nil {
+		if in.resolvedCfg == nil {
+			// This is the most common ancestor included.
+			in.resolvedCfg = in.cfg
+		}
+		resolvedConfig, err := merge(*in.resolvedCfg, *in.parent.cfg)
+		if err != nil {
+			in.resolved = false
+			return fmt.Errorf("merge include: %w", err)
+		}
+		in.parent.resolvedCfg = &resolvedConfig
+	} else if in.resolvedCfg == nil {
+		in.resolvedCfg = in.cfg
+	}
 	return nil
 }
 

diff --git a/internal/config/resolver.go b/internal/config/resolver.go
@@ -47,5 +47,5 @@ func (r *resolver) resolve() (cfg Config, err error) {
 	if !r.root.resolved {
 		return Config{}, ErrRootIncludeNotResolved
 	}
-	return *r.root.cfg, nil
+	return *r.root.resolvedCfg, nil
 }
diff --git a/internal/config/resolver_test.go b/internal/config/resolver_test.go
@@ -22,13 +22,7 @@ func TestResolver_Resolve(t *testing.T) {
 			want: Config{
 				LavaVersion: ptr("v1.0.0"),
 				ChecktypeURLs: []string{
-					"checktypes.json",
-				},
-				Targets: []Target{
-					{
-						Identifier: "example.com",
-						AssetType:  types.DomainName,
-					},
+					"commonchecktypes.json",
 				},
 			},
 			wantErr: false,
@@ -40,6 +34,7 @@ func TestResolver_Resolve(t *testing.T) {
 				Includes:    []string{"testdata/includes/without_includes.yaml"},
 				LavaVersion: ptr("v1.0.0"),
 				ChecktypeURLs: []string{
+					"commonchecktypes.json",
 					"checktypes.json",
 				},
 				Targets: []Target{
@@ -66,6 +61,7 @@ func TestResolver_Resolve(t *testing.T) {
 				},
 				LavaVersion: ptr("v1.0.0"),
 				ChecktypeURLs: []string{
+					"commonchecktypes.json",
 					"checktypes.json",
 				},
 				Targets: []Target{
@@ -82,19 +78,23 @@ func TestResolver_Resolve(t *testing.T) {
 			URL:  "testdata/includes/include_two_with_common_include.yaml",
 			want: Config{
 				Includes: []string{
+					"testdata/includes/without_includes.yaml",
 					"testdata/includes/include_a.yaml",
 					"testdata/includes/include_b.yaml",
 				},
 				LavaVersion: ptr("v1.0.0"),
 				ChecktypeURLs: []string{
-					"checktypes.json",
+					"commonchecktypes.json",
 				},
 				Targets: []Target{
 					{
 						Identifier: "example.com",
 						AssetType:  types.DomainName,
 					},
 				},
+				ReportConfig: ReportConfig{
+					Severity: ptr(SeverityCritical),
+				},
 			},
 			wantErr: false,
 		},

diff --git a/internal/config/testdata/includes/include_a.yaml b/internal/config/testdata/includes/include_a.yaml
@@ -1,8 +1,5 @@
 lava: v1.0.0
 include:
   - testdata/includes/without_includes.yaml
-checktypes:
-  - checktypes.json
-targets:
-  - identifier: example.com
-    type: DomainName
+report:
+  severity: medium
diff --git a/internal/config/testdata/includes/include_b.yaml b/internal/config/testdata/includes/include_b.yaml
@@ -1,8 +1,5 @@
 lava: v1.0.0
 include:
   - testdata/includes/without_includes.yaml
-checktypes:
-  - checktypes.json
-targets:
-  - identifier: example.com
-    type: DomainName
+report:
+  severity: high
diff --git a/internal/config/testdata/includes/include_two_with_common_include.yaml b/internal/config/testdata/includes/include_two_with_common_include.yaml
@@ -2,8 +2,8 @@ lava: v1.0.0
 include:
   - testdata/includes/include_a.yaml
   - testdata/includes/include_b.yaml
-checktypes:
-  - checktypes.json
 targets:
   - identifier: example.com
     type: DomainName
+report:
+  severity: critical
diff --git a/internal/config/testdata/includes/without_includes.yaml b/internal/config/testdata/includes/without_includes.yaml
@@ -1,6 +1,3 @@
 lava: v1.0.0
 checktypes:
-  - checktypes.json
-targets:
-  - identifier: example.com
-    type: DomainName
+  - commonchecktypes.json