X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/579f6139c9c03fe1b08993746c87aa525ff314e9..fbeb2feadb8d7615480d5174bbf5d3acf2556576:/sdk/go/arvadosclient/arvadosclient_test.go

diff --git a/sdk/go/arvadosclient/arvadosclient_test.go b/sdk/go/arvadosclient/arvadosclient_test.go
index 2f180b11df..372f09d14b 100644
--- a/sdk/go/arvadosclient/arvadosclient_test.go
+++ b/sdk/go/arvadosclient/arvadosclient_test.go
@@ -1,14 +1,19 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+
 package arvadosclient
 
 import (
-	"git.curoverse.com/arvados.git/sdk/go/arvadostest"
-	. "gopkg.in/check.v1"
+	"fmt"
 	"net"
 	"net/http"
 	"os"
-	"strings"
 	"testing"
 	"time"
+
+	"git.curoverse.com/arvados.git/sdk/go/arvadostest"
+	. "gopkg.in/check.v1"
 )
 
 // Gocheck boilerplate
@@ -26,6 +31,12 @@ type ServerRequiredSuite struct{}
 func (s *ServerRequiredSuite) SetUpSuite(c *C) {
 	arvadostest.StartAPI()
 	arvadostest.StartKeep(2, false)
+	RetryDelay = 0
+}
+
+func (s *ServerRequiredSuite) TearDownSuite(c *C) {
+	arvadostest.StopKeep(2)
+	arvadostest.StopAPI()
 }
 
 func (s *ServerRequiredSuite) SetUpTest(c *C) {
@@ -34,21 +45,21 @@ func (s *ServerRequiredSuite) SetUpTest(c *C) {
 
 func (s *ServerRequiredSuite) TestMakeArvadosClientSecure(c *C) {
 	os.Setenv("ARVADOS_API_HOST_INSECURE", "")
-	kc, err := MakeArvadosClient()
+	ac, err := MakeArvadosClient()
 	c.Assert(err, Equals, nil)
-	c.Check(kc.ApiServer, Equals, os.Getenv("ARVADOS_API_HOST"))
-	c.Check(kc.ApiToken, Equals, os.Getenv("ARVADOS_API_TOKEN"))
-	c.Check(kc.ApiInsecure, Equals, false)
+	c.Check(ac.ApiServer, Equals, os.Getenv("ARVADOS_API_HOST"))
+	c.Check(ac.ApiToken, Equals, os.Getenv("ARVADOS_API_TOKEN"))
+	c.Check(ac.ApiInsecure, Equals, false)
 }
 
 func (s *ServerRequiredSuite) TestMakeArvadosClientInsecure(c *C) {
 	os.Setenv("ARVADOS_API_HOST_INSECURE", "true")
-	kc, err := MakeArvadosClient()
+	ac, err := MakeArvadosClient()
 	c.Assert(err, Equals, nil)
-	c.Check(kc.ApiInsecure, Equals, true)
-	c.Check(kc.ApiServer, Equals, os.Getenv("ARVADOS_API_HOST"))
-	c.Check(kc.ApiToken, Equals, os.Getenv("ARVADOS_API_TOKEN"))
-	c.Check(kc.Client.Transport.(*http.Transport).TLSClientConfig.InsecureSkipVerify, Equals, true)
+	c.Check(ac.ApiInsecure, Equals, true)
+	c.Check(ac.ApiServer, Equals, os.Getenv("ARVADOS_API_HOST"))
+	c.Check(ac.ApiToken, Equals, os.Getenv("ARVADOS_API_TOKEN"))
+	c.Check(ac.Client.Transport.(*http.Transport).TLSClientConfig.InsecureSkipVerify, Equals, true)
 }
 
 func (s *ServerRequiredSuite) TestGetInvalidUUID(c *C) {
@@ -162,7 +173,7 @@ func (s *ServerRequiredSuite) TestErrorResponse(c *C) {
 			Dict{"log": Dict{"bogus_attr": "foo"}},
 			&getback)
 		c.Assert(err, ErrorMatches, "arvados API server error: .*")
-		c.Assert(err, ErrorMatches, ".*unknown attribute: bogus_attr.*")
+		c.Assert(err, ErrorMatches, ".*unknown attribute(: | ')bogus_attr.*")
 		c.Assert(err, FitsTypeOf, APIServerError{})
 		c.Assert(err.(APIServerError).HttpStatusCode, Equals, 422)
 	}
@@ -226,6 +237,7 @@ func (s *UnitSuite) TestPDHMatch(c *C) {
 type MockArvadosServerSuite struct{}
 
 func (s *MockArvadosServerSuite) SetUpSuite(c *C) {
+	RetryDelay = 0
 }
 
 func (s *MockArvadosServerSuite) SetUpTest(c *C) {
@@ -247,73 +259,94 @@ func RunFakeArvadosServer(st http.Handler) (api APIServer, err error) {
 	return
 }
 
-type FailHandler struct {
-	status int
+type APIStub struct {
+	method        string
+	retryAttempts int
+	expected      int
+	respStatus    []int
+	responseBody  []string
 }
 
-func (h FailHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) {
-	resp.WriteHeader(h.status)
-}
-
-func (s *MockArvadosServerSuite) TestFailWithRetries(c *C) {
-	for _, testCase := range []string{
-		"get",
-		"create",
-	} {
-		stub := FailHandler{500}
-
-		api, err := RunFakeArvadosServer(stub)
-		c.Check(err, IsNil)
-
-		defer api.listener.Close()
-
-		arv := ArvadosClient{
-			Scheme:      "http",
-			ApiServer:   api.url,
-			ApiToken:    "abc123",
-			ApiInsecure: true,
-			Client:      &http.Client{},
-			Retries:     2}
-
-		getback := make(Dict)
-		switch testCase {
-		case "get":
-			err = arv.Get("collections", "zzzzz-4zz18-znfnqtbbv4spc3w", nil, &getback)
-		case "create":
-			err = arv.Create("collections",
-				Dict{"collection": Dict{"name": "testing"}},
-				&getback)
-		}
-		c.Check(err, NotNil)
-		c.Check(strings.Contains(err.Error(), "arvados API server error: 500"), Equals, true)
-		c.Assert(err.(APIServerError).HttpStatusCode, Equals, 500)
+func (h *APIStub) ServeHTTP(resp http.ResponseWriter, req *http.Request) {
+	if req.URL.Path == "/redirect-loop" {
+		http.Redirect(resp, req, "/redirect-loop", http.StatusFound)
+		return
 	}
-}
-
-type FailThenSucceedHandler struct {
-	count      int
-	failStatus int
-}
-
-func (h *FailThenSucceedHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) {
-	if h.count == 0 {
-		resp.WriteHeader(h.failStatus)
-		h.count += 1
+	if h.respStatus[h.retryAttempts] < 0 {
+		// Fail the client's Do() by starting a redirect loop
+		http.Redirect(resp, req, "/redirect-loop", http.StatusFound)
 	} else {
-		resp.WriteHeader(http.StatusOK)
-		respJSON := []byte(`{"name":"testing"}`)
-		resp.Write(respJSON)
+		resp.WriteHeader(h.respStatus[h.retryAttempts])
+		resp.Write([]byte(h.responseBody[h.retryAttempts]))
 	}
+	h.retryAttempts++
 }
 
-func (s *MockArvadosServerSuite) TestFailThenSucceed(c *C) {
-	for _, testCase := range []string{
-		"get",
-		"create",
+func (s *MockArvadosServerSuite) TestWithRetries(c *C) {
+	for _, stub := range []APIStub{
+		{
+			"get", 0, 200, []int{200, 500}, []string{`{"ok":"ok"}`, ``},
+		},
+		{
+			"create", 0, 200, []int{200, 500}, []string{`{"ok":"ok"}`, ``},
+		},
+		{
+			"get", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"create", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"update", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"delete", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"get", 0, 502, []int{500, 500, 502, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"create", 0, 502, []int{500, 500, 502, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"get", 0, 200, []int{500, 500, 200}, []string{``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"create", 0, 200, []int{500, 500, 200}, []string{``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"delete", 0, 200, []int{500, 500, 200}, []string{``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"update", 0, 200, []int{500, 500, 200}, []string{``, ``, `{"ok":"ok"}`},
+		},
+		{
+			"get", 0, 401, []int{401, 200}, []string{``, `{"ok":"ok"}`},
+		},
+		{
+			"create", 0, 401, []int{401, 200}, []string{``, `{"ok":"ok"}`},
+		},
+		{
+			"get", 0, 404, []int{404, 200}, []string{``, `{"ok":"ok"}`},
+		},
+		{
+			"get", 0, 401, []int{500, 401, 200}, []string{``, ``, `{"ok":"ok"}`},
+		},
+
+		// Response code -1 simulates an HTTP/network error
+		// (i.e., Do() returns an error; there is no HTTP
+		// response status code).
+
+		// Succeed on second retry
+		{
+			"get", 0, 200, []int{-1, -1, 200}, []string{``, ``, `{"ok":"ok"}`},
+		},
+		// "POST" is not safe to retry: fail after one error
+		{
+			"create", 0, -1, []int{-1, 200}, []string{``, `{"ok":"ok"}`},
+		},
 	} {
-		stub := &FailThenSucceedHandler{0, 500}
-
-		api, err := RunFakeArvadosServer(stub)
+		api, err := RunFakeArvadosServer(&stub)
 		c.Check(err, IsNil)
 
 		defer api.listener.Close()
@@ -323,19 +356,36 @@ func (s *MockArvadosServerSuite) TestFailThenSucceed(c *C) {
 			ApiServer:   api.url,
 			ApiToken:    "abc123",
 			ApiInsecure: true,
-			Client:      &http.Client{},
+			Client:      &http.Client{Transport: &http.Transport{}},
 			Retries:     2}
 
 		getback := make(Dict)
-		switch testCase {
+		switch stub.method {
 		case "get":
 			err = arv.Get("collections", "zzzzz-4zz18-znfnqtbbv4spc3w", nil, &getback)
 		case "create":
 			err = arv.Create("collections",
 				Dict{"collection": Dict{"name": "testing"}},
 				&getback)
+		case "update":
+			err = arv.Update("collections", "zzzzz-4zz18-znfnqtbbv4spc3w",
+				Dict{"collection": Dict{"name": "testing"}},
+				&getback)
+		case "delete":
+			err = arv.Delete("pipeline_templates", "zzzzz-4zz18-znfnqtbbv4spc3w", nil, &getback)
+		}
+
+		switch stub.expected {
+		case 200:
+			c.Check(err, IsNil)
+			c.Check(getback["ok"], Equals, "ok")
+		case -1:
+			c.Check(err, NotNil)
+			c.Check(err, ErrorMatches, `.*stopped after \d+ redirects`)
+		default:
+			c.Check(err, NotNil)
+			c.Check(err, ErrorMatches, fmt.Sprintf("arvados API server error: %d.*", stub.expected))
+			c.Check(err.(APIServerError).HttpStatusCode, Equals, stub.expected)
 		}
-		c.Check(err, IsNil)
-		c.Assert(getback["name"], Equals, "testing")
 	}
 }