X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b53513423ab948804425424278ac554870864997..da5858d5f794c14cf00b830166bb34b1bcd79ba5:/sdk/go/arvados/client_test.go

diff --git a/sdk/go/arvados/client_test.go b/sdk/go/arvados/client_test.go
index 2363803cab..55e2f998c4 100644
--- a/sdk/go/arvados/client_test.go
+++ b/sdk/go/arvados/client_test.go
@@ -6,14 +6,19 @@ package arvados
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"io/ioutil"
+	"math"
+	"math/rand"
 	"net/http"
+	"net/http/httptest"
 	"net/url"
 	"os"
 	"strings"
 	"sync"
 	"testing/iotest"
+	"time"
 
 	check "gopkg.in/check.v1"
 )
@@ -165,6 +170,44 @@ func (*clientSuite) TestAnythingToValues(c *check.C) {
 	}
 }
 
+// select=["uuid"] is added automatically when RequestAndDecode's
+// destination argument is nil.
+func (*clientSuite) TestAutoSelectUUID(c *check.C) {
+	var req *http.Request
+	var err error
+	server := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Check(r.ParseForm(), check.IsNil)
+		req = r
+		w.Write([]byte("{}"))
+	}))
+	client := Client{
+		APIHost:   strings.TrimPrefix(server.URL, "https://"),
+		AuthToken: "zzz",
+		Insecure:  true,
+		Timeout:   2 * time.Second,
+	}
+
+	req = nil
+	err = client.RequestAndDecode(nil, http.MethodPost, "test", nil, nil)
+	c.Check(err, check.IsNil)
+	c.Check(req.FormValue("select"), check.Equals, `["uuid"]`)
+
+	req = nil
+	err = client.RequestAndDecode(nil, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.IsNil)
+	c.Check(req.FormValue("select"), check.Equals, `["uuid"]`)
+
+	req = nil
+	err = client.RequestAndDecode(nil, http.MethodGet, "test", nil, map[string]interface{}{"select": []string{"blergh"}})
+	c.Check(err, check.IsNil)
+	c.Check(req.FormValue("select"), check.Equals, `["uuid"]`)
+
+	req = nil
+	err = client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, map[string]interface{}{"select": []string{"blergh"}})
+	c.Check(err, check.IsNil)
+	c.Check(req.FormValue("select"), check.Equals, `["blergh"]`)
+}
+
 func (*clientSuite) TestLoadConfig(c *check.C) {
 	oldenv := os.Environ()
 	defer func() {
@@ -217,3 +260,198 @@ func (*clientSuite) TestLoadConfig(c *check.C) {
 	c.Check(client.APIHost, check.Equals, "[::]:3")
 	c.Check(client.Insecure, check.Equals, false)
 }
+
+var _ = check.Suite(&clientRetrySuite{})
+
+type clientRetrySuite struct {
+	server     *httptest.Server
+	client     Client
+	reqs       []*http.Request
+	respStatus chan int
+	respDelay  time.Duration
+
+	origLimiterQuietPeriod time.Duration
+}
+
+func (s *clientRetrySuite) SetUpTest(c *check.C) {
+	// Test server: delay and return errors until a final status
+	// appears on the respStatus channel.
+	s.origLimiterQuietPeriod = requestLimiterQuietPeriod
+	requestLimiterQuietPeriod = time.Second / 100
+	s.server = httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		s.reqs = append(s.reqs, r)
+		delay := s.respDelay
+		if delay == 0 {
+			delay = time.Duration(rand.Int63n(int64(time.Second / 10)))
+		}
+		timer := time.NewTimer(delay)
+		defer timer.Stop()
+		select {
+		case code, ok := <-s.respStatus:
+			if !ok {
+				code = http.StatusOK
+			}
+			w.WriteHeader(code)
+			w.Write([]byte(`{}`))
+		case <-timer.C:
+			w.WriteHeader(http.StatusServiceUnavailable)
+		}
+	}))
+	s.reqs = nil
+	s.respStatus = make(chan int, 1)
+	s.client = Client{
+		APIHost:   s.server.URL[8:],
+		AuthToken: "zzz",
+		Insecure:  true,
+		Timeout:   2 * time.Second,
+	}
+}
+
+func (s *clientRetrySuite) TearDownTest(c *check.C) {
+	s.server.Close()
+	requestLimiterQuietPeriod = s.origLimiterQuietPeriod
+}
+
+func (s *clientRetrySuite) TestOK(c *check.C) {
+	s.respStatus <- http.StatusOK
+	err := s.client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.IsNil)
+	c.Check(s.reqs, check.HasLen, 1)
+}
+
+func (s *clientRetrySuite) TestNetworkError(c *check.C) {
+	// Close the stub server to produce a "connection refused" error.
+	s.server.Close()
+
+	start := time.Now()
+	timeout := time.Second
+	ctx, cancel := context.WithDeadline(context.Background(), start.Add(timeout))
+	defer cancel()
+	s.client.Timeout = timeout * 2
+	err := s.client.RequestAndDecodeContext(ctx, &struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.ErrorMatches, `.*dial tcp .* connection refused.*`)
+	delta := time.Since(start)
+	c.Check(delta > timeout, check.Equals, true, check.Commentf("time.Since(start) == %v, timeout = %v", delta, timeout))
+}
+
+func (s *clientRetrySuite) TestNonRetryableError(c *check.C) {
+	s.respStatus <- http.StatusBadRequest
+	err := s.client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.ErrorMatches, `.*400 Bad Request.*`)
+	c.Check(s.reqs, check.HasLen, 1)
+}
+
+// as of 0.7.2., retryablehttp does not recognize this as a
+// non-retryable error.
+func (s *clientRetrySuite) TestNonRetryableStdlibError(c *check.C) {
+	s.respStatus <- http.StatusOK
+	req, err := http.NewRequest(http.MethodGet, "https://"+s.client.APIHost+"/test", nil)
+	c.Assert(err, check.IsNil)
+	req.Header.Set("Good-Header", "T\033rrible header value")
+	err = s.client.DoAndDecode(&struct{}{}, req)
+	c.Check(err, check.ErrorMatches, `.*after 1 attempt.*net/http: invalid header .*`)
+	if !c.Check(s.reqs, check.HasLen, 0) {
+		c.Logf("%v", s.reqs[0])
+	}
+}
+
+func (s *clientRetrySuite) TestNonRetryableAfter503s(c *check.C) {
+	time.AfterFunc(time.Second, func() { s.respStatus <- http.StatusNotFound })
+	err := s.client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.ErrorMatches, `.*404 Not Found.*`)
+}
+
+func (s *clientRetrySuite) TestOKAfter503s(c *check.C) {
+	start := time.Now()
+	delay := time.Second
+	time.AfterFunc(delay, func() { s.respStatus <- http.StatusOK })
+	err := s.client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.IsNil)
+	c.Check(len(s.reqs) > 1, check.Equals, true, check.Commentf("len(s.reqs) == %d", len(s.reqs)))
+	c.Check(time.Since(start) > delay, check.Equals, true)
+}
+
+func (s *clientRetrySuite) TestTimeoutAfter503(c *check.C) {
+	s.respStatus <- http.StatusServiceUnavailable
+	s.respDelay = time.Second * 2
+	s.client.Timeout = time.Second / 2
+	err := s.client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.ErrorMatches, `.*503 Service Unavailable.*`)
+	c.Check(s.reqs, check.HasLen, 2)
+}
+
+func (s *clientRetrySuite) Test503Forever(c *check.C) {
+	err := s.client.RequestAndDecode(&struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.ErrorMatches, `.*503 Service Unavailable.*`)
+	c.Check(len(s.reqs) > 1, check.Equals, true, check.Commentf("len(s.reqs) == %d", len(s.reqs)))
+}
+
+func (s *clientRetrySuite) TestContextAlreadyCanceled(c *check.C) {
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel()
+	err := s.client.RequestAndDecodeContext(ctx, &struct{}{}, http.MethodGet, "test", nil, nil)
+	c.Check(err, check.Equals, context.Canceled)
+}
+
+func (s *clientRetrySuite) TestExponentialBackoff(c *check.C) {
+	var min, max time.Duration
+	min, max = time.Second, 64*time.Second
+
+	t := exponentialBackoff(min, max, 0, nil)
+	c.Check(t, check.Equals, min)
+
+	for e := float64(1); e < 5; e += 1 {
+		ok := false
+		for i := 0; i < 20; i++ {
+			t = exponentialBackoff(min, max, int(e), nil)
+			// Every returned value must be between min and min(2^e, max)
+			c.Check(t >= min, check.Equals, true)
+			c.Check(t <= min*time.Duration(math.Pow(2, e)), check.Equals, true)
+			c.Check(t <= max, check.Equals, true)
+			// Check that jitter is actually happening by
+			// checking that at least one in 20 trials is
+			// between min*2^(e-.75) and min*2^(e-.25)
+			jittermin := time.Duration(float64(min) * math.Pow(2, e-0.75))
+			jittermax := time.Duration(float64(min) * math.Pow(2, e-0.25))
+			c.Logf("min %v max %v e %v jittermin %v jittermax %v t %v", min, max, e, jittermin, jittermax, t)
+			if t > jittermin && t < jittermax {
+				ok = true
+				break
+			}
+		}
+		c.Check(ok, check.Equals, true)
+	}
+
+	for i := 0; i < 20; i++ {
+		t := exponentialBackoff(min, max, 100, nil)
+		c.Check(t < max, check.Equals, true)
+	}
+
+	for _, trial := range []struct {
+		retryAfter string
+		expect     time.Duration
+	}{
+		{"1", time.Second * 4},             // minimum enforced
+		{"5", time.Second * 5},             // header used
+		{"55", time.Second * 10},           // maximum enforced
+		{"eleventy-nine", time.Second * 4}, // invalid header, exponential backoff used
+		{time.Now().UTC().Add(time.Second).Format(time.RFC1123), time.Second * 4},  // minimum enforced
+		{time.Now().UTC().Add(time.Minute).Format(time.RFC1123), time.Second * 10}, // maximum enforced
+		{time.Now().UTC().Add(-time.Minute).Format(time.RFC1123), time.Second * 4}, // minimum enforced
+	} {
+		c.Logf("trial %+v", trial)
+		t := exponentialBackoff(time.Second*4, time.Second*10, 0, &http.Response{
+			StatusCode: http.StatusTooManyRequests,
+			Header:     http.Header{"Retry-After": {trial.retryAfter}}})
+		c.Check(t, check.Equals, trial.expect)
+	}
+	t = exponentialBackoff(time.Second*4, time.Second*10, 0, &http.Response{
+		StatusCode: http.StatusTooManyRequests,
+	})
+	c.Check(t, check.Equals, time.Second*4)
+
+	t = exponentialBackoff(0, max, 0, nil)
+	c.Check(t, check.Equals, time.Duration(0))
+	t = exponentialBackoff(0, max, 1, nil)
+	c.Check(t, check.Not(check.Equals), time.Duration(0))
+}