msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

fix gofmt

Browse Source 
Signed-off-by: zetHannes <zetHannes@outlook.com>
pull/10979/head
zetHannes 3 years ago
parent ed02e8e826
commit 523d0a08be
1 changed files with 185 additions and 185 deletions
Show Stats Download Patch File Download Diff File

368
pkg/plugin/plugin.go
Unescape View File

@ -16,19 +16,19 @@ limitations under the License.
package plugin // import "helm.sh/helm/v3/pkg/plugin" package plugin // import "helm.sh/helm/v3/pkg/plugin"
import ( import (
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"os" "os"
"path/filepath" "path/filepath"
"regexp" "regexp"
"runtime" "runtime"
"strings" "strings"
"unicode" "unicode"
"github.com/pkg/errors" "github.com/pkg/errors"
"sigs.k8s.io/yaml" "sigs.k8s.io/yaml"
"helm.sh/helm/v3/pkg/cli" "helm.sh/helm/v3/pkg/cli"
) )
const PluginFileName = "plugin.yaml" const PluginFileName = "plugin.yaml"
@ -36,81 +36,81 @@ const PluginFileName = "plugin.yaml"
// Downloaders represents the plugins capability if it can retrieve // Downloaders represents the plugins capability if it can retrieve
// charts from special sources // charts from special sources
type Downloaders struct { type Downloaders struct {
// Protocols are the list of schemes from the charts URL. // Protocols are the list of schemes from the charts URL.
Protocols []string `json:"protocols"` Protocols []string `json:"protocols"`
// Command is the executable path with which the plugin performs // Command is the executable path with which the plugin performs
// the actual download for the corresponding Protocols // the actual download for the corresponding Protocols
Command string `json:"command"` Command string `json:"command"`
} }
// PlatformCommand represents a command for a particular operating system and architecture // PlatformCommand represents a command for a particular operating system and architecture
type PlatformCommand struct { type PlatformCommand struct {
OperatingSystem string `json:"os"` OperatingSystem string `json:"os"`
Architecture string `json:"arch"` Architecture string `json:"arch"`
Command string `json:"command"` Command string `json:"command"`
} }
// Metadata describes a plugin. // Metadata describes a plugin.
// //
// This is the plugin equivalent of a chart.Metadata. // This is the plugin equivalent of a chart.Metadata.
type Metadata struct { type Metadata struct {
// Name is the name of the plugin // Name is the name of the plugin
Name string `json:"name"` Name string `json:"name"`
// Version is a SemVer 2 version of the plugin. // Version is a SemVer 2 version of the plugin.
Version string `json:"version"` Version string `json:"version"`
// Usage is the single-line usage text shown in help // Usage is the single-line usage text shown in help
Usage string `json:"usage"` Usage string `json:"usage"`
// Description is a long description shown in places like `helm help` // Description is a long description shown in places like `helm help`
Description string `json:"description"` Description string `json:"description"`
// Command is the command, as a single string. // Command is the command, as a single string.
// //
// The command will be passed through environment expansion, so env vars can // The command will be passed through environment expansion, so env vars can
// be present in this command. Unless IgnoreFlags is set, this will // be present in this command. Unless IgnoreFlags is set, this will
// also merge the flags passed from Helm. // also merge the flags passed from Helm.
// //
// Note that command is not executed in a shell. To do so, we suggest // Note that command is not executed in a shell. To do so, we suggest
// pointing the command to a shell script. // pointing the command to a shell script.
// //
// The following rules will apply to processing commands: // The following rules will apply to processing commands:
// - If platformCommand is present, it will be searched first // - If platformCommand is present, it will be searched first
// - If both OS and Arch match the current platform, search will stop and the command will be executed // - If both OS and Arch match the current platform, search will stop and the command will be executed
// - If OS matches and there is no more specific match, the command will be executed // - If OS matches and there is no more specific match, the command will be executed
// - If no OS/Arch match is found, the default command will be executed // - If no OS/Arch match is found, the default command will be executed
// - If no command is present and no matches are found in platformCommand, Helm will exit with an error // - If no command is present and no matches are found in platformCommand, Helm will exit with an error
PlatformCommand []PlatformCommand `json:"platformCommand"` PlatformCommand []PlatformCommand `json:"platformCommand"`
Command string `json:"command"` Command string `json:"command"`
// IgnoreFlags ignores any flags passed in from Helm // IgnoreFlags ignores any flags passed in from Helm
// //
// For example, if the plugin is invoked as `helm --debug myplugin`, if this // For example, if the plugin is invoked as `helm --debug myplugin`, if this
// is false, `--debug` will be appended to `--command`. If this is true, // is false, `--debug` will be appended to `--command`. If this is true,
// the `--debug` flag will be discarded. // the `--debug` flag will be discarded.
IgnoreFlags bool `json:"ignoreFlags"` IgnoreFlags bool `json:"ignoreFlags"`
// Hooks are commands that will run on events. // Hooks are commands that will run on events.
Hooks Hooks Hooks Hooks
// Downloaders field is used if the plugin supply downloader mechanism // Downloaders field is used if the plugin supply downloader mechanism
// for special protocols. // for special protocols.
Downloaders []Downloaders `json:"downloaders"` Downloaders []Downloaders `json:"downloaders"`
// UseTunnelDeprecated indicates that this command needs a tunnel. // UseTunnelDeprecated indicates that this command needs a tunnel.
// Setting this will cause a number of side effects, such as the // Setting this will cause a number of side effects, such as the
// automatic setting of HELM_HOST. // automatic setting of HELM_HOST.
// DEPRECATED and unused, but retained for backwards compatibility with Helm 2 plugins. Remove in Helm 4 // DEPRECATED and unused, but retained for backwards compatibility with Helm 2 plugins. Remove in Helm 4
UseTunnelDeprecated bool `json:"useTunnel,omitempty"` UseTunnelDeprecated bool `json:"useTunnel,omitempty"`
} }
// Plugin represents a plugin. // Plugin represents a plugin.
type Plugin struct { type Plugin struct {
// Metadata is a parsed representation of a plugin.yaml // Metadata is a parsed representation of a plugin.yaml
Metadata *Metadata Metadata *Metadata
// Dir is the string path to the directory that holds the plugin. // Dir is the string path to the directory that holds the plugin.
Dir string Dir string
} }
// The following rules will apply to processing the Plugin.PlatformCommand.Command: // The following rules will apply to processing the Plugin.PlatformCommand.Command:
@ -118,17 +118,17 @@ type Plugin struct {
// - If OS matches and there is no more specific match, the command will be prepared for execution // - If OS matches and there is no more specific match, the command will be prepared for execution
// - If no OS/Arch match is found, return nil // - If no OS/Arch match is found, return nil
func getPlatformCommand(cmds []PlatformCommand) []string { func getPlatformCommand(cmds []PlatformCommand) []string {
var command []string var command []string
eq := strings.EqualFold eq := strings.EqualFold
for _, c := range cmds { for _, c := range cmds {
if eq(c.OperatingSystem, runtime.GOOS) { if eq(c.OperatingSystem, runtime.GOOS) {
command = strings.Split(os.ExpandEnv(c.Command), " ") command = strings.Split(os.ExpandEnv(c.Command), " ")
} }
if eq(c.OperatingSystem, runtime.GOOS) && eq(c.Architecture, runtime.GOARCH) { if eq(c.OperatingSystem, runtime.GOOS) && eq(c.Architecture, runtime.GOARCH) {
return strings.Split(os.ExpandEnv(c.Command), " ") return strings.Split(os.ExpandEnv(c.Command), " ")
} }
} }
return command return command
} }
// PrepareCommand takes a Plugin.PlatformCommand.Command, a Plugin.Command and will applying the following processing: // PrepareCommand takes a Plugin.PlatformCommand.Command, a Plugin.Command and will applying the following processing:
@ -143,27 +143,27 @@ func getPlatformCommand(cmds []PlatformCommand) []string {
// //
// The result is suitable to pass to exec.Command. // The result is suitable to pass to exec.Command.
func (p *Plugin) PrepareCommand(extraArgs []string) (string, []string, error) { func (p *Plugin) PrepareCommand(extraArgs []string) (string, []string, error) {
var parts []string var parts []string
platCmdLen := len(p.Metadata.PlatformCommand) platCmdLen := len(p.Metadata.PlatformCommand)
if platCmdLen > 0 { if platCmdLen > 0 {
parts = getPlatformCommand(p.Metadata.PlatformCommand) parts = getPlatformCommand(p.Metadata.PlatformCommand)
} }
if platCmdLen == 0 || parts == nil { if platCmdLen == 0 || parts == nil {
parts = strings.Split(os.ExpandEnv(p.Metadata.Command), " ") parts = strings.Split(os.ExpandEnv(p.Metadata.Command), " ")
} }
if len(parts) == 0 || parts[0] == "" { if len(parts) == 0 || parts[0] == "" {
return "", nil, fmt.Errorf("no plugin command is applicable") return "", nil, fmt.Errorf("no plugin command is applicable")
} }
main := parts[0] main := parts[0]
baseArgs := []string{} baseArgs := []string{}
if len(parts) > 1 { if len(parts) > 1 {
baseArgs = parts[1:] baseArgs = parts[1:]
} }
if !p.Metadata.IgnoreFlags { if !p.Metadata.IgnoreFlags {
baseArgs = append(baseArgs, extraArgs...) baseArgs = append(baseArgs, extraArgs...)
} }
return main, baseArgs, nil return main, baseArgs, nil
} }
// validPluginName is a regular expression that validates plugin names. // validPluginName is a regular expression that validates plugin names.
@ -173,110 +173,110 @@ var validPluginName = regexp.MustCompile("^[A-Za-z0-9_-]+$")
// validatePluginData validates a plugin's YAML data. // validatePluginData validates a plugin's YAML data.
func validatePluginData(plug *Plugin, filepath string) error { func validatePluginData(plug *Plugin, filepath string) error {
if !validPluginName.MatchString(plug.Metadata.Name) { if !validPluginName.MatchString(plug.Metadata.Name) {
return fmt.Errorf("invalid plugin name at %q", filepath) return fmt.Errorf("invalid plugin name at %q", filepath)
} }
plug.Metadata.Usage = sanitizeString(plug.Metadata.Usage) plug.Metadata.Usage = sanitizeString(plug.Metadata.Usage)
// We could also validate SemVer, executable, and other fields should we so choose. // We could also validate SemVer, executable, and other fields should we so choose.
return nil return nil
} }
// sanitizeString normalize spaces and removes non-printable characters. // sanitizeString normalize spaces and removes non-printable characters.
func sanitizeString(str string) string { func sanitizeString(str string) string {
return strings.Map(func(r rune) rune { return strings.Map(func(r rune) rune {
if unicode.IsSpace(r) { if unicode.IsSpace(r) {
return ' ' return ' '
} }
if unicode.IsPrint(r) { if unicode.IsPrint(r) {
return r return r
} }
return -1 return -1
}, str) }, str)
} }
func detectDuplicates(plugs []*Plugin) error { func detectDuplicates(plugs []*Plugin) error {
names := map[string]string{} names := map[string]string{}
for _, plug := range plugs { for _, plug := range plugs {
if oldpath, ok := names[plug.Metadata.Name]; ok { if oldpath, ok := names[plug.Metadata.Name]; ok {
return fmt.Errorf( return fmt.Errorf(
"two plugins claim the name %q at %q and %q", "two plugins claim the name %q at %q and %q",
plug.Metadata.Name, plug.Metadata.Name,
oldpath, oldpath,
plug.Dir, plug.Dir,
) )
} }
names[plug.Metadata.Name] = plug.Dir names[plug.Metadata.Name] = plug.Dir
} }
return nil return nil
} }
// LoadDir loads a plugin from the given directory. // LoadDir loads a plugin from the given directory.
func LoadDir(dirname string) (*Plugin, error) { func LoadDir(dirname string) (*Plugin, error) {
pluginfile := filepath.Join(dirname, PluginFileName) pluginfile := filepath.Join(dirname, PluginFileName)
data, err := ioutil.ReadFile(pluginfile) data, err := ioutil.ReadFile(pluginfile)
if err != nil { if err != nil {
return nil, errors.Wrapf(err, "failed to read plugin at %q", pluginfile) return nil, errors.Wrapf(err, "failed to read plugin at %q", pluginfile)
} }
plug := &Plugin{Dir: dirname} plug := &Plugin{Dir: dirname}
if err := yaml.UnmarshalStrict(data, &plug.Metadata); err != nil { if err := yaml.UnmarshalStrict(data, &plug.Metadata); err != nil {
return nil, errors.Wrapf(err, "failed to load plugin at %q", pluginfile) return nil, errors.Wrapf(err, "failed to load plugin at %q", pluginfile)
} }
return plug, validatePluginData(plug, pluginfile) return plug, validatePluginData(plug, pluginfile)
} }
// LoadAll loads all plugins found beneath the base directory. // LoadAll loads all plugins found beneath the base directory.
// //
// This scans only one directory level. // This scans only one directory level.
func LoadAll(basedir string) ([]*Plugin, error) { func LoadAll(basedir string) ([]*Plugin, error) {
plugins := []*Plugin{} plugins := []*Plugin{}
// We want basedir/*/plugin.yaml // We want basedir/*/plugin.yaml
scanpath := filepath.Join(basedir, "*", PluginFileName) scanpath := filepath.Join(basedir, "*", PluginFileName)
matches, err := filepath.Glob(scanpath) matches, err := filepath.Glob(scanpath)
if err != nil { if err != nil {
return plugins, errors.Wrapf(err, "failed to find plugins in %q", scanpath) return plugins, errors.Wrapf(err, "failed to find plugins in %q", scanpath)
} }
if matches == nil { if matches == nil {
return plugins, nil return plugins, nil
} }
for _, yaml := range matches { for _, yaml := range matches {
dir := filepath.Dir(yaml) dir := filepath.Dir(yaml)
p, err := LoadDir(dir) p, err := LoadDir(dir)
if err != nil { if err != nil {
return plugins, err return plugins, err
} }
plugins = append(plugins, p) plugins = append(plugins, p)
} }
return plugins, detectDuplicates(plugins) return plugins, detectDuplicates(plugins)
} }
// FindPlugins returns a list of YAML files that describe plugins. // FindPlugins returns a list of YAML files that describe plugins.
func FindPlugins(plugdirs string) ([]*Plugin, error) { func FindPlugins(plugdirs string) ([]*Plugin, error) {
found := []*Plugin{} found := []*Plugin{}
// Let's get all UNIXy and allow path separators // Let's get all UNIXy and allow path separators
for _, p := range filepath.SplitList(plugdirs) { for _, p := range filepath.SplitList(plugdirs) {
matches, err := LoadAll(p) matches, err := LoadAll(p)
if err != nil { if err != nil {
return matches, err return matches, err
} }
found = append(found, matches...) found = append(found, matches...)
} }
return found, nil return found, nil
} }
// SetupPluginEnv prepares os.Env for plugins. It operates on os.Env because // SetupPluginEnv prepares os.Env for plugins. It operates on os.Env because
// the plugin subsystem itself needs access to the environment variables // the plugin subsystem itself needs access to the environment variables
// created here. // created here.
func SetupPluginEnv(settings *cli.EnvSettings, name, base string) { func SetupPluginEnv(settings *cli.EnvSettings, name, base string) {
env := settings.EnvVars() env := settings.EnvVars()
env["HELM_PLUGIN_NAME"] = name env["HELM_PLUGIN_NAME"] = name
env["HELM_PLUGIN_DIR"] = base env["HELM_PLUGIN_DIR"] = base
for key, val := range env { for key, val := range env {
os.Setenv(key, val) os.Setenv(key, val)
} }
} }
Write Preview
Loading…
Cancel
Save