Merge pull request #300 from Liujingfang1/patchtransformer

Add transformer to apply json patch6902

pkg/patch/jsonpatch.go

@@ -16,18 +16,25 @@ limitations under the License.
 
 package patch
 
+import (
+	yamlpatch "github.com/krishicks/yaml-patch"
+)
+
 // PatchJson6902 represents a json patch for an object
 // with format documented https://tools.ietf.org/html/rfc6902.
 type PatchJson6902 struct {
-	// Relative file path within the kustomization for a json patch file.
-	Path string `json:"path" yaml:"path"`
-
 	// Target refers to a Kubernetes object that the json patch will be
 	// applied to. It must refer to a Kubernetes resource under the
 	// purview of this kustomization. Target should use the
 	// raw name of the object (the name specified in its YAML,
 	// before addition of a namePrefix).
-	Target Target `json:"target" yaml:"target"`
+	Target *Target `json:"target" yaml:"target"`
+
+	// jsonPatch is a list of operations in YAML format that follows JSON 6902 rule.
+	JsonPatch yamlpatch.Patch `json:"jsonPatch,omitempty" yaml:"jsonPatch,omitempty"`
+
+	// relative file path for a json patch file inside a kustomization
+	Path string `json:"path,omitempty" yaml:"path,omitempty"`
 }
 
 // Target represents the kubernetes object that the patch is applied to

pkg/patch/transformer/factory.go

@@ -0,0 +1,83 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	"fmt"
+
+	jsonpatch "github.com/evanphx/json-patch"
+	yamlpatch "github.com/krishicks/yaml-patch"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/loader"
+	"github.com/kubernetes-sigs/kustomize/pkg/patch"
+	"github.com/kubernetes-sigs/kustomize/pkg/resource"
+	"github.com/kubernetes-sigs/kustomize/pkg/transformers"
+)
+
+// PatchJson6902Factory makes PatchJson6902 transformers.
+type PatchJson6902Factory struct {
+	targetId       resource.ResId
+	operationsYAML yamlpatch.Patch
+	operationsJSON jsonpatch.Patch
+}
+
+// NewPatchJson6902Factory returns a new PatchJson6902Factory.
+func NewPatchJson6902Factory(l loader.Loader, p patch.PatchJson6902) (*PatchJson6902Factory, error) {
+
+	if p.Target == nil {
+		return nil, fmt.Errorf("must specify the target field in patchesJson6902")
+	}
+	if p.Path != "" && p.JsonPatch != nil {
+		return nil, fmt.Errorf("cannot specify path and jsonPath at the same time")
+	}
+
+	targetId := resource.NewResIdWithPrefixNamespace(
+		schema.GroupVersionKind{
+			Group:   p.Target.Group,
+			Version: p.Target.Version,
+			Kind:    p.Target.Kind,
+		},
+		p.Target.Name,
+		"",
+		p.Target.Namespace,
+	)
+
+	if p.JsonPatch != nil {
+		return &PatchJson6902Factory{targetId: targetId, operationsYAML: p.JsonPatch}, nil
+	}
+	if p.Path != "" {
+		rawOp, err := l.Load(p.Path)
+		if err != nil {
+			return nil, err
+		}
+		patch, err := jsonpatch.DecodePatch(rawOp)
+		if err != nil {
+			return nil, err
+		}
+		return &PatchJson6902Factory{targetId: targetId, operationsJSON: patch}, nil
+	}
+	return nil, nil
+}
+
+// MakePatchJson6902Transformer returns a transformer for applying Json6902 patch
+func (f *PatchJson6902Factory) MakePatchJson6902Transformer() (transformers.Transformer, error) {
+	if f.operationsJSON != nil {
+		return newPatchJson6902JSONTransformer(f.targetId, f.operationsJSON)
+	}
+	return newPatchJson6902YAMLTransformer(f.targetId, f.operationsYAML)
+}

pkg/patch/transformer/factory_test.go

