@@ -6,6 +6,7 @@ package git
66
77import (
88 "bytes"
9+ "context"
910 "fmt"
1011 "io"
1112 "os"
@@ -14,56 +15,62 @@ import (
1415 "time"
1516)
1617
17- // Command represents a command with its subcommands or arguments .
18+ // Command contains the name, arguments and environment variables of a command .
1819type Command struct {
1920 name string
2021 args []string
2122 envs []string
2223}
2324
25+ // String returns the string representation of the command.
2426func (c * Command ) String () string {
2527 if len (c .args ) == 0 {
2628 return c .name
2729 }
2830 return fmt .Sprintf ("%s %s" , c .name , strings .Join (c .args , " " ))
2931}
3032
31- // NewCommand creates and returns a new Git Command based on given command and arguments .
33+ // NewCommand creates and returns a new Command with given arguments for "git" .
3234func NewCommand (args ... string ) * Command {
3335 return & Command {
3436 name : "git" ,
3537 args : args ,
3638 }
3739}
3840
39- // AddArguments adds new argument(s) to the command.
40- func (c * Command ) AddArguments (args ... string ) * Command {
41+ // AddArgs appends given arguments to the command.
42+ func (c * Command ) AddArgs (args ... string ) * Command {
4143 c .args = append (c .args , args ... )
4244 return c
4345}
4446
45- // AddEnvs adds new environment variables to the command.
47+ // AddEnvs appends given environment variables to the command.
4648func (c * Command ) AddEnvs (envs ... string ) * Command {
4749 c .envs = append (c .envs , envs ... )
4850 return c
4951}
5052
51- const DEFAULT_TIMEOUT = 60 * time .Second
53+ // DefaultTimeout is the default timeout duration for all commands.
54+ const DefaultTimeout = time .Minute
5255
53- // RunInDirTimeoutPipeline executes the command in given directory with given timeout,
54- // it pipes stdout and stderr to given io.Writer.
55- func (c * Command ) RunInDirTimeoutPipeline (timeout time.Duration , dir string , stdout , stderr io.Writer ) error {
56- if timeout == - 1 {
57- timeout = DEFAULT_TIMEOUT
56+ // RunInDirPipelineWithTimeout executes the command in given directory and timeout duration.
57+ // It pipes stdout and stderr to supplied io.Writer. DefaultTimeout will be used if the timeout
58+ // duration is less than time.Nanosecond (i.e. less than or equal to 0).
59+ func (c * Command ) RunInDirPipelineWithTimeout (timeout time.Duration , stdout , stderr io.Writer , dir string ) error {
60+ if timeout < time .Nanosecond {
61+ timeout = DefaultTimeout
5862 }
5963
6064 if len (dir ) == 0 {
61- log (c . String () )
65+ log ("[timeout: %v] %s" , timeout , c )
6266 } else {
63- log ("% s: %v" , dir , c )
67+ log ("[timeout: %v] % s: %s" , timeout , dir , c )
6468 }
6569
66- cmd := exec .Command (c .name , c .args ... )
70+ ctx , cancel := context .WithTimeout (context .Background (), timeout )
71+ defer cancel ()
72+
73+ cmd := exec .CommandContext (ctx , c .name , c .args ... )
6774 if c .envs != nil {
6875 cmd .Env = append (os .Environ (), c .envs ... )
6976 }
@@ -74,34 +81,38 @@ func (c *Command) RunInDirTimeoutPipeline(timeout time.Duration, dir string, std
7481 return err
7582 }
7683
77- done := make (chan error )
84+ result := make (chan error )
7885 go func () {
79- done <- cmd .Wait ()
86+ result <- cmd .Wait ()
8087 }()
8188
82- var err error
8389 select {
84- case <- time . After ( timeout ):
90+ case <- ctx . Done ( ):
8591 if cmd .Process != nil && cmd .ProcessState != nil && ! cmd .ProcessState .Exited () {
8692 if err := cmd .Process .Kill (); err != nil {
87- return fmt .Errorf ("fail to kill process: %v" , err )
93+ return fmt .Errorf ("kill process: %v" , err )
8894 }
8995 }
9096
91- <- done
97+ <- result
9298 return ErrExecTimeout {timeout }
93- case err = <- done :
99+ case err := <- result :
100+ return err
94101 }
102+ }
95103
96- return err
104+ // RunInDirPipeline executes the command in given directory and default timeout duration.
105+ // It pipes stdout and stderr to supplied io.Writer.
106+ func (c * Command ) RunInDirPipeline (stdout , stderr io.Writer , dir string ) error {
107+ return c .RunInDirPipelineWithTimeout (DefaultTimeout , stdout , stderr , dir )
97108}
98109
99- // RunInDirTimeout executes the command in given directory with given timeout,
100- // and returns stdout in []byte and error (combined with stderr).
101- func (c * Command ) RunInDirTimeout (timeout time.Duration , dir string ) ([]byte , error ) {
110+ // RunInDirWithTimeout executes the command in given directory and timeout duration.
111+ // It returns stdout in []byte and error (combined with stderr).
112+ func (c * Command ) RunInDirWithTimeout (timeout time.Duration , dir string ) ([]byte , error ) {
102113 stdout := new (bytes.Buffer )
103114 stderr := new (bytes.Buffer )
104- if err := c .RunInDirTimeoutPipeline (timeout , dir , stdout , stderr ); err != nil {
115+ if err := c .RunInDirPipelineWithTimeout (timeout , stdout , stderr , dir ); err != nil {
105116 return nil , concatenateError (err , stderr .String ())
106117 }
107118
@@ -111,40 +122,24 @@ func (c *Command) RunInDirTimeout(timeout time.Duration, dir string) ([]byte, er
111122 return stdout .Bytes (), nil
112123}
113124
114- // RunInDirPipeline executes the command in given directory,
115- // it pipes stdout and stderr to given io.Writer.
116- func (c * Command ) RunInDirPipeline (dir string , stdout , stderr io.Writer ) error {
117- return c .RunInDirTimeoutPipeline (- 1 , dir , stdout , stderr )
118- }
119-
120- // RunInDirBytes executes the command in given directory
121- // and returns stdout in []byte and error (combined with stderr).
122- func (c * Command ) RunInDirBytes (dir string ) ([]byte , error ) {
123- return c .RunInDirTimeout (- 1 , dir )
124- }
125-
126- // RunInDir executes the command in given directory
127- // and returns stdout in string and error (combined with stderr).
128- func (c * Command ) RunInDir (dir string ) (string , error ) {
129- stdout , err := c .RunInDirTimeout (- 1 , dir )
130- if err != nil {
131- return "" , err
132- }
133- return string (stdout ), nil
125+ // RunInDir executes the command in given directory and default timeout duration.
126+ // It returns stdout and error (combined with stderr).
127+ func (c * Command ) RunInDir (dir string ) ([]byte , error ) {
128+ return c .RunInDirWithTimeout (DefaultTimeout , dir )
134129}
135130
136- // RunTimeout executes the command in defualt working directory with given timeout,
137- // and returns stdout in string and error (combined with stderr).
138- func (c * Command ) RunTimeout (timeout time.Duration ) (string , error ) {
139- stdout , err := c .RunInDirTimeout (timeout , "" )
131+ // RunWithTimeout executes the command in working directory and given timeout duration.
132+ // It returns stdout in string and error (combined with stderr).
133+ func (c * Command ) RunWithTimeout (timeout time.Duration ) ([] byte , error ) {
134+ stdout , err := c .RunInDirWithTimeout (timeout , "" )
140135 if err != nil {
141- return "" , err
136+ return nil , err
142137 }
143- return string ( stdout ) , nil
138+ return stdout , nil
144139}
145140
146- // Run executes the command in defualt working directory
147- // and returns stdout in string and error (combined with stderr).
148- func (c * Command ) Run () (string , error ) {
149- return c .RunTimeout ( - 1 )
141+ // Run executes the command in working directory and default timeout duration.
142+ // It returns stdout in string and error (combined with stderr).
143+ func (c * Command ) Run () ([] byte , error ) {
144+ return c .RunWithTimeout ( DefaultTimeout )
150145}
0 commit comments