5538: using fake arvados server to generate errors, added tests with retries.
[arvados.git] / sdk / go / arvadosclient / arvadosclient_test.go
index 678c53310e359c8e8783b5652c9ad6c7bff1e3c9..26a4349acdb35076634d58470cf15232464b949f 100644 (file)
@@ -1,11 +1,12 @@
 package arvadosclient
 
 import (
-       "fmt"
+       "git.curoverse.com/arvados.git/sdk/go/arvadostest"
        . "gopkg.in/check.v1"
+       "net"
        "net/http"
        "os"
-       "os/exec"
+       "strings"
        "testing"
 )
 
@@ -15,51 +16,93 @@ 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 pythonDir() string {
-       cwd, _ := os.Getwd()
-       return fmt.Sprintf("%s/../../python/tests", cwd)
+func (s *ServerRequiredSuite) SetUpSuite(c *C) {
+       arvadostest.StartAPI()
+       arvadostest.StartKeep(2, false)
 }
 
-func (s *ServerRequiredSuite) SetUpSuite(c *C) {
-       os.Chdir(pythonDir())
-       if err := exec.Command("python", "run_test_server.py", "start").Run(); err != nil {
-               panic("'python run_test_server.py start' returned error")
-       }
-       if err := exec.Command("python", "run_test_server.py", "start_keep").Run(); err != nil {
-               panic("'python run_test_server.py start_keep' returned error")
-       }
+func (s *ServerRequiredSuite) SetUpTest(c *C) {
+       arvadostest.ResetEnv()
 }
 
-func (s *ServerRequiredSuite) TestMakeArvadosClient(c *C) {
-       os.Setenv("ARVADOS_API_HOST", "localhost:3001")
-       os.Setenv("ARVADOS_API_TOKEN", "4axaw8zxe0qm22wa6urpp5nskcne8z88cvbupv653y1njyi05h")
+func (s *ServerRequiredSuite) TestMakeArvadosClientSecure(c *C) {
        os.Setenv("ARVADOS_API_HOST_INSECURE", "")
-
        kc, err := MakeArvadosClient()
-       c.Check(kc.ApiServer, Equals, "localhost:3001")
-       c.Check(kc.ApiToken, Equals, "4axaw8zxe0qm22wa6urpp5nskcne8z88cvbupv653y1njyi05h")
+       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)
+}
 
+func (s *ServerRequiredSuite) TestMakeArvadosClientInsecure(c *C) {
        os.Setenv("ARVADOS_API_HOST_INSECURE", "true")
-
-       kc, err = MakeArvadosClient()
-       c.Check(kc.ApiServer, Equals, "localhost:3001")
-       c.Check(kc.ApiToken, Equals, "4axaw8zxe0qm22wa6urpp5nskcne8z88cvbupv653y1njyi05h")
+       kc, 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.Assert(err, Equals, nil)
+func (s *ServerRequiredSuite) TestGetInvalidUUID(c *C) {
+       arv, err := MakeArvadosClient()
+
+       getback := make(Dict)
+       err = arv.Get("collections", "", nil, &getback)
+       c.Assert(err, Equals, ErrInvalidArgument)
+       c.Assert(len(getback), Equals, 0)
+
+       err = arv.Get("collections", "zebra-moose-unicorn", nil, &getback)
+       c.Assert(err, Equals, ErrInvalidArgument)
+       c.Assert(len(getback), Equals, 0)
+
+       err = arv.Get("collections", "acbd18db4cc2f85cedef654fccc4a4d8", nil, &getback)
+       c.Assert(err, Equals, ErrInvalidArgument)
+       c.Assert(len(getback), Equals, 0)
 }
 
-func (s *ServerRequiredSuite) TestCreatePipelineTemplate(c *C) {
-       os.Setenv("ARVADOS_API_HOST", "localhost:3001")
-       os.Setenv("ARVADOS_API_TOKEN", "4axaw8zxe0qm22wa6urpp5nskcne8z88cvbupv653y1njyi05h")
-       os.Setenv("ARVADOS_API_HOST_INSECURE", "true")
+func (s *ServerRequiredSuite) TestGetValidUUID(c *C) {
+       arv, err := MakeArvadosClient()
 
+       getback := make(Dict)
+       err = arv.Get("collections", "zzzzz-4zz18-abcdeabcdeabcde", nil, &getback)
+       c.Assert(err, FitsTypeOf, APIServerError{})
+       c.Assert(err.(APIServerError).HttpStatusCode, Equals, http.StatusNotFound)
+       c.Assert(len(getback), Equals, 0)
+
+       err = arv.Get("collections", "acbd18db4cc2f85cedef654fccc4a4d8+3", nil, &getback)
+       c.Assert(err, FitsTypeOf, APIServerError{})
+       c.Assert(err.(APIServerError).HttpStatusCode, Equals, http.StatusNotFound)
+       c.Assert(len(getback), Equals, 0)
+}
+
+func (s *ServerRequiredSuite) TestInvalidResourceType(c *C) {
+       arv, err := MakeArvadosClient()
+
+       getback := make(Dict)
+       err = arv.Get("unicorns", "zzzzz-zebra-unicorn7unicorn", nil, &getback)
+       c.Assert(err, FitsTypeOf, APIServerError{})
+       c.Assert(err.(APIServerError).HttpStatusCode, Equals, http.StatusNotFound)
+       c.Assert(len(getback), Equals, 0)
+
+       err = arv.Update("unicorns", "zzzzz-zebra-unicorn7unicorn", nil, &getback)
+       c.Assert(err, FitsTypeOf, APIServerError{})
+       c.Assert(err.(APIServerError).HttpStatusCode, Equals, http.StatusNotFound)
+       c.Assert(len(getback), Equals, 0)
+
+       err = arv.List("unicorns", nil, &getback)
+       c.Assert(err, FitsTypeOf, APIServerError{})
+       c.Assert(err.(APIServerError).HttpStatusCode, Equals, http.StatusNotFound)
+       c.Assert(len(getback), Equals, 0)
+}
+
+func (s *ServerRequiredSuite) TestCreatePipelineTemplate(c *C) {
        arv, err := MakeArvadosClient()
 
        getback := make(Dict)
@@ -75,6 +118,13 @@ func (s *ServerRequiredSuite) TestCreatePipelineTemplate(c *C) {
        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{
@@ -89,3 +139,191 @@ func (s *ServerRequiredSuite) TestCreatePipelineTemplate(c *C) {
        c.Assert(err, Equals, nil)
        c.Assert(getback["name"], Equals, "tmp2")
 }
+
+func (s *ServerRequiredSuite) TestErrorResponse(c *C) {
+       arv, _ := MakeArvadosClient()
+
+       getback := make(Dict)
+
+       {
+               err := arv.Create("logs",
+                       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, FitsTypeOf, APIServerError{})
+               c.Assert(err.(APIServerError).HttpStatusCode, Equals, 422)
+       }
+
+       {
+               err := arv.Create("bogus",
+                       Dict{"bogus": Dict{}},
+                       &getback)
+               c.Assert(err, ErrorMatches, "arvados API server error: .*")
+               c.Assert(err, ErrorMatches, ".*Path not found.*")
+               c.Assert(err, FitsTypeOf, APIServerError{})
+               c.Assert(err.(APIServerError).HttpStatusCode, Equals, 404)
+       }
+}
+
+func (s *ServerRequiredSuite) TestAPIDiscovery_Get_defaultCollectionReplication(c *C) {
+       arv, err := MakeArvadosClient()
+       value, err := arv.Discovery("defaultCollectionReplication")
+       c.Assert(err, IsNil)
+       c.Assert(value, NotNil)
+}
+
+func (s *ServerRequiredSuite) TestAPIDiscovery_Get_noSuchParameter(c *C) {
+       arv, err := MakeArvadosClient()
+       value, err := arv.Discovery("noSuchParameter")
+       c.Assert(err, NotNil)
+       c.Assert(value, IsNil)
+}
+
+type UnitSuite struct{}
+
+func (s *UnitSuite) TestUUIDMatch(c *C) {
+       c.Assert(UUIDMatch("zzzzz-tpzed-000000000000000"), Equals, true)
+       c.Assert(UUIDMatch("zzzzz-zebra-000000000000000"), Equals, true)
+       c.Assert(UUIDMatch("00000-00000-zzzzzzzzzzzzzzz"), Equals, true)
+       c.Assert(UUIDMatch("ZEBRA-HORSE-AFRICANELEPHANT"), Equals, false)
+       c.Assert(UUIDMatch(" zzzzz-tpzed-000000000000000"), Equals, false)
+       c.Assert(UUIDMatch("d41d8cd98f00b204e9800998ecf8427e"), Equals, false)
+       c.Assert(UUIDMatch("d41d8cd98f00b204e9800998ecf8427e+0"), Equals, false)
+       c.Assert(UUIDMatch(""), Equals, false)
+}
+
+func (s *UnitSuite) TestPDHMatch(c *C) {
+       c.Assert(PDHMatch("zzzzz-tpzed-000000000000000"), Equals, false)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e"), Equals, false)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e+0"), Equals, true)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e+12345"), Equals, true)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e 12345"), Equals, false)
+       c.Assert(PDHMatch("D41D8CD98F00B204E9800998ECF8427E+12345"), Equals, false)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e+12345 "), Equals, false)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e+abcdef"), Equals, false)
+       c.Assert(PDHMatch("da39a3ee5e6b4b0d3255bfef95601890afd80709"), Equals, false)
+       c.Assert(PDHMatch("da39a3ee5e6b4b0d3255bfef95601890afd80709+0"), Equals, false)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427+12345"), Equals, false)
+       c.Assert(PDHMatch("d41d8cd98f00b204e9800998ecf8427e+12345\n"), Equals, false)
+       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) {
+}
+
+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 FailHandler struct {
+       status int
+}
+
+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)
+       }
+}
+
+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
+       } else {
+               resp.WriteHeader(http.StatusOK)
+               respJSON := []byte(`{"name":"testing"}`)
+               resp.Write(respJSON)
+       }
+}
+
+func (s *MockArvadosServerSuite) TestFailThenSucceed(c *C) {
+       for _, testCase := range []string{
+               "get",
+               "create",
+       } {
+               stub := &FailThenSucceedHandler{0, 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, IsNil)
+               c.Assert(getback["name"], Equals, "testing")
+       }
+}