@@ -0,0 +1,156 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	"strings"
+	"testing"
+
+	yaml "gopkg.in/yaml.v2"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/internal/loadertest"
+	"github.com/kubernetes-sigs/kustomize/pkg/patch"
+)
+
+func TestNewPatchJson6902FactoryNull(t *testing.T) {
+	p := patch.PatchJson6902{
+		Target: &patch.Target{
+			Name: "some-name",
+		},
+	}
+	f, err := NewPatchJson6902Factory(nil, p)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+	if f != nil {
+		t.Fatal("a nil should be returned")
+	}
+}
+
+func TestNewPatchJson6902FactoryNoTarget(t *testing.T) {
+	p := patch.PatchJson6902{}
+	_, err := NewPatchJson6902Factory(nil, p)
+	if err == nil {
+		t.Fatal("expected error")
+	}
+	if !strings.Contains(err.Error(), "must specify the target field in patchesJson6902") {
+		t.Fatalf("incorrect error returned: %v", err)
+	}
+}
+
+func TestNewPatchJson6902FactoryConflict(t *testing.T) {
+	jsonPatch := []byte(`
+target:
+  name: some-name
+  kind: Deployment
+jsonPatch:
+  - op: replace
+    path: /spec/template/spec/containers/0/name
+    value: my-nginx
+  - op: add
+    path: /spec/template/spec/containers/0/command
+    value: [arg1,arg2,arg3]
+path: /some/dir/some/file
+`)
+	p := patch.PatchJson6902{}
+	err := yaml.Unmarshal(jsonPatch, &p)
+	if err != nil {
+		t.Fatalf("expected error %v", err)
+	}
+	_, err = NewPatchJson6902Factory(nil, p)
+	if err == nil {
+		t.Fatal("expected error")
+	}
+	if !strings.Contains(err.Error(), "cannot specify path and jsonPath at the same time") {
+		t.Fatalf("incorrect error returned %v", err)
+	}
+}
+
+func TestNewPatchJson6902FactoryJSON(t *testing.T) {
+	ldr := loadertest.NewFakeLoader("/testpath")
+	operations := []byte(`[
+        {"op": "replace", "path": "/spec/template/spec/containers/0/name", "value": "my-nginx"},
+        {"op": "add", "path": "/spec/replica", "value": "3"},
+        {"op": "add", "path": "/spec/template/spec/containers/0/command", "value": ["arg1", "arg2", "arg3"]}
+]`)
+	err := ldr.AddFile("/testpath/patch.json", operations)
+	if err != nil {
+		t.Fatalf("Failed to setup fake ldr.")
+	}
+
+	jsonPatch := []byte(`
+target:
+  kind: Deployment
+  name: some-name
+path: /testpath/patch.json
+`)
+	p := patch.PatchJson6902{}
+	err = yaml.Unmarshal(jsonPatch, &p)
+	if err != nil {
+		t.Fatal("expected error")
+	}
+
+	f, err := NewPatchJson6902Factory(ldr, p)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+	if f == nil {
+		t.Fatalf("the returned factory shouldn't be nil ")
+	}
+
+	_, err = f.MakePatchJson6902Transformer()
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+}
+
+func TestNewPatchJson6902FactoryYAML(t *testing.T) {
+	jsonPatch := []byte(`
+target:
+  name: some-name
+  kind: Deployment
+jsonPatch:
+- op: replace
+  path: /spec/template/spec/containers/0/name
+  value: my-nginx
+- op: add
+  path: /spec/replica
+  value: 3
+- op: add
+  path: /spec/template/spec/containers/0/command
+  value: ["arg1", "arg2", "arg3"]
+`)
+	p := patch.PatchJson6902{}
+	err := yaml.Unmarshal(jsonPatch, &p)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+
+	f, err := NewPatchJson6902Factory(nil, p)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+	if f == nil {
+		t.Fatalf("the returned factory shouldn't be nil ")
+	}
+
+	_, err = f.MakePatchJson6902Transformer()
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+
+}

pkg/patch/transformer/patchjson6902json.go

@@ -0,0 +1,62 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	jsonpatch "github.com/evanphx/json-patch"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
+	"github.com/kubernetes-sigs/kustomize/pkg/resource"
+	"github.com/kubernetes-sigs/kustomize/pkg/transformers"
+)
+
+// patchJson6902Transformer applies patches.
+type patchJson6902JSONTransformer struct {
+	target resource.ResId
+	patch  jsonpatch.Patch
+}
+
+var _ transformers.Transformer = &patchJson6902JSONTransformer{}
+
+// newPatchJson6902JSONTransformer constructs a PatchJson6902 transformer.
+func newPatchJson6902JSONTransformer(t resource.ResId, p jsonpatch.Patch) (transformers.Transformer, error) {
+	if len(p) == 0 {
+		return transformers.NewNoOpTransformer(), nil
+	}
+	return &patchJson6902JSONTransformer{target: t, patch: p}, nil
+}
+
+// Transform apply the json patches on top of the base resources.
+func (t *patchJson6902JSONTransformer) Transform(baseResourceMap resmap.ResMap) error {
+	obj, err := findTargetObj(baseResourceMap, t.target)
+	if obj == nil {
+		return err
+	}
+	rawObj, err := obj.Unstructured.MarshalJSON()
+	if err != nil {
+		return err
+	}
+	modifiedObj, err := t.patch.Apply(rawObj)
+	if err != nil {
+		return err
+	}
+	err = obj.UnmarshalJSON(modifiedObj)
+	if err != nil {
+		return err
+	}
+	return nil
+}

