Keep non-yaml files when healing config comments (#3142)

Author: martinmaly

porch/pkg/engine/engine.go

@@ -583,10 +583,12 @@ func healConfig(old, new map[string]string) (map[string]string, error) {
 		},
 	}
 
+	extra := map[string]string{}
+
 	if err := (kio.Pipeline{
 		Inputs: []kio.Reader{&packageReader{
 			input: repository.PackageResources{Contents: new},
-			extra: map[string]string{},
+			extra: extra,
 		}},
 		Filters:               []kio.Filter{filter},
 		Outputs:               []kio.Writer{out},
@@ -595,5 +597,11 @@ func healConfig(old, new map[string]string) (map[string]string, error) {
 		return nil, err
 	}
 
-	return out.output.Contents, nil
+	healed := out.output.Contents
+
+	for k, v := range extra {
+		healed[k] = v
+	}
+
+	return healed, nil
 }

porch/pkg/engine/replace_test.go

@@ -17,6 +17,7 @@ package engine
 import (
 	"bytes"
 	"context"
+	"path"
 	"path/filepath"
 	"testing"
 
@@ -63,20 +64,30 @@ func removeComments(t *testing.T, r repository.PackageResources) repository.Pack
 	}
 
 	for k, v := range r.Contents {
-		var data interface{}
-		if err := yaml.Unmarshal([]byte(v), &data); err != nil {
-			t.Fatalf("Failed to unmarshal %q: %v", k, err)
-		}
+		base := path.Base(k)
+		ext := path.Ext(base)
 
-		var nocomment bytes.Buffer
-		encoder := yaml.NewEncoder(&nocomment)
-		encoder.SetIndent(0)
-		if err := encoder.Encode(data); err != nil {
-			t.Fatalf("Failed to re-encode yaml output: %v", err)
+		if ext == ".yaml" || ext == ".yml" || base == "Kptfile" {
+			v = removeCommentsFromFile(t, k, v)
 		}
 
-		out.Contents[k] = nocomment.String()
+		out.Contents[k] = v
 	}
-
 	return out
 }
+
+func removeCommentsFromFile(t *testing.T, name, contents string) string {
+	var data interface{}
+	if err := yaml.Unmarshal([]byte(contents), &data); err != nil {
+		t.Fatalf("Failed to unmarshal %q: %v", name, err)
+	}
+
+	var nocomment bytes.Buffer
+	encoder := yaml.NewEncoder(&nocomment)
+	encoder.SetIndent(0)
+	if err := encoder.Encode(data); err != nil {
+		t.Fatalf("Failed to re-encode yaml output: %v", err)
+	}
+
+	return nocomment.String()
+}

porch/pkg/engine/testdata/replace/README.md

@@ -0,0 +1 @@
+# replace test