mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-11 17:12:51 +00:00
Simplify plugin loader code.
* use one place to build plugin file names, * use one loader instance, * test for plugin enabled flag in just one place to avoid errors and reduce if statements, * don't return private objects, * factor goplugin loading to a method, * fix a related test that was commented out.
This commit is contained in:
@@ -29,9 +29,9 @@ import (
|
|||||||
"sigs.k8s.io/kustomize/pkg/ifc/transformer"
|
"sigs.k8s.io/kustomize/pkg/ifc/transformer"
|
||||||
"sigs.k8s.io/kustomize/pkg/loader"
|
"sigs.k8s.io/kustomize/pkg/loader"
|
||||||
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
||||||
|
"sigs.k8s.io/kustomize/pkg/plugins"
|
||||||
"sigs.k8s.io/kustomize/pkg/resmap"
|
"sigs.k8s.io/kustomize/pkg/resmap"
|
||||||
"sigs.k8s.io/kustomize/pkg/target"
|
"sigs.k8s.io/kustomize/pkg/target"
|
||||||
"sigs.k8s.io/kustomize/pkg/types"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Options contain the options for running a build
|
// Options contain the options for running a build
|
||||||
@@ -70,7 +70,7 @@ func NewCmdBuild(
|
|||||||
out io.Writer, fs fs.FileSystem,
|
out io.Writer, fs fs.FileSystem,
|
||||||
rf *resmap.Factory,
|
rf *resmap.Factory,
|
||||||
ptf transformer.Factory,
|
ptf transformer.Factory,
|
||||||
pc *types.PluginConfig) *cobra.Command {
|
pl *plugins.Loader) *cobra.Command {
|
||||||
var o Options
|
var o Options
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
@@ -83,7 +83,7 @@ func NewCmdBuild(
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return o.RunBuild(out, fs, rf, ptf, pc)
|
return o.RunBuild(out, fs, rf, ptf, pl)
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
cmd.Flags().StringVarP(
|
cmd.Flags().StringVarP(
|
||||||
@@ -92,7 +92,7 @@ func NewCmdBuild(
|
|||||||
"If specified, write the build output to this path.")
|
"If specified, write the build output to this path.")
|
||||||
loader.AddLoadRestrictionsFlag(cmd.Flags())
|
loader.AddLoadRestrictionsFlag(cmd.Flags())
|
||||||
|
|
||||||
cmd.AddCommand(NewCmdBuildPrune(out, fs, rf, ptf, pc))
|
cmd.AddCommand(NewCmdBuildPrune(out, fs, rf, ptf, pl))
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -115,14 +115,14 @@ func (o *Options) Validate(args []string) (err error) {
|
|||||||
func (o *Options) RunBuild(
|
func (o *Options) RunBuild(
|
||||||
out io.Writer, fSys fs.FileSystem,
|
out io.Writer, fSys fs.FileSystem,
|
||||||
rf *resmap.Factory, ptf transformer.Factory,
|
rf *resmap.Factory, ptf transformer.Factory,
|
||||||
pc *types.PluginConfig) error {
|
pl *plugins.Loader) error {
|
||||||
ldr, err := loader.NewLoader(
|
ldr, err := loader.NewLoader(
|
||||||
o.loadRestrictor, o.kustomizationPath, fSys)
|
o.loadRestrictor, o.kustomizationPath, fSys)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer ldr.Cleanup()
|
defer ldr.Cleanup()
|
||||||
kt, err := target.NewKustTarget(ldr, rf, ptf, pc)
|
kt, err := target.NewKustTarget(ldr, rf, ptf, pl)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -136,14 +136,14 @@ func (o *Options) RunBuild(
|
|||||||
func (o *Options) RunBuildPrune(
|
func (o *Options) RunBuildPrune(
|
||||||
out io.Writer, fSys fs.FileSystem,
|
out io.Writer, fSys fs.FileSystem,
|
||||||
rf *resmap.Factory, ptf transformer.Factory,
|
rf *resmap.Factory, ptf transformer.Factory,
|
||||||
pc *types.PluginConfig) error {
|
pl *plugins.Loader) error {
|
||||||
ldr, err := loader.NewLoader(
|
ldr, err := loader.NewLoader(
|
||||||
o.loadRestrictor, o.kustomizationPath, fSys)
|
o.loadRestrictor, o.kustomizationPath, fSys)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer ldr.Cleanup()
|
defer ldr.Cleanup()
|
||||||
kt, err := target.NewKustTarget(ldr, rf, ptf, pc)
|
kt, err := target.NewKustTarget(ldr, rf, ptf, pl)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -174,7 +174,7 @@ func NewCmdBuildPrune(
|
|||||||
out io.Writer, fs fs.FileSystem,
|
out io.Writer, fs fs.FileSystem,
|
||||||
rf *resmap.Factory,
|
rf *resmap.Factory,
|
||||||
ptf transformer.Factory,
|
ptf transformer.Factory,
|
||||||
pc *types.PluginConfig) *cobra.Command {
|
pl *plugins.Loader) *cobra.Command {
|
||||||
var o Options
|
var o Options
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
@@ -187,7 +187,7 @@ func NewCmdBuildPrune(
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return o.RunBuildPrune(out, fs, rf, ptf, pc)
|
return o.RunBuildPrune(out, fs, rf, ptf, pl)
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
return cmd
|
return cmd
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ import (
|
|||||||
"sigs.k8s.io/kustomize/pkg/commands/misc"
|
"sigs.k8s.io/kustomize/pkg/commands/misc"
|
||||||
"sigs.k8s.io/kustomize/pkg/fs"
|
"sigs.k8s.io/kustomize/pkg/fs"
|
||||||
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
||||||
|
"sigs.k8s.io/kustomize/pkg/plugins"
|
||||||
"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/kustomize/pkg/types"
|
"sigs.k8s.io/kustomize/pkg/types"
|
||||||
@@ -64,12 +65,13 @@ See https://sigs.k8s.io/kustomize
|
|||||||
PluginConfig: pluginConfig,
|
PluginConfig: pluginConfig,
|
||||||
}
|
}
|
||||||
uf := kunstruct.NewKunstructuredFactoryWithGeneratorArgs(&genMetaArgs)
|
uf := kunstruct.NewKunstructuredFactoryWithGeneratorArgs(&genMetaArgs)
|
||||||
|
rf := resmap.NewFactory(resource.NewFactory(uf))
|
||||||
c.AddCommand(
|
c.AddCommand(
|
||||||
build.NewCmdBuild(
|
build.NewCmdBuild(
|
||||||
stdOut, fSys,
|
stdOut, fSys,
|
||||||
resmap.NewFactory(resource.NewFactory(uf)),
|
rf,
|
||||||
transformer.NewFactoryImpl(), pluginConfig),
|
transformer.NewFactoryImpl(),
|
||||||
|
plugins.NewLoader(pluginConfig, rf)),
|
||||||
edit.NewCmdEdit(fSys, validator.NewKustValidator(), uf),
|
edit.NewCmdEdit(fSys, validator.NewKustValidator(), uf),
|
||||||
misc.NewCmdConfig(fSys),
|
misc.NewCmdConfig(fSys),
|
||||||
misc.NewCmdVersion(stdOut),
|
misc.NewCmdVersion(stdOut),
|
||||||
|
|||||||
@@ -62,8 +62,7 @@ func DefaultSrcRoot() (string, error) {
|
|||||||
}
|
}
|
||||||
nope = append(nope, root)
|
nope = append(nope, root)
|
||||||
|
|
||||||
root = filepath.Join(
|
root = plugin.DefaultPluginConfig().DirectoryPath
|
||||||
pgmconfig.ConfigRoot(), plugin.PluginRoot)
|
|
||||||
if FileExists(root) {
|
if FileExists(root) {
|
||||||
return root, nil
|
return root, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,9 +27,8 @@ import (
|
|||||||
"syscall"
|
"syscall"
|
||||||
|
|
||||||
"github.com/ghodss/yaml"
|
"github.com/ghodss/yaml"
|
||||||
"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
|
|
||||||
"sigs.k8s.io/kustomize/pkg/ifc"
|
"sigs.k8s.io/kustomize/pkg/ifc"
|
||||||
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
"sigs.k8s.io/kustomize/pkg/resid"
|
||||||
"sigs.k8s.io/kustomize/pkg/resmap"
|
"sigs.k8s.io/kustomize/pkg/resmap"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -59,11 +58,23 @@ type ExecPlugin struct {
|
|||||||
ldr ifc.Loader
|
ldr ifc.Loader
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func NewExecPlugin(root string, id resid.ResId) *ExecPlugin {
|
||||||
|
return &ExecPlugin{
|
||||||
|
name: filepath.Join(root, pluginPath(id)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// isAvailable checks to see if the plugin is available
|
||||||
|
func (p *ExecPlugin) isAvailable() bool {
|
||||||
|
f, err := os.Stat(p.name)
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return f.Mode()&0111 != 0000
|
||||||
|
}
|
||||||
|
|
||||||
func (p *ExecPlugin) Config(
|
func (p *ExecPlugin) Config(
|
||||||
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error {
|
ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error {
|
||||||
dir := filepath.Join(pgmconfig.ConfigRoot(), plugin.PluginRoot)
|
|
||||||
id := k.GetGvk()
|
|
||||||
p.name = filepath.Join(dir, id.Group, id.Version, id.Kind)
|
|
||||||
p.rf = rf
|
p.rf = rf
|
||||||
p.ldr = ldr
|
p.ldr = ldr
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sigs.k8s.io/kustomize/k8sdeps/kunstruct"
|
"sigs.k8s.io/kustomize/k8sdeps/kunstruct"
|
||||||
|
"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
|
||||||
"sigs.k8s.io/kustomize/pkg/internal/loadertest"
|
"sigs.k8s.io/kustomize/pkg/internal/loadertest"
|
||||||
"sigs.k8s.io/kustomize/pkg/resmap"
|
"sigs.k8s.io/kustomize/pkg/resmap"
|
||||||
"sigs.k8s.io/kustomize/pkg/resource"
|
"sigs.k8s.io/kustomize/pkg/resource"
|
||||||
@@ -25,11 +26,11 @@ import (
|
|||||||
|
|
||||||
func TestExecPluginConfig(t *testing.T) {
|
func TestExecPluginConfig(t *testing.T) {
|
||||||
path := "/app"
|
path := "/app"
|
||||||
kFactory := kunstruct.NewKunstructuredFactoryImpl()
|
rf := resmap.NewFactory(
|
||||||
rf := resmap.NewFactory(resource.NewFactory(kFactory))
|
resource.NewFactory(
|
||||||
|
kunstruct.NewKunstructuredFactoryImpl()))
|
||||||
ldr := loadertest.NewFakeLoader(path)
|
ldr := loadertest.NewFakeLoader(path)
|
||||||
|
pluginConfig := rf.RF().FromMap(
|
||||||
pluginConfig := kFactory.FromMap(
|
|
||||||
map[string]interface{}{
|
map[string]interface{}{
|
||||||
"apiVersion": "someteam.example.com/v1",
|
"apiVersion": "someteam.example.com/v1",
|
||||||
"kind": "SedTransformer",
|
"kind": "SedTransformer",
|
||||||
@@ -46,7 +47,9 @@ s/$BAR/bar/g
|
|||||||
\ \ \
|
\ \ \
|
||||||
`))
|
`))
|
||||||
|
|
||||||
p := &ExecPlugin{}
|
p := NewExecPlugin(
|
||||||
|
plugin.DefaultPluginConfig().DirectoryPath,
|
||||||
|
pluginConfig.Id())
|
||||||
|
|
||||||
p.Config(ldr, rf, pluginConfig)
|
p.Config(ldr, rf, pluginConfig)
|
||||||
|
|
||||||
|
|||||||
@@ -22,38 +22,19 @@ 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/transformers"
|
"sigs.k8s.io/kustomize/pkg/transformers"
|
||||||
"sigs.k8s.io/kustomize/pkg/types"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type generatorLoader struct {
|
func (l *Loader) LoadGenerators(
|
||||||
pc *types.PluginConfig
|
ldr ifc.Loader, rm resmap.ResMap) ([]transformers.Generator, error) {
|
||||||
ldr ifc.Loader
|
|
||||||
rf *resmap.Factory
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewGeneratorLoader(
|
|
||||||
pc *types.PluginConfig,
|
|
||||||
ldr ifc.Loader, rf *resmap.Factory) generatorLoader {
|
|
||||||
return generatorLoader{pc: pc, ldr: ldr, rf: rf}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l generatorLoader) Load(
|
|
||||||
rm resmap.ResMap) ([]transformers.Generator, error) {
|
|
||||||
if len(rm) == 0 {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
if !l.pc.GoEnabled {
|
|
||||||
return nil, fmt.Errorf("plugins not enabled")
|
|
||||||
}
|
|
||||||
var result []transformers.Generator
|
var result []transformers.Generator
|
||||||
for id, res := range rm {
|
for _, res := range rm {
|
||||||
c, err := loadAndConfigurePlugin(l.pc.DirectoryPath, id, l.ldr, l.rf, res)
|
c, err := l.loadAndConfigurePlugin(ldr, res)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
g, ok := c.(transformers.Generator)
|
g, ok := c.(transformers.Generator)
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil, fmt.Errorf("plugin %s not a generator", id.String())
|
return nil, fmt.Errorf("plugin %s not a generator", res.Id())
|
||||||
}
|
}
|
||||||
result = append(result, g)
|
result = append(result, g)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,10 +18,10 @@ package plugins
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/pkg/errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"plugin"
|
"plugin"
|
||||||
|
|
||||||
|
"github.com/pkg/errors"
|
||||||
kplugin "sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
|
kplugin "sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
|
||||||
"sigs.k8s.io/kustomize/pkg/ifc"
|
"sigs.k8s.io/kustomize/pkg/ifc"
|
||||||
"sigs.k8s.io/kustomize/pkg/resid"
|
"sigs.k8s.io/kustomize/pkg/resid"
|
||||||
@@ -35,91 +35,86 @@ type Configurable interface {
|
|||||||
Config(ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error
|
Config(ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error
|
||||||
}
|
}
|
||||||
|
|
||||||
type transformerLoader struct {
|
type Loader struct {
|
||||||
pc *types.PluginConfig
|
pc *types.PluginConfig
|
||||||
ldr ifc.Loader
|
rf *resmap.Factory
|
||||||
rf *resmap.Factory
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewTransformerLoader(
|
func NewLoader(
|
||||||
pc *types.PluginConfig,
|
pc *types.PluginConfig, rf *resmap.Factory) *Loader {
|
||||||
ldr ifc.Loader, rf *resmap.Factory) transformerLoader {
|
return &Loader{pc: pc, rf: rf}
|
||||||
return transformerLoader{pc: pc, ldr: ldr, rf: rf}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l transformerLoader) Load(
|
func (l *Loader) LoadTransformers(
|
||||||
rm resmap.ResMap) ([]transformers.Transformer, error) {
|
ldr ifc.Loader, rm resmap.ResMap) ([]transformers.Transformer, error) {
|
||||||
if len(rm) == 0 {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
if !l.pc.GoEnabled {
|
|
||||||
return nil, fmt.Errorf("plugins not enabled")
|
|
||||||
}
|
|
||||||
var result []transformers.Transformer
|
var result []transformers.Transformer
|
||||||
for id, res := range rm {
|
for _, res := range rm {
|
||||||
c, err := loadAndConfigurePlugin(l.pc.DirectoryPath, id, l.ldr, l.rf, res)
|
c, err := l.loadAndConfigurePlugin(ldr, res)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
t, ok := c.(transformers.Transformer)
|
t, ok := c.(transformers.Transformer)
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil, fmt.Errorf("plugin %s not a transformer", id.String())
|
return nil, fmt.Errorf("plugin %s not a transformer", res.Id())
|
||||||
}
|
}
|
||||||
result = append(result, t)
|
result = append(result, t)
|
||||||
}
|
}
|
||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func goPluginFileName(dir string, id resid.ResId) string {
|
func pluginPath(id resid.ResId) string {
|
||||||
return execPluginFileName(dir, id) + ".so"
|
return filepath.Join(id.Gvk().Group, id.Gvk().Version, id.Gvk().Kind)
|
||||||
}
|
}
|
||||||
|
|
||||||
func execPluginFileName(dir string, id resid.ResId) string {
|
func (l *Loader) loadAndConfigurePlugin(
|
||||||
return filepath.Join(
|
ldr ifc.Loader, res *resource.Resource) (c Configurable, err error) {
|
||||||
dir,
|
if !l.pc.GoEnabled {
|
||||||
id.Gvk().Group, id.Gvk().Version, id.Gvk().Kind)
|
return nil, errors.Errorf(
|
||||||
}
|
"plugins not enabled, but trying to load %s", res.Id())
|
||||||
|
|
||||||
// isExecAvailable checks if an executable is available
|
|
||||||
func isExecAvailable(name string) bool {
|
|
||||||
f, err := os.Stat(name)
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
return false
|
|
||||||
}
|
}
|
||||||
return f.Mode()&0111 != 0000
|
if p := NewExecPlugin(l.pc.DirectoryPath, res.Id()); p.isAvailable() {
|
||||||
}
|
c = p
|
||||||
|
|
||||||
func loadAndConfigurePlugin(
|
|
||||||
dir string, id resid.ResId,
|
|
||||||
ldr ifc.Loader,
|
|
||||||
rf *resmap.Factory, res *resource.Resource) (Configurable, error) {
|
|
||||||
var fileName string
|
|
||||||
var c Configurable
|
|
||||||
|
|
||||||
exec := execPluginFileName(dir, id)
|
|
||||||
if isExecAvailable(exec) {
|
|
||||||
c = &ExecPlugin{}
|
|
||||||
} else {
|
} else {
|
||||||
fileName = goPluginFileName(dir, id)
|
c, err = l.loadGoPlugin(res.Id())
|
||||||
goPlugin, err := plugin.Open(fileName)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.Wrapf(err, "plugin %s fails to load", fileName)
|
return nil, err
|
||||||
}
|
|
||||||
symbol, err := goPlugin.Lookup(kplugin.PluginSymbol)
|
|
||||||
if err != nil {
|
|
||||||
return nil, errors.Wrapf(
|
|
||||||
err, "plugin %s doesn't have symbol %s",
|
|
||||||
fileName, kplugin.PluginSymbol)
|
|
||||||
}
|
|
||||||
var ok bool
|
|
||||||
c, ok = symbol.(Configurable)
|
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("plugin %s not configurable", fileName)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
err := c.Config(ldr, rf, res)
|
err = c.Config(ldr, l.rf, res)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.Wrapf(err, "plugin %s fails configuration", fileName)
|
return nil, errors.Wrapf(
|
||||||
|
err, "plugin %s fails configuration", res.Id())
|
||||||
}
|
}
|
||||||
return c, nil
|
return c, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Each test makes its own loader, and tries to load its own plugins,
|
||||||
|
// but the loaded .so files are in shared memory, so one will get
|
||||||
|
// "this plugin already loaded" errors if the registry is maintained
|
||||||
|
// as a Loader instance variable. So make it a package variable.
|
||||||
|
var registry = make(map[string]Configurable)
|
||||||
|
|
||||||
|
func (l *Loader) loadGoPlugin(id resid.ResId) (c Configurable, err error) {
|
||||||
|
var ok bool
|
||||||
|
path := pluginPath(id)
|
||||||
|
if c, ok = registry[path]; ok {
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
name := filepath.Join(l.pc.DirectoryPath, path)
|
||||||
|
p, err := plugin.Open(name + ".so")
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrapf(err, "plugin %s fails to load", name)
|
||||||
|
}
|
||||||
|
symbol, err := p.Lookup(kplugin.PluginSymbol)
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrapf(
|
||||||
|
err, "plugin %s doesn't have symbol %s",
|
||||||
|
name, kplugin.PluginSymbol)
|
||||||
|
}
|
||||||
|
c, ok = symbol.(Configurable)
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf("plugin %s not configurable", name)
|
||||||
|
}
|
||||||
|
registry[path] = c
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ type KustTarget struct {
|
|||||||
ldr ifc.Loader
|
ldr ifc.Loader
|
||||||
rFactory *resmap.Factory
|
rFactory *resmap.Factory
|
||||||
tFactory transformer.Factory
|
tFactory transformer.Factory
|
||||||
pluginConfig *types.PluginConfig
|
pLdr *plugins.Loader
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewKustTarget returns a new instance of KustTarget primed with a Loader.
|
// NewKustTarget returns a new instance of KustTarget primed with a Loader.
|
||||||
@@ -52,7 +52,7 @@ func NewKustTarget(
|
|||||||
ldr ifc.Loader,
|
ldr ifc.Loader,
|
||||||
rFactory *resmap.Factory,
|
rFactory *resmap.Factory,
|
||||||
tFactory transformer.Factory,
|
tFactory transformer.Factory,
|
||||||
pc *types.PluginConfig) (*KustTarget, error) {
|
pLdr *plugins.Loader) (*KustTarget, error) {
|
||||||
content, err := loadKustFile(ldr)
|
content, err := loadKustFile(ldr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -74,7 +74,7 @@ func NewKustTarget(
|
|||||||
ldr: ldr,
|
ldr: ldr,
|
||||||
rFactory: rFactory,
|
rFactory: rFactory,
|
||||||
tFactory: tFactory,
|
tFactory: tFactory,
|
||||||
pluginConfig: pc,
|
pLdr: pLdr,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -240,11 +240,9 @@ func (kt *KustTarget) AccumulateTarget() (
|
|||||||
return nil, errors.Wrap(
|
return nil, errors.Wrap(
|
||||||
err, "merging legacy configMaps and secrets")
|
err, "merging legacy configMaps and secrets")
|
||||||
}
|
}
|
||||||
if kt.pluginConfig.GoEnabled {
|
err = kt.generateFromPlugins(ra)
|
||||||
err := kt.generateFromPlugins(ra)
|
if err != nil {
|
||||||
if err != nil {
|
return nil, err
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
patches, err := kt.rFactory.RF().SliceFromPatches(
|
patches, err := kt.rFactory.RF().SliceFromPatches(
|
||||||
kt.ldr, kt.kustomization.PatchesStrategicMerge)
|
kt.ldr, kt.kustomization.PatchesStrategicMerge)
|
||||||
@@ -328,7 +326,7 @@ func (kt *KustTarget) accumulateDirectory(
|
|||||||
ra *accumulator.ResAccumulator, ldr ifc.Loader, path string) error {
|
ra *accumulator.ResAccumulator, ldr ifc.Loader, path string) error {
|
||||||
defer ldr.Cleanup()
|
defer ldr.Cleanup()
|
||||||
subKt, err := NewKustTarget(
|
subKt, err := NewKustTarget(
|
||||||
ldr, kt.rFactory, kt.tFactory, kt.pluginConfig)
|
ldr, kt.rFactory, kt.tFactory, kt.pLdr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrapf(err, "couldn't make target for path '%s'", path)
|
return errors.Wrapf(err, "couldn't make target for path '%s'", path)
|
||||||
}
|
}
|
||||||
@@ -403,14 +401,11 @@ func (kt *KustTarget) newTransformer(
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
r = append(r, t)
|
r = append(r, t)
|
||||||
|
tp, err := kt.loadTransformerPlugins()
|
||||||
if kt.pluginConfig.GoEnabled {
|
if err != nil {
|
||||||
tp, err := kt.loadTransformerPlugins()
|
return nil, err
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
r = append(r, tp...)
|
|
||||||
}
|
}
|
||||||
|
r = append(r, tp...)
|
||||||
return transformers.NewMultiTransformer(r), nil
|
return transformers.NewMultiTransformer(r), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -420,8 +415,7 @@ func (kt *KustTarget) loadTransformerPlugins() ([]transformers.Transformer, erro
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
return plugins.NewTransformerLoader(
|
return kt.pLdr.LoadTransformers(kt.ldr, ra.ResMap())
|
||||||
kt.pluginConfig, kt.ldr, kt.rFactory).Load(ra.ResMap())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (kt *KustTarget) loadGeneratorPlugins() ([]transformers.Generator, error) {
|
func (kt *KustTarget) loadGeneratorPlugins() ([]transformers.Generator, error) {
|
||||||
@@ -430,6 +424,5 @@ func (kt *KustTarget) loadGeneratorPlugins() ([]transformers.Generator, error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
return plugins.NewGeneratorLoader(
|
return kt.pLdr.LoadGenerators(kt.ldr, ra.ResMap())
|
||||||
kt.pluginConfig, kt.ldr, kt.rFactory).Load(ra.ResMap())
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -23,7 +23,6 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
|
|
||||||
"sigs.k8s.io/kustomize/pkg/gvk"
|
"sigs.k8s.io/kustomize/pkg/gvk"
|
||||||
"sigs.k8s.io/kustomize/pkg/ifc"
|
"sigs.k8s.io/kustomize/pkg/ifc"
|
||||||
"sigs.k8s.io/kustomize/pkg/internal/loadertest"
|
"sigs.k8s.io/kustomize/pkg/internal/loadertest"
|
||||||
@@ -206,8 +205,7 @@ func TestResources(t *testing.T) {
|
|||||||
|
|
||||||
func TestKustomizationNotFound(t *testing.T) {
|
func TestKustomizationNotFound(t *testing.T) {
|
||||||
_, err := NewKustTarget(
|
_, err := NewKustTarget(
|
||||||
loadertest.NewFakeLoader("/foo"),
|
loadertest.NewFakeLoader("/foo"), nil, nil, nil)
|
||||||
nil, nil, plugin.DefaultPluginConfig())
|
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatalf("expected an error")
|
t.Fatalf("expected an error")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ import (
|
|||||||
"sigs.k8s.io/kustomize/pkg/internal/loadertest"
|
"sigs.k8s.io/kustomize/pkg/internal/loadertest"
|
||||||
"sigs.k8s.io/kustomize/pkg/loader"
|
"sigs.k8s.io/kustomize/pkg/loader"
|
||||||
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
"sigs.k8s.io/kustomize/pkg/pgmconfig"
|
||||||
|
"sigs.k8s.io/kustomize/pkg/plugins"
|
||||||
"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/kustomize/pkg/target"
|
. "sigs.k8s.io/kustomize/pkg/target"
|
||||||
@@ -41,7 +42,7 @@ type KustTestHarness struct {
|
|||||||
t *testing.T
|
t *testing.T
|
||||||
rf *resmap.Factory
|
rf *resmap.Factory
|
||||||
ldr loadertest.FakeLoader
|
ldr loadertest.FakeLoader
|
||||||
pc *types.PluginConfig
|
pl *plugins.Loader
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewKustTestHarness(t *testing.T, path string) *KustTestHarness {
|
func NewKustTestHarness(t *testing.T, path string) *KustTestHarness {
|
||||||
@@ -58,18 +59,19 @@ func NewKustTestHarnessWithPluginConfig(
|
|||||||
func NewKustTestHarnessFull(
|
func NewKustTestHarnessFull(
|
||||||
t *testing.T, path string,
|
t *testing.T, path string,
|
||||||
lr loader.LoadRestrictorFunc, pc *types.PluginConfig) *KustTestHarness {
|
lr loader.LoadRestrictorFunc, pc *types.PluginConfig) *KustTestHarness {
|
||||||
|
rf := resmap.NewFactory(resource.NewFactory(
|
||||||
|
kunstruct.NewKunstructuredFactoryWithGeneratorArgs(
|
||||||
|
&types.GeneratorMetaArgs{PluginConfig: pc})))
|
||||||
return &KustTestHarness{
|
return &KustTestHarness{
|
||||||
t: t,
|
t: t,
|
||||||
rf: resmap.NewFactory(resource.NewFactory(
|
rf: rf,
|
||||||
kunstruct.NewKunstructuredFactoryWithGeneratorArgs(
|
|
||||||
&types.GeneratorMetaArgs{PluginConfig: pc}))),
|
|
||||||
ldr: loadertest.NewFakeLoaderWithRestrictor(lr, path),
|
ldr: loadertest.NewFakeLoaderWithRestrictor(lr, path),
|
||||||
pc: pc}
|
pl: plugins.NewLoader(pc, rf)}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (th *KustTestHarness) makeKustTarget() *KustTarget {
|
func (th *KustTestHarness) makeKustTarget() *KustTarget {
|
||||||
kt, err := NewKustTarget(
|
kt, err := NewKustTarget(
|
||||||
th.ldr, th.rf, transformer.NewFactoryImpl(), th.pc)
|
th.ldr, th.rf, transformer.NewFactoryImpl(), th.pl)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
th.t.Fatalf("Unexpected construction error %v", err)
|
th.t.Fatalf("Unexpected construction error %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -42,8 +42,7 @@ func writeStringPrefixer(th *KustTestHarness, path string) {
|
|||||||
apiVersion: someteam.example.com/v1
|
apiVersion: someteam.example.com/v1
|
||||||
kind: StringPrefixer
|
kind: StringPrefixer
|
||||||
metadata:
|
metadata:
|
||||||
name: myStringPrefixer
|
name: apple
|
||||||
prefix: apple-
|
|
||||||
`)
|
`)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -52,7 +51,7 @@ func writeDatePrefixer(th *KustTestHarness, path string) {
|
|||||||
apiVersion: someteam.example.com/v1
|
apiVersion: someteam.example.com/v1
|
||||||
kind: DatePrefixer
|
kind: DatePrefixer
|
||||||
metadata:
|
metadata:
|
||||||
name: myDatePrefixer
|
name: irrelevant
|
||||||
`)
|
`)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -73,7 +72,11 @@ resources:
|
|||||||
- deployment.yaml
|
- deployment.yaml
|
||||||
transformers:
|
transformers:
|
||||||
- stringPrefixer.yaml
|
- stringPrefixer.yaml
|
||||||
|
# - datePrefixer.yaml
|
||||||
`)
|
`)
|
||||||
|
// TODO(monopole): assure ordering of loaded
|
||||||
|
// transformers and this will work - the trouble
|
||||||
|
// is we load into a map (ResMap), not a list.
|
||||||
writeDeployment(th, "/app/deployment.yaml")
|
writeDeployment(th, "/app/deployment.yaml")
|
||||||
writeStringPrefixer(th, "/app/stringPrefixer.yaml")
|
writeStringPrefixer(th, "/app/stringPrefixer.yaml")
|
||||||
writeDatePrefixer(th, "/app/datePrefixer.yaml")
|
writeDatePrefixer(th, "/app/datePrefixer.yaml")
|
||||||
@@ -144,7 +147,16 @@ metadata:
|
|||||||
`)
|
`)
|
||||||
}
|
}
|
||||||
|
|
||||||
func xTestTransformedTransformers(t *testing.T) {
|
func TestTransformedTransformers(t *testing.T) {
|
||||||
|
tc := NewTestEnvController(t).Set()
|
||||||
|
defer tc.Reset()
|
||||||
|
|
||||||
|
tc.BuildGoPlugin(
|
||||||
|
"someteam.example.com", "v1", "StringPrefixer")
|
||||||
|
|
||||||
|
tc.BuildGoPlugin(
|
||||||
|
"someteam.example.com", "v1", "DatePrefixer")
|
||||||
|
|
||||||
th := NewKustTestHarnessWithPluginConfig(
|
th := NewKustTestHarnessWithPluginConfig(
|
||||||
t, "/app/overlay", plugin.ActivePluginConfig())
|
t, "/app/overlay", plugin.ActivePluginConfig())
|
||||||
|
|
||||||
@@ -170,6 +182,18 @@ transformers:
|
|||||||
t.Fatalf("Err: %v", err)
|
t.Fatalf("Err: %v", err)
|
||||||
}
|
}
|
||||||
th.assertActualEqualsExpected(m, `
|
th.assertActualEqualsExpected(m, `
|
||||||
HEY
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: 2018-05-11-apple-myDeployment
|
||||||
|
spec:
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
backend: awesome
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- image: whatever
|
||||||
|
name: whatever
|
||||||
`)
|
`)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,8 +3,6 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"time"
|
|
||||||
|
|
||||||
"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"
|
||||||
@@ -20,9 +18,17 @@ func (p *plugin) Config(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Returns a constant, rather than
|
||||||
|
// time.Now().Format("2006-01-02")
|
||||||
|
// to make tests happy.
|
||||||
|
// This is just an example.
|
||||||
|
func getDate() string {
|
||||||
|
return "2018-05-11"
|
||||||
|
}
|
||||||
|
|
||||||
func (p *plugin) Transform(m resmap.ResMap) error {
|
func (p *plugin) Transform(m resmap.ResMap) error {
|
||||||
tr, err := transformers.NewNamePrefixSuffixTransformer(
|
tr, err := transformers.NewNamePrefixSuffixTransformer(
|
||||||
time.Now().Format("2006-01-02")+"-", "",
|
getDate()+"-", "",
|
||||||
config.MakeDefaultConfig().NamePrefix)
|
config.MakeDefaultConfig().NamePrefix)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
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"
|
||||||
@@ -26,11 +27,11 @@ 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, k ifc.Kunstructured) error {
|
||||||
var err error
|
name := k.GetName()
|
||||||
p.prefix, err = k.GetFieldValue("prefix")
|
if name == "" {
|
||||||
if err != nil {
|
return fmt.Errorf("name cannot be empty")
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
p.prefix = name + "-"
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user