Skip to content

Commit

Permalink
add PatchJson6902Factory to make transformer
Browse files Browse the repository at this point in the history
  • Loading branch information
Liujingfang1 committed Aug 31, 2018
1 parent 7f0e9e3 commit cedf215
Show file tree
Hide file tree
Showing 9 changed files with 320 additions and 153 deletions.
83 changes: 83 additions & 0 deletions pkg/patch/transformer/factory.go
Original file line number Diff line number Diff line change
@@ -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)
}
156 changes: 156 additions & 0 deletions pkg/patch/transformer/factory_test.go
Original file line number Diff line number Diff line change
@@ -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)
}

}
48 changes: 0 additions & 48 deletions pkg/patch/transformer/patchjson6902.go

This file was deleted.

1 change: 0 additions & 1 deletion pkg/patch/transformer/patchjson6902_test.go

This file was deleted.

54 changes: 11 additions & 43 deletions pkg/patch/transformer/patchjson6902json.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,72 +17,40 @@ limitations under the License.
package transformer

import (
"fmt"
"log"

jsonpatch "github.com/evanphx/json-patch"
"k8s.io/apimachinery/pkg/runtime/schema"

"github.com/kubernetes-sigs/kustomize/pkg/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 *patch.Target
operations []byte
target resource.ResId
patch jsonpatch.Patch
}

var _ transformers.Transformer = &patchJson6902JSONTransformer{}

// NewPatchJson6902JSONTransformer constructs a PatchJson6902 transformer.
func NewPatchJson6902JSONTransformer(t *patch.Target, o []byte) (transformers.Transformer, error) {
return &patchJson6902JSONTransformer{target: t, operations: o}, nil
// 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 {
targetId := resource.NewResIdWithPrefixNamespace(
schema.GroupVersionKind{
Group: t.target.Group,
Version: t.target.Version,
Kind: t.target.Kind,
},
t.target.Name,
"",
t.target.Namespace,
)

matchedIds := baseResourceMap.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
}
if len(matchedIds) > 1 {
return fmt.Errorf("found multiple objects that the patch can apply %v", matchedIds)
}

decodedPatch, err := jsonpatch.DecodePatch(t.operations)
if err != nil {
obj, err := findTargetObj(baseResourceMap, t.target)
if obj == nil {
return err
}
obj := baseResourceMap[matchedIds[0]]
rawObj, err := obj.Unstructured.MarshalJSON()
if err != nil {
return err
}
modifiedObj, err := decodedPatch.Apply(rawObj)
modifiedObj, err := t.patch.Apply(rawObj)
if err != nil {
return err
}
Expand Down
Loading

0 comments on commit cedf215

Please sign in to comment.