Allow overwriting plugin output with command's stdout

derailed · Mar 27, 2024 · dc47063 · dc47063
1 parent d3027c8
commit dc47063
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 28 deletions.
diff --git a/internal/config/json/schemas/plugins.json b/internal/config/json/schemas/plugins.json
@@ -21,6 +21,7 @@
           },
           "command": { "type": "string" },
           "background": { "type": "boolean" },
+          "overwriteOutput": { "type": "boolean" },
           "args": {
             "type": "array",
             "items": { "type": ["string", "number"] }

diff --git a/internal/config/plugin.go b/internal/config/plugin.go
@@ -27,16 +27,17 @@ type Plugins struct {
 
 // Plugin describes a K9s plugin.
 type Plugin struct {
-	Scopes      []string `yaml:"scopes"`
-	Args        []string `yaml:"args"`
-	ShortCut    string   `yaml:"shortCut"`
-	Override    bool     `yaml:"override"`
-	Pipes       []string `yaml:"pipes"`
-	Description string   `yaml:"description"`
-	Command     string   `yaml:"command"`
-	Confirm     bool     `yaml:"confirm"`
-	Background  bool     `yaml:"background"`
-	Dangerous   bool     `yaml:"dangerous"`
+	Scopes          []string `yaml:"scopes"`
+	Args            []string `yaml:"args"`
+	ShortCut        string   `yaml:"shortCut"`
+	Override        bool     `yaml:"override"`
+	Pipes           []string `yaml:"pipes"`
+	Description     string   `yaml:"description"`
+	Command         string   `yaml:"command"`
+	Confirm         bool     `yaml:"confirm"`
+	Background      bool     `yaml:"background"`
+	Dangerous       bool     `yaml:"dangerous"`
+	OverwriteOutput bool     `yaml:"overwriteOutput"`
 }
 
 func (p Plugin) String() string {

diff --git a/internal/config/plugin_test.go b/internal/config/plugin_test.go
@@ -22,23 +22,25 @@ var pluginYmlTestData = Plugin{
 }
 
 var test1YmlTestData = Plugin{
-	Scopes:      []string{"po", "dp"},
-	Args:        []string{"-n", "$NAMESPACE", "-boolean"},
-	ShortCut:    "shift-s",
-	Description: "blee",
-	Command:     "duh",
-	Confirm:     true,
-	Background:  false,
+	Scopes:          []string{"po", "dp"},
+	Args:            []string{"-n", "$NAMESPACE", "-boolean"},
+	ShortCut:        "shift-s",
+	Description:     "blee",
+	Command:         "duh",
+	Confirm:         true,
+	Background:      false,
+	OverwriteOutput: true,
 }
 
 var test2YmlTestData = Plugin{
-	Scopes:      []string{"svc", "ing"},
-	Args:        []string{"-n", "$NAMESPACE", "-oyaml"},
-	ShortCut:    "shift-r",
-	Description: "bla",
-	Command:     "duha",
-	Confirm:     false,
-	Background:  true,
+	Scopes:          []string{"svc", "ing"},
+	Args:            []string{"-n", "$NAMESPACE", "-oyaml"},
+	ShortCut:        "shift-r",
+	Description:     "bla",
+	Command:         "duha",
+	Confirm:         false,
+	Background:      true,
+	OverwriteOutput: false,
 }
 
 func TestPluginLoad(t *testing.T) {

diff --git a/internal/view/actions.go b/internal/view/actions.go
@@ -206,7 +206,15 @@ func pluginAction(r Runner, p config.Plugin) ui.ActionHandler {
 			}
 			go func() {
 				for st := range statusChan {
-					r.App().Flash().Infof("Plugin command launched successfully: %q", st)
+					if !p.OverwriteOutput {
+						r.App().Flash().Infof("Plugin command launched successfully: %q", st)
+					} else {
+						if strings.Contains(st, outputPrefix) {
+							infoMsg := strings.TrimPrefix(st, outputPrefix)
+							r.App().Flash().Info(strings.TrimSpace(infoMsg))
+							return
+						}
+					}
 				}
 			}()
 

diff --git a/internal/view/exec.go b/internal/view/exec.go
@@ -34,8 +34,9 @@ import (
 )
 
 const (
-	shellCheck = `command -v bash >/dev/null && exec bash || exec sh`
-	bannerFmt  = "<<K9s-Shell>> Pod: %s | Container: %s \n"
+	shellCheck   = `command -v bash >/dev/null && exec bash || exec sh`
+	bannerFmt    = "<<K9s-Shell>> Pod: %s | Container: %s \n"
+	outputPrefix = "[output]"
 )
 
 var editorEnvVars = []string{"KUBE_EDITOR", "K9S_EDITOR", "EDITOR"}
@@ -492,7 +493,7 @@ func pipe(_ context.Context, opts shellOpts, statusChan chan<- string, w, e *byt
 				} else {
 					for _, l := range strings.Split(w.String(), "\n") {
 						if l != "" {
-							statusChan <- fmt.Sprintf("[output] %s", l)
+							statusChan <- fmt.Sprintf("%s %s", outputPrefix, l)
 						}
 					}
 					statusChan <- fmt.Sprintf("Command completed successfully: %q", render.Truncate(cmd.String(), 20))