14287: Move federation.Interface to arvados.API.
[arvados.git] / lib / controller / router / router_test.go
index 9664907dae5e62e215960eabac2543fd0463c6d1..daa2ac9bf7074d7ae79eb0f6a095aa84de0bda8f 100644 (file)
@@ -11,6 +11,7 @@ import (
        "net/http"
        "net/http/httptest"
        "os"
+       "strings"
        "testing"
        "time"
 
@@ -38,7 +39,7 @@ func (s *RouterSuite) SetUpTest(c *check.C) {
        s.rtr = New(cluster)
 }
 
-func (s *RouterSuite) TearDownTest(c *check.C) {
+func (s *RouterSuite) TearDownSuite(c *check.C) {
        err := arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil)
        c.Check(err, check.IsNil)
 }
@@ -49,37 +50,60 @@ func (s *RouterSuite) doRequest(c *check.C, token, method, path string, hdrs htt
                req.Header[k] = v
        }
        req.Header.Set("Authorization", "Bearer "+token)
-       rw := httptest.NewRecorder()
-       s.rtr.ServeHTTP(rw, req)
-       c.Logf("response body: %s", rw.Body.String())
+       rr := httptest.NewRecorder()
+       s.rtr.ServeHTTP(rr, req)
+       c.Logf("response body: %s", rr.Body.String())
        var jresp map[string]interface{}
-       err := json.Unmarshal(rw.Body.Bytes(), &jresp)
+       err := json.Unmarshal(rr.Body.Bytes(), &jresp)
        c.Check(err, check.IsNil)
-       return req, rw, jresp
+       return req, rr, jresp
 }
 
