1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
20 "git.arvados.org/arvados.git/sdk/go/arvados"
21 "git.arvados.org/arvados.git/sdk/go/arvadostest"
22 "git.arvados.org/arvados.git/sdk/go/auth"
23 "git.arvados.org/arvados.git/sdk/go/ctxlog"
24 "git.arvados.org/arvados.git/sdk/go/httpserver"
25 "github.com/prometheus/client_golang/prometheus"
26 check "gopkg.in/check.v1"
29 // Gocheck boilerplate
30 func Test(t *testing.T) {
34 var _ = check.Suite(&HandlerSuite{})
36 type HandlerSuite struct {
37 cluster *arvados.Cluster
40 cancel context.CancelFunc
43 func (s *HandlerSuite) SetUpTest(c *check.C) {
44 s.ctx, s.cancel = context.WithCancel(context.Background())
45 s.ctx = ctxlog.Context(s.ctx, ctxlog.New(os.Stderr, "json", "debug"))
46 s.cluster = &arvados.Cluster{
48 PostgreSQL: integrationTestCluster().PostgreSQL,
50 s.cluster.API.RequestTimeout = arvados.Duration(5 * time.Minute)
51 s.cluster.TLS.Insecure = true
52 arvadostest.SetServiceURL(&s.cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
53 arvadostest.SetServiceURL(&s.cluster.Services.Controller, "http://localhost:/")
54 s.handler = newHandler(s.ctx, s.cluster, "", prometheus.NewRegistry())
57 func (s *HandlerSuite) TearDownTest(c *check.C) {
61 func (s *HandlerSuite) TestConfigExport(c *check.C) {
62 s.cluster.ManagementToken = "secret"
63 s.cluster.SystemRootToken = "secret"
64 s.cluster.Collections.BlobSigning = true
65 s.cluster.Collections.BlobSigningTTL = arvados.Duration(23 * time.Second)
66 for _, method := range []string{"GET", "OPTIONS"} {
67 req := httptest.NewRequest(method, "/arvados/v1/config", nil)
68 resp := httptest.NewRecorder()
69 s.handler.ServeHTTP(resp, req)
70 c.Log(resp.Body.String())
71 if !c.Check(resp.Code, check.Equals, http.StatusOK) {
74 c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, `*`)
75 c.Check(resp.Header().Get("Access-Control-Allow-Methods"), check.Matches, `.*\bGET\b.*`)
76 c.Check(resp.Header().Get("Access-Control-Allow-Headers"), check.Matches, `.+`)
77 if method == "OPTIONS" {
78 c.Check(resp.Body.String(), check.HasLen, 0)
81 var cluster arvados.Cluster
82 err := json.Unmarshal(resp.Body.Bytes(), &cluster)
83 c.Check(err, check.IsNil)
84 c.Check(cluster.ManagementToken, check.Equals, "")
85 c.Check(cluster.SystemRootToken, check.Equals, "")
86 c.Check(cluster.Collections.BlobSigning, check.Equals, true)
87 c.Check(cluster.Collections.BlobSigningTTL, check.Equals, arvados.Duration(23*time.Second))
91 func (s *HandlerSuite) TestProxyDiscoveryDoc(c *check.C) {
92 req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
93 resp := httptest.NewRecorder()
94 s.handler.ServeHTTP(resp, req)
95 c.Check(resp.Code, check.Equals, http.StatusOK)
96 var dd arvados.DiscoveryDocument
97 err := json.Unmarshal(resp.Body.Bytes(), &dd)
98 c.Check(err, check.IsNil)
99 c.Check(dd.BlobSignatureTTL, check.Not(check.Equals), int64(0))
100 c.Check(dd.BlobSignatureTTL > 0, check.Equals, true)
101 c.Check(len(dd.Resources), check.Not(check.Equals), 0)
102 c.Check(len(dd.Schemas), check.Not(check.Equals), 0)
105 func (s *HandlerSuite) TestRequestTimeout(c *check.C) {
106 s.cluster.API.RequestTimeout = arvados.Duration(time.Nanosecond)
107 req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
108 resp := httptest.NewRecorder()
109 s.handler.ServeHTTP(resp, req)
110 c.Check(resp.Code, check.Equals, http.StatusBadGateway)
111 var jresp httpserver.ErrorResponse
112 err := json.Unmarshal(resp.Body.Bytes(), &jresp)
113 c.Check(err, check.IsNil)
114 c.Assert(len(jresp.Errors), check.Equals, 1)
115 c.Check(jresp.Errors[0], check.Matches, `.*context deadline exceeded.*`)
118 func (s *HandlerSuite) TestProxyWithoutToken(c *check.C) {
119 req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
120 resp := httptest.NewRecorder()
121 s.handler.ServeHTTP(resp, req)
122 c.Check(resp.Code, check.Equals, http.StatusUnauthorized)
123 jresp := map[string]interface{}{}
124 err := json.Unmarshal(resp.Body.Bytes(), &jresp)
125 c.Check(err, check.IsNil)
126 c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
129 func (s *HandlerSuite) TestProxyWithToken(c *check.C) {
130 req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
131 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
132 resp := httptest.NewRecorder()
133 s.handler.ServeHTTP(resp, req)
134 c.Check(resp.Code, check.Equals, http.StatusOK)
136 err := json.Unmarshal(resp.Body.Bytes(), &u)
137 c.Check(err, check.IsNil)
138 c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
141 func (s *HandlerSuite) TestProxyWithTokenInRequestBody(c *check.C) {
142 req := httptest.NewRequest("POST", "/arvados/v1/users/current", strings.NewReader(url.Values{
144 "api_token": {arvadostest.ActiveToken},
146 req.Header.Set("Content-type", "application/x-www-form-urlencoded")
147 resp := httptest.NewRecorder()
148 s.handler.ServeHTTP(resp, req)
149 c.Check(resp.Code, check.Equals, http.StatusOK)
151 err := json.Unmarshal(resp.Body.Bytes(), &u)
152 c.Check(err, check.IsNil)
153 c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
156 func (s *HandlerSuite) TestProxyNotFound(c *check.C) {
157 req := httptest.NewRequest("GET", "/arvados/v1/xyzzy", nil)
158 resp := httptest.NewRecorder()
159 s.handler.ServeHTTP(resp, req)
160 c.Check(resp.Code, check.Equals, http.StatusNotFound)
161 jresp := map[string]interface{}{}
162 err := json.Unmarshal(resp.Body.Bytes(), &jresp)
163 c.Check(err, check.IsNil)
164 c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
167 func (s *HandlerSuite) TestProxyRedirect(c *check.C) {
168 s.cluster.Login.SSO.Enable = true
169 s.cluster.Login.SSO.ProviderAppID = "test"
170 s.cluster.Login.SSO.ProviderAppSecret = "test"
171 req := httptest.NewRequest("GET", "https://0.0.0.0:1/login?return_to=foo", nil)
172 resp := httptest.NewRecorder()
173 s.handler.ServeHTTP(resp, req)
174 if !c.Check(resp.Code, check.Equals, http.StatusFound) {
175 c.Log(resp.Body.String())
177 // Old "proxy entire request" code path returns an absolute
178 // URL. New lib/controller/federation code path returns a
180 c.Check(resp.Header().Get("Location"), check.Matches, `(https://0.0.0.0:1)?/auth/joshid\?return_to=%2Cfoo&?`)
183 func (s *HandlerSuite) TestLogoutSSO(c *check.C) {
184 s.cluster.Login.SSO.Enable = true
185 s.cluster.Login.SSO.ProviderAppID = "test"
186 req := httptest.NewRequest("GET", "https://0.0.0.0:1/logout?return_to=https://example.com/foo", nil)
187 resp := httptest.NewRecorder()
188 s.handler.ServeHTTP(resp, req)
189 if !c.Check(resp.Code, check.Equals, http.StatusFound) {
190 c.Log(resp.Body.String())
192 c.Check(resp.Header().Get("Location"), check.Equals, "http://localhost:3002/users/sign_out?"+url.Values{"redirect_uri": {"https://example.com/foo"}}.Encode())
195 func (s *HandlerSuite) TestLogoutGoogle(c *check.C) {
196 s.cluster.Login.Google.Enable = true
197 s.cluster.Login.Google.ClientID = "test"
198 req := httptest.NewRequest("GET", "https://0.0.0.0:1/logout?return_to=https://example.com/foo", nil)
199 resp := httptest.NewRecorder()
200 s.handler.ServeHTTP(resp, req)
201 if !c.Check(resp.Code, check.Equals, http.StatusFound) {
202 c.Log(resp.Body.String())
204 c.Check(resp.Header().Get("Location"), check.Equals, "https://example.com/foo")
207 func (s *HandlerSuite) TestValidateV1APIToken(c *check.C) {
208 req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
209 user, ok, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveToken)
210 c.Assert(err, check.IsNil)
211 c.Check(ok, check.Equals, true)
212 c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
213 c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
214 c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
215 c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
218 func (s *HandlerSuite) TestValidateV2APIToken(c *check.C) {
219 req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
220 user, ok, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveTokenV2)
221 c.Assert(err, check.IsNil)
222 c.Check(ok, check.Equals, true)
223 c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
224 c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
225 c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
226 c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
227 c.Check(user.Authorization.TokenV2(), check.Equals, arvadostest.ActiveTokenV2)
230 func (s *HandlerSuite) TestValidateRemoteToken(c *check.C) {
231 saltedToken, err := auth.SaltToken(arvadostest.ActiveTokenV2, "abcde")
232 c.Assert(err, check.IsNil)
233 for _, trial := range []struct {
237 {http.StatusOK, saltedToken},
238 {http.StatusUnauthorized, "bogus"},
240 req := httptest.NewRequest("GET", "https://0.0.0.0:1/arvados/v1/users/current?remote=abcde", nil)
241 req.Header.Set("Authorization", "Bearer "+trial.token)
242 resp := httptest.NewRecorder()
243 s.handler.ServeHTTP(resp, req)
244 if !c.Check(resp.Code, check.Equals, trial.code) {
245 c.Logf("HTTP %d: %s", resp.Code, resp.Body.String())
250 func (s *HandlerSuite) TestCreateAPIToken(c *check.C) {
251 req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
252 auth, err := s.handler.(*Handler).createAPItoken(req, arvadostest.ActiveUserUUID, nil)
253 c.Assert(err, check.IsNil)
254 c.Check(auth.Scopes, check.DeepEquals, []string{"all"})
256 user, ok, err := s.handler.(*Handler).validateAPItoken(req, auth.TokenV2())
257 c.Assert(err, check.IsNil)
258 c.Check(ok, check.Equals, true)
259 c.Check(user.Authorization.UUID, check.Equals, auth.UUID)
260 c.Check(user.Authorization.APIToken, check.Equals, auth.APIToken)
261 c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
262 c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
263 c.Check(user.Authorization.TokenV2(), check.Equals, auth.TokenV2())
266 func (s *HandlerSuite) CheckObjectType(c *check.C, url string, token string, skippedFields map[string]bool) {
267 var proxied, direct map[string]interface{}
270 // Get collection from controller
271 req := httptest.NewRequest("GET", url, nil)
272 req.Header.Set("Authorization", "Bearer "+token)
273 resp := httptest.NewRecorder()
274 s.handler.ServeHTTP(resp, req)
275 c.Assert(resp.Code, check.Equals, http.StatusOK,
276 check.Commentf("Wasn't able to get data from the controller at %q", url))
277 err = json.Unmarshal(resp.Body.Bytes(), &proxied)
278 c.Check(err, check.Equals, nil)
280 // Get collection directly from RailsAPI
281 client := &http.Client{
282 Transport: &http.Transport{
283 TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
286 resp2, err := client.Get(s.cluster.Services.RailsAPI.ExternalURL.String() + url + "/?api_token=" + token)
287 c.Check(err, check.Equals, nil)
288 c.Assert(resp2.StatusCode, check.Equals, http.StatusOK,
289 check.Commentf("Wasn't able to get data from the RailsAPI at %q", url))
290 defer resp2.Body.Close()
291 db, err := ioutil.ReadAll(resp2.Body)
292 c.Check(err, check.Equals, nil)
293 err = json.Unmarshal(db, &direct)
294 c.Check(err, check.Equals, nil)
296 // Check that all RailsAPI provided keys exist on the controller response.
297 for k := range direct {
298 if _, ok := skippedFields[k]; ok {
300 } else if val, ok := proxied[k]; ok {
301 if direct["kind"] == "arvados#collection" && k == "manifest_text" {
302 // Tokens differ from request to request
303 c.Check(strings.Split(val.(string), "+A")[0], check.Equals, strings.Split(direct[k].(string), "+A")[0])
305 c.Check(val, check.DeepEquals, direct[k],
306 check.Commentf("RailsAPI %s key %q's value %q differs from controller's %q.", direct["kind"], k, direct[k], val))
309 c.Errorf("%s's key %q missing on controller's response.", direct["kind"], k)
314 func (s *HandlerSuite) TestGetObjects(c *check.C) {
315 // Get the 1st keep service's uuid from the running test server.
316 req := httptest.NewRequest("GET", "/arvados/v1/keep_services/", nil)
317 req.Header.Set("Authorization", "Bearer "+arvadostest.AdminToken)
318 resp := httptest.NewRecorder()
319 s.handler.ServeHTTP(resp, req)
320 c.Assert(resp.Code, check.Equals, http.StatusOK)
321 var ksList arvados.KeepServiceList
322 json.Unmarshal(resp.Body.Bytes(), &ksList)
323 c.Assert(len(ksList.Items), check.Not(check.Equals), 0)
324 ksUUID := ksList.Items[0].UUID
326 testCases := map[string]map[string]bool{
327 "api_clients/" + arvadostest.TrustedWorkbenchAPIClientUUID: nil,
328 "api_client_authorizations/" + arvadostest.AdminTokenUUID: nil,
329 "authorized_keys/" + arvadostest.AdminAuthorizedKeysUUID: nil,
330 "collections/" + arvadostest.CollectionWithUniqueWordsUUID: {"href": true},
331 "containers/" + arvadostest.RunningContainerUUID: nil,
332 "container_requests/" + arvadostest.QueuedContainerRequestUUID: nil,
333 "groups/" + arvadostest.AProjectUUID: nil,
334 "keep_services/" + ksUUID: nil,
335 "links/" + arvadostest.ActiveUserCanReadAllUsersLinkUUID: nil,
336 "logs/" + arvadostest.CrunchstatForRunningJobLogUUID: nil,
337 "nodes/" + arvadostest.IdleNodeUUID: nil,
338 "repositories/" + arvadostest.ArvadosRepoUUID: nil,
339 "users/" + arvadostest.ActiveUserUUID: {"href": true},
340 "virtual_machines/" + arvadostest.TestVMUUID: nil,
341 "workflows/" + arvadostest.WorkflowWithDefinitionYAMLUUID: nil,
343 for url, skippedFields := range testCases {
344 s.CheckObjectType(c, "/arvados/v1/"+url, arvadostest.AdminToken, skippedFields)