Convert plugins to accept bytes instead of unstruct.

This commit is contained in:
Jeffrey Regan
2019-05-07 17:54:02 -07:00
committed by jregan
parent 06acd3caa9
commit 2e71a3b862
14 changed files with 109 additions and 96 deletions

View File

@@ -33,8 +33,6 @@ import (
) )
const ( const (
ArgsOneLiner = "argsOneLiner"
ArgsFromFile = "argsFromFile"
idAnnotation = "kustomize.config.k8s.io/id" idAnnotation = "kustomize.config.k8s.io/id"
) )
@@ -75,30 +73,26 @@ func (p *ExecPlugin) isAvailable() bool {
} }
func (p *ExecPlugin) Config( func (p *ExecPlugin) Config(
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error { ldr ifc.Loader, rf *resmap.Factory, config []byte) error {
p.rf = rf p.rf = rf
p.ldr = ldr p.ldr = ldr
p.cfg = config
var err error return p.processOptionalArgsFields()
p.cfg, err = yaml.Marshal(k)
if err != nil {
return err
}
err = p.processOptionalArgsFields(k)
if err != nil {
return err
}
return nil
} }
func (p *ExecPlugin) processOptionalArgsFields(k ifc.Kunstructured) error { type argsConfig struct {
args, err := k.GetFieldValue(ArgsOneLiner) ArgsOneLiner string `json:"argsOneLiner,omitempty" yaml:"argsOneLiner,omitempty"`
if err == nil && args != "" { ArgsFromFile string `json:"argsFromFile,omitempty" yaml:"argsFromFile,omitempty"`
p.args = strings.Split(args, " ") }
func (p *ExecPlugin) processOptionalArgsFields() error {
var c argsConfig
yaml.Unmarshal(p.cfg, &c)
if c.ArgsOneLiner != "" {
p.args = strings.Split(c.ArgsOneLiner, " ")
} }
fileName, err := k.GetFieldValue(ArgsFromFile) if c.ArgsFromFile != "" {
if err == nil && fileName != "" { content, err := p.ldr.Load(c.ArgsFromFile)
content, err := p.ldr.Load(fileName)
if err != nil { if err != nil {
return err return err
} }

View File

@@ -40,8 +40,8 @@ func TestExecPluginConfig(t *testing.T) {
"metadata": map[string]interface{}{ "metadata": map[string]interface{}{
"name": "some-random-name", "name": "some-random-name",
}, },
ArgsOneLiner: "one two", "argsOneLiner": "one two",
ArgsFromFile: "sed-input.txt", "argsFromFile": "sed-input.txt",
}) })
ldr.AddFile("/app/sed-input.txt", []byte(` ldr.AddFile("/app/sed-input.txt", []byte(`
@@ -54,7 +54,11 @@ s/$BAR/bar/g
plugin.DefaultPluginConfig().DirectoryPath, plugin.DefaultPluginConfig().DirectoryPath,
pluginConfig.Id()) pluginConfig.Id())
p.Config(ldr, rf, pluginConfig) yaml, err := pluginConfig.AsYAML()
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
p.Config(ldr, rf, yaml)
expected := "/kustomize/plugin/someteam.example.com/v1/SedTransformer" expected := "/kustomize/plugin/someteam.example.com/v1/SedTransformer"
if !strings.HasSuffix(p.name, expected) { if !strings.HasSuffix(p.name, expected) {

View File

@@ -31,7 +31,7 @@ import (
) )
type Configurable interface { type Configurable interface {
Config(ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error Config(ldr ifc.Loader, rf *resmap.Factory, config []byte) error
} }
type Loader struct { type Loader struct {
@@ -114,7 +114,11 @@ func (l *Loader) loadAndConfigurePlugin(
return nil, err return nil, err
} }
} }
err = c.Config(ldr, l.rf, res) yaml, err := res.AsYAML()
if err != nil {
return nil, errors.Wrapf(err, "marshalling yaml from res %s", res.Id())
}
err = c.Config(ldr, l.rf, yaml)
if err != nil { if err != nil {
return nil, errors.Wrapf( return nil, errors.Wrapf(
err, "plugin %s fails configuration", res.Id()) err, "plugin %s fails configuration", res.Id())

View File

@@ -18,7 +18,6 @@ package resmap_test
import ( import (
"encoding/base64" "encoding/base64"
"fmt"
"reflect" "reflect"
"testing" "testing"
@@ -124,7 +123,6 @@ metadata:
}), }),
} }
m, err := rmF.NewResMapFromBytes(encoded) m, err := rmF.NewResMapFromBytes(encoded)
fmt.Printf("%v\n", m)
if err != nil { if err != nil {
t.Fatalf("unexpected error: %v", err) t.Fatalf("unexpected error: %v", err)
} }

View File

@@ -23,6 +23,7 @@ import (
"sigs.k8s.io/kustomize/pkg/ifc" "sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resid" "sigs.k8s.io/kustomize/pkg/resid"
"sigs.k8s.io/kustomize/pkg/types" "sigs.k8s.io/kustomize/pkg/types"
"sigs.k8s.io/yaml"
) )
// Resource is map representation of a Kubernetes API resource object // Resource is map representation of a Kubernetes API resource object
@@ -56,6 +57,16 @@ func (r *Resource) DeepCopy() *Resource {
return rc return rc
} }
// AsYAML returns the resource in Yaml form.
// Easier to read than JSON.
func (r *Resource) AsYAML() ([]byte, error) {
json, err := r.MarshalJSON()
if err != nil {
return nil, err
}
return yaml.JSONToYAML(json)
}
// Behavior returns the behavior for the resource. // Behavior returns the behavior for the resource.
func (r *Resource) Behavior() types.GenerationBehavior { func (r *Resource) Behavior() types.GenerationBehavior {
return r.options.Behavior() return r.options.Behavior()

View File

@@ -54,6 +54,21 @@ var testDeployment = factory.FromMap(
const deploymentAsString = `{"apiVersion":"apps/v1","kind":"Deployment","metadata":{"name":"pooh"}}` const deploymentAsString = `{"apiVersion":"apps/v1","kind":"Deployment","metadata":{"name":"pooh"}}`
func TestAsYAML(t *testing.T) {
expected := `apiVersion: apps/v1
kind: Deployment
metadata:
name: pooh
`
yaml, err := testDeployment.AsYAML()
if err != nil {
t.Fatal(err)
}
if string(yaml) != expected {
t.Fatalf("--- expected\n%s\n--- got\n%s\n", expected, string(yaml))
}
}
func TestResourceString(t *testing.T) { func TestResourceString(t *testing.T) {
tests := []struct { tests := []struct {
in *Resource in *Resource

View File

@@ -31,7 +31,7 @@ apiVersion: someteam.example.com/v1
kind: ServiceGenerator kind: ServiceGenerator
metadata: metadata:
name: myServiceGenerator name: myServiceGenerator
service: my-service name: my-service
port: "12345" port: "12345"
`) `)
} }
@@ -74,12 +74,13 @@ func writeSecretGeneratorConfig(th *kusttest_test.KustTestHarness, root string)
apiVersion: builtin apiVersion: builtin
kind: SecretGenerator kind: SecretGenerator
metadata: metadata:
name: mySecret name: mySecGen
name: mySecret
behavior: merge behavior: merge
envFiles: envs:
- a.env - a.env
- b.env - b.env
valueFiles: files:
- longsecret.txt - longsecret.txt
literals: literals:
- FRUIT=apple - FRUIT=apple

View File

@@ -22,27 +22,31 @@ import (
"sigs.k8s.io/kustomize/pkg/ifc" "sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resmap" "sigs.k8s.io/kustomize/pkg/resmap"
"sigs.k8s.io/kustomize/pkg/types" "sigs.k8s.io/kustomize/pkg/types"
"sigs.k8s.io/yaml"
) )
type plugin struct { type plugin struct {
ldr ifc.Loader ldr ifc.Loader
rf *resmap.Factory rf *resmap.Factory
options types.GeneratorOptions types.GeneratorOptions
args types.ConfigMapArgs types.ConfigMapArgs
} }
var KustomizePlugin plugin var KustomizePlugin plugin
func (p *plugin) Config( func (p *plugin) Config(
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) (err error) { ldr ifc.Loader, rf *resmap.Factory, config []byte) (err error) {
p.GeneratorOptions = types.GeneratorOptions{}
p.ConfigMapArgs = types.ConfigMapArgs{}
err = yaml.Unmarshal(config, p)
p.ldr = ldr p.ldr = ldr
p.rf = rf p.rf = rf
p.args.GeneratorArgs, err = resmap.GeneratorArgsFromKunstruct(k)
return return
} }
func (p *plugin) Generate() (resmap.ResMap, error) { func (p *plugin) Generate() (resmap.ResMap, error) {
argsList := make([]types.ConfigMapArgs, 1) argsList := make([]types.ConfigMapArgs, 1)
argsList[0] = p.args argsList[0] = p.ConfigMapArgs
return p.rf.NewResMapFromConfigMapArgs(p.ldr, &p.options, argsList) return p.rf.NewResMapFromConfigMapArgs(
p.ldr, &p.GeneratorOptions, argsList)
} }

View File

@@ -46,8 +46,9 @@ COLOR=red
apiVersion: builtin apiVersion: builtin
kind: ConfigMapGenerator kind: ConfigMapGenerator
metadata: metadata:
name: myMap name: myMapGen
envFiles: name: myMap
envs:
- devops.env - devops.env
- uxteam.env - uxteam.env
literals: literals:

View File

@@ -22,34 +22,31 @@ import (
"sigs.k8s.io/kustomize/pkg/ifc" "sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resmap" "sigs.k8s.io/kustomize/pkg/resmap"
"sigs.k8s.io/kustomize/pkg/types" "sigs.k8s.io/kustomize/pkg/types"
"sigs.k8s.io/yaml"
) )
type plugin struct { type plugin struct {
ldr ifc.Loader ldr ifc.Loader
rf *resmap.Factory rf *resmap.Factory
options types.GeneratorOptions types.GeneratorOptions
args types.SecretArgs types.SecretArgs
} }
var KustomizePlugin plugin var KustomizePlugin plugin
func (p *plugin) Config( func (p *plugin) Config(
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) (err error) { ldr ifc.Loader, rf *resmap.Factory, config []byte) (err error) {
p.GeneratorOptions = types.GeneratorOptions{}
p.SecretArgs = types.SecretArgs{}
err = yaml.Unmarshal(config, p)
p.ldr = ldr p.ldr = ldr
p.rf = rf p.rf = rf
p.args.GeneratorArgs, err = resmap.GeneratorArgsFromKunstruct(k)
if err != nil {
return return
}
p.args.Type, err = k.GetFieldValue("type")
if !resmap.IsAcceptableError(err) {
return
}
return nil
} }
func (p *plugin) Generate() (resmap.ResMap, error) { func (p *plugin) Generate() (resmap.ResMap, error) {
argsList := make([]types.SecretArgs, 1) argsList := make([]types.SecretArgs, 1)
argsList[0] = p.args argsList[0] = p.SecretArgs
return p.rf.NewResMapFromSecretArgs(p.ldr, &p.options, argsList) return p.rf.NewResMapFromSecretArgs(
p.ldr, &p.GeneratorOptions, argsList)
} }

View File

@@ -50,12 +50,14 @@ consectetur adipiscing elit.
apiVersion: builtin apiVersion: builtin
kind: SecretGenerator kind: SecretGenerator
metadata: metadata:
name: mySecret name: exampleSecGen
name: mySecret
namespace: whatever
behavior: merge behavior: merge
envFiles: envs:
- a.env - a.env
- b.env - b.env
valueFiles: files:
- obscure=longsecret.txt - obscure=longsecret.txt
literals: literals:
- FRUIT=apple - FRUIT=apple
@@ -73,6 +75,7 @@ data:
kind: Secret kind: Secret
metadata: metadata:
name: mySecret name: mySecret
namespace: whatever
type: Opaque type: Opaque
`) `)
} }

