Merge branch '17521-dot-slash-glob' refs #17521
[arvados.git] / lib / controller / router / router_test.go
index d53d4945b87417200b623bbd42a80a8431a5cadc..0330ec4252c9ad3ee8f461faf9ce7508c17bd3fc 100644 (file)
@@ -10,13 +10,16 @@ import (
        "io"
        "net/http"
        "net/http/httptest"
+       "net/url"
        "os"
        "strings"
        "testing"
        "time"
 
-       "git.curoverse.com/arvados.git/sdk/go/arvados"
-       "git.curoverse.com/arvados.git/sdk/go/arvadostest"
+       "git.arvados.org/arvados.git/lib/controller/rpc"
+       "git.arvados.org/arvados.git/sdk/go/arvados"
+       "git.arvados.org/arvados.git/sdk/go/arvadostest"
+       "github.com/gorilla/mux"
        check "gopkg.in/check.v1"
 )
 
@@ -28,42 +31,157 @@ func Test(t *testing.T) {
 var _ = check.Suite(&RouterSuite{})
 
 type RouterSuite struct {
-       rtr *router
+       rtr  *router
+       stub arvadostest.APIStub
 }
 
 func (s *RouterSuite) SetUpTest(c *check.C) {
-       cluster := &arvados.Cluster{
-               TLS: arvados.TLS{Insecure: true},
+       s.stub = arvadostest.APIStub{}
+       s.rtr = &router{
+               mux:     mux.NewRouter(),
+               backend: &s.stub,
        }
-       arvadostest.SetServiceURL(&cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
-       s.rtr = New(cluster)
+       s.rtr.addRoutes()
 }
 
-func (s *RouterSuite) TearDownTest(c *check.C) {
-       err := arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil)
-       c.Check(err, check.IsNil)
-}
+func (s *RouterSuite) TestOptions(c *check.C) {
+       token := arvadostest.ActiveToken
+       for _, trial := range []struct {
+               method       string
+               path         string
+               header       http.Header
+               body         string
+               shouldStatus int // zero value means 200
+               shouldCall   string
+               withOptions  interface{}
+       }{
+               {
+                       method:      "GET",
+                       path:        "/arvados/v1/collections/" + arvadostest.FooCollection,
+                       shouldCall:  "CollectionGet",
+                       withOptions: arvados.GetOptions{UUID: arvadostest.FooCollection},
+               },
+               {
+                       method:      "PUT",
+                       path:        "/arvados/v1/collections/" + arvadostest.FooCollection,
+                       shouldCall:  "CollectionUpdate",
+                       withOptions: arvados.UpdateOptions{UUID: arvadostest.FooCollection},
+               },
+               {
+                       method:      "PATCH",
+                       path:        "/arvados/v1/collections/" + arvadostest.FooCollection,
+                       shouldCall:  "CollectionUpdate",
+                       withOptions: arvados.UpdateOptions{UUID: arvadostest.FooCollection},
+               },
+               {
+                       method:      "DELETE",
+                       path:        "/arvados/v1/collections/" + arvadostest.FooCollection,
+                       shouldCall:  "CollectionDelete",
+                       withOptions: arvados.DeleteOptions{UUID: arvadostest.FooCollection},
+               },
+               {
+                       method:      "POST",
+                       path:        "/arvados/v1/collections",
+                       shouldCall:  "CollectionCreate",
+                       withOptions: arvados.CreateOptions{},
+               },
+               {
+                       method:      "GET",
+                       path:        "/arvados/v1/collections",
+                       shouldCall:  "CollectionList",
+                       withOptions: arvados.ListOptions{Limit: -1},
+               },
+               {
+                       method:      "GET",
+                       path:        "/arvados/v1/collections?limit=123&offset=456&include_trash=true&include_old_versions=1",
+                       shouldCall:  "CollectionList",
+                       withOptions: arvados.ListOptions{Limit: 123, Offset: 456, IncludeTrash: true, IncludeOldVersions: true},
+               },
+               {
+                       method:      "POST",
+                       path:        "/arvados/v1/collections?limit=123&_method=GET",
+                       body:        `{"offset":456,"include_trash":true,"include_old_versions":true}`,
+                       shouldCall:  "CollectionList",
+                       withOptions: arvados.ListOptions{Limit: 123, Offset: 456, IncludeTrash: true, IncludeOldVersions: true},
+               },
+               {
+                       method:      "POST",
+                       path:        "/arvados/v1/collections?limit=123",
+                       body:        `{"offset":456,"include_trash":true,"include_old_versions":true}`,
+                       header:      http.Header{"X-Http-Method-Override": {"GET"}, "Content-Type": {"application/json"}},
+                       shouldCall:  "CollectionList",
+                       withOptions: arvados.ListOptions{Limit: 123, Offset: 456, IncludeTrash: true, IncludeOldVersions: true},
+               },
+               {
+                       method:      "POST",
+                       path:        "/arvados/v1/collections?limit=123",
+                       body:        "offset=456&include_trash=true&include_old_versions=1&_method=GET",
+                       header:      http.Header{"Content-Type": {"application/x-www-form-urlencoded"}},
+                       shouldCall:  "CollectionList",
+                       withOptions: arvados.ListOptions{Limit: 123, Offset: 456, IncludeTrash: true, IncludeOldVersions: true},
+               },
+               {
+                       method:       "PATCH",
+                       path:         "/arvados/v1/collections",
+                       shouldStatus: http.StatusMethodNotAllowed,
+               },
+               {
+                       method:       "PUT",
+                       path:         "/arvados/v1/collections",
+                       shouldStatus: http.StatusMethodNotAllowed,
+               },
+               {
+                       method:       "DELETE",
+                       path:         "/arvados/v1/collections",
+                       shouldStatus: http.StatusMethodNotAllowed,
+               },
+       } {
+               // Reset calls captured in previous trial
+               s.stub = arvadostest.APIStub{}
 
-func (s *RouterSuite) doRequest(c *check.C, token, method, path string, hdrs http.Header, body io.Reader) (*http.Request, *httptest.ResponseRecorder, map[string]interface{}) {
-       req := httptest.NewRequest(method, path, body)
-       for k, v := range hdrs {
-               req.Header[k] = v
+               c.Logf("trial: %#v", trial)
+               _, rr, _ := doRequest(c, s.rtr, token, trial.method, trial.path, trial.header, bytes.NewBufferString(trial.body))
+               if trial.shouldStatus == 0 {
+                       c.Check(rr.Code, check.Equals, http.StatusOK)
+               } else {
+                       c.Check(rr.Code, check.Equals, trial.shouldStatus)
+               }
+               calls := s.stub.Calls(nil)
+               if trial.shouldCall == "" {
+                       c.Check(calls, check.HasLen, 0)
+               } else if len(calls) != 1 {
+                       c.Check(calls, check.HasLen, 1)
+               } else {
+                       c.Check(calls[0].Method, isMethodNamed, trial.shouldCall)
+                       c.Check(calls[0].Options, check.DeepEquals, trial.withOptions)
+               }
        }
-       req.Header.Set("Authorization", "Bearer "+token)
-       rr := httptest.NewRecorder()
-       s.rtr.ServeHTTP(rr, req)
-       c.Logf("response body: %s", rr.Body.String())
-       var jresp map[string]interface{}
-       err := json.Unmarshal(rr.Body.Bytes(), &jresp)
+}
+
+var _ = check.Suite(&RouterIntegrationSuite{})
+
+type RouterIntegrationSuite struct {
+       rtr *router
+}
+
+func (s *RouterIntegrationSuite) SetUpTest(c *check.C) {
+       cluster := &arvados.Cluster{}
+       cluster.TLS.Insecure = true
+       arvadostest.SetServiceURL(&cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
+       url, _ := url.Parse("https://" + os.Getenv("ARVADOS_TEST_API_HOST"))
+       s.rtr = New(rpc.NewConn("zzzzz", url, true, rpc.PassthroughTokenProvider), Config{})
+}
+
+func (s *RouterIntegrationSuite) TearDownSuite(c *check.C) {
+       err := arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil)
        c.Check(err, check.IsNil)
-       return req, rr, jresp
 }
 
-func (s *RouterSuite) TestCollectionResponses(c *check.C) {
+func (s *RouterIntegrationSuite) TestCollectionResponses(c *check.C) {
        token := arvadostest.ActiveTokenV2
 
        // Check "get collection" response has "kind" key
-       _, rr, jresp := s.doRequest(c, token, "GET", `/arvados/v1/collections`, nil, bytes.NewBufferString(`{"include_trash":true}`))
+       _, rr, jresp := doRequest(c, s.rtr, token, "GET", `/arvados/v1/collections`, nil, bytes.NewBufferString(`{"include_trash":true}`))
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["items"], check.FitsTypeOf, []interface{}{})
        c.Check(jresp["kind"], check.Equals, "arvados#collectionList")
@@ -77,7 +195,7 @@ func (s *RouterSuite) TestCollectionResponses(c *check.C) {
                `,"select":["name"]`,
                `,"select":["uuid"]`,
        } {
-               _, rr, jresp = s.doRequest(c, token, "GET", `/arvados/v1/collections`, nil, bytes.NewBufferString(`{"where":{"uuid":["`+arvadostest.FooCollection+`"]}`+selectj+`}`))
+               _, rr, jresp = doRequest(c, s.rtr, token, "GET", `/arvados/v1/collections`, nil, bytes.NewBufferString(`{"where":{"uuid":["`+arvadostest.FooCollection+`"]}`+selectj+`}`))
                c.Check(rr.Code, check.Equals, http.StatusOK)
                c.Check(jresp["items"], check.FitsTypeOf, []interface{}{})
                c.Check(jresp["items_available"], check.FitsTypeOf, float64(0))
@@ -102,22 +220,57 @@ func (s *RouterSuite) TestCollectionResponses(c *check.C) {
        }
 
        // Check "create collection" response has "kind" key
-       _, rr, jresp = s.doRequest(c, token, "POST", `/arvados/v1/collections`, http.Header{"Content-Type": {"application/x-www-form-urlencoded"}}, bytes.NewBufferString(`ensure_unique_name=true`))
+       _, rr, jresp = doRequest(c, s.rtr, token, "POST", `/arvados/v1/collections`, http.Header{"Content-Type": {"application/x-www-form-urlencoded"}}, bytes.NewBufferString(`ensure_unique_name=true`))
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["uuid"], check.FitsTypeOf, "")
        c.Check(jresp["kind"], check.Equals, "arvados#collection")
 }
 
-func (s *RouterSuite) TestContainerList(c *check.C) {
+func (s *RouterIntegrationSuite) TestMaxRequestSize(c *check.C) {
+       token := arvadostest.ActiveTokenV2
+       for _, maxRequestSize := range []int{
+               // Ensure 5M limit is enforced.
+               5000000,
+               // Ensure 50M limit is enforced, and that a >25M body
+               // is accepted even though the default Go request size
+               // limit is 10M.
+               50000000,
+       } {
+               s.rtr.config.MaxRequestSize = maxRequestSize
+               okstr := "a"
+               for len(okstr) < maxRequestSize/2 {
+                       okstr = okstr + okstr
+               }
+
+               hdr := http.Header{"Content-Type": {"application/x-www-form-urlencoded"}}
+
+               body := bytes.NewBufferString(url.Values{"foo_bar": {okstr}}.Encode())
+               _, rr, _ := doRequest(c, s.rtr, token, "POST", `/arvados/v1/collections`, hdr, body)
+               c.Check(rr.Code, check.Equals, http.StatusOK)
+
+               body = bytes.NewBufferString(url.Values{"foo_bar": {okstr + okstr}}.Encode())
+               _, rr, _ = doRequest(c, s.rtr, token, "POST", `/arvados/v1/collections`, hdr, body)
+               c.Check(rr.Code, check.Equals, http.StatusRequestEntityTooLarge)
+       }
+}
+
+func (s *RouterIntegrationSuite) TestContainerList(c *check.C) {
        token := arvadostest.ActiveTokenV2
 
-       _, rr, jresp := s.doRequest(c, token, "GET", `/arvados/v1/containers?limit=0`, nil, nil)
+       _, rr, jresp := doRequest(c, s.rtr, token, "GET", `/arvados/v1/containers?limit=0`, nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["items_available"], check.FitsTypeOf, float64(0))
        c.Check(jresp["items_available"].(float64) > 2, check.Equals, true)
+       c.Check(jresp["items"], check.NotNil)
+       c.Check(jresp["items"], check.HasLen, 0)
+
+       _, rr, jresp = doRequest(c, s.rtr, token, "GET", `/arvados/v1/containers?filters=[["uuid","in",[]]]`, nil, nil)
+       c.Check(rr.Code, check.Equals, http.StatusOK)
+       c.Check(jresp["items_available"], check.Equals, float64(0))
+       c.Check(jresp["items"], check.NotNil)
        c.Check(jresp["items"], check.HasLen, 0)
 
-       _, rr, jresp = s.doRequest(c, token, "GET", `/arvados/v1/containers?limit=2&select=["uuid","command"]`, nil, nil)
+       _, rr, jresp = doRequest(c, s.rtr, token, "GET", `/arvados/v1/containers?limit=2&select=["uuid","command"]`, nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["items_available"], check.FitsTypeOf, float64(0))
        c.Check(jresp["items_available"].(float64) > 2, check.Equals, true)
@@ -128,7 +281,7 @@ func (s *RouterSuite) TestContainerList(c *check.C) {
        c.Check(item0["command"].([]interface{})[0], check.FitsTypeOf, "")
        c.Check(item0["mounts"], check.IsNil)
 
-       _, rr, jresp = s.doRequest(c, token, "GET", `/arvados/v1/containers`, nil, nil)
+       _, rr, jresp = doRequest(c, s.rtr, token, "GET", `/arvados/v1/containers`, nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["items_available"], check.FitsTypeOf, float64(0))
        c.Check(jresp["items_available"].(float64) > 2, check.Equals, true)
@@ -141,31 +294,37 @@ func (s *RouterSuite) TestContainerList(c *check.C) {
        c.Check(item0["mounts"], check.NotNil)
 }
 
-func (s *RouterSuite) TestContainerLock(c *check.C) {
+func (s *RouterIntegrationSuite) TestContainerLock(c *check.C) {
        uuid := arvadostest.QueuedContainerUUID
        token := arvadostest.AdminToken
-       _, rr, jresp := s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/lock", nil, nil)
+       _, rr, jresp := doRequest(c, s.rtr, token, "POST", "/arvados/v1/containers/"+uuid+"/lock", nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["uuid"], check.HasLen, 27)
        c.Check(jresp["state"], check.Equals, "Locked")
-       _, rr, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/lock", nil, nil)
+       _, rr, _ = doRequest(c, s.rtr, token, "POST", "/arvados/v1/containers/"+uuid+"/lock", nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusUnprocessableEntity)
        c.Check(rr.Body.String(), check.Not(check.Matches), `.*"uuid":.*`)
-       _, rr, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
+       _, rr, jresp = doRequest(c, s.rtr, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["uuid"], check.HasLen, 27)
        c.Check(jresp["state"], check.Equals, "Queued")
        c.Check(jresp["environment"], check.IsNil)
-       _, rr, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
+       _, rr, jresp = doRequest(c, s.rtr, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusUnprocessableEntity)
        c.Check(jresp["uuid"], check.IsNil)
 }
 
-func (s *RouterSuite) TestFullTimestampsInResponse(c *check.C) {
+func (s *RouterIntegrationSuite) TestWritableBy(c *check.C) {
+       _, rr, jresp := doRequest(c, s.rtr, arvadostest.ActiveTokenV2, "GET", `/arvados/v1/users/`+arvadostest.ActiveUserUUID, nil, nil)
+       c.Check(rr.Code, check.Equals, http.StatusOK)
+       c.Check(jresp["writable_by"], check.DeepEquals, []interface{}{"zzzzz-tpzed-000000000000000", "zzzzz-tpzed-xurymjxw79nv3jz", "zzzzz-j7d0g-48foin4vonvc2at"})
+}
+
+func (s *RouterIntegrationSuite) TestFullTimestampsInResponse(c *check.C) {
        uuid := arvadostest.CollectionReplicationDesired2Confirmed2UUID
        token := arvadostest.ActiveTokenV2
 
-       _, rr, jresp := s.doRequest(c, token, "GET", `/arvados/v1/collections/`+uuid, nil, nil)
+       _, rr, jresp := doRequest(c, s.rtr, token, "GET", `/arvados/v1/collections/`+uuid, nil, nil)
        c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["uuid"], check.Equals, uuid)
        expectNS := map[string]int{
@@ -182,7 +341,7 @@ func (s *RouterSuite) TestFullTimestampsInResponse(c *check.C) {
        }
 }
 
-func (s *RouterSuite) TestSelectParam(c *check.C) {
+func (s *RouterIntegrationSuite) TestSelectParam(c *check.C) {
        uuid := arvadostest.QueuedContainerUUID
        token := arvadostest.ActiveTokenV2
        for _, sel := range [][]string{
@@ -192,10 +351,12 @@ func (s *RouterSuite) TestSelectParam(c *check.C) {
        } {
                j, err := json.Marshal(sel)
                c.Assert(err, check.IsNil)
-               _, rr, resp := s.doRequest(c, token, "GET", "/arvados/v1/containers/"+uuid+"?select="+string(j), nil, nil)
+               _, rr, resp := doRequest(c, s.rtr, token, "GET", "/arvados/v1/containers/"+uuid+"?select="+string(j), nil, nil)
                c.Check(rr.Code, check.Equals, http.StatusOK)
 
                c.Check(resp["kind"], check.Equals, "arvados#container")
+               c.Check(resp["etag"], check.FitsTypeOf, "")
+               c.Check(resp["etag"], check.Not(check.Equals), "")
                c.Check(resp["uuid"], check.HasLen, 27)
                c.Check(resp["command"], check.HasLen, 2)
                c.Check(resp["mounts"], check.IsNil)
@@ -204,7 +365,12 @@ func (s *RouterSuite) TestSelectParam(c *check.C) {
        }
 }
 
-func (s *RouterSuite) TestRouteNotFound(c *check.C) {
+func (s *RouterIntegrationSuite) TestHEAD(c *check.C) {
+       _, rr, _ := doRequest(c, s.rtr, arvadostest.ActiveTokenV2, "HEAD", "/arvados/v1/containers/"+arvadostest.QueuedContainerUUID, nil, nil)
+       c.Check(rr.Code, check.Equals, http.StatusOK)
+}
+
+func (s *RouterIntegrationSuite) TestRouteNotFound(c *check.C) {
        token := arvadostest.ActiveTokenV2
        req := (&testReq{
                method: "POST",
@@ -223,7 +389,7 @@ func (s *RouterSuite) TestRouteNotFound(c *check.C) {
        c.Check(j["errors"].([]interface{})[0], check.Equals, "API endpoint not found")
 }
 
-func (s *RouterSuite) TestCORS(c *check.C) {
+func (s *RouterIntegrationSuite) TestCORS(c *check.C) {
        token := arvadostest.ActiveTokenV2
        req := (&testReq{
                method: "OPTIONS",
@@ -239,7 +405,7 @@ func (s *RouterSuite) TestCORS(c *check.C) {
        for _, hdr := range []string{"Authorization", "Content-Type"} {
                c.Check(rr.Result().Header.Get("Access-Control-Allow-Headers"), check.Matches, ".*"+hdr+".*")
        }
-       for _, method := range []string{"GET", "HEAD", "PUT", "POST", "DELETE"} {
+       for _, method := range []string{"GET", "HEAD", "PUT", "POST", "PATCH", "DELETE"} {
                c.Check(rr.Result().Header.Get("Access-Control-Allow-Methods"), check.Matches, ".*"+method+".*")
        }
 
@@ -271,3 +437,18 @@ func (s *RouterSuite) TestCORS(c *check.C) {
                c.Check(rr.Result().Header.Get("Access-Control-Allow-Headers"), check.Equals, "")
        }
 }
+
+func doRequest(c *check.C, rtr http.Handler, token, method, path string, hdrs http.Header, body io.Reader) (*http.Request, *httptest.ResponseRecorder, map[string]interface{}) {
+       req := httptest.NewRequest(method, path, body)
+       for k, v := range hdrs {
+               req.Header[k] = v
+       }
+       req.Header.Set("Authorization", "Bearer "+token)
+       rr := httptest.NewRecorder()
+       rtr.ServeHTTP(rr, req)
+       c.Logf("response body: %s", rr.Body.String())
+       var jresp map[string]interface{}
+       err := json.Unmarshal(rr.Body.Bytes(), &jresp)
+       c.Check(err, check.IsNil)
+       return req, rr, jresp
+}