Skip to content

Commit 6a3bf0b

Browse files
dhaiducekdhaiducek
committed
fix: Resolve panic when manifest has an int
ref: https://issues.redhat.com/browse/ACM-18816 Signed-off-by: Dale Haiducek <[email protected]>
1 parent 0f114fa commit 6a3bf0b

File tree

19 files changed

+85
-9
lines changed

19 files changed

+85
-9
lines changed

‎cmd/template-resolver/client_test.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,14 @@ func cliTest(testName string) func(t *testing.T) {
8484
// If an error file is provided, overwrite the
8585
// expected and resolved with the error contents
8686
expectedBytes = errorBytes
87+
8788
errMatch := regexp.MustCompile("template: tmpl:[0-9]+:[0-9]+: .*")
8889
resolvedYAML = errMatch.Find([]byte(err.Error()))
90+
91+
// If nothing is matched, use the entire error
92+
if len(resolvedYAML) == 0 {
93+
resolvedYAML = []byte(err.Error())
94+
}
8995
}
9096

9197
if !bytes.Equal(expectedBytes, resolvedYAML) {

‎cmd/template-resolver/testdata/test_invalid-objdef-missing/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates entry was provided at index 0: objectDefinition key not found

‎cmd/template-resolver/testdata/test_invalid-objdef-missing/input.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-object-definition
5+
spec:
6+
policy-templates: [{}]

‎cmd/template-resolver/testdata/test_invalid-objdef/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates entry was provided at index 0: .objectDefinition accessor error: 0 is of the type float64, expected map[string]interface{}

‎cmd/template-resolver/testdata/test_invalid-objdef/input.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-object-definition
5+
spec:
6+
policy-templates:
7+
- objectDefinition: 0

‎cmd/template-resolver/testdata/test_invalid-policy-spec-missing/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates array was provided: spec.policy-templates keys not found

‎cmd/template-resolver/testdata/test_invalid-policy-spec-missing/input.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: no-spec

‎cmd/template-resolver/testdata/test_invalid-policy-spec/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates array was provided: .spec.policy-templates accessor error: [] is of the type []interface {}, expected map[string]interface{}

‎cmd/template-resolver/testdata/test_invalid-policy-spec/input.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-spec
5+
spec: []

‎cmd/template-resolver/testdata/test_invalid-policy-templates-bad-entry/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates entry was provided at index 0: could not parse to map[string]interface{}

‎cmd/template-resolver/testdata/test_invalid-policy-templates-bad-entry/input.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-policy-template-entry
5+
spec:
6+
policy-templates:
7+
- whee!!!

‎cmd/template-resolver/testdata/test_invalid-policy-templates-missing/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates array was provided: spec.policy-templates keys not found

‎cmd/template-resolver/testdata/test_invalid-policy-templates-missing/input.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: missing-policy-templates
5+
spec: {}

‎cmd/template-resolver/testdata/test_invalid-policy-templates/error.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
invalid policy-templates array was provided: .spec.policy-templates accessor error: map[] is of the type map[string]interface {}, expected []interface{}

‎cmd/template-resolver/testdata/test_invalid-policy-templates/input.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-policy-templates
5+
spec:
6+
policy-templates: {}

‎cmd/template-resolver/testdata/test_policy-policy-templates-int/input.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-spec
5+
spec:
6+
policy-templates:
7+
- objectDefinition:
8+
int-map: 100

‎cmd/template-resolver/testdata/test_policy-policy-templates-int/output.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: policy.open-cluster-management.io/v1
2+
kind: Policy
3+
metadata:
4+
name: invalid-spec
5+
spec:
6+
policy-templates:
7+
- objectDefinition:
8+
int-map: 100

‎cmd/template-resolver/utils/resolver_utils.go

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ import (
44
"bytes"
55
"context"
66
"encoding/json"
7+
"errors"
78
"fmt"
89
"io"
910
"os"
1011

11-
"gopkg.in/yaml.v3"
1212
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1313
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
1414
"k8s.io/apimachinery/pkg/runtime/schema"
1515
"k8s.io/client-go/dynamic"
1616
"k8s.io/client-go/tools/clientcmd"
17+
k8syaml "sigs.k8s.io/yaml"
1718

1819
"github.com/stolostron/go-template-utils/v6/pkg/templates"
1920
)
@@ -74,7 +75,7 @@ func HandleFile(yamlFile string) ([]byte, error) {
7475
func ProcessTemplate(yamlBytes []byte, hubKubeConfigPath, clusterName, hubNS string) ([]byte, error) {
7576
policy := unstructured.Unstructured{}
7677

77-
err := yaml.Unmarshal(yamlBytes, &policy.Object)
78+
err := k8syaml.Unmarshal(yamlBytes, &policy.Object)
7879
if err != nil {
7980
return nil, fmt.Errorf("failed to parse input to YAML: %w", err)
8081
}
@@ -229,20 +230,26 @@ func processPolicyTemplate(
229230
policy *unstructured.Unstructured,
230231
resolver *templates.TemplateResolver,
231232
) error {
232-
policyTemplates, _, err := unstructured.NestedSlice(policy.Object, "spec", "policy-templates")
233+
policyTemplates, found, err := unstructured.NestedSlice(policy.Object, "spec", "policy-templates")
233234
if err != nil {
234235
return fmt.Errorf("invalid policy-templates array was provided: %w", err)
236+
} else if !found {
237+
return errors.New("invalid policy-templates array was provided: spec.policy-templates keys not found")
235238
}
236239

237240
for i := range policyTemplates {
238-
policyTemplate, ok := policyTemplates[i].(map[string]interface{})
241+
policyTemplate, ok := policyTemplates[i].(map[string]any)
239242
if !ok {
240-
return fmt.Errorf("invalid policy-templates entry was provided: %w", err)
243+
return fmt.Errorf("invalid policy-templates entry was provided at index %d: "+
244+
"could not parse to map[string]interface{}", i)
241245
}
242246

243-
objectDefinition, ok := policyTemplate["objectDefinition"].(map[string]interface{})
244-
if !ok {
245-
return fmt.Errorf("invalid policy-templates entry was provided: %w", err)
247+
objectDefinition, found, err := unstructured.NestedMap(policyTemplate, "objectDefinition")
248+
if err != nil {
249+
return fmt.Errorf("invalid policy-templates entry was provided at index %d: %w", i, err)
250+
} else if !found {
251+
return fmt.Errorf("invalid policy-templates entry was provided at index %d: "+
252+
"objectDefinition key not found", i)
246253
}
247254

248255
templateObj := unstructured.Unstructured{Object: objectDefinition}

‎go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ require (
1414
k8s.io/client-go v0.31.0
1515
k8s.io/klog v1.0.0
1616
sigs.k8s.io/controller-runtime v0.19.0
17+
sigs.k8s.io/yaml v1.4.0
1718
)
1819

1920
require (
@@ -65,5 +66,4 @@ require (
6566
k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
6667
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
6768
sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
68-
sigs.k8s.io/yaml v1.4.0 // indirect
6969
)

0 commit comments

Comments
 (0)