-func (s *RouterSuite) TestCollectionParams(c *check.C) {
+func (s *RouterSuite) TestCollectionResponses(c *check.C) {
        token := arvadostest.ActiveTokenV2
 
-       _, rw, jresp := s.doRequest(c, token, "GET", `/arvados/v1/collections?include_trash=true`, nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
-       c.Check(jresp["items_available"], check.FitsTypeOf, float64(0))
-       c.Check(jresp["kind"], check.Equals, "arvados#collectionList")
-       c.Check(jresp["items"].([]interface{})[0].(map[string]interface{})["kind"], check.Equals, "arvados#collection")
-
-       _, rw, jresp = s.doRequest(c, token, "GET", `/arvados/v1/collections`, nil, bytes.NewBufferString(`{"include_trash":true}`))
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       // Check "get collection" response has "kind" key
+       _, rr, jresp := s.doRequest(c, 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")
        c.Check(jresp["items"].([]interface{})[0].(map[string]interface{})["kind"], check.Equals, "arvados#collection")
 
-       _, rw, jresp = s.doRequest(c, token, "POST", `/arvados/v1/collections`, http.Header{"Content-Type": {"application/x-www-form-urlencoded"}}, bytes.NewBufferString(`ensure_unique_name=true`))
-       c.Check(rw.Code, check.Equals, http.StatusOK)
-       c.Check(jresp["uuid"], check.FitsTypeOf, "")
-       c.Check(jresp["kind"], check.Equals, "arvados#collection")
+       // Check items in list response have a "kind" key regardless
+       // of whether a uuid/pdh is selected.
+       for _, selectj := range []string{
+               ``,
+               `,"select":["portable_data_hash"]`,
+               `,"select":["name"]`,
+               `,"select":["uuid"]`,
+       } {
+               _, rr, jresp = s.doRequest(c, 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))
+               c.Check(jresp["kind"], check.Equals, "arvados#collectionList")
+               item0 := jresp["items"].([]interface{})[0].(map[string]interface{})
+               c.Check(item0["kind"], check.Equals, "arvados#collection")
+               if selectj == "" || strings.Contains(selectj, "portable_data_hash") {
+                       c.Check(item0["portable_data_hash"], check.Equals, arvadostest.FooCollectionPDH)
+               } else {
+                       c.Check(item0["portable_data_hash"], check.IsNil)
+               }
+               if selectj == "" || strings.Contains(selectj, "name") {
+                       c.Check(item0["name"], check.FitsTypeOf, "")
+               } else {
+                       c.Check(item0["name"], check.IsNil)
+               }
+               if selectj == "" || strings.Contains(selectj, "uuid") {
+                       c.Check(item0["uuid"], check.Equals, arvadostest.FooCollection)
+               } else {
+                       c.Check(item0["uuid"], check.IsNil)
+               }
+       }
 
-       _, rw, jresp = s.doRequest(c, token, "POST", `/arvados/v1/collections?ensure_unique_name=true`, nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       // 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`))
+       c.Check(rr.Code, check.Equals, http.StatusOK)
        c.Check(jresp["uuid"], check.FitsTypeOf, "")
        c.Check(jresp["kind"], check.Equals, "arvados#collection")
 }
@@ -87,14 +111,14 @@ func (s *RouterSuite) TestCollectionParams(c *check.C) {
 func (s *RouterSuite) TestContainerList(c *check.C) {
        token := arvadostest.ActiveTokenV2
 
-       _, rw, jresp := s.doRequest(c, token, "GET", `/arvados/v1/containers?limit=0`, nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       _, rr, jresp := s.doRequest(c, 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.HasLen, 0)
 
-       _, rw, jresp = s.doRequest(c, token, "GET", `/arvados/v1/containers?limit=2&select=["uuid","command"]`, nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       _, rr, jresp = s.doRequest(c, 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)
        c.Check(jresp["items"], check.HasLen, 2)
@@ -104,8 +128,8 @@ func (s *RouterSuite) TestContainerList(c *check.C) {
        c.Check(item0["command"].([]interface{})[0], check.FitsTypeOf, "")
        c.Check(item0["mounts"], check.IsNil)
 
-       _, rw, jresp = s.doRequest(c, token, "GET", `/arvados/v1/containers`, nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       _, rr, jresp = s.doRequest(c, 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)
        avail := int(jresp["items_available"].(float64))
@@ -120,20 +144,20 @@ func (s *RouterSuite) TestContainerList(c *check.C) {
 func (s *RouterSuite) TestContainerLock(c *check.C) {
        uuid := arvadostest.QueuedContainerUUID
        token := arvadostest.AdminToken
-       _, rw, jresp := s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/lock", nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       _, rr, jresp := s.doRequest(c, 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")
-       _, rw, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/lock", nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusUnprocessableEntity)
-       c.Check(rw.Body.String(), check.Not(check.Matches), `.*"uuid":.*`)
-       _, rw, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       _, rr, jresp = s.doRequest(c, 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)
+       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)
-       _, rw, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusUnprocessableEntity)
+       _, rr, jresp = s.doRequest(c, token, "POST", "/arvados/v1/containers/"+uuid+"/unlock", nil, nil)
+       c.Check(rr.Code, check.Equals, http.StatusUnprocessableEntity)
        c.Check(jresp["uuid"], check.IsNil)
 }
 
@@ -141,8 +165,8 @@ func (s *RouterSuite) TestFullTimestampsInResponse(c *check.C) {
        uuid := arvadostest.CollectionReplicationDesired2Confirmed2UUID
        token := arvadostest.ActiveTokenV2
 
-       _, rw, jresp := s.doRequest(c, token, "GET", `/arvados/v1/collections/`+uuid, nil, nil)
-       c.Check(rw.Code, check.Equals, http.StatusOK)
+       _, rr, jresp := s.doRequest(c, 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{
                "created_at":  596506000, // fixture says 596506247, but truncated by postgresql
@@ -168,8 +192,8 @@ func (s *RouterSuite) TestSelectParam(c *check.C) {
        } {
                j, err := json.Marshal(sel)
                c.Assert(err, check.IsNil)
-               _, rw, resp := s.doRequest(c, token, "GET", "/arvados/v1/containers/"+uuid+"?select="+string(j), nil, nil)
-               c.Check(rw.Code, check.Equals, http.StatusOK)
+               _, rr, resp := s.doRequest(c, 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["uuid"], check.HasLen, 27)
@@ -179,3 +203,71 @@ func (s *RouterSuite) TestSelectParam(c *check.C) {
                c.Check(hasMounts, check.Equals, false)
        }
 }
+
+func (s *RouterSuite) TestRouteNotFound(c *check.C) {
+       token := arvadostest.ActiveTokenV2
+       req := (&testReq{
+               method: "POST",
+               path:   "arvados/v1/collections/" + arvadostest.FooCollection + "/error404pls",
+               token:  token,
+       }).Request()
+       rr := httptest.NewRecorder()
+       s.rtr.ServeHTTP(rr, req)
+       c.Check(rr.Code, check.Equals, http.StatusNotFound)
+       c.Logf("body: %q", rr.Body.String())
+       var j map[string]interface{}
+       err := json.Unmarshal(rr.Body.Bytes(), &j)
+       c.Check(err, check.IsNil)
+       c.Logf("decoded: %v", j)
+       c.Assert(j["errors"], check.FitsTypeOf, []interface{}{})
+       c.Check(j["errors"].([]interface{})[0], check.Equals, "API endpoint not found")
+}
+
+func (s *RouterSuite) TestCORS(c *check.C) {
+       token := arvadostest.ActiveTokenV2
+       req := (&testReq{
+               method: "OPTIONS",
+               path:   "arvados/v1/collections/" + arvadostest.FooCollection,
+               header: http.Header{"Origin": {"https://example.com"}},
+               token:  token,
+       }).Request()
+       rr := httptest.NewRecorder()
+       s.rtr.ServeHTTP(rr, req)
+       c.Check(rr.Code, check.Equals, http.StatusOK)
+       c.Check(rr.Body.String(), check.HasLen, 0)
+       c.Check(rr.Result().Header.Get("Access-Control-Allow-Origin"), check.Equals, "*")
+       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"} {
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Methods"), check.Matches, ".*"+method+".*")
+       }
+
+       for _, unsafe := range []string{"login", "logout", "auth", "auth/foo", "login/?blah"} {
+               req := (&testReq{
+                       method: "OPTIONS",
+                       path:   unsafe,
+                       header: http.Header{"Origin": {"https://example.com"}},
+                       token:  token,
+               }).Request()
+               rr := httptest.NewRecorder()
+               s.rtr.ServeHTTP(rr, req)
+               c.Check(rr.Code, check.Equals, http.StatusOK)
+               c.Check(rr.Body.String(), check.HasLen, 0)
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Origin"), check.Equals, "")
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Methods"), check.Equals, "")
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Headers"), check.Equals, "")
+
+               req = (&testReq{
+                       method: "POST",
+                       path:   unsafe,
+                       header: http.Header{"Origin": {"https://example.com"}},
+                       token:  token,
+               }).Request()
+               rr = httptest.NewRecorder()
+               s.rtr.ServeHTTP(rr, req)
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Origin"), check.Equals, "")
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Methods"), check.Equals, "")
+               c.Check(rr.Result().Header.Get("Access-Control-Allow-Headers"), check.Equals, "")
+       }
+}