Merge branch '21666-provision-test-improvement'
[arvados.git] / sdk / go / arvadosclient / arvadosclient_test.go
index f5ce338af19f303f4d080e7f0e242398be9d8a7b..b074e21e8124f88e7831fc21b184d070e9d0079a 100644 (file)
@@ -1,15 +1,20 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+
 package arvadosclient
 
 import (
        "fmt"
-       "git.curoverse.com/arvados.git/sdk/go/arvadostest"
-       . "gopkg.in/check.v1"
        "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
@@ -25,9 +30,12 @@ var _ = Suite(&MockArvadosServerSuite{})
 type ServerRequiredSuite struct{}
 
 func (s *ServerRequiredSuite) SetUpSuite(c *C) {
-       arvadostest.StartAPI()
        arvadostest.StartKeep(2, false)
-       RetryDelay = 0
+       RetryDelay = 2 * time.Second
+}
+
+func (s *ServerRequiredSuite) TearDownSuite(c *C) {
+       arvadostest.StopKeep(2)
 }
 
 func (s *ServerRequiredSuite) SetUpTest(c *C) {
@@ -36,25 +44,26 @@ 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) {
        arv, err := MakeArvadosClient()
+       c.Assert(err, IsNil)
 
        getback := make(Dict)
        err = arv.Get("collections", "", nil, &getback)
@@ -72,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)
@@ -87,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)
@@ -105,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()
 
@@ -164,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 attributebogus_attr.*")
+               c.Assert(err, ErrorMatches, ".*unknown attribute(: | ')bogus_attr.*")
                c.Assert(err, FitsTypeOf, APIServerError{})
                c.Assert(err.(APIServerError).HttpStatusCode, Equals, 422)
        }
@@ -182,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)
@@ -189,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) {
@@ -228,7 +248,7 @@ func (s *UnitSuite) TestPDHMatch(c *C) {
 type MockArvadosServerSuite struct{}
 
 func (s *MockArvadosServerSuite) SetUpSuite(c *C) {
-       RetryDelay = 0
+       RetryDelay = 100 * time.Millisecond
 }
 
 func (s *MockArvadosServerSuite) SetUpTest(c *C) {
@@ -259,8 +279,19 @@ type APIStub struct {
 }
 
 func (h *APIStub) ServeHTTP(resp http.ResponseWriter, req *http.Request) {
-       resp.WriteHeader(h.respStatus[h.retryAttempts])
-       resp.Write([]byte(h.responseBody[h.retryAttempts]))
+       if status := h.respStatus[h.retryAttempts]; status < 0 {
+               // Fail the client's Do() by hanging up without
+               // sending an HTTP response header.
+               conn, _, err := resp.(http.Hijacker).Hijack()
+               if err != nil {
+                       panic(err)
+               }
+               conn.Write([]byte("zzzzzzzzzz"))
+               conn.Close()
+       } else {
+               resp.WriteHeader(status)
+               resp.Write([]byte(h.responseBody[h.retryAttempts]))
+       }
        h.retryAttempts++
 }
 
@@ -273,22 +304,22 @@ func (s *MockArvadosServerSuite) TestWithRetries(c *C) {
                        "create", 0, 200, []int{200, 500}, []string{`{"ok":"ok"}`, ``},
                },
                {
-                       "get", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+                       "get", 0, 423, []int{500, 500, 423, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
                },
                {
-                       "create", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+                       "create", 0, 423, []int{500, 500, 423, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
                },
                {
-                       "update", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+                       "update", 0, 422, []int{500, 500, 422, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
                },
                {
-                       "delete", 0, 500, []int{500, 500, 500, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+                       "delete", 0, 422, []int{500, 500, 422, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
                },
                {
-                       "get", 0, 502, []int{500, 500, 502, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+                       "get", 0, 401, []int{500, 502, 401, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
                },
                {
-                       "create", 0, 502, []int{500, 500, 502, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
+                       "create", 0, 422, []int{500, 502, 422, 200}, []string{``, ``, ``, `{"ok":"ok"}`},
                },
                {
                        "get", 0, 200, []int{500, 500, 200}, []string{``, ``, `{"ok":"ok"}`},
@@ -308,21 +339,34 @@ func (s *MockArvadosServerSuite) TestWithRetries(c *C) {
                {
                        "create", 0, 401, []int{401, 200}, []string{``, `{"ok":"ok"}`},
                },
+               {
+                       "create", 0, 403, []int{403, 200}, []string{``, `{"ok":"ok"}`},
+               },
+               {
+                       "create", 0, 422, []int{422, 200}, []string{``, `{"ok":"ok"}`},
+               },
                {
                        "get", 0, 404, []int{404, 200}, []string{``, `{"ok":"ok"}`},
                },
                {
                        "get", 0, 401, []int{500, 401, 200}, []string{``, ``, `{"ok":"ok"}`},
                },
-               // Use expected = 0 to simulate error during request processing
-               // Even though retryable, the simulated error applies during reties also, and hence "get" also eventually fails in this test.
+
+               // 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, 0, []int{500, 500, 500}, []string{``, ``, ``},
+                       "get", 0, 200, []int{-1, -1, 200}, []string{``, ``, `{"ok":"ok"}`},
                },
+               // "POST" protocol error is safe to retry
                {
-                       "create", 0, 0, []int{500, 500, 500}, []string{``, ``, ``},
+                       "create", 0, 200, []int{-1, 200}, []string{``, `{"ok":"ok"}`},
                },
        } {
+               c.Logf("stub: %#v", stub)
+
                api, err := RunFakeArvadosServer(&stub)
                c.Check(err, IsNil)
 
@@ -336,12 +380,6 @@ func (s *MockArvadosServerSuite) TestWithRetries(c *C) {
                        Client:      &http.Client{Transport: &http.Transport{}},
                        Retries:     2}
 
-               // We use expected = 0 to look for errors during request processing
-               // Simulate an error using https (but the arv.Client transport used does not support it)
-               if stub.expected == 0 {
-                       arv.Scheme = "https"
-               }
-
                getback := make(Dict)
                switch stub.method {
                case "get":
@@ -358,17 +396,18 @@ func (s *MockArvadosServerSuite) TestWithRetries(c *C) {
                        err = arv.Delete("pipeline_templates", "zzzzz-4zz18-znfnqtbbv4spc3w", nil, &getback)
                }
 
-               if stub.expected == 200 {
+               switch stub.expected {
+               case 200:
                        c.Check(err, IsNil)
-                       c.Assert(getback["ok"], Equals, "ok")
-               } else {
+                       c.Check(getback["ok"], Equals, "ok")
+               case -1:
                        c.Check(err, NotNil)
-
-                       if stub.expected == 0 { // test uses 0 to look for errors during request processing
-                               c.Check(strings.Contains(err.Error(), fmt.Sprintf("%s", "tls: oversized record received")), Equals, true)
-                       } else {
-                               c.Check(strings.Contains(err.Error(), fmt.Sprintf("%s%d", "arvados API server error: ", stub.expected)), Equals, true)
-                               c.Assert(err.(APIServerError).HttpStatusCode, Equals, stub.expected)
+                       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))
+                       if c.Check(err, FitsTypeOf, APIServerError{}) {
+                               c.Check(err.(APIServerError).HttpStatusCode, Equals, stub.expected)
                        }
                }
        }