| // Copyright 2015 The Go Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style |
| // license that can be found in the LICENSE file. |
| |
| package buildlet // import "golang.org/x/build/buildlet" |
| |
| import ( |
| "bufio" |
| "context" |
| "encoding/json" |
| "errors" |
| "fmt" |
| "io" |
| "io/ioutil" |
| "log" |
| "net" |
| "net/http" |
| "net/url" |
| "os" |
| "strings" |
| "sync" |
| "time" |
| |
| "golang.org/x/oauth2" |
| ) |
| |
| var _ Client = (*client)(nil) |
| |
| // NewClient returns a *client that will manipulate ipPort, |
| // authenticated using the provided keypair. |
| // |
| // This constructor returns immediately without testing the host or auth. |
| func NewClient(ipPort string, kp KeyPair) Client { |
| tr := &http.Transport{ |
| Dial: defaultDialer(), |
| DialTLS: kp.tlsDialer(), |
| IdleConnTimeout: time.Minute, |
| } |
| c := &client{ |
| ipPort: ipPort, |
| tls: kp, |
| password: kp.Password(), |
| httpClient: &http.Client{Transport: tr}, |
| closeFuncs: []func(){tr.CloseIdleConnections}, |
| } |
| c.setCommon() |
| return c |
| } |
| |
| func (c *client) setCommon() { |
| c.peerDead = make(chan struct{}) |
| c.ctx, c.ctxCancel = context.WithCancel(context.Background()) |
| } |
| |
| // SetOnHeartbeatFailure sets a function to be called when heartbeats |
| // against this builder fail, or when the client is destroyed with |
| // Close. The function fn is never called more than once. |
| // SetOnHeartbeatFailure must be set before any use of the buildlet. |
| func (c *client) SetOnHeartbeatFailure(fn func()) { |
| c.heartbeatFailure = fn |
| } |
| |
| var ErrClosed = errors.New("buildlet: Client closed") |
| |
| // Closes destroys and closes down the buildlet, destroying all state |
| // immediately. |
| func (c *client) Close() error { |
| // TODO(bradfitz): have a Client-wide Done channel we set on |
| // all outbound HTTP Requests and close it in the once here? |
| // Then if something was in-flight and somebody else Closes, |
| // the local http.Transport notices, rather than noticing via |
| // the remote machine dying or timing out. |
| c.closeOnce.Do(func() { |
| // Send a best-effort notification to the server to destroy itself. |
| // Don't want too long (since it's likely in a broken state anyway). |
| // Ignore the return value, since we're about to forcefully destroy |
| // it anyway. |
| req, err := http.NewRequest("POST", c.URL()+"/halt", nil) |
| if err != nil { |
| // ignore. |
| } else { |
| _, err = c.doHeaderTimeout(req, 2*time.Second) |
| } |
| if err == nil { |
| err = ErrClosed |
| } |
| for _, fn := range c.closeFuncs { |
| fn() |
| } |
| c.setPeerDead(err) // which will also cause c.heartbeatFailure to run |
| }) |
| return nil |
| } |
| |
| func (c *client) setPeerDead(err error) { |
| c.setPeerDeadOnce.Do(func() { |
| c.MarkBroken() |
| if err == nil { |
| err = errors.New("peer dead (no specific error)") |
| } |
| c.deadErr = err |
| close(c.peerDead) |
| }) |
| } |
| |
| // SetDescription sets a short description of where the buildlet |
| // connection came from. This is used by the build coordinator status |
| // page, mostly for debugging. |
| func (c *client) SetDescription(v string) { |
| c.desc = v |
| } |
| |
| // SetGCEInstanceName sets an instance name for GCE buildlets. |
| // This value differs from the buildlet name used in the CLI and web interface. |
| func (c *client) SetGCEInstanceName(v string) { |
| c.gceInstanceName = v |
| } |
| |
| // GCEInstanceName gets an instance name for GCE buildlets. |
| // This value differs from the buildlet name used in the CLI and web interface. |
| // For non-GCE buildlets, this will return an empty string. |
| func (c *client) GCEInstanceName() string { |
| return c.gceInstanceName |
| } |
| |
| // SetHTTPClient replaces the underlying HTTP client. |
| // It should only be called before the Client is used. |
| func (c *client) SetHTTPClient(httpClient *http.Client) { |
| c.httpClient = httpClient |
| } |
| |
| // SetDialer sets the function that creates a new connection to the buildlet. |
| // By default, net.Dialer.DialContext is used. SetDialer has effect only when |
| // TLS isn't used. |
| // |
| // TODO(bradfitz): this is only used for ssh connections to buildlets, |
| // which previously required the client to do its own net.Dial + |
| // upgrade request. But now that the net/http client supports |
| // read/write bodies for protocol upgrades, we could change how ssh |
| // works and delete this. |
| func (c *client) SetDialer(dialer func(context.Context) (net.Conn, error)) { |
| c.dialer = dialer |
| } |
| |
| // defaultDialer returns the net/http package's default Dial function. |
| // Notably, this sets TCP keep-alive values, so when we kill VMs |
| // (whose TCP stacks stop replying, forever), we don't leak file |
| // descriptors for otherwise forever-stalled TCP connections. |
| func defaultDialer() func(network, addr string) (net.Conn, error) { |
| if fn := http.DefaultTransport.(*http.Transport).Dial; fn != nil { |
| return fn |
| } |
| return net.Dial |
| } |
| |
| // A client interacts with a single buildlet. |
| type client struct { |
| ipPort string // required, unless remoteBuildlet+baseURL is set |
| tls KeyPair |
| httpClient *http.Client |
| dialer func(context.Context) (net.Conn, error) // nil means to use net.Dialer.DialContext |
| baseURL string // optional baseURL (used by remote buildlets) |
| authUser string // defaults to "gomote", if password is non-empty |
| password string // basic auth password or empty for none |
| remoteBuildlet string // non-empty if for remote buildlets (used by client) |
| name string // optional name for debugging, returned by Name |
| gceInstanceName string // instance name for GCE VMs |
| |
| closeFuncs []func() // optional extra code to run on close |
| |
| ctx context.Context |
| ctxCancel context.CancelFunc |
| heartbeatFailure func() // optional |
| desc string |
| |
| closeOnce sync.Once |
| initHeartbeatOnce sync.Once |
| setPeerDeadOnce sync.Once |
| peerDead chan struct{} // closed on peer death |
| deadErr error // guarded by peerDead's close |
| |
| mu sync.Mutex |
| broken bool // client is broken in some way |
| } |
| |
| func (c *client) String() string { |
| if c == nil { |
| return "(nil buildlet.Client)" |
| } |
| return strings.TrimSpace(c.URL() + " " + c.desc) |
| } |
| |
| // RemoteName returns the name of this client's buildlet on the |
| // coordinator. If this buildlet isn't a remote buildlet created via |
| // gomote, this returns the empty string. |
| func (c *client) RemoteName() string { |
| return c.remoteBuildlet |
| } |
| |
| // URL returns the buildlet's URL prefix, without a trailing slash. |
| func (c *client) URL() string { |
| if c.baseURL != "" { |
| return strings.TrimRight(c.baseURL, "/") |
| } |
| if !c.tls.IsZero() { |
| return "https://" + strings.TrimSuffix(c.ipPort, ":443") |
| } |
| return "http://" + strings.TrimSuffix(c.ipPort, ":80") |
| } |
| |
| func (c *client) IPPort() string { return c.ipPort } |
| |
| func (c *client) SetName(name string) { c.name = name } |
| |
| // Name returns the name of this buildlet. |
| // It returns the first non-empty string from the name given to |
| // SetName, its remote buildlet name, its ip:port, or "(unnamed-buildlet)" in the case where |
| // ip:port is empty because there's a custom dialer. |
| func (c *client) Name() string { |
| if c.name != "" { |
| return c.name |
| } |
| if c.remoteBuildlet != "" { |
| return c.remoteBuildlet |
| } |
| if c.ipPort != "" { |
| return c.ipPort |
| } |
| return "(unnamed-buildlet)" |
| } |
| |
| // MarkBroken marks this client as broken in some way. |
| func (c *client) MarkBroken() { |
| c.mu.Lock() |
| defer c.mu.Unlock() |
| c.broken = true |
| c.ctxCancel() |
| } |
| |
| // IsBroken reports whether this client is broken in some way. |
| func (c *client) IsBroken() bool { |
| c.mu.Lock() |
| defer c.mu.Unlock() |
| return c.broken |
| } |
| |
| func (c *client) authUsername() string { |
| if c.authUser != "" { |
| return c.authUser |
| } |
| return "gomote" |
| } |
| |
| func (c *client) do(req *http.Request) (*http.Response, error) { |
| c.initHeartbeatOnce.Do(c.initHeartbeats) |
| if c.password != "" { |
| req.SetBasicAuth(c.authUsername(), c.password) |
| } |
| if c.remoteBuildlet != "" { |
| req.Header.Set("X-Buildlet-Proxy", c.remoteBuildlet) |
| } |
| return c.httpClient.Do(req) |
| } |
| |
| // ProxyTCP connects to the given port on the remote buildlet. |
| // The buildlet client must currently be a gomote client (RemoteName != "") |
| // and the target type must be a VM type running on GCE. This was primarily |
| // created for RDP to Windows machines, but it might get reused for other |
| // purposes in the future. |
| func (c *client) ProxyTCP(port int) (io.ReadWriteCloser, error) { |
| if c.RemoteName() == "" { |
| return nil, errors.New("ProxyTCP currently only supports gomote-created buildlets") |
| } |
| req, err := http.NewRequest("POST", c.URL()+"/tcpproxy", nil) |
| if err != nil { |
| return nil, err |
| } |
| req.Header.Add("X-Target-Port", fmt.Sprint(port)) |
| res, err := c.do(req) |
| if err != nil { |
| return nil, err |
| } |
| if res.StatusCode != http.StatusSwitchingProtocols { |
| slurp, _ := ioutil.ReadAll(io.LimitReader(res.Body, 4<<10)) |
| res.Body.Close() |
| return nil, fmt.Errorf("wanted 101 Switching Protocols; unexpected response: %v, %q", res.Status, slurp) |
| } |
| rwc, ok := res.Body.(io.ReadWriteCloser) |
| if !ok { |
| res.Body.Close() |
| return nil, fmt.Errorf("tcpproxy response was not a Writer") |
| } |
| return rwc, nil |
| } |
| |
| // ProxyRoundTripper returns a RoundTripper that sends HTTP requests directly |
| // through to the underlying buildlet, adding auth and X-Buildlet-Proxy headers |
| // as necessary. This is really only intended for use by the coordinator. |
| func (c *client) ProxyRoundTripper() http.RoundTripper { |
| return proxyRoundTripper{c} |
| } |
| |
| type proxyRoundTripper struct { |
| c *client |
| } |
| |
| func (p proxyRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) { |
| return p.c.do(req) |
| } |
| |
| func (c *client) initHeartbeats() { |
| go c.heartbeatLoop() |
| } |
| |
| func (c *client) heartbeatLoop() { |
| failInARow := 0 |
| for { |
| select { |
| case <-c.peerDead: |
| // Dead for whatever reason (heartbeat, remote |
| // side closed, caller Closed |
| // normally). Regardless, we call the |
| // heartbeatFailure func if set. |
| if c.heartbeatFailure != nil { |
| c.heartbeatFailure() |
| } |
| return |
| case <-time.After(10 * time.Second): |
| t0 := time.Now() |
| if _, err := c.Status(context.Background()); err != nil { |
| failInARow++ |
| if failInARow == 3 { |
| log.Printf("Buildlet %v failed three heartbeats; final error: %v", c, err) |
| c.setPeerDead(fmt.Errorf("Buildlet %v failed heartbeat after %v; marking dead; err=%v", c, time.Since(t0), err)) |
| } |
| } else { |
| failInARow = 0 |
| } |
| } |
| } |
| } |
| |
| var errHeaderTimeout = errors.New("timeout waiting for headers") |
| |
| // doHeaderTimeout calls c.do(req) and returns its results, or |
| // errHeaderTimeout if max elapses first. |
| func (c *client) doHeaderTimeout(req *http.Request, max time.Duration) (res *http.Response, err error) { |
| type resErr struct { |
| res *http.Response |
| err error |
| } |
| |
| ctx, cancel := context.WithCancel(req.Context()) |
| |
| req = req.WithContext(ctx) |
| |
| timer := time.NewTimer(max) |
| defer timer.Stop() |
| |
| resErrc := make(chan resErr, 1) |
| go func() { |
| res, err := c.do(req) |
| resErrc <- resErr{res, err} |
| }() |
| |
| cleanup := func() { |
| cancel() |
| if re := <-resErrc; re.res != nil { |
| re.res.Body.Close() |
| } |
| } |
| |
| select { |
| case re := <-resErrc: |
| if re.err != nil { |
| cancel() |
| return nil, re.err |
| } |
| // Clean up our cancel context above when the caller |
| // reads to the end of the response body or closes. |
| re.res.Body = onEOFReadCloser{re.res.Body, cancel} |
| return re.res, nil |
| case <-c.peerDead: |
| log.Printf("%s: peer dead with %v, waiting for headers for %v", c.Name(), c.deadErr, req.URL.Path) |
| go cleanup() |
| return nil, c.deadErr |
| case <-timer.C: |
| log.Printf("%s: timeout after %v waiting for headers for %v", c.Name(), max, req.URL.Path) |
| go cleanup() |
| return nil, errHeaderTimeout |
| } |
| } |
| |
| // doOK sends the request and expects a 200 OK response. |
| func (c *client) doOK(req *http.Request) error { |
| res, err := c.do(req) |
| if err != nil { |
| return err |
| } |
| defer res.Body.Close() |
| if res.StatusCode != http.StatusOK { |
| slurp, _ := ioutil.ReadAll(io.LimitReader(res.Body, 4<<10)) |
| return fmt.Errorf("%v; body: %s", res.Status, slurp) |
| } |
| return nil |
| } |
| |
| // PutTar writes files to the remote buildlet, rooted at the relative |
| // directory dir. |
| // If dir is empty, they're placed at the root of the buildlet's work directory. |
| // The dir is created if necessary. |
| // The Reader must be of a tar.gz file. |
| func (c *client) PutTar(ctx context.Context, r io.Reader, dir string) error { |
| req, err := http.NewRequest("PUT", c.URL()+"/writetgz?dir="+url.QueryEscape(dir), r) |
| if err != nil { |
| return err |
| } |
| return c.doOK(req.WithContext(ctx)) |
| } |
| |
| // PutTarFromURL tells the buildlet to download the tar.gz file from tarURL |
| // and write it to dir, a relative directory from the workdir. |
| // If dir is empty, they're placed at the root of the buildlet's work directory. |
| // The dir is created if necessary. |
| // The url must be of a tar.gz file. |
| func (c *client) PutTarFromURL(ctx context.Context, tarURL, dir string) error { |
| form := url.Values{ |
| "url": {tarURL}, |
| } |
| req, err := http.NewRequest("POST", c.URL()+"/writetgz?dir="+url.QueryEscape(dir), strings.NewReader(form.Encode())) |
| if err != nil { |
| return err |
| } |
| req.Header.Set("Content-Type", "application/x-www-form-urlencoded") |
| return c.doOK(req.WithContext(ctx)) |
| } |
| |
| // Put writes the provided file to path (relative to workdir) and sets mode. |
| func (c *client) Put(ctx context.Context, r io.Reader, path string, mode os.FileMode) error { |
| param := url.Values{ |
| "path": {path}, |
| "mode": {fmt.Sprint(int64(mode))}, |
| } |
| req, err := http.NewRequest("PUT", c.URL()+"/write?"+param.Encode(), r) |
| if err != nil { |
| return err |
| } |
| return c.doOK(req.WithContext(ctx)) |
| } |
| |
| // GetTar returns a .tar.gz stream of the given directory, relative to the buildlet's work dir. |
| // The provided dir may be empty to get everything. |
| func (c *client) GetTar(ctx context.Context, dir string) (io.ReadCloser, error) { |
| req, err := http.NewRequest("GET", c.URL()+"/tgz?dir="+url.QueryEscape(dir), nil) |
| if err != nil { |
| return nil, err |
| } |
| res, err := c.do(req.WithContext(ctx)) |
| if err != nil { |
| return nil, err |
| } |
| if res.StatusCode != http.StatusOK { |
| slurp, _ := ioutil.ReadAll(io.LimitReader(res.Body, 4<<10)) |
| res.Body.Close() |
| return nil, fmt.Errorf("%v; body: %s", res.Status, slurp) |
| } |
| return res.Body, nil |
| } |
| |
| // ExecOpts are options for a remote command invocation. |
| type ExecOpts struct { |
| // Output is the output of stdout and stderr. |
| // If nil, the output is discarded. |
| Output io.Writer |
| |
| // Dir is the directory from which to execute the command, |
| // as an absolute or relative path using the buildlet's native |
| // path separator, or a slash-separated relative path. |
| // If relative, it is relative to the buildlet's work directory. |
| // |
| // Dir is optional. If not specified, it defaults to the directory of |
| // the command, or the work directory if SystemLevel is set. |
| Dir string |
| |
| // Args are the arguments to pass to the cmd given to Client.Exec. |
| Args []string |
| |
| // ExtraEnv are KEY=VALUE pairs to append to the buildlet |
| // process's environment. |
| ExtraEnv []string |
| |
| // Path, if non-nil, specifies the PATH variable of the executed process's |
| // environment. Each path in the list should use separators native to the |
| // buildlet's platform, and a non-nil empty list clears the path. |
| // |
| // The following expansions apply: |
| // - the string "$PATH" expands to any existing PATH element(s) |
| // - the substring "$WORKDIR" expands to buildlet's temp workdir |
| // |
| // After expansion, the list is joined with an OS-specific list |
| // separator and supplied to the executed process as its PATH |
| // environment variable. |
| Path []string |
| |
| // SystemLevel controls whether the command is expected to be found outside of |
| // the buildlet's environment. |
| SystemLevel bool |
| |
| // Debug, if true, instructs to the buildlet to print extra debug |
| // info to the output before the command begins executing. |
| Debug bool |
| |
| // OnStartExec is an optional hook that runs after the 200 OK |
| // response from the buildlet, but before the output begins |
| // writing to Output. |
| OnStartExec func() |
| } |
| |
| // ErrTimeout is a sentinel error that represents that waiting |
| // for a command to complete has exceeded the given timeout. |
| var ErrTimeout = errors.New("buildlet: timeout waiting for command to complete") |
| |
| // Exec runs cmd on the buildlet. |
| // |
| // cmd may be an absolute or relative path using the buildlet's native path |
| // separator, or a slash-separated relative path. If relative, it is |
| // relative to the buildlet's work directory (not opts.Dir). |
| // |
| // Two errors are returned: one is whether the command succeeded |
| // remotely (remoteErr), and the second (execErr) is whether there |
| // were system errors preventing the command from being started or |
| // seen to completition. If execErr is non-nil, the remoteErr is |
| // meaningless. |
| // |
| // If the context's deadline is exceeded while waiting for the command |
| // to complete, the returned execErr is ErrTimeout. |
| func (c *client) Exec(ctx context.Context, cmd string, opts ExecOpts) (remoteErr, execErr error) { |
| var mode string |
| if opts.SystemLevel { |
| mode = "sys" |
| } |
| path := opts.Path |
| if len(path) == 0 && path != nil { |
| // url.Values doesn't distinguish between a nil slice and |
| // a non-nil zero-length slice, so use this sentinel value. |
| path = []string{"$EMPTY"} |
| } |
| form := url.Values{ |
| "cmd": {cmd}, |
| "mode": {mode}, |
| "dir": {opts.Dir}, |
| "cmdArg": opts.Args, |
| "env": opts.ExtraEnv, |
| "path": path, |
| "debug": {fmt.Sprint(opts.Debug)}, |
| } |
| req, err := http.NewRequest("POST", c.URL()+"/exec", strings.NewReader(form.Encode())) |
| if err != nil { |
| return nil, err |
| } |
| req = req.WithContext(ctx) |
| req.Header.Set("Content-Type", "application/x-www-form-urlencoded") |
| |
| // The first thing the buildlet's exec handler does is flush the headers, so |
| // 20 seconds should be plenty of time, regardless of where on the planet |
| // (Atlanta, Paris, Sydney, etc.) the reverse buildlet is: |
| res, err := c.doHeaderTimeout(req, 20*time.Second) |
| if err == errHeaderTimeout { |
| // If we don't see headers after all that time, |
| // consider the buildlet to be unhealthy. |
| c.MarkBroken() |
| return nil, errors.New("buildlet: timeout waiting for exec header response") |
| } else if err != nil { |
| return nil, err |
| } |
| defer res.Body.Close() |
| if res.StatusCode != http.StatusOK { |
| slurp, _ := ioutil.ReadAll(io.LimitReader(res.Body, 4<<10)) |
| return nil, fmt.Errorf("buildlet: HTTP status %v: %s", res.Status, slurp) |
| } |
| condRun(opts.OnStartExec) |
| |
| type errs struct { |
| remoteErr, execErr error |
| } |
| resc := make(chan errs, 1) |
| go func() { |
| // Stream the output: |
| out := opts.Output |
| if out == nil { |
| out = ioutil.Discard |
| } |
| if _, err := io.Copy(out, res.Body); err != nil { |
| resc <- errs{execErr: fmt.Errorf("error copying response: %w", err)} |
| return |
| } |
| |
| // Don't record to the dashboard unless we heard the trailer from |
| // the buildlet, otherwise it was probably some unrelated error |
| // (like the VM being killed, or the buildlet crashing due to |
| // e.g. https://golang.org/issue/9309, since we require a tip |
| // build of the buildlet to get Trailers support) |
| state := res.Trailer.Get("Process-State") |
| if state == "" { |
| resc <- errs{execErr: errors.New("missing Process-State trailer from HTTP response; buildlet built with old (<= 1.4) Go?")} |
| return |
| } |
| if state != "ok" { |
| resc <- errs{remoteErr: errors.New(state)} |
| } else { |
| resc <- errs{} // success |
| } |
| }() |
| select { |
| case res := <-resc: |
| if res.execErr != nil { |
| // Note: We've historically marked the buildlet as unhealthy after |
| // reaching any kind of execution error, even when it's a remote command |
| // execution timeout (see use of ErrTimeout below). |
| // This is certainly on the safer side of avoiding false positive signal, |
| // but maybe someday we'll want to start to rely on the buildlet to report |
| // such a condition and not mark it as unhealthy. |
| |
| c.MarkBroken() |
| if errors.Is(res.execErr, context.DeadlineExceeded) { |
| res.execErr = ErrTimeout |
| } |
| } |
| return res.remoteErr, res.execErr |
| case <-c.peerDead: |
| return nil, c.deadErr |
| } |
| } |
| |
| // RemoveAll deletes the provided paths, relative to the work directory. |
| func (c *client) RemoveAll(ctx context.Context, paths ...string) error { |
| if len(paths) == 0 { |
| return nil |
| } |
| form := url.Values{"path": paths} |
| req, err := http.NewRequest("POST", c.URL()+"/removeall", strings.NewReader(form.Encode())) |
| if err != nil { |
| return err |
| } |
| req.Header.Set("Content-Type", "application/x-www-form-urlencoded") |
| return c.doOK(req.WithContext(ctx)) |
| } |
| |
| // DestroyVM shuts down the buildlet and destroys the VM instance. |
| func (c *client) DestroyVM(ts oauth2.TokenSource, proj, zone, instance string) error { |
| // TODO(bradfitz): move GCE stuff out of this package? |
| gceErrc := make(chan error, 1) |
| buildletErrc := make(chan error, 1) |
| go func() { |
| gceErrc <- DestroyVM(ts, proj, zone, instance) |
| }() |
| go func() { |
| buildletErrc <- c.Close() |
| }() |
| timeout := time.NewTimer(5 * time.Second) |
| defer timeout.Stop() |
| |
| var retErr error |
| var gceDone, buildletDone bool |
| for !gceDone || !buildletDone { |
| select { |
| case err := <-gceErrc: |
| if err != nil { |
| retErr = err |
| } |
| gceDone = true |
| case err := <-buildletErrc: |
| if err != nil { |
| retErr = err |
| } |
| buildletDone = true |
| case <-timeout.C: |
| e := "" |
| if !buildletDone { |
| e = "timeout asking buildlet to shut down" |
| } |
| if !gceDone { |
| if e != "" { |
| e += " and " |
| } |
| e += "timeout asking GCE to delete builder VM" |
| } |
| return errors.New(e) |
| } |
| } |
| return retErr |
| } |
| |
| // Status provides status information about the buildlet. |
| // |
| // A coordinator can use the provided information to decide what, if anything, |
| // to do with a buildlet. |
| type Status struct { |
| Version int // buildlet version, coordinator rejects value that is too old (see minBuildletVersion). |
| } |
| |
| // Status returns an Status value describing this buildlet. |
| func (c *client) Status(ctx context.Context) (Status, error) { |
| select { |
| case <-c.peerDead: |
| return Status{}, c.deadErr |
| default: |
| // Continue below. |
| } |
| req, err := http.NewRequest("GET", c.URL()+"/status", nil) |
| if err != nil { |
| return Status{}, err |
| } |
| req = req.WithContext(ctx) |
| resp, err := c.doHeaderTimeout(req, 20*time.Second) // plenty of time |
| if err != nil { |
| return Status{}, err |
| } |
| if resp.StatusCode != http.StatusOK { |
| return Status{}, errors.New(resp.Status) |
| } |
| b, err := ioutil.ReadAll(resp.Body) |
| resp.Body.Close() |
| if err != nil { |
| return Status{}, err |
| } |
| var status Status |
| if err := json.Unmarshal(b, &status); err != nil { |
| return Status{}, err |
| } |
| return status, nil |
| } |
| |
| // WorkDir returns the absolute path to the buildlet work directory. |
| func (c *client) WorkDir(ctx context.Context) (string, error) { |
| req, err := http.NewRequest("GET", c.URL()+"/workdir", nil) |
| if err != nil { |
| return "", err |
| } |
| req = req.WithContext(ctx) |
| resp, err := c.doHeaderTimeout(req, 20*time.Second) // plenty of time |
| if err != nil { |
| return "", err |
| } |
| if resp.StatusCode != http.StatusOK { |
| return "", errors.New(resp.Status) |
| } |
| b, err := ioutil.ReadAll(resp.Body) |
| resp.Body.Close() |
| if err != nil { |
| return "", err |
| } |
| return string(b), nil |
| } |
| |
| // DirEntry is the information about a file on a buildlet. |
| type DirEntry struct { |
| // Line is of the form "drw-rw-rw\t<name>" and then if a regular file, |
| // also "\t<size>\t<modtime>". in either case, without trailing newline. |
| // TODO: break into parsed fields? |
| Line string |
| } |
| |
| func (de DirEntry) String() string { |
| return de.Line |
| } |
| |
| // Name returns the relative path to the file, such as "src/net/http/" or "src/net/http/jar.go". |
| func (de DirEntry) Name() string { |
| f := strings.Split(de.Line, "\t") |
| if len(f) < 2 { |
| return "" |
| } |
| return f[1] |
| } |
| |
| // Perm returns the permission bits in string form, such as "-rw-r--r--" or "drwxr-xr-x". |
| func (de DirEntry) Perm() string { |
| i := strings.IndexByte(de.Line, '\t') |
| if i == -1 { |
| return "" |
| } |
| return de.Line[:i] |
| } |
| |
| // IsDir reports whether de describes a directory. That is, |
| // it tests for the os.ModeDir bit being set in de.Perm(). |
| func (de DirEntry) IsDir() bool { |
| if len(de.Line) == 0 { |
| return false |
| } |
| return de.Line[0] == 'd' |
| } |
| |
| // Digest returns the SHA-1 digest of the file, such as "da39a3ee5e6b4b0d3255bfef95601890afd80709". |
| // It returns the empty string if the digest isn't included. |
| func (de DirEntry) Digest() string { |
| f := strings.Split(de.Line, "\t") |
| if len(f) < 5 { |
| return "" |
| } |
| return f[4] |
| } |
| |
| // ListDirOpts are options for Client.ListDir. |
| type ListDirOpts struct { |
| // Recursive controls whether the directory is listed |
| // recursively. |
| Recursive bool |
| |
| // Skip are the directories to skip, relative to the directory |
| // passed to ListDir. Each item should contain only forward |
| // slashes and not start or end in slashes. |
| Skip []string |
| |
| // Digest controls whether the SHA-1 digests of regular files |
| // are returned. |
| Digest bool |
| } |
| |
| // ListDir lists the contents of a directory. |
| // The fn callback is run for each entry. |
| // The directory dir itself is not included. |
| func (c *client) ListDir(ctx context.Context, dir string, opts ListDirOpts, fn func(DirEntry)) error { |
| param := url.Values{ |
| "dir": {dir}, |
| "recursive": {fmt.Sprint(opts.Recursive)}, |
| "skip": opts.Skip, |
| "digest": {fmt.Sprint(opts.Digest)}, |
| } |
| req, err := http.NewRequest("GET", c.URL()+"/ls?"+param.Encode(), nil) |
| if err != nil { |
| return err |
| } |
| resp, err := c.do(req.WithContext(ctx)) |
| if err != nil { |
| return err |
| } |
| defer resp.Body.Close() |
| if resp.StatusCode != http.StatusOK { |
| slurp, _ := ioutil.ReadAll(io.LimitReader(resp.Body, 1<<10)) |
| return fmt.Errorf("%s: %s", resp.Status, slurp) |
| } |
| sc := bufio.NewScanner(resp.Body) |
| for sc.Scan() { |
| line := strings.TrimSpace(sc.Text()) |
| fn(DirEntry{Line: line}) |
| } |
| return sc.Err() |
| } |
| |
| func (c *client) getDialer() func(context.Context) (net.Conn, error) { |
| if !c.tls.IsZero() { |
| return func(_ context.Context) (net.Conn, error) { |
| return c.tls.tlsDialer()("tcp", c.ipPort) |
| } |
| } |
| if c.dialer != nil { |
| return c.dialer |
| } |
| return c.dialWithNetDial |
| } |
| |
| func (c *client) dialWithNetDial(ctx context.Context) (net.Conn, error) { |
| var d net.Dialer |
| return d.DialContext(ctx, "tcp", c.ipPort) |
| } |
| |
| // ConnectSSH opens an SSH connection to the buildlet for the given username. |
| // The authorizedPubKey must be a line from an ~/.ssh/authorized_keys file |
| // and correspond to the private key to be used to communicate over the net.Conn. |
| func (c *client) ConnectSSH(user, authorizedPubKey string) (net.Conn, error) { |
| ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second) |
| defer cancel() |
| conn, err := c.getDialer()(ctx) |
| if err != nil { |
| return nil, fmt.Errorf("error dialing HTTP connection before SSH upgrade: %v", err) |
| } |
| deadline, _ := ctx.Deadline() |
| conn.SetDeadline(deadline) |
| req, err := http.NewRequest("POST", "/connect-ssh", nil) |
| if err != nil { |
| conn.Close() |
| return nil, err |
| } |
| req.Header.Add("X-Go-Ssh-User", user) |
| req.Header.Add("X-Go-Authorized-Key", authorizedPubKey) |
| if !c.tls.IsZero() { |
| req.SetBasicAuth(c.authUsername(), c.password) |
| } |
| if err := req.Write(conn); err != nil { |
| conn.Close() |
| return nil, fmt.Errorf("writing /connect-ssh HTTP request failed: %v", err) |
| } |
| bufr := bufio.NewReader(conn) |
| res, err := http.ReadResponse(bufr, req) |
| if err != nil { |
| conn.Close() |
| return nil, fmt.Errorf("reading /connect-ssh response: %v", err) |
| } |
| if res.StatusCode != http.StatusSwitchingProtocols { |
| slurp, _ := ioutil.ReadAll(res.Body) |
| conn.Close() |
| return nil, fmt.Errorf("unexpected /connect-ssh response: %v, %s", res.Status, slurp) |
| } |
| conn.SetDeadline(time.Time{}) |
| return conn, nil |
| } |
| |
| // AddCloseFunc adds an optional extra code to run on close. |
| func (c *client) AddCloseFunc(fn func()) { |
| c.closeFuncs = append(c.closeFuncs, fn) |
| } |
| |
| func condRun(fn func()) { |
| if fn != nil { |
| fn() |
| } |
| } |
| |
| type onEOFReadCloser struct { |
| rc io.ReadCloser |
| fn func() |
| } |
| |
| func (o onEOFReadCloser) Read(p []byte) (n int, err error) { |
| n, err = o.rc.Read(p) |
| if err == io.EOF { |
| o.fn() |
| } |
| return |
| } |
| |
| func (o onEOFReadCloser) Close() error { |
| o.fn() |
| return o.rc.Close() |
| } |