chore: change command timeout flag (#92 )

* chore: change command timeout flag Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * docs: update setting Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * doc: update readme. Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2026-06-04 18:23:59 +08:00 · 2019-03-07 13:56:40 +08:00
7 changed files with 65 additions and 29 deletions
@@ -146,6 +146,26 @@ pipeline:
        - release/*.tar.gz
 ```

+Example configuration using command timeout:
+
+```diff
+pipeline:
+  scp:
+    image: appleboy/drone-scp
+    settings:
+      host:
+        - example1.com
+        - example2.com
+      user: ubuntu
+      port: 22
+-     command_timeout: 120
+     command_timeout: 2m
+        from_secret: ssh_password
+      target: /home/deploy/web
+      source:
+        - release/*.tar.gz
+```
+
 # Parameter Reference

 host
@@ -175,6 +195,9 @@ rm
 timeout
 : timeout is the maximum amount of time for the TCP connection to establish

+command_timeout
+: timeout is the maximum amount of time for execute command
+
 strip_components
 : remove the specified number of leading path elements

@@ -31,6 +31,28 @@ Copy files and artifacts via SSH using a binary, docker or [Drone CI](http://doc
     192.168.1.5       121.1.2.3         10.10.29.68
 ```

+## Breaking changes
+
+`v1.5.0`: change command timeout flag to `Duration`. See the following setting:
+
+```diff
+pipeline:
+  scp:
+    image: appleboy/drone-scp
+    settings:
+      host:
+        - example1.com
+        - example2.com
+      user: ubuntu
+      port: 22
+-     command_timeout: 120
+     command_timeout: 2m
+        from_secret: ssh_password
+      target: /home/deploy/web
+      source:
+        - release/*.tar.gz
+```
+
 ## Build or Download a binary

 The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/drone-scp/releases). Support the following OS type.
@@ -4,13 +4,11 @@ go 1.12

 require (
 	github.com/appleboy/com v0.0.1
-	github.com/appleboy/easyssh-proxy v0.0.0-20170511070730-14882d1d04ac
-	github.com/fatih/color v1.4.1
+	github.com/appleboy/easyssh-proxy v1.2.0
+	github.com/fatih/color v1.7.0
 	github.com/joho/godotenv v1.3.0
 	github.com/mattn/go-colorable v0.1.1 // indirect
 	github.com/mattn/go-isatty v0.0.6 // indirect
 	github.com/stretchr/testify v1.3.0
 	github.com/urfave/cli v1.20.0
-	golang.org/x/crypto v0.0.0-20170413182223-cbc3d0884eac // indirect
-	golang.org/x/sys v0.0.0-20190302025703-b6889370fb10 // indirect
 )
@@ -1,11 +1,11 @@
 github.com/appleboy/com v0.0.1 h1:SeP6J/YlZGWRwH7jdPYXXWA+qJy4GoQfcQFPda0ERYU=
 github.com/appleboy/com v0.0.1/go.mod h1:rtwjPnHClMOJw4K5oW3ASx9BCPCJ1SDbFbzJjY4Ebqw=
-github.com/appleboy/easyssh-proxy v0.0.0-20170511070730-14882d1d04ac h1:OcOz99ulMMpNqjpRVE8UBqFo5pyRamELU6xZuOR7GJs=
-github.com/appleboy/easyssh-proxy v0.0.0-20170511070730-14882d1d04ac/go.mod h1:bQbHdUQpAmc4Nv22/0slLXWdllbncGfA9ALkPuCe704=
+github.com/appleboy/easyssh-proxy v1.2.0 h1:KvaUGC18WkBFet+N1oofQy03jkC5HaKFn2XGxFxCTtg=
+github.com/appleboy/easyssh-proxy v1.2.0/go.mod h1:vHskChUNhxwW4dXMe2MNE/k+UBCkBagrQDm70UWZrS0=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/fatih/color v1.4.1 h1:YJhD/SoQqn7ev9zwhIm7lHTAqsOAF2AN4xlAVZzNZnU=
-github.com/fatih/color v1.4.1/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
+github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
+github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
 github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
 github.com/mattn/go-colorable v0.1.1 h1:G1f5SKeVxmagw/IyvzvtZE4Gybcc4Tr1tf7I8z0XgOg=
@@ -15,21 +15,12 @@ github.com/mattn/go-isatty v0.0.6 h1:SrwhHcpV4nWrMGdNcC2kXpMfcBVYGDuTArqyhocJgvA
 github.com/mattn/go-isatty v0.0.6/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v0.0.0-20170130113145-4d4bfba8f1d1 h1:Zx8Rp9ozC4FPFxfEKRSUu8+Ay3sZxEUZ7JrCWMbGgvE=
-github.com/stretchr/testify v0.0.0-20170130113145-4d4bfba8f1d1/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/urfave/cli v1.19.1 h1:0mKm4ZoB74PxYmZVua162y1dGt1qc10MyymYRBf3lb8=
-github.com/urfave/cli v1.19.1/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
 github.com/urfave/cli v1.20.0 h1:fDqGv3UG/4jbVl/QkFwEdddtEDjh/5Ov6X+0B/3bPaw=
 github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
-golang.org/x/crypto v0.0.0-20170413182223-cbc3d0884eac h1:XuNEIEGF9/ewb6jVpjEjwb46FsNjTtgWCseDgY136n0=
-golang.org/x/crypto v0.0.0-20170413182223-cbc3d0884eac/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190228161510-8dd112bcdc25 h1:jsG6UpNLt9iAsb0S2AGW28DveNzzgmbXR+ENoPjUeIU=
 golang.org/x/crypto v0.0.0-20190228161510-8dd112bcdc25/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190302025703-b6889370fb10 h1:xQJI9OEiErEQ++DoXOHqEpzsGMrAv2Q2jyCpi7DmfpQ=
-golang.org/x/sys v0.0.0-20190302025703-b6889370fb10/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -3,6 +3,7 @@ package main
 import (
 	"log"
 	"os"
+	"time"

 	"github.com/appleboy/easyssh-proxy"
 	"github.com/joho/godotenv"
@@ -57,11 +58,11 @@ func main() {
 			Usage:  "connection timeout",
 			EnvVar: "PLUGIN_TIMEOUT,SCP_TIMEOUT",
 		},
-		cli.IntFlag{
+		cli.DurationFlag{
 			Name:   "command.timeout,T",
 			Usage:  "command timeout",
 			EnvVar: "PLUGIN_COMMAND_TIMEOUT,SSH_COMMAND_TIMEOUT",
-			Value:  60,
+			Value:  60 * time.Second,
 		},
 		cli.StringFlag{
 			Name:   "key, k",
@@ -269,7 +270,7 @@ func run(c *cli.Context) error {
 			Username:        c.String("username"),
 			Password:        c.String("password"),
 			Timeout:         c.Duration("timeout"),
-			CommandTimeout:  c.Int("command.timeout"),
+			CommandTimeout:  c.Duration("command.timeout"),
 			Key:             c.String("key"),
 			KeyPath:         c.String("key-path"),
 			Target:          c.StringSlice("target"),
@@ -51,7 +51,7 @@ type (
 		Key             string
 		KeyPath         string
 		Timeout         time.Duration
-		CommandTimeout  int
+		CommandTimeout  time.Duration
 		Target          []string
 		Source          []string
 		Remove          bool
@@ -6,6 +6,7 @@ import (
 	"os/user"
 	"path/filepath"
 	"testing"
+	"time"

 	"github.com/appleboy/easyssh-proxy"
 	"github.com/stretchr/testify/assert"
@@ -98,7 +99,7 @@ func TestSCPFileFromPublicKey(t *testing.T) {
 			KeyPath:        "tests/.ssh/id_rsa",
 			Source:         []string{"tests/a.txt", "tests/b.txt"},
 			Target:         []string{filepath.Join(u.HomeDir, "/test")},
-			CommandTimeout: 60,
+			CommandTimeout: 60 * time.Second,
 			TarExec:        "tar",
 		},
 	}
@@ -148,7 +149,7 @@ func TestSCPWildcardFileList(t *testing.T) {
 			KeyPath:        "tests/.ssh/id_rsa",
 			Source:         []string{"tests/global/*"},
 			Target:         []string{filepath.Join(u.HomeDir, "abc")},
-			CommandTimeout: 60,
+			CommandTimeout: 60 * time.Second,
 			TarExec:        "tar",
 		},
 	}
@@ -180,7 +181,7 @@ func TestSCPFromProxySetting(t *testing.T) {
 			KeyPath:        "tests/.ssh/id_rsa",
 			Source:         []string{"tests/global/*"},
 			Target:         []string{filepath.Join(u.HomeDir, "def")},
-			CommandTimeout: 60,
+			CommandTimeout: 60 * time.Second,
 			TarExec:        "tar",
 			Proxy: easyssh.DefaultConfig{
 				Server:  "localhost",
@@ -225,7 +226,7 @@ func TestStripComponentsFlag(t *testing.T) {
 			Source:          []string{"tests/global/*"},
 			StripComponents: 2,
 			Target:          []string{filepath.Join(u.HomeDir, "123")},
-			CommandTimeout:  60,
+			CommandTimeout:  60 * time.Second,
 			TarExec:         "tar",
 		},
 	}
@@ -264,7 +265,7 @@ func TestIgnoreList(t *testing.T) {
 			Source:          []string{"tests/global/*", "!tests/global/c.txt", "!tests/global/e.txt"},
 			StripComponents: 2,
 			Target:          []string{filepath.Join(u.HomeDir, "ignore")},
-			CommandTimeout:  60,
+			CommandTimeout:  60 * time.Second,
 			TarExec:         "tar",
 		},
 	}
@@ -342,7 +343,7 @@ func TestIncorrectPassword(t *testing.T) {
 			Password:       "123456",
 			Source:         []string{"tests/a.txt", "tests/b.txt"},
 			Target:         []string{"/home"},
-			CommandTimeout: 60,
+			CommandTimeout: 60 * time.Second,
 			TarExec:        "tar",
 		},
 	}
@@ -365,7 +366,7 @@ func TestNoPermissionCreateFolder(t *testing.T) {
 			KeyPath:        "tests/.ssh/id_rsa",
 			Source:         []string{"tests/a.txt", "tests/b.txt"},
 			Target:         []string{"/etc/test"},
-			CommandTimeout: 60,
+			CommandTimeout: 60 * time.Second,
 			TarExec:        "tar",
 		},
 	}
@@ -440,7 +441,7 @@ func TestRemoveDestFile(t *testing.T) {
 	}
 	plugin := Plugin{
 		Config: Config{
-			CommandTimeout: 60,
+			CommandTimeout: 60 * time.Second,
 		},
 		DestFile: "/etc/resolv.conf",
 	}