docs: update drone docs.

* feat(tar): add Overwrite flag

* chore: remove

* chore: output

* chore: output

.drone.yml

@@ -351,13 +351,6 @@ steps:
     username:
       from_secret: docker_username
 
-- name: microbadger
-  pull: always
-  image: plugins/webhook:1
-  settings:
-    url:
-      from_secret: microbadger_url
-
 trigger:
   ref:
   - refs/heads/master

DOCS.md

@@ -223,6 +223,15 @@ command_timeout
 strip_components
 : remove the specified number of leading path elements
 
+tar_tmp_path
+: temporary path for tar file on the dest host
+
+tar_exec
+: alternative `tar` executable to on the dest host
+
+overwrite
+: use `--overwrite` flag with tar
+
 proxy_host
 : proxy hostname or IP
 

main.go

@@ -193,11 +193,21 @@ func main() {
 			EnvVar: "PLUGIN_TAR_EXEC,SCP_TAR_EXEC,INPUT_TAR_EXEC",
 			Value:  "tar",
 		},
+		cli.StringFlag{
+			Name:   "tar.tmp-path",
+			Usage:  "Temporary path for tar file on the dest host",
+			EnvVar: "PLUGIN_TAR_TMP_PATH,SCP_TAR_TMP_PATH",
+		},
 		cli.BoolFlag{
 			Name:   "debug",
 			Usage:  "remove target folder before upload data",
 			EnvVar: "PLUGIN_DEBUG,DEBUG,INPUT_DEBUG",
 		},
+		cli.BoolFlag{
+			Name:   "overwrite",
+			Usage:  "use --overwrite flag with tar",
+			EnvVar: "PLUGIN_OVERWRITE,SCP_OVERWRITE,INPUT_OVERWRITE",
+		},
 	}
 
 	// Override a template
@@ -273,6 +283,8 @@ func run(c *cli.Context) error {
 			Debug:           c.Bool("debug"),
 			StripComponents: c.Int("strip.components"),
 			TarExec:         c.String("tar.exec"),
+			TarTmpPath:      c.String("tar.tmp-path"),
+			Overwrite:       c.Bool("overwrite"),
 			Proxy: easyssh.DefaultConfig{
 				Key:      c.String("proxy.ssh-key"),
 				KeyPath:  c.String("proxy.key-path"),

pipeline.libsonnet

@@ -239,14 +239,6 @@
           ignore_missing: true,
         },
       },
-      {
-        name: 'microbadger',
-        image: 'plugins/webhook:1',
-        pull: 'always',
-        settings: {
-          url: { 'from_secret': 'microbadger_url' },
-        },
-      },
     ],
     depends_on: depends_on,
     trigger: {

plugin.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"sync"
 	"time"
@@ -57,8 +58,10 @@ type (
 		Remove          bool
 		StripComponents int
 		TarExec         string
+		TarTmpPath      string
 		Proxy           easyssh.DefaultConfig
 		Debug           bool
+		Overwrite       bool
 	}
 
 	// Plugin values.
@@ -194,6 +197,32 @@ type fileList struct {
 	Source []string
 }
 
+func (p *Plugin) buildArgs(target string) []string {
+	args := []string{}
+
+	args = append(args,
+		p.Config.TarExec,
+		"-xf",
+		p.DestFile,
+	)
+
+	if p.Config.StripComponents > 0 {
+		args = append(args, "--strip-components")
+		args = append(args, strconv.Itoa(p.Config.StripComponents))
+	}
+
+	if p.Config.Overwrite {
+		args = append(args, "--overwrite")
+	}
+
+	args = append(args,
+		"-C",
+		target,
+	)
+
+	return args
+}
+
 // Exec executes the plugin.
 func (p *Plugin) Exec() error {
 	if len(p.Config.Host) == 0 {
@@ -261,6 +290,9 @@ func (p *Plugin) Exec() error {
 				},
 			}
 
+			// upload file to the tmp path
+			p.DestFile = fmt.Sprintf("%s%s", p.Config.TarTmpPath, p.DestFile)
+
 			// Call Scp method with file you want to upload to remote server.
 			p.log(host, "scp file to server.")
 			err := ssh.Scp(tar, p.DestFile)
@@ -298,10 +330,18 @@ func (p *Plugin) Exec() error {
 
 				// untar file
 				p.log(host, "untar file", p.DestFile)
-				if p.Config.StripComponents > 0 {
-					_, _, _, err = ssh.Run(fmt.Sprintf("%s -xf %s --strip-components=%d -C %s", p.Config.TarExec, p.DestFile, p.Config.StripComponents, target), p.Config.CommandTimeout)
-				} else {
-					_, _, _, err = ssh.Run(fmt.Sprintf("%s -xf %s -C %s", p.Config.TarExec, p.DestFile, target), p.Config.CommandTimeout)
+				commamd := strings.Join(p.buildArgs(target), " ")
+				if p.Config.Debug {
+					fmt.Println("$", commamd)
+				}
+				outStr, errStr, _, err := ssh.Run(commamd, p.Config.CommandTimeout)
+
+				if outStr != "" {
+					p.log(host, "output: ", outStr)
+				}
+
+				if errStr != "" {
+					p.log(host, "error: ", errStr)
 				}
 
 				if err != nil {

plugin_test.go

@@ -5,6 +5,7 @@ import (
 	"os/exec"
 	"os/user"
 	"path/filepath"
+	"reflect"
 	"testing"
 	"time"
 
@@ -267,6 +268,7 @@ func TestIgnoreList(t *testing.T) {
 			Target:          []string{filepath.Join(u.HomeDir, "ignore")},
 			CommandTimeout:  60 * time.Second,
 			TarExec:         "tar",
+			Debug:           true,
 		},
 	}
 
@@ -456,3 +458,79 @@ func TestRemoveDestFile(t *testing.T) {
 	err = plugin.removeDestFile(ssh)
 	assert.Error(t, err)
 }
+
+func TestPlugin_buildArgs(t *testing.T) {
+	type fields struct {
+		Repo     Repo
+		Build    Build
+		Config   Config
+		DestFile string
+	}
+	type args struct {
+		target string
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		args   args
+		want   []string
+	}{
+		{
+			name: "default command",
+			fields: fields{
+				Config: Config{
+					Overwrite: false,
+					TarExec:   "tar",
+				},
+				DestFile: "foo.tar",
+			},
+			args: args{
+				target: "foo",
+			},
+			want: []string{"tar", "-xf", "foo.tar", "-C", "foo"},
+		},
+		{
+			name: "strip components",
+			fields: fields{
+				Config: Config{
+					Overwrite:       false,
+					TarExec:         "tar",
+					StripComponents: 2,
+				},
+				DestFile: "foo.tar",
+			},
+			args: args{
+				target: "foo",
+			},
+			want: []string{"tar", "-xf", "foo.tar", "--strip-components", "2", "-C", "foo"},
+		},
+		{
+			name: "overwrite",
+			fields: fields{
+				Config: Config{
+					TarExec:         "tar",
+					StripComponents: 2,
+					Overwrite:       true,
+				},
+				DestFile: "foo.tar",
+			},
+			args: args{
+				target: "foo",
+			},
+			want: []string{"tar", "-xf", "foo.tar", "--strip-components", "2", "--overwrite", "-C", "foo"},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			p := &Plugin{
+				Repo:     tt.fields.Repo,
+				Build:    tt.fields.Build,
+				Config:   tt.fields.Config,
+				DestFile: tt.fields.DestFile,
+			}
+			if got := p.buildArgs(tt.args.target); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("Plugin.buildArgs() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}