X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ffdfd0ac6e501514c5327c2d6b5f8507bb6353bc..7aaf9f22aa646077b4b7fd961d6b731185b88137:/sdk/go/arvadosclient/arvadosclient_test.go diff --git a/sdk/go/arvadosclient/arvadosclient_test.go b/sdk/go/arvadosclient/arvadosclient_test.go index 20cac55092..27e23c1aea 100644 --- a/sdk/go/arvadosclient/arvadosclient_test.go +++ b/sdk/go/arvadosclient/arvadosclient_test.go @@ -1,14 +1,20 @@ +// 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.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvadostest" + . "gopkg.in/check.v1" ) // Gocheck boilerplate @@ -24,36 +30,40 @@ var _ = Suite(&MockArvadosServerSuite{}) 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) +} + func (s *ServerRequiredSuite) SetUpTest(c *C) { arvadostest.ResetEnv() } 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) { arv, err := MakeArvadosClient() + c.Assert(err, IsNil) getback := make(Dict) err = arv.Get("collections", "", nil, &getback) @@ -71,6 +81,7 @@ func (s *ServerRequiredSuite) TestGetInvalidUUID(c *C) { func (s *ServerRequiredSuite) TestGetValidUUID(c *C) { arv, err := MakeArvadosClient() + c.Assert(err, IsNil) getback := make(Dict) err = arv.Get("collections", "zzzzz-4zz18-abcdeabcdeabcde", nil, &getback) @@ -86,6 +97,7 @@ func (s *ServerRequiredSuite) TestGetValidUUID(c *C) { func (s *ServerRequiredSuite) TestInvalidResourceType(c *C) { arv, err := MakeArvadosClient() + c.Assert(err, IsNil) getback := make(Dict) err = arv.Get("unicorns", "zzzzz-zebra-unicorn7unicorn", nil, &getback) @@ -104,55 +116,6 @@ func (s *ServerRequiredSuite) TestInvalidResourceType(c *C) { c.Assert(len(getback), Equals, 0) } -func (s *ServerRequiredSuite) TestCreatePipelineTemplate(c *C) { - arv, err := MakeArvadosClient() - - 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) { arv, _ := MakeArvadosClient() @@ -163,7 +126,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) } @@ -181,6 +144,7 @@ func (s *ServerRequiredSuite) TestErrorResponse(c *C) { func (s *ServerRequiredSuite) TestAPIDiscovery_Get_defaultCollectionReplication(c *C) { arv, err := MakeArvadosClient() + c.Assert(err, IsNil) value, err := arv.Discovery("defaultCollectionReplication") c.Assert(err, IsNil) c.Assert(value, NotNil) @@ -188,11 +152,68 @@ func (s *ServerRequiredSuite) TestAPIDiscovery_Get_defaultCollectionReplication( func (s *ServerRequiredSuite) TestAPIDiscovery_Get_noSuchParameter(c *C) { arv, err := MakeArvadosClient() + c.Assert(err, IsNil) value, err := arv.Discovery("noSuchParameter") c.Assert(err, NotNil) c.Assert(value, IsNil) } +func (s *ServerRequiredSuite) TestAPIClusterConfig_Get_StorageClasses(c *C) { + arv, err := MakeArvadosClient() + c.Assert(err, IsNil) + data, err := arv.ClusterConfig("StorageClasses") + c.Assert(err, IsNil) + c.Assert(data, NotNil) + clusterConfig := data.(map[string]interface{}) + _, ok := clusterConfig["default"] + c.Assert(ok, Equals, true) +} + +func (s *ServerRequiredSuite) TestAPIClusterConfig_Get_All(c *C) { + arv, err := MakeArvadosClient() + c.Assert(err, IsNil) + data, err := arv.ClusterConfig("") + c.Assert(err, IsNil) + c.Assert(data, NotNil) + clusterConfig := data.(map[string]interface{}) + _, ok := clusterConfig["StorageClasses"] + c.Assert(ok, Equals, true) +} + +func (s *ServerRequiredSuite) TestAPIClusterConfig_Get_noSuchSection(c *C) { + arv, err := MakeArvadosClient() + c.Assert(err, IsNil) + data, err := arv.ClusterConfig("noSuchSection") + c.Assert(err, NotNil) + c.Assert(data, IsNil) +} + +func (s *ServerRequiredSuite) TestCreateLarge(c *C) { + arv, err := MakeArvadosClient() + c.Assert(err, IsNil) + + txt := arvados.SignLocator("d41d8cd98f00b204e9800998ecf8427e+0", arv.ApiToken, time.Now().Add(time.Minute), time.Minute, []byte(arvadostest.SystemRootToken)) + // Ensure our request body is bigger than the Go http server's + // default max size, 10 MB. + for len(txt) < 12000000 { + txt = txt + " " + txt + } + txt = ". " + txt + " 0:0:foo\n" + + resp := Dict{} + err = arv.Create("collections", Dict{ + "ensure_unique_name": true, + "collection": Dict{ + "is_trashed": true, + "name": "test", + "manifest_text": txt, + }, + }, &resp) + c.Check(err, IsNil) + c.Check(resp["portable_data_hash"], Not(Equals), "") + c.Check(resp["portable_data_hash"], Not(Equals), "d41d8cd98f00b204e9800998ecf8427e+0") +} + type UnitSuite struct{} func (s *UnitSuite) TestUUIDMatch(c *C) { @@ -249,73 +270,94 @@ func RunFakeArvadosServer(st http.Handler) (api APIServer, err error) { return } -type FailHandler struct { - status int -} - -func (h FailHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { - resp.WriteHeader(h.status) +type APIStub struct { + method string + retryAttempts int + expected int + respStatus []int + responseBody []string } -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{Transport: &http.Transport{}}, - 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() @@ -329,15 +371,32 @@ func (s *MockArvadosServerSuite) TestFailThenSucceed(c *C) { 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") } }