pkg/patch/transformer/patchjson6902json_test.go

@@ -0,0 +1,113 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	"reflect"
+	"testing"
+
+	jsonpatch "github.com/evanphx/json-patch"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
+	"github.com/kubernetes-sigs/kustomize/pkg/resource"
+)
+
+func TestJsonPatchJSONTransformer_Transform(t *testing.T) {
+	id := resource.NewResId(deploy, "deploy1")
+	base := resmap.ResMap{
+		id: resource.NewResourceFromMap(
+			map[string]interface{}{
+				"apiVersion": "apps/v1",
+				"kind":       "Deployment",
+				"metadata": map[string]interface{}{
+					"name": "deploy1",
+				},
+				"spec": map[string]interface{}{
+					"template": map[string]interface{}{
+						"metadata": map[string]interface{}{
+							"labels": map[string]interface{}{
+								"old-label": "old-value",
+							},
+						},
+						"spec": map[string]interface{}{
+							"containers": []interface{}{
+								map[string]interface{}{
+									"name":  "nginx",
+									"image": "nginx",
+								},
+							},
+						},
+					},
+				},
+			}),
+	}
+
+	operations := []byte(`[
+        {"op": "replace", "path": "/spec/template/spec/containers/0/name", "value": "my-nginx"},
+        {"op": "add", "path": "/spec/replica", "value": "3"},
+        {"op": "add", "path": "/spec/template/spec/containers/0/command", "value": ["arg1", "arg2", "arg3"]}
+]`)
+	patch, err := jsonpatch.DecodePatch(operations)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+	expected := resmap.ResMap{
+		id: resource.NewResourceFromMap(
+			map[string]interface{}{
+				"apiVersion": "apps/v1",
+				"kind":       "Deployment",
+				"metadata": map[string]interface{}{
+					"name": "deploy1",
+				},
+				"spec": map[string]interface{}{
+					"replica": "3",
+					"template": map[string]interface{}{
+						"metadata": map[string]interface{}{
+							"labels": map[string]interface{}{
+								"old-label": "old-value",
+							},
+						},
+						"spec": map[string]interface{}{
+							"containers": []interface{}{
+								map[string]interface{}{
+									"image": "nginx",
+									"name":  "my-nginx",
+									"command": []interface{}{
+										"arg1",
+										"arg2",
+										"arg3",
+									},
+								},
+							},
+						},
+					},
+				},
+			}),
+	}
+	jpt, err := newPatchJson6902JSONTransformer(id, patch)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+	err = jpt.Transform(base)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if !reflect.DeepEqual(base, expected) {
+		err = expected.ErrorIfNotEqual(base)
+		t.Fatalf("actual doesn't match expected: %v", err)
+	}
+}

pkg/patch/transformer/patchjson6902yaml.go

@@ -0,0 +1,63 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	"github.com/ghodss/yaml"
+	yamlpatch "github.com/krishicks/yaml-patch"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
+	"github.com/kubernetes-sigs/kustomize/pkg/resource"
+	"github.com/kubernetes-sigs/kustomize/pkg/transformers"
+)
+
+// patchJson6902Transformer applies patches.
+type patchJson6902YAMLTransformer struct {
+	target resource.ResId
+	patch  yamlpatch.Patch
+}
+
+var _ transformers.Transformer = &patchJson6902YAMLTransformer{}
+
+// newPatchJson6902YAMLTransformer constructs a PatchJson6902 transformer.
+func newPatchJson6902YAMLTransformer(t resource.ResId, p yamlpatch.Patch) (transformers.Transformer, error) {
+	if len(p) == 0 {
+		return transformers.NewNoOpTransformer(), nil
+	}
+	return &patchJson6902YAMLTransformer{target: t, patch: p}, nil
+}
+
+// Transform apply the json patches on top of the base resources.
+func (t *patchJson6902YAMLTransformer) Transform(baseResourceMap resmap.ResMap) error {
+	obj, err := findTargetObj(baseResourceMap, t.target)
+	if obj == nil {
+		return err
+	}
+	rawObj, err := yaml.Marshal(obj.Unstructured.Object)
+	if err != nil {
+		return err
+	}
+	modifiedObj, err := t.patch.Apply(rawObj)
+	if err != nil {
+		return err
+	}
+	err = yaml.Unmarshal(modifiedObj, &obj.Unstructured.Object)
+	if err != nil {
+		return err
+	}
+	return nil
+}

