kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-14 10:30:59 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Merge pull request #1045 from Liujingfang1/transformer

Browse Source 
pass resources to transformer plugin all together
This commit is contained in:
Kubernetes Prow Robot
2019-05-07 15:50:34 -07:00
committed by GitHub
parent 03ad8efcba 86f0f9a435
commit 34e8de3fc8
4 changed files with 169 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
pkg/plugins/execplugin.go
View File

@@ -35,6 +35,7 @@ import (
const ( const (
ArgsOneLiner = "argsOneLiner" ArgsOneLiner = "argsOneLiner"
ArgsFromFile = "argsFromFile" ArgsFromFile = "argsFromFile"
idAnnotation = "kustomize.config.k8s.io/id"
) )
// ExecPlugin record the name and args of an executable // ExecPlugin record the name and args of an executable
@@ -133,17 +134,7 @@ func (p *ExecPlugin) writeConfig() (string, error) {
} }
func (p *ExecPlugin) Generate() (resmap.ResMap, error) { func (p *ExecPlugin) Generate() (resmap.ResMap, error) {
args, err := p.getArgs() output, err := p.invokePlugin(nil)
if err != nil {
return nil, err
}
cmd := exec.Command(p.name, args...)
cmd.Env = p.getEnv()
cmd.Stderr = os.Stderr
if _, err := os.Stat(p.ldr.Root()); err == nil {
cmd.Dir = p.ldr.Root()
}
output, err := cmd.Output()
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -151,38 +142,42 @@ func (p *ExecPlugin) Generate() (resmap.ResMap, error) {
} }
func (p *ExecPlugin) Transform(rm resmap.ResMap) error { func (p *ExecPlugin) Transform(rm resmap.ResMap) error {
args, err := p.getArgs() // add ResIds as annotations to all objects so that we can add them back
inputRM, err := p.getResMapWithIdAnnotation(rm)
if err != nil { if err != nil {
return err return err
} }
for id, r := range rm {
content, err := yaml.Marshal(r.Kunstructured) // encode the ResMap so it can be fed to the plugin
if err != nil { resources, err := inputRM.EncodeAsYaml()
return err if err != nil {
} return err
cmd := exec.Command(p.name, args...)
cmd.Env = p.getEnv()
cmd.Stdin = bytes.NewReader(content)
cmd.Stderr = os.Stderr
if _, err := os.Stat(p.ldr.Root()); err == nil {
cmd.Dir = p.ldr.Root()
}
output, err := cmd.Output()
if err != nil {
return err
}
tmpMap, err := p.rf.NewResMapFromBytes(output)
if err != nil {
return err
}
if len(tmpMap) != 1 {
return fmt.Errorf("unable to put two resources into one")
}
for _, v := range tmpMap {
rm[id].Kunstructured = v.Kunstructured
}
} }
return nil
// invoke the plugin with resources as the input
output, err := p.invokePlugin(resources)
if err != nil {
return err
}
// update the original ResMap based on the output
return p.updateResMapValues(output, rm)
}
// invokePlugin invokes the plugin
func (p *ExecPlugin) invokePlugin(input []byte) ([]byte, error) {
args, err := p.getArgs()
if err != nil {
return nil, err
}
cmd := exec.Command(p.name, args...)
cmd.Env = p.getEnv()
cmd.Stdin = bytes.NewReader(input)
cmd.Stderr = os.Stderr
if _, err := os.Stat(p.ldr.Root()); err == nil {
cmd.Dir = p.ldr.Root()
}
return cmd.Output()
} }
// The first arg is always the absolute path to a temporary file // The first arg is always the absolute path to a temporary file
@@ -202,3 +197,63 @@ func (p *ExecPlugin) getEnv() []string {
"KUSTOMIZE_PLUGIN_CONFIG_ROOT="+p.ldr.Root()) "KUSTOMIZE_PLUGIN_CONFIG_ROOT="+p.ldr.Root())
return env return env
} }
// Returns a new copy of the given ResMap with the ResIds annotated in each Resource
func (p *ExecPlugin) getResMapWithIdAnnotation(rm resmap.ResMap) (resmap.ResMap, error) {
inputRM := rm.DeepCopy(p.rf.RF())
for id, r := range inputRM {
idString, err := yaml.Marshal(id)
if err != nil {
return nil, err
}
annotations := r.GetAnnotations()
if annotations == nil {
annotations = map[string]string{
idAnnotation: string(idString),
}
r.SetAnnotations(annotations)
}
annotations[idAnnotation] = string(idString)
}
return inputRM, nil
}
/*
updateResMapValues updates the Resource value in the given ResMap
with the emitted Resource values in output.
*/
func (p *ExecPlugin) updateResMapValues(output []byte, rm resmap.ResMap) error {
outputRM, err := p.rf.NewResMapFromBytes(output)
if err != nil {
return err
}
for _, r := range outputRM {
// for each emitted Resource, find the matching Resource in the original ResMap
// using its id
annotations := r.GetAnnotations()
idString, ok := annotations[idAnnotation]
if !ok {
return fmt.Errorf("the transformer %s should not remove annotation %s",
p.name, idAnnotation)
}
id := resid.ResId{}
err := yaml.Unmarshal([]byte(idString), &id)
if err != nil {
return err
}
res, ok := rm[id]
if !ok {
return fmt.Errorf("unable to find id %s in resource map", id.String())
}
// remove the annotation set by Kustomize to track the resource
delete(annotations, idAnnotation)
if len(annotations) == 0 {
annotations = nil
}
r.SetAnnotations(annotations)
// update the ResMap resource value with the transformed object
res.Kunstructured = r.Kunstructured
}
return nil
}

36
pkg/resid/resid.go
View File

@@ -29,33 +29,33 @@ type ResId struct {
// An untransformed resource has no prefix. // An untransformed resource has no prefix.
// A fully transformed resource has an arbitrary // A fully transformed resource has an arbitrary
// number of prefixes concatenated together. // number of prefixes concatenated together.
prefix string Prefix string `json:"prefix,omitempty"`
// nameSuffix of the resource. // nameSuffix of the resource.
// An untransformed resource has no suffix. // An untransformed resource has no suffix.
// A fully transformed resource has an arbitrary // A fully transformed resource has an arbitrary
// number of suffixes concatenated together. // number of suffixes concatenated together.
suffix string Suffix string `json:"suffix,omitempty"`
} }
// NewResIdWithPrefixSuffixNamespace creates new resource identifier with a prefix, suffix and a namespace // NewResIdWithPrefixSuffixNamespace creates new resource identifier with a prefix, suffix and a namespace
func NewResIdWithPrefixSuffixNamespace(k gvk.Gvk, n, p, s, ns string) ResId { func NewResIdWithPrefixSuffixNamespace(k gvk.Gvk, n, p, s, ns string) ResId {
return ResId{ItemId: ItemId{Gvk: k, Name: n, Namespace: ns}, prefix: p, suffix: s} return ResId{ItemId: ItemId{Gvk: k, Name: n, Namespace: ns}, Prefix: p, Suffix: s}
} }
// NewResIdWithPrefixNamespace creates new resource identifier with a prefix and a namespace // NewResIdWithPrefixNamespace creates new resource identifier with a prefix and a namespace
func NewResIdWithPrefixNamespace(k gvk.Gvk, n, p, ns string) ResId { func NewResIdWithPrefixNamespace(k gvk.Gvk, n, p, ns string) ResId {
return ResId{ItemId: ItemId{Gvk: k, Name: n, Namespace: ns}, prefix: p} return ResId{ItemId: ItemId{Gvk: k, Name: n, Namespace: ns}, Prefix: p}
} }
// NewResIdWithSuffixNamespace creates new resource identifier with a suffix and a namespace // NewResIdWithSuffixNamespace creates new resource identifier with a suffix and a namespace
func NewResIdWithSuffixNamespace(k gvk.Gvk, n, s, ns string) ResId { func NewResIdWithSuffixNamespace(k gvk.Gvk, n, s, ns string) ResId {
return ResId{ItemId: ItemId{Gvk: k, Name: n, Namespace: ns}, suffix: s} return ResId{ItemId: ItemId{Gvk: k, Name: n, Namespace: ns}, Suffix: s}
} }
// NewResIdWithPrefixSuffix creates new resource identifier with a prefix and suffix // NewResIdWithPrefixSuffix creates new resource identifier with a prefix and suffix
func NewResIdWithPrefixSuffix(k gvk.Gvk, n, p, s string) ResId { func NewResIdWithPrefixSuffix(k gvk.Gvk, n, p, s string) ResId {
return ResId{ItemId: ItemId{Gvk: k, Name: n}, prefix: p, suffix: s} return ResId{ItemId: ItemId{Gvk: k, Name: n}, Prefix: p, Suffix: s}
} }
// NewResId creates new resource identifier // NewResId creates new resource identifier
@@ -82,7 +82,7 @@ func (n ResId) String() string {
if ns == "" { if ns == "" {
ns = noNamespace ns = noNamespace
} }
p := n.prefix p := n.Prefix
if p == "" { if p == "" {
p = noPrefix p = noPrefix
} }
@@ -90,7 +90,7 @@ func (n ResId) String() string {
if nm == "" { if nm == "" {
nm = noName nm = noName
} }
s := n.suffix s := n.Suffix
if s == "" { if s == "" {
s = noSuffix s = noSuffix
} }
@@ -136,10 +136,10 @@ func (n ResId) Namespace() string {
func (n ResId) CopyWithNewPrefixSuffix(p, s string) ResId { func (n ResId) CopyWithNewPrefixSuffix(p, s string) ResId {
result := n result := n
if p != "" { if p != "" {
result.prefix = n.concatPrefix(p) result.Prefix = n.concatPrefix(p)
} }
if s != "" { if s != "" {
result.suffix = n.concatSuffix(s) result.Suffix = n.concatSuffix(s)
} }
return result return result
} }
@@ -169,28 +169,28 @@ func (n ResId) HasSameRightmostSuffix(id ResId) bool {
func (n ResId) concatPrefix(p string) string { func (n ResId) concatPrefix(p string) string {
if p == "" { if p == "" {
return n.prefix return n.Prefix
} }
if n.prefix == "" { if n.Prefix == "" {
return p return p
} }
return p + ":" + n.prefix return p + ":" + n.Prefix
} }
func (n ResId) concatSuffix(s string) string { func (n ResId) concatSuffix(s string) string {
if s == "" { if s == "" {
return n.suffix return n.Suffix
} }
if n.suffix == "" { if n.Suffix == "" {
return s return s
} }
return n.suffix + ":" + s return n.Suffix + ":" + s
} }
func (n ResId) prefixList() []string { func (n ResId) prefixList() []string {
return strings.Split(n.prefix, ":") return strings.Split(n.Prefix, ":")
} }
func (n ResId) suffixList() []string { func (n ResId) suffixList() []string {
return strings.Split(n.suffix, ":") return strings.Split(n.Suffix, ":")
} }

112
pkg/resid/resid_test.go
View File

@@ -17,8 +17,8 @@ var stringTests = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"g_v_k|ns|p|nm|s", "g_v_k|ns|p|nm|s",
}, },
@@ -29,8 +29,8 @@ var stringTests = []struct {
Gvk: gvk.Gvk{Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_v_k|ns|p|nm|s", "~G_v_k|ns|p|nm|s",
}, },
@@ -41,8 +41,8 @@ var stringTests = []struct {
Gvk: gvk.Gvk{Kind: "k"}, Gvk: gvk.Gvk{Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_~V_k|ns|p|nm|s", "~G_~V_k|ns|p|nm|s",
}, },
@@ -53,8 +53,8 @@ var stringTests = []struct {
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|ns|p|nm|s", "~G_~V_~K|ns|p|nm|s",
}, },
@@ -64,8 +64,8 @@ var stringTests = []struct {
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|~X|p|nm|s", "~G_~V_~K|~X|p|nm|s",
}, },
@@ -75,7 +75,7 @@ var stringTests = []struct {
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
Name: "nm", Name: "nm",
}, },
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|~X|~P|nm|s", "~G_~V_~K|~X|~P|nm|s",
}, },
@@ -84,7 +84,7 @@ var stringTests = []struct {
ItemId: ItemId{ ItemId: ItemId{
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
}, },
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|~X|~P|~N|s", "~G_~V_~K|~X|~P|~N|s",
}, },
@@ -121,8 +121,8 @@ var gvknStringTests = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"g_v_k|nm", "g_v_k|nm",
}, },
@@ -133,8 +133,8 @@ var gvknStringTests = []struct {
Gvk: gvk.Gvk{Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_v_k|nm", "~G_v_k|nm",
}, },
@@ -145,8 +145,8 @@ var gvknStringTests = []struct {
Gvk: gvk.Gvk{Kind: "k"}, Gvk: gvk.Gvk{Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_~V_k|nm", "~G_~V_k|nm",
}, },
@@ -157,8 +157,8 @@ var gvknStringTests = []struct {
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|nm", "~G_~V_~K|nm",
}, },
@@ -168,8 +168,8 @@ var gvknStringTests = []struct {
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
Name: "nm", Name: "nm",
}, },
prefix: "p", Prefix: "p",
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|nm", "~G_~V_~K|nm",
}, },
@@ -179,7 +179,7 @@ var gvknStringTests = []struct {
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
Name: "nm", Name: "nm",
}, },
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|nm", "~G_~V_~K|nm",
}, },
@@ -188,7 +188,7 @@ var gvknStringTests = []struct {
ItemId: ItemId{ ItemId: ItemId{
Gvk: gvk.Gvk{}, Gvk: gvk.Gvk{},
}, },
suffix: "s", Suffix: "s",
}, },
"~G_~V_~K|", "~G_~V_~K|",
}, },
@@ -227,8 +227,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "AA", Prefix: "AA",
suffix: "aa", Suffix: "aa",
}, },
id2: ResId{ id2: ResId{
ItemId: ItemId{ ItemId: ItemId{
@@ -236,8 +236,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "BB", Prefix: "BB",
suffix: "bb", Suffix: "bb",
}, },
gVknResult: true, gVknResult: true,
nSgVknResult: true, nSgVknResult: true,
@@ -249,8 +249,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "AA", Prefix: "AA",
suffix: "aa", Suffix: "aa",
}, },
id2: ResId{ id2: ResId{
ItemId: ItemId{ ItemId: ItemId{
@@ -258,8 +258,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "BB", Prefix: "BB",
suffix: "bb", Suffix: "bb",
}, },
gVknResult: true, gVknResult: true,
nSgVknResult: false, nSgVknResult: false,
@@ -271,16 +271,16 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "AA", Prefix: "AA",
suffix: "aa", Suffix: "aa",
}, },
id2: ResId{ id2: ResId{
ItemId: ItemId{ ItemId: ItemId{
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "BB", Prefix: "BB",
suffix: "bb", Suffix: "bb",
}, },
gVknResult: true, gVknResult: true,
nSgVknResult: false, nSgVknResult: false,
@@ -292,8 +292,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "AA", Prefix: "AA",
suffix: "aa", Suffix: "aa",
}, },
id2: ResId{ id2: ResId{
ItemId: ItemId{ ItemId: ItemId{
@@ -301,8 +301,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "BB", Prefix: "BB",
suffix: "bb", Suffix: "bb",
}, },
gVknResult: true, gVknResult: true,
nSgVknResult: false, nSgVknResult: false,
@@ -314,8 +314,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Kind: "k"}, Gvk: gvk.Gvk{Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "AA", Prefix: "AA",
suffix: "aa", Suffix: "aa",
}, },
id2: ResId{ id2: ResId{
ItemId: ItemId{ ItemId: ItemId{
@@ -323,8 +323,8 @@ var GvknEqualsTest = []struct {
Gvk: gvk.Gvk{Kind: "k"}, Gvk: gvk.Gvk{Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "BB", Prefix: "BB",
suffix: "bb", Suffix: "bb",
}, },
gVknResult: true, gVknResult: true,
nSgVknResult: false, nSgVknResult: false,
@@ -335,16 +335,16 @@ var GvknEqualsTest = []struct {
Namespace: "X", Namespace: "X",
Name: "nm", Name: "nm",
}, },
prefix: "AA", Prefix: "AA",
suffix: "aa", Suffix: "aa",
}, },
id2: ResId{ id2: ResId{
ItemId: ItemId{ ItemId: ItemId{
Namespace: "Z", Namespace: "Z",
Name: "nm", Name: "nm",
}, },
prefix: "BB", Prefix: "BB",
suffix: "bb", Suffix: "bb",
}, },
gVknResult: true, gVknResult: true,
nSgVknResult: false, nSgVknResult: false,
@@ -371,8 +371,8 @@ func TestCopyWithNewPrefixSuffix(t *testing.T) {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "a", Prefix: "a",
suffix: "b", Suffix: "b",
} }
r2 := r1.CopyWithNewPrefixSuffix("p-", "-s") r2 := r1.CopyWithNewPrefixSuffix("p-", "-s")
expected := ResId{ expected := ResId{
@@ -381,8 +381,8 @@ func TestCopyWithNewPrefixSuffix(t *testing.T) {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "p-a", Prefix: "p-a",
suffix: "b-s", Suffix: "b-s",
} }
if !r2.GvknEquals(expected) { if !r2.GvknEquals(expected) {
t.Fatalf("%v should equal %v", r2, expected) t.Fatalf("%v should equal %v", r2, expected)
@@ -396,8 +396,8 @@ func TestCopyWithNewNamespace(t *testing.T) {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "a", Prefix: "a",
suffix: "b", Suffix: "b",
} }
r2 := r1.CopyWithNewNamespace("zzz") r2 := r1.CopyWithNewNamespace("zzz")
expected := ResId{ expected := ResId{
@@ -406,8 +406,8 @@ func TestCopyWithNewNamespace(t *testing.T) {
Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"}, Gvk: gvk.Gvk{Group: "g", Version: "v", Kind: "k"},
Name: "nm", Name: "nm",
}, },
prefix: "a", Prefix: "a",
suffix: "b", Suffix: "b",
} }
if !r2.GvknEquals(expected) { if !r2.GvknEquals(expected) {
t.Fatalf("%v should equal %v", r2, expected) t.Fatalf("%v should equal %v", r2, expected)

1
pkg/target/transformerplugin_test.go
View File

@@ -145,6 +145,7 @@ data:
FOO: foo FOO: foo
kind: ConfigMap kind: ConfigMap
metadata: metadata:
annotations: {}
name: test-k4bkhftttd name: test-k4bkhftttd
`) `)
} }