1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
21 "git.curoverse.com/arvados.git/sdk/go/arvados"
22 "git.curoverse.com/arvados.git/sdk/go/arvadostest"
23 "git.curoverse.com/arvados.git/sdk/go/ctxlog"
24 "git.curoverse.com/arvados.git/sdk/go/httpserver"
25 "git.curoverse.com/arvados.git/sdk/go/keepclient"
26 "github.com/sirupsen/logrus"
27 check "gopkg.in/check.v1"
30 // Gocheck boilerplate
31 var _ = check.Suite(&FederationSuite{})
33 type FederationSuite struct {
34 log logrus.FieldLogger
35 // testServer and testHandler are the controller being tested,
37 testServer *httpserver.Server
39 // remoteServer ("zzzzz") forwards requests to the Rails API
40 // provided by the integration test environment.
41 remoteServer *httpserver.Server
42 // remoteMock ("zmock") appends each incoming request to
43 // remoteMockRequests, and returns 200 with an empty JSON
45 remoteMock *httpserver.Server
46 remoteMockRequests []http.Request
49 func (s *FederationSuite) SetUpTest(c *check.C) {
50 s.log = ctxlog.TestLogger(c)
52 s.remoteServer = newServerFromIntegrationTestEnv(c)
53 c.Assert(s.remoteServer.Start(), check.IsNil)
55 s.remoteMock = newServerFromIntegrationTestEnv(c)
56 s.remoteMock.Server.Handler = http.HandlerFunc(s.remoteMockHandler)
57 c.Assert(s.remoteMock.Start(), check.IsNil)
59 cluster := &arvados.Cluster{
61 PostgreSQL: integrationTestCluster().PostgreSQL,
62 EnableBetaController14287: enableBetaController14287,
64 cluster.TLS.Insecure = true
65 cluster.API.MaxItemsPerResponse = 1000
66 cluster.API.MaxRequestAmplification = 4
67 arvadostest.SetServiceURL(&cluster.Services.RailsAPI, "http://localhost:1/")
68 arvadostest.SetServiceURL(&cluster.Services.Controller, "http://localhost:/")
69 s.testHandler = &Handler{Cluster: cluster}
70 s.testServer = newServerFromIntegrationTestEnv(c)
71 s.testServer.Server.Handler = httpserver.HandlerWithContext(
72 ctxlog.Context(context.Background(), s.log),
73 httpserver.AddRequestIDs(httpserver.LogRequests(s.testHandler)))
75 cluster.RemoteClusters = map[string]arvados.RemoteCluster{
77 Host: s.remoteServer.Addr,
82 Host: s.remoteMock.Addr,
91 c.Assert(s.testServer.Start(), check.IsNil)
93 s.remoteMockRequests = nil
96 func (s *FederationSuite) remoteMockHandler(w http.ResponseWriter, req *http.Request) {
100 req.Body = ioutil.NopCloser(b)
101 s.remoteMockRequests = append(s.remoteMockRequests, *req)
102 // Repond 200 with a valid JSON object
106 func (s *FederationSuite) TearDownTest(c *check.C) {
107 if s.remoteServer != nil {
108 s.remoteServer.Close()
110 if s.testServer != nil {
115 func (s *FederationSuite) testRequest(req *http.Request) *httptest.ResponseRecorder {
116 resp := httptest.NewRecorder()
117 s.testServer.Server.Handler.ServeHTTP(resp, req)
121 func (s *FederationSuite) TestLocalRequest(c *check.C) {
122 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zhome-", 1), nil)
123 resp := s.testRequest(req).Result()
124 s.checkHandledLocally(c, resp)
127 func (s *FederationSuite) checkHandledLocally(c *check.C, resp *http.Response) {
128 // Our "home" controller can't handle local requests because
129 // it doesn't have its own stub/test Rails API, so we rely on
130 // "connection refused" to indicate the controller tried to
131 // proxy the request to its local Rails API.
132 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
133 s.checkJSONErrorMatches(c, resp, `.*connection refused`)
136 func (s *FederationSuite) TestNoAuth(c *check.C) {
137 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
138 resp := s.testRequest(req).Result()
139 c.Check(resp.StatusCode, check.Equals, http.StatusUnauthorized)
140 s.checkJSONErrorMatches(c, resp, `Not logged in.*`)
143 func (s *FederationSuite) TestBadAuth(c *check.C) {
144 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
145 req.Header.Set("Authorization", "Bearer aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
146 resp := s.testRequest(req).Result()
147 c.Check(resp.StatusCode, check.Equals, http.StatusUnauthorized)
148 s.checkJSONErrorMatches(c, resp, `Not logged in.*`)
151 func (s *FederationSuite) TestNoAccess(c *check.C) {
152 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
153 req.Header.Set("Authorization", "Bearer "+arvadostest.SpectatorToken)
154 resp := s.testRequest(req).Result()
155 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
156 s.checkJSONErrorMatches(c, resp, `.*not found.*`)
159 func (s *FederationSuite) TestGetUnknownRemote(c *check.C) {
160 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zz404-", 1), nil)
161 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
162 resp := s.testRequest(req).Result()
163 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
164 s.checkJSONErrorMatches(c, resp, `.*no proxy available for cluster zz404`)
167 func (s *FederationSuite) TestRemoteError(c *check.C) {
168 rc := s.testHandler.Cluster.RemoteClusters["zzzzz"]
170 s.testHandler.Cluster.RemoteClusters["zzzzz"] = rc
172 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
173 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
174 resp := s.testRequest(req).Result()
175 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
176 s.checkJSONErrorMatches(c, resp, `.*HTTP response to HTTPS client`)
179 func (s *FederationSuite) TestGetRemoteWorkflow(c *check.C) {
180 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
181 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
182 resp := s.testRequest(req).Result()
183 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
184 var wf arvados.Workflow
185 c.Check(json.NewDecoder(resp.Body).Decode(&wf), check.IsNil)
186 c.Check(wf.UUID, check.Equals, arvadostest.WorkflowWithDefinitionYAMLUUID)
187 c.Check(wf.OwnerUUID, check.Equals, arvadostest.ActiveUserUUID)
190 func (s *FederationSuite) TestOptionsMethod(c *check.C) {
191 req := httptest.NewRequest("OPTIONS", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
192 req.Header.Set("Origin", "https://example.com")
193 resp := s.testRequest(req).Result()
194 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
195 body, err := ioutil.ReadAll(resp.Body)
196 c.Check(err, check.IsNil)
197 c.Check(string(body), check.Equals, "")
198 c.Check(resp.Header.Get("Access-Control-Allow-Origin"), check.Equals, "*")
199 for _, hdr := range []string{"Authorization", "Content-Type"} {
200 c.Check(resp.Header.Get("Access-Control-Allow-Headers"), check.Matches, ".*"+hdr+".*")
202 for _, method := range []string{"GET", "HEAD", "PUT", "POST", "DELETE"} {
203 c.Check(resp.Header.Get("Access-Control-Allow-Methods"), check.Matches, ".*"+method+".*")
207 func (s *FederationSuite) TestRemoteWithTokenInQuery(c *check.C) {
208 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zmock-", 1)+"?api_token="+arvadostest.ActiveToken, nil)
209 s.testRequest(req).Result()
210 c.Assert(s.remoteMockRequests, check.HasLen, 1)
211 pr := s.remoteMockRequests[0]
212 // Token is salted and moved from query to Authorization header.
213 c.Check(pr.URL.String(), check.Not(check.Matches), `.*api_token=.*`)
214 c.Check(pr.Header.Get("Authorization"), check.Equals, "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/7fd31b61f39c0e82a4155592163218272cedacdc")
217 func (s *FederationSuite) TestLocalTokenSalted(c *check.C) {
218 defer s.localServiceReturns404(c).Close()
219 for _, path := range []string{
220 // During the transition to the strongly typed
221 // controller implementation (#14287), workflows and
222 // collections test different code paths.
223 "/arvados/v1/workflows/" + strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zmock-", 1),
224 "/arvados/v1/collections/" + strings.Replace(arvadostest.UserAgreementCollection, "zzzzz-", "zmock-", 1),
226 c.Log("testing path ", path)
227 s.remoteMockRequests = nil
228 req := httptest.NewRequest("GET", path, nil)
229 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
230 s.testRequest(req).Result()
231 c.Assert(s.remoteMockRequests, check.HasLen, 1)
232 pr := s.remoteMockRequests[0]
233 // The salted token here has a "zzzzz-" UUID instead of a
234 // "ztest-" UUID because ztest's local database has the
235 // "zzzzz-" test fixtures. The "secret" part is HMAC(sha1,
236 // arvadostest.ActiveToken, "zmock") = "7fd3...".
237 c.Check(pr.Header.Get("Authorization"), check.Equals, "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/7fd31b61f39c0e82a4155592163218272cedacdc")
241 func (s *FederationSuite) TestRemoteTokenNotSalted(c *check.C) {
242 defer s.localServiceReturns404(c).Close()
243 // remoteToken can be any v1 token that doesn't appear in
245 remoteToken := "abcdef00000000000000000000000000000000000000000000"
247 for _, path := range []string{
248 // During the transition to the strongly typed
249 // controller implementation (#14287), workflows and
250 // collections test different code paths.
251 "/arvados/v1/workflows/" + strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zmock-", 1),
252 "/arvados/v1/collections/" + strings.Replace(arvadostest.UserAgreementCollection, "zzzzz-", "zmock-", 1),
254 c.Log("testing path ", path)
255 s.remoteMockRequests = nil
256 req := httptest.NewRequest("GET", path, nil)
257 req.Header.Set("Authorization", "Bearer "+remoteToken)
258 s.testRequest(req).Result()
259 c.Assert(s.remoteMockRequests, check.HasLen, 1)
260 pr := s.remoteMockRequests[0]
261 c.Check(pr.Header.Get("Authorization"), check.Equals, "Bearer "+remoteToken)
265 func (s *FederationSuite) TestWorkflowCRUD(c *check.C) {
266 var wf arvados.Workflow
268 req := httptest.NewRequest("POST", "/arvados/v1/workflows", strings.NewReader(url.Values{
269 "workflow": {`{"description": "TestCRUD"}`},
271 req.Header.Set("Content-type", "application/x-www-form-urlencoded")
272 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
273 rec := httptest.NewRecorder()
274 s.remoteServer.Server.Handler.ServeHTTP(rec, req) // direct to remote -- can't proxy a create req because no uuid
276 s.checkResponseOK(c, resp)
277 json.NewDecoder(resp.Body).Decode(&wf)
280 req := httptest.NewRequest("DELETE", "/arvados/v1/workflows/"+wf.UUID, nil)
281 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
282 s.remoteServer.Server.Handler.ServeHTTP(httptest.NewRecorder(), req)
284 c.Check(wf.UUID, check.Not(check.Equals), "")
286 c.Assert(wf.ModifiedAt, check.NotNil)
287 c.Logf("wf.ModifiedAt: %v", wf.ModifiedAt)
288 c.Check(time.Since(*wf.ModifiedAt) < time.Minute, check.Equals, true)
290 for _, method := range []string{"PATCH", "PUT", "POST"} {
292 "workflow": {`{"description": "Updated with ` + method + `"}`},
294 if method == "POST" {
295 form["_method"] = []string{"PATCH"}
297 req := httptest.NewRequest(method, "/arvados/v1/workflows/"+wf.UUID, strings.NewReader(form.Encode()))
298 req.Header.Set("Content-type", "application/x-www-form-urlencoded")
299 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
300 resp := s.testRequest(req).Result()
301 s.checkResponseOK(c, resp)
302 err := json.NewDecoder(resp.Body).Decode(&wf)
303 c.Check(err, check.IsNil)
305 c.Check(wf.Description, check.Equals, "Updated with "+method)
308 req := httptest.NewRequest("DELETE", "/arvados/v1/workflows/"+wf.UUID, nil)
309 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
310 resp := s.testRequest(req).Result()
311 s.checkResponseOK(c, resp)
312 err := json.NewDecoder(resp.Body).Decode(&wf)
313 c.Check(err, check.IsNil)
316 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+wf.UUID, nil)
317 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
318 resp := s.testRequest(req).Result()
319 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
323 func (s *FederationSuite) checkResponseOK(c *check.C, resp *http.Response) {
324 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
325 if resp.StatusCode != http.StatusOK {
326 body, err := ioutil.ReadAll(resp.Body)
327 c.Logf("... response body = %q, %v\n", body, err)
331 func (s *FederationSuite) checkJSONErrorMatches(c *check.C, resp *http.Response, re string) {
332 var jresp httpserver.ErrorResponse
333 err := json.NewDecoder(resp.Body).Decode(&jresp)
334 c.Check(err, check.IsNil)
335 c.Assert(jresp.Errors, check.HasLen, 1)
336 c.Check(jresp.Errors[0], check.Matches, re)
339 func (s *FederationSuite) localServiceHandler(c *check.C, h http.Handler) *httpserver.Server {
340 srv := &httpserver.Server{
345 c.Assert(srv.Start(), check.IsNil)
346 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "http://"+srv.Addr)
350 func (s *FederationSuite) localServiceReturns404(c *check.C) *httpserver.Server {
351 return s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
352 if req.URL.Path == "/arvados/v1/api_client_authorizations/current" {
353 if req.Header.Get("Authorization") == "Bearer "+arvadostest.ActiveToken {
354 json.NewEncoder(w).Encode(arvados.APIClientAuthorization{UUID: arvadostest.ActiveTokenUUID, APIToken: arvadostest.ActiveToken})
356 w.WriteHeader(http.StatusUnauthorized)
364 func (s *FederationSuite) TestGetLocalCollection(c *check.C) {
365 s.testHandler.Cluster.ClusterID = "zzzzz"
366 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
370 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementCollection, nil)
371 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
372 resp := s.testRequest(req).Result()
374 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
375 var col arvados.Collection
376 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
377 c.Check(col.UUID, check.Equals, arvadostest.UserAgreementCollection)
378 c.Check(col.ManifestText, check.Matches,
379 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
382 // HTTP POST with _method=GET as a form parameter
384 req = httptest.NewRequest("POST", "/arvados/v1/collections/"+arvadostest.UserAgreementCollection, bytes.NewBufferString((url.Values{
387 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
388 req.Header.Set("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
389 resp = s.testRequest(req).Result()
391 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
392 col = arvados.Collection{}
393 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
394 c.Check(col.UUID, check.Equals, arvadostest.UserAgreementCollection)
395 c.Check(col.ManifestText, check.Matches,
396 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
400 func (s *FederationSuite) TestGetRemoteCollection(c *check.C) {
401 defer s.localServiceReturns404(c).Close()
403 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementCollection, nil)
404 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
405 resp := s.testRequest(req).Result()
406 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
407 var col arvados.Collection
408 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
409 c.Check(col.UUID, check.Equals, arvadostest.UserAgreementCollection)
410 c.Check(col.ManifestText, check.Matches,
411 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+Rzzzzz-[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
415 func (s *FederationSuite) TestGetRemoteCollectionError(c *check.C) {
416 defer s.localServiceReturns404(c).Close()
418 req := httptest.NewRequest("GET", "/arvados/v1/collections/zzzzz-4zz18-fakefakefakefak", nil)
419 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
420 resp := s.testRequest(req).Result()
421 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
424 func (s *FederationSuite) TestSignedLocatorPattern(c *check.C) {
425 // Confirm the regular expression identifies other groups of hints correctly
426 c.Check(keepclient.SignedLocatorRe.FindStringSubmatch(`6a4ff0499484c6c79c95cd8c566bd25f+249025+B1+C2+A05227438989d04712ea9ca1c91b556cef01d5cc7@5ba5405b+D3+E4`),
428 []string{"6a4ff0499484c6c79c95cd8c566bd25f+249025+B1+C2+A05227438989d04712ea9ca1c91b556cef01d5cc7@5ba5405b+D3+E4",
429 "6a4ff0499484c6c79c95cd8c566bd25f",
432 "+A05227438989d04712ea9ca1c91b556cef01d5cc7@5ba5405b",
433 "05227438989d04712ea9ca1c91b556cef01d5cc7", "5ba5405b",
437 func (s *FederationSuite) TestGetLocalCollectionByPDH(c *check.C) {
438 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
440 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementPDH, nil)
441 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
442 resp := s.testRequest(req).Result()
444 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
445 var col arvados.Collection
446 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
447 c.Check(col.PortableDataHash, check.Equals, arvadostest.UserAgreementPDH)
448 c.Check(col.ManifestText, check.Matches,
449 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
453 func (s *FederationSuite) TestGetRemoteCollectionByPDH(c *check.C) {
454 defer s.localServiceReturns404(c).Close()
456 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementPDH, nil)
457 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
458 resp := s.testRequest(req).Result()
460 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
462 var col arvados.Collection
463 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
464 c.Check(col.PortableDataHash, check.Equals, arvadostest.UserAgreementPDH)
465 c.Check(col.ManifestText, check.Matches,
466 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+Rzzzzz-[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
470 func (s *FederationSuite) TestGetCollectionByPDHError(c *check.C) {
471 defer s.localServiceReturns404(c).Close()
473 // zmock's normal response (200 with an empty body) would
474 // change the outcome from 404 to 502
475 delete(s.testHandler.Cluster.RemoteClusters, "zmock")
477 req := httptest.NewRequest("GET", "/arvados/v1/collections/99999999999999999999999999999999+99", nil)
478 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
480 resp := s.testRequest(req).Result()
481 defer resp.Body.Close()
483 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
486 func (s *FederationSuite) TestGetCollectionByPDHErrorBadHash(c *check.C) {
487 defer s.localServiceReturns404(c).Close()
489 // zmock's normal response (200 with an empty body) would
490 // change the outcome
491 delete(s.testHandler.Cluster.RemoteClusters, "zmock")
493 srv2 := &httpserver.Server{
495 Handler: http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
497 // Return a collection where the hash
498 // of the manifest text doesn't match
499 // PDH that was requested.
500 var col arvados.Collection
501 col.PortableDataHash = "99999999999999999999999999999999+99"
502 col.ManifestText = `. 6a4ff0499484c6c79c95cd8c566bd25f\+249025 0:249025:GNU_General_Public_License,_version_3.pdf
504 enc := json.NewEncoder(w)
510 c.Assert(srv2.Start(), check.IsNil)
513 // Direct zzzzz to service that returns a 200 result with a bogus manifest_text
514 s.testHandler.Cluster.RemoteClusters["zzzzz"] = arvados.RemoteCluster{
520 req := httptest.NewRequest("GET", "/arvados/v1/collections/99999999999999999999999999999999+99", nil)
521 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
523 resp := s.testRequest(req).Result()
524 defer resp.Body.Close()
526 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
529 func (s *FederationSuite) TestSaltedTokenGetCollectionByPDH(c *check.C) {
530 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
532 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementPDH, nil)
533 req.Header.Set("Authorization", "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/282d7d172b6cfdce364c5ed12ddf7417b2d00065")
534 resp := s.testRequest(req).Result()
536 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
537 var col arvados.Collection
538 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
539 c.Check(col.PortableDataHash, check.Equals, arvadostest.UserAgreementPDH)
540 c.Check(col.ManifestText, check.Matches,
541 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
545 func (s *FederationSuite) TestSaltedTokenGetCollectionByPDHError(c *check.C) {
546 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
548 // zmock's normal response (200 with an empty body) would
549 // change the outcome
550 delete(s.testHandler.Cluster.RemoteClusters, "zmock")
552 req := httptest.NewRequest("GET", "/arvados/v1/collections/99999999999999999999999999999999+99", nil)
553 req.Header.Set("Authorization", "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/282d7d172b6cfdce364c5ed12ddf7417b2d00065")
554 resp := s.testRequest(req).Result()
556 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
559 func (s *FederationSuite) TestGetRemoteContainerRequest(c *check.C) {
560 defer s.localServiceReturns404(c).Close()
561 req := httptest.NewRequest("GET", "/arvados/v1/container_requests/"+arvadostest.QueuedContainerRequestUUID, nil)
562 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
563 resp := s.testRequest(req).Result()
564 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
565 var cr arvados.ContainerRequest
566 c.Check(json.NewDecoder(resp.Body).Decode(&cr), check.IsNil)
567 c.Check(cr.UUID, check.Equals, arvadostest.QueuedContainerRequestUUID)
568 c.Check(cr.Priority, check.Equals, 1)
571 func (s *FederationSuite) TestUpdateRemoteContainerRequest(c *check.C) {
572 defer s.localServiceReturns404(c).Close()
573 setPri := func(pri int) {
574 req := httptest.NewRequest("PATCH", "/arvados/v1/container_requests/"+arvadostest.QueuedContainerRequestUUID,
575 strings.NewReader(fmt.Sprintf(`{"container_request": {"priority": %d}}`, pri)))
576 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
577 req.Header.Set("Content-type", "application/json")
578 resp := s.testRequest(req).Result()
579 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
580 var cr arvados.ContainerRequest
581 c.Check(json.NewDecoder(resp.Body).Decode(&cr), check.IsNil)
582 c.Check(cr.UUID, check.Equals, arvadostest.QueuedContainerRequestUUID)
583 c.Check(cr.Priority, check.Equals, pri)
586 setPri(1) // Reset fixture so side effect doesn't break other tests.
589 func (s *FederationSuite) TestCreateRemoteContainerRequest(c *check.C) {
590 defer s.localServiceReturns404(c).Close()
591 // pass cluster_id via query parameter, this allows arvados-controller
592 // to avoid parsing the body
593 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zzzzz",
595 "container_request": {
596 "name": "hello world",
597 "state": "Uncommitted",
599 "container_image": "123",
604 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
605 req.Header.Set("Content-type", "application/json")
606 resp := s.testRequest(req).Result()
607 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
608 var cr arvados.ContainerRequest
609 c.Check(json.NewDecoder(resp.Body).Decode(&cr), check.IsNil)
610 c.Check(cr.Name, check.Equals, "hello world")
611 c.Check(strings.HasPrefix(cr.UUID, "zzzzz-"), check.Equals, true)
614 func (s *FederationSuite) TestCreateRemoteContainerRequestCheckRuntimeToken(c *check.C) {
615 // Send request to zmock and check that outgoing request has
616 // runtime_token set with a new random v2 token.
618 defer s.localServiceReturns404(c).Close()
619 // pass cluster_id via query parameter, this allows arvados-controller
620 // to avoid parsing the body
621 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zmock",
623 "container_request": {
624 "name": "hello world",
625 "state": "Uncommitted",
627 "container_image": "123",
632 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveTokenV2)
633 req.Header.Set("Content-type", "application/json")
635 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
636 s.testHandler.Cluster.ClusterID = "zzzzz"
638 resp := s.testRequest(req).Result()
639 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
641 arvados.ContainerRequest `json:"container_request"`
643 c.Check(json.NewDecoder(s.remoteMockRequests[0].Body).Decode(&cr), check.IsNil)
644 c.Check(strings.HasPrefix(cr.ContainerRequest.RuntimeToken, "v2/zzzzz-gj3su-"), check.Equals, true)
645 c.Check(cr.ContainerRequest.RuntimeToken, check.Not(check.Equals), arvadostest.ActiveTokenV2)
648 func (s *FederationSuite) TestCreateRemoteContainerRequestCheckSetRuntimeToken(c *check.C) {
649 // Send request to zmock and check that outgoing request has
650 // runtime_token set with the explicitly provided token.
652 defer s.localServiceReturns404(c).Close()
653 // pass cluster_id via query parameter, this allows arvados-controller
654 // to avoid parsing the body
655 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zmock",
657 "container_request": {
658 "name": "hello world",
659 "state": "Uncommitted",
661 "container_image": "123",
663 "runtime_token": "xyz"
667 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
668 req.Header.Set("Content-type", "application/json")
669 resp := s.testRequest(req).Result()
670 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
672 arvados.ContainerRequest `json:"container_request"`
674 c.Check(json.NewDecoder(s.remoteMockRequests[0].Body).Decode(&cr), check.IsNil)
675 c.Check(cr.ContainerRequest.RuntimeToken, check.Equals, "xyz")
678 func (s *FederationSuite) TestCreateRemoteContainerRequestRuntimeTokenFromAuth(c *check.C) {
679 // Send request to zmock and check that outgoing request has
680 // runtime_token set using the Auth token because the user is remote.
682 defer s.localServiceReturns404(c).Close()
683 // pass cluster_id via query parameter, this allows arvados-controller
684 // to avoid parsing the body
685 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zmock",
687 "container_request": {
688 "name": "hello world",
689 "state": "Uncommitted",
691 "container_image": "123",
696 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveTokenV2+"/zzzzz-dz642-parentcontainer")
697 req.Header.Set("Content-type", "application/json")
698 resp := s.testRequest(req).Result()
699 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
701 arvados.ContainerRequest `json:"container_request"`
703 c.Check(json.NewDecoder(s.remoteMockRequests[0].Body).Decode(&cr), check.IsNil)
704 c.Check(cr.ContainerRequest.RuntimeToken, check.Equals, arvadostest.ActiveTokenV2)
707 func (s *FederationSuite) TestCreateRemoteContainerRequestError(c *check.C) {
708 defer s.localServiceReturns404(c).Close()
709 // pass cluster_id via query parameter, this allows arvados-controller
710 // to avoid parsing the body
711 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zz404",
713 "container_request": {
714 "name": "hello world",
715 "state": "Uncommitted",
717 "container_image": "123",
722 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
723 req.Header.Set("Content-type", "application/json")
724 resp := s.testRequest(req).Result()
725 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
728 func (s *FederationSuite) TestGetRemoteContainer(c *check.C) {
729 defer s.localServiceReturns404(c).Close()
730 req := httptest.NewRequest("GET", "/arvados/v1/containers/"+arvadostest.QueuedContainerUUID, nil)
731 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
732 resp := s.testRequest(req)
733 c.Check(resp.Code, check.Equals, http.StatusOK)
734 var cn arvados.Container
735 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
736 c.Check(cn.UUID, check.Equals, arvadostest.QueuedContainerUUID)
739 func (s *FederationSuite) TestListRemoteContainer(c *check.C) {
740 defer s.localServiceReturns404(c).Close()
741 req := httptest.NewRequest("GET", "/arvados/v1/containers?count=none&filters="+
742 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v"]]]`, arvadostest.QueuedContainerUUID)), nil)
743 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
744 resp := s.testRequest(req).Result()
745 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
746 var cn arvados.ContainerList
747 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
748 c.Assert(cn.Items, check.HasLen, 1)
749 c.Check(cn.Items[0].UUID, check.Equals, arvadostest.QueuedContainerUUID)
752 func (s *FederationSuite) TestListMultiRemoteContainers(c *check.C) {
753 defer s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
754 bd, _ := ioutil.ReadAll(req.Body)
755 c.Check(string(bd), check.Equals, `_method=GET&count=none&filters=%5B%5B%22uuid%22%2C+%22in%22%2C+%5B%22zhome-xvhdp-cr5queuedcontnr%22%5D%5D%5D&select=%5B%22uuid%22%2C+%22command%22%5D`)
757 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr5queuedcontnr", "command": ["abc"]}]}`))
759 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&select=%s",
760 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
761 arvadostest.QueuedContainerUUID)),
762 url.QueryEscape(`["uuid", "command"]`)),
764 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
765 resp := s.testRequest(req).Result()
766 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
767 var cn arvados.ContainerList
768 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
769 c.Check(cn.Items, check.HasLen, 2)
770 mp := make(map[string]arvados.Container)
771 for _, cr := range cn.Items {
774 c.Check(mp[arvadostest.QueuedContainerUUID].Command, check.DeepEquals, []string{"echo", "hello"})
775 c.Check(mp[arvadostest.QueuedContainerUUID].ContainerImage, check.Equals, "")
776 c.Check(mp["zhome-xvhdp-cr5queuedcontnr"].Command, check.DeepEquals, []string{"abc"})
777 c.Check(mp["zhome-xvhdp-cr5queuedcontnr"].ContainerImage, check.Equals, "")
780 func (s *FederationSuite) TestListMultiRemoteContainerError(c *check.C) {
781 defer s.localServiceReturns404(c).Close()
782 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&select=%s",
783 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
784 arvadostest.QueuedContainerUUID)),
785 url.QueryEscape(`["uuid", "command"]`)),
787 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
788 resp := s.testRequest(req).Result()
789 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
790 s.checkJSONErrorMatches(c, resp, `error fetching from zhome \(404 Not Found\): EOF`)
793 func (s *FederationSuite) TestListMultiRemoteContainersPaged(c *check.C) {
796 defer s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
797 bd, _ := ioutil.ReadAll(req.Body)
799 c.Check(string(bd), check.Equals, `_method=GET&count=none&filters=%5B%5B%22uuid%22%2C+%22in%22%2C+%5B%22zhome-xvhdp-cr5queuedcontnr%22%2C%22zhome-xvhdp-cr6queuedcontnr%22%5D%5D%5D`)
801 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr5queuedcontnr", "command": ["abc"]}]}`))
802 } else if callCount == 1 {
803 c.Check(string(bd), check.Equals, `_method=GET&count=none&filters=%5B%5B%22uuid%22%2C+%22in%22%2C+%5B%22zhome-xvhdp-cr6queuedcontnr%22%5D%5D%5D`)
805 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr6queuedcontnr", "command": ["efg"]}]}`))
809 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s",
810 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr", "zhome-xvhdp-cr6queuedcontnr"]]]`,
811 arvadostest.QueuedContainerUUID))),
813 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
814 resp := s.testRequest(req).Result()
815 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
816 c.Check(callCount, check.Equals, 2)
817 var cn arvados.ContainerList
818 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
819 c.Check(cn.Items, check.HasLen, 3)
820 mp := make(map[string]arvados.Container)
821 for _, cr := range cn.Items {
824 c.Check(mp[arvadostest.QueuedContainerUUID].Command, check.DeepEquals, []string{"echo", "hello"})
825 c.Check(mp["zhome-xvhdp-cr5queuedcontnr"].Command, check.DeepEquals, []string{"abc"})
826 c.Check(mp["zhome-xvhdp-cr6queuedcontnr"].Command, check.DeepEquals, []string{"efg"})
829 func (s *FederationSuite) TestListMultiRemoteContainersMissing(c *check.C) {
832 defer s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
833 bd, _ := ioutil.ReadAll(req.Body)
835 c.Check(string(bd), check.Equals, `_method=GET&count=none&filters=%5B%5B%22uuid%22%2C+%22in%22%2C+%5B%22zhome-xvhdp-cr5queuedcontnr%22%2C%22zhome-xvhdp-cr6queuedcontnr%22%5D%5D%5D`)
837 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr6queuedcontnr", "command": ["efg"]}]}`))
838 } else if callCount == 1 {
839 c.Check(string(bd), check.Equals, `_method=GET&count=none&filters=%5B%5B%22uuid%22%2C+%22in%22%2C+%5B%22zhome-xvhdp-cr5queuedcontnr%22%5D%5D%5D`)
841 w.Write([]byte(`{"kind": "arvados#containerList", "items": []}`))
845 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s",
846 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr", "zhome-xvhdp-cr6queuedcontnr"]]]`,
847 arvadostest.QueuedContainerUUID))),
849 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
850 resp := s.testRequest(req).Result()
851 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
852 c.Check(callCount, check.Equals, 2)
853 var cn arvados.ContainerList
854 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
855 c.Check(cn.Items, check.HasLen, 2)
856 mp := make(map[string]arvados.Container)
857 for _, cr := range cn.Items {
860 c.Check(mp[arvadostest.QueuedContainerUUID].Command, check.DeepEquals, []string{"echo", "hello"})
861 c.Check(mp["zhome-xvhdp-cr6queuedcontnr"].Command, check.DeepEquals, []string{"efg"})
864 func (s *FederationSuite) TestListMultiRemoteContainerPageSizeError(c *check.C) {
865 s.testHandler.Cluster.API.MaxItemsPerResponse = 1
866 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s",
867 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
868 arvadostest.QueuedContainerUUID))),
870 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
871 resp := s.testRequest(req).Result()
872 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
873 s.checkJSONErrorMatches(c, resp, `Federated multi-object request for 2 objects which is more than max page size 1.`)
876 func (s *FederationSuite) TestListMultiRemoteContainerLimitError(c *check.C) {
877 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&limit=1",
878 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
879 arvadostest.QueuedContainerUUID))),
881 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
882 resp := s.testRequest(req).Result()
883 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
884 s.checkJSONErrorMatches(c, resp, `Federated multi-object may not provide 'limit', 'offset' or 'order'.`)
887 func (s *FederationSuite) TestListMultiRemoteContainerOffsetError(c *check.C) {
888 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&offset=1",
889 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
890 arvadostest.QueuedContainerUUID))),
892 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
893 resp := s.testRequest(req).Result()
894 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
895 s.checkJSONErrorMatches(c, resp, `Federated multi-object may not provide 'limit', 'offset' or 'order'.`)
898 func (s *FederationSuite) TestListMultiRemoteContainerOrderError(c *check.C) {
899 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&order=uuid",
900 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
901 arvadostest.QueuedContainerUUID))),
903 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
904 resp := s.testRequest(req).Result()
905 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
906 s.checkJSONErrorMatches(c, resp, `Federated multi-object may not provide 'limit', 'offset' or 'order'.`)
909 func (s *FederationSuite) TestListMultiRemoteContainerSelectError(c *check.C) {
910 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&select=%s",
911 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
912 arvadostest.QueuedContainerUUID)),
913 url.QueryEscape(`["command"]`)),
915 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
916 resp := s.testRequest(req).Result()
917 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
918 s.checkJSONErrorMatches(c, resp, `Federated multi-object request must include 'uuid' in 'select'`)