View File

@@ -30,7 +30,7 @@ type plugin struct{}
var KustomizePlugin plugin var KustomizePlugin plugin
func (p *plugin) Config( func (p *plugin) Config(
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error { ldr ifc.Loader, rf *resmap.Factory, c []byte) error {
return nil return nil
} }

View File

@@ -26,22 +26,23 @@ import (
"sigs.k8s.io/kustomize/pkg/ifc" "sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resmap" "sigs.k8s.io/kustomize/pkg/resmap"
"sigs.k8s.io/kustomize/pkg/resource" "sigs.k8s.io/kustomize/pkg/resource"
"sigs.k8s.io/yaml"
) )
type plugin struct { type plugin struct {
ServiceName string Name string `json:"name,omitempty" yaml:"name,omitempty"`
Port string Port string `json:"port,omitempty" yaml:"port,omitempty"`
} }
var KustomizePlugin plugin var KustomizePlugin plugin
var manifest = ` const tmpl = `
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
labels: labels:
app: dev app: dev
name: {{.ServiceName}} name: {{.Name}}
spec: spec:
ports: ports:
- port: {{.Port}} - port: {{.Port}}
@@ -50,23 +51,13 @@ spec:
` `
func (p *plugin) Config( func (p *plugin) Config(
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error { ldr ifc.Loader, rf *resmap.Factory, config []byte) error {
var err error return yaml.Unmarshal(config, p)
p.ServiceName, err = k.GetFieldValue("service")
if err != nil {
return err
}
p.Port, err = k.GetFieldValue("port")
if err != nil {
return err
}
return nil
} }
func (p *plugin) Generate() (resmap.ResMap, error) { func (p *plugin) Generate() (resmap.ResMap, error) {
var buf bytes.Buffer var buf bytes.Buffer
temp := template.Must(template.New("tmpl").Parse(tmpl))
temp := template.Must(template.New("manifest").Parse(manifest))
err := temp.Execute(&buf, p) err := temp.Execute(&buf, p)
if err != nil { if err != nil {
return nil, err return nil, err

View File

@@ -16,44 +16,34 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
// Assuming GOPATH is something like
// ~/gopath
// and this source file is located at
// $GOPATH/src/sigs.k8s.io/kustomize/plugins/StringPrefixer.go,
// build it like this:
// dir=$GOPATH/src/sigs.k8s.io/kustomize/plugins
// go build -buildmode plugin -tags=plugin \
// -o $dir/StringPrefixer.so $dir/StringPrefixer.go
package main package main
import ( import (
"fmt"
"sigs.k8s.io/kustomize/pkg/ifc" "sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resmap" "sigs.k8s.io/kustomize/pkg/resmap"
"sigs.k8s.io/kustomize/pkg/transformers" "sigs.k8s.io/kustomize/pkg/transformers"
"sigs.k8s.io/kustomize/pkg/transformers/config" "sigs.k8s.io/kustomize/pkg/transformers/config"
"sigs.k8s.io/yaml"
) )
type plugin struct { type plugin struct {
prefix string Metadata metaData `json:"metadata,omitempty" yaml:"metadata,omitempty"`
}
type metaData struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
} }
var KustomizePlugin plugin var KustomizePlugin plugin
func (p *plugin) Config( func (p *plugin) Config(
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error { ldr ifc.Loader, rf *resmap.Factory, c []byte) error {
name := k.GetName() return yaml.Unmarshal(c, p)
if name == "" {
return fmt.Errorf("name cannot be empty")
}
p.prefix = name + "-"
return nil
} }
func (p *plugin) Transform(m resmap.ResMap) error { func (p *plugin) Transform(m resmap.ResMap) error {
tr, err := transformers.NewNamePrefixSuffixTransformer( tr, err := transformers.NewNamePrefixSuffixTransformer(
p.prefix, "", p.Metadata.Name + "-", "",
config.MakeDefaultConfig().NamePrefix) config.MakeDefaultConfig().NamePrefix)
if err != nil { if err != nil {
return err return err