pkg/patch/transformer/patchjson6902yaml_test.go

@@ -0,0 +1,128 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	"reflect"
+	"testing"
+
+	yamlpatch "github.com/krishicks/yaml-patch"
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
+	"github.com/kubernetes-sigs/kustomize/pkg/resource"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+var deploy = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
+
+func TestJsonPatchYAMLTransformer_Transform(t *testing.T) {
+	id := resource.NewResId(deploy, "deploy1")
+	base := resmap.ResMap{
+		id: resource.NewResourceFromMap(
+			map[string]interface{}{
+				"apiVersion": "apps/v1",
+				"kind":       "Deployment",
+				"metadata": map[string]interface{}{
+					"name": "deploy1",
+				},
+				"spec": map[string]interface{}{
+					"template": map[string]interface{}{
+						"metadata": map[string]interface{}{
+							"labels": map[string]interface{}{
+								"old-label": "old-value",
+							},
+						},
+						"spec": map[string]interface{}{
+							"containers": []interface{}{
+								map[string]interface{}{
+									"name":  "nginx",
+									"image": "nginx",
+								},
+							},
+						},
+					},
+				},
+			}),
+	}
+
+	var image, replica, command interface{}
+	image = "my-nginx"
+	replica = "3"
+	command = []string{"arg1", "arg2", "arg3"}
+	patch := yamlpatch.Patch{
+		{
+			Op:    "replace",
+			Path:  "/spec/template/spec/containers/0/name",
+			Value: yamlpatch.NewNode(&image),
+		},
+		{
+			Op:    "add",
+			Path:  "/spec/replica",
+			Value: yamlpatch.NewNode(&replica),
+		},
+		{
+			Op:    "add",
+			Path:  "/spec/template/spec/containers/0/command",
+			Value: yamlpatch.NewNode(&command),
+		},
+	}
+
+	expected := resmap.ResMap{
+		id: resource.NewResourceFromMap(
+			map[string]interface{}{
+				"apiVersion": "apps/v1",
+				"kind":       "Deployment",
+				"metadata": map[string]interface{}{
+					"name": "deploy1",
+				},
+				"spec": map[string]interface{}{
+					"replica": "3",
+					"template": map[string]interface{}{
+						"metadata": map[string]interface{}{
+							"labels": map[string]interface{}{
+								"old-label": "old-value",
+							},
+						},
+						"spec": map[string]interface{}{
+							"containers": []interface{}{
+								map[string]interface{}{
+									"image": "nginx",
+									"name":  "my-nginx",
+									"command": []interface{}{
+										"arg1",
+										"arg2",
+										"arg3",
+									},
+								},
+							},
+						},
+					},
+				},
+			}),
+	}
+	jpt, err := newPatchJson6902YAMLTransformer(id, patch)
+	if err != nil {
+		t.Fatalf("unexpected error : %v", err)
+	}
+	err = jpt.Transform(base)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if !reflect.DeepEqual(base, expected) {
+		err = expected.ErrorIfNotEqual(base)
+		t.Fatalf("actual doesn't match expected: %v", err)
+	}
+}

pkg/patch/transformer/util.go

@@ -0,0 +1,47 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package transformer
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
+	"github.com/kubernetes-sigs/kustomize/pkg/resource"
+)
+
+func findTargetObj(m resmap.ResMap, targetId resource.ResId) (*resource.Resource, error) {
+	matchedIds := m.FindByGVKN(targetId)
+	if targetId.Namespace() != "" {
+		ids := []resource.ResId{}
+		for _, id := range matchedIds {
+			if id.Namespace() == targetId.Namespace() {
+				ids = append(ids, id)
+			}
+		}
+		matchedIds = ids
+	}
+
+	if len(matchedIds) == 0 {
+		log.Printf("Couldn't find any object to apply the json patch %v, skipping it.", targetId)
+		return nil, nil
+	}
+	if len(matchedIds) > 1 {
+		return nil, fmt.Errorf("found multiple objects that the patch can apply %v", matchedIds)
+	}
+	return m[matchedIds[0]], nil
+}