X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/f96550cc40f340c79339338d1da81394bfcb64ad..0eb72b526bf8bbb011551ecf019f604e17a534f1:/sdk/go/arvadosclient/arvadosclient_test.go

diff --git a/sdk/go/arvadosclient/arvadosclient_test.go b/sdk/go/arvadosclient/arvadosclient_test.go
index d35f6dacb7..372f09d14b 100644
--- a/sdk/go/arvadosclient/arvadosclient_test.go
+++ b/sdk/go/arvadosclient/arvadosclient_test.go
@@ -1,11 +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"
 	"testing"
+	"time"
+
+	"git.curoverse.com/arvados.git/sdk/go/arvadostest"
+	. "gopkg.in/check.v1"
 )
 
 // Gocheck boilerplate
@@ -15,13 +23,20 @@ func Test(t *testing.T) {
 
 var _ = Suite(&ServerRequiredSuite{})
 var _ = Suite(&UnitSuite{})
+var _ = Suite(&MockArvadosServerSuite{})
 
 // Tests that require the Keep server running
 type ServerRequiredSuite struct{}
 
 func (s *ServerRequiredSuite) SetUpSuite(c *C) {
 	arvadostest.StartAPI()
-	arvadostest.StartKeep()
+	arvadostest.StartKeep(2, false)
+	RetryDelay = 0
+}
+
+func (s *ServerRequiredSuite) TearDownSuite(c *C) {
+	arvadostest.StopKeep(2)
+	arvadostest.StopAPI()
 }
 
 func (s *ServerRequiredSuite) SetUpTest(c *C) {
@@ -30,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) {
@@ -102,39 +117,50 @@ func (s *ServerRequiredSuite) TestInvalidResourceType(c *C) {
 func (s *ServerRequiredSuite) TestCreatePipelineTemplate(c *C) {
 	arv, err := MakeArvadosClient()
 
-	getback := make(Dict)
-	err = arv.Create("pipeline_templates",
-		Dict{"pipeline_template": Dict{
-			"name": "tmp",
-			"components": Dict{
-				"c1": map[string]string{"script": "script1"},
-				"c2": map[string]string{"script": "script2"}}}},
-		&getback)
-	c.Assert(err, Equals, nil)
-	c.Assert(getback["name"], Equals, "tmp")
-	c.Assert(getback["components"].(map[string]interface{})["c2"].(map[string]interface{})["script"], Equals, "script2")
-
-	uuid := getback["uuid"].(string)
-
-	getback = make(Dict)
-	err = arv.Get("pipeline_templates", uuid, nil, &getback)
-	c.Assert(err, Equals, nil)
-	c.Assert(getback["name"], Equals, "tmp")
-	c.Assert(getback["components"].(map[string]interface{})["c1"].(map[string]interface{})["script"], Equals, "script1")
-
-	getback = make(Dict)
-	err = arv.Update("pipeline_templates", uuid,
-		Dict{
-			"pipeline_template": Dict{"name": "tmp2"}},
-		&getback)
-	c.Assert(err, Equals, nil)
-	c.Assert(getback["name"], Equals, "tmp2")
-
-	c.Assert(getback["uuid"].(string), Equals, uuid)
-	getback = make(Dict)
-	err = arv.Delete("pipeline_templates", uuid, nil, &getback)
-	c.Assert(err, Equals, nil)
-	c.Assert(getback["name"], Equals, "tmp2")
+	for _, idleConnections := range []bool{
+		false,
+		true,
+	} {
+		if idleConnections {
+			arv.lastClosedIdlesAt = time.Now().Add(-time.Minute)
+		} else {
+			arv.lastClosedIdlesAt = time.Now()
+		}
+
+		getback := make(Dict)
+		err = arv.Create("pipeline_templates",
+			Dict{"pipeline_template": Dict{
+				"name": "tmp",
+				"components": Dict{
+					"c1": map[string]string{"script": "script1"},
+					"c2": map[string]string{"script": "script2"}}}},
+			&getback)
+		c.Assert(err, Equals, nil)
+		c.Assert(getback["name"], Equals, "tmp")
+		c.Assert(getback["components"].(map[string]interface{})["c2"].(map[string]interface{})["script"], Equals, "script2")
+
+		uuid := getback["uuid"].(string)
+
+		getback = make(Dict)
+		err = arv.Get("pipeline_templates", uuid, nil, &getback)
+		c.Assert(err, Equals, nil)
+		c.Assert(getback["name"], Equals, "tmp")
+		c.Assert(getback["components"].(map[string]interface{})["c1"].(map[string]interface{})["script"], Equals, "script1")
+
+		getback = make(Dict)
+		err = arv.Update("pipeline_templates", uuid,
+			Dict{
+				"pipeline_template": Dict{"name": "tmp2"}},
+			&getback)
+		c.Assert(err, Equals, nil)
+		c.Assert(getback["name"], Equals, "tmp2")
+
+		c.Assert(getback["uuid"].(string), Equals, uuid)
+		getback = make(Dict)
+		err = arv.Delete("pipeline_templates", uuid, nil, &getback)
+		c.Assert(err, Equals, nil)
+		c.Assert(getback["name"], Equals, "tmp2")
+	}
 }
 
 func (s *ServerRequiredSuite) TestErrorResponse(c *C) {
@@ -147,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)
 	}
@@ -206,3 +232,160 @@ func (s *UnitSuite) TestPDHMatch(c *C) {
 	c.Assert(PDHMatch("+12345"), Equals, false)
 	c.Assert(PDHMatch(""), Equals, false)
 }
+
+// Tests that use mock arvados server
+type MockArvadosServerSuite struct{}
+
+func (s *MockArvadosServerSuite) SetUpSuite(c *C) {
+	RetryDelay = 0
+}
+
+func (s *MockArvadosServerSuite) SetUpTest(c *C) {
+	arvadostest.ResetEnv()
+}
+
+type APIServer struct {
+	listener net.Listener
+	url      string
+}
+
+func RunFakeArvadosServer(st http.Handler) (api APIServer, err error) {
+	api.listener, err = net.ListenTCP("tcp", &net.TCPAddr{Port: 0})
+	if err != nil {
+		return
+	}
+	api.url = api.listener.Addr().String()
+	go http.Serve(api.listener, st)
+	return
+}
+
+type APIStub struct {
+	method        string
+	retryAttempts int
+	expected      int
+	respStatus    []int
+	responseBody  []string
+}
+
+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
+	}
+	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(h.respStatus[h.retryAttempts])
+		resp.Write([]byte(h.responseBody[h.retryAttempts]))
+	}
+	h.retryAttempts++
+}
+
+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"}`},
+		},
+	} {
+		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{Transport: &http.Transport{}},
+			Retries:     2}
+
+		getback := make(Dict)
+		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)
+		}
+	}
+}