Files
kustomize/pkg/plugins/transformers.go
2019-04-09 15:42:08 -07:00

126 lines
3.2 KiB
Go

/*
Copyright 2019 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 plugins
import (
"fmt"
"os"
"path/filepath"
"plugin"
"runtime"
"github.com/pkg/errors"
kplugin "sigs.k8s.io/kustomize/k8sdeps/kv/plugin"
"sigs.k8s.io/kustomize/pkg/ifc"
"sigs.k8s.io/kustomize/pkg/resid"
"sigs.k8s.io/kustomize/pkg/resmap"
"sigs.k8s.io/kustomize/pkg/resource"
"sigs.k8s.io/kustomize/pkg/transformers"
"sigs.k8s.io/kustomize/pkg/types"
)
type Configurable interface {
Config(ldr ifc.Loader, rf *resmap.Factory, k ifc.Kunstructured) error
}
type transformerLoader struct {
pc *types.PluginConfig
ldr ifc.Loader
rf *resmap.Factory
}
func NewTransformerLoader(
pc *types.PluginConfig,
ldr ifc.Loader, rf *resmap.Factory) transformerLoader {
return transformerLoader{pc: pc, ldr: ldr, rf: rf}
}
func (l transformerLoader) Load(
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
for id, res := range rm {
c, err := loadAndConfigurePlugin(l.pc.DirectoryPath, id, l.ldr, l.rf, res)
if err != nil {
return nil, err
}
t, ok := c.(transformers.Transformer)
if !ok {
return nil, fmt.Errorf("plugin %s not a transformer", id.String())
}
result = append(result, t)
}
return result, nil
}
func goPluginFileName(dir string, id resid.ResId) string {
return execPluginFileName(dir, id) + ".so"
}
func execPluginFileName(dir string, id resid.ResId) string {
return filepath.Join(
dir,
id.Gvk().Group, id.Gvk().Version, id.Gvk().Kind)
}
// 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
}
func loadAndConfigurePlugin(
dir string, id resid.ResId,
ldr ifc.Loader,
rf *resmap.Factory, res *resource.Resource) (Configurable, error) {
var fileName string
exec := execPluginFileName(dir, id)
if isExecAvailable(exec) {
_, f, _, _ := runtime.Caller(1)
fileName = filepath.Join(filepath.Dir(f), "builtin", "executable.so")
} else {
fileName = goPluginFileName(dir, id)
}
goPlugin, err := plugin.Open(fileName)
if err != nil {
return nil, errors.Wrapf(err, "plugin %s fails to load", fileName)
}
symbol, err := goPlugin.Lookup(kplugin.PluginSymbol)
if err != nil {
return nil, errors.Wrapf(
err, "plugin %s doesn't have symbol %s",
fileName, kplugin.PluginSymbol)
}
c, ok := symbol.(Configurable)
if !ok {
return nil, fmt.Errorf("plugin %s not configurable", fileName)
}
err = c.Config(ldr, rf, res)
if err != nil {
return nil, errors.Wrapf(err, "plugin %s fails configuration", fileName)
}
return c, nil
}