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,
88 c.Assert(s.testServer.Start(), check.IsNil)
90 s.remoteMockRequests = nil
93 func (s *FederationSuite) remoteMockHandler(w http.ResponseWriter, req *http.Request) {
97 req.Body = ioutil.NopCloser(b)
98 s.remoteMockRequests = append(s.remoteMockRequests, *req)
99 // Repond 200 with a valid JSON object
103 func (s *FederationSuite) TearDownTest(c *check.C) {
104 if s.remoteServer != nil {
105 s.remoteServer.Close()
107 if s.testServer != nil {
112 func (s *FederationSuite) testRequest(req *http.Request) *httptest.ResponseRecorder {
113 resp := httptest.NewRecorder()
114 s.testServer.Server.Handler.ServeHTTP(resp, req)
118 func (s *FederationSuite) TestLocalRequest(c *check.C) {
119 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zhome-", 1), nil)
120 resp := s.testRequest(req).Result()
121 s.checkHandledLocally(c, resp)
124 func (s *FederationSuite) checkHandledLocally(c *check.C, resp *http.Response) {
125 // Our "home" controller can't handle local requests because
126 // it doesn't have its own stub/test Rails API, so we rely on
127 // "connection refused" to indicate the controller tried to
128 // proxy the request to its local Rails API.
129 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
130 s.checkJSONErrorMatches(c, resp, `.*connection refused`)
133 func (s *FederationSuite) TestNoAuth(c *check.C) {
134 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
135 resp := s.testRequest(req).Result()
136 c.Check(resp.StatusCode, check.Equals, http.StatusUnauthorized)
137 s.checkJSONErrorMatches(c, resp, `Not logged in`)
140 func (s *FederationSuite) TestBadAuth(c *check.C) {
141 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
142 req.Header.Set("Authorization", "Bearer aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
143 resp := s.testRequest(req).Result()
144 c.Check(resp.StatusCode, check.Equals, http.StatusUnauthorized)
145 s.checkJSONErrorMatches(c, resp, `Not logged in`)
148 func (s *FederationSuite) TestNoAccess(c *check.C) {
149 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
150 req.Header.Set("Authorization", "Bearer "+arvadostest.SpectatorToken)
151 resp := s.testRequest(req).Result()
152 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
153 s.checkJSONErrorMatches(c, resp, `.*not found`)
156 func (s *FederationSuite) TestGetUnknownRemote(c *check.C) {
157 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zz404-", 1), nil)
158 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
159 resp := s.testRequest(req).Result()
160 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
161 s.checkJSONErrorMatches(c, resp, `.*no proxy available for cluster zz404`)
164 func (s *FederationSuite) TestRemoteError(c *check.C) {
165 rc := s.testHandler.Cluster.RemoteClusters["zzzzz"]
167 s.testHandler.Cluster.RemoteClusters["zzzzz"] = rc
169 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
170 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
171 resp := s.testRequest(req).Result()
172 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
173 s.checkJSONErrorMatches(c, resp, `.*HTTP response to HTTPS client`)
176 func (s *FederationSuite) TestGetRemoteWorkflow(c *check.C) {
177 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
178 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
179 resp := s.testRequest(req).Result()
180 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
181 var wf arvados.Workflow
182 c.Check(json.NewDecoder(resp.Body).Decode(&wf), check.IsNil)
183 c.Check(wf.UUID, check.Equals, arvadostest.WorkflowWithDefinitionYAMLUUID)
184 c.Check(wf.OwnerUUID, check.Equals, arvadostest.ActiveUserUUID)
187 func (s *FederationSuite) TestOptionsMethod(c *check.C) {
188 req := httptest.NewRequest("OPTIONS", "/arvados/v1/workflows/"+arvadostest.WorkflowWithDefinitionYAMLUUID, nil)
189 req.Header.Set("Origin", "https://example.com")
190 resp := s.testRequest(req).Result()
191 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
192 body, err := ioutil.ReadAll(resp.Body)
193 c.Check(err, check.IsNil)
194 c.Check(string(body), check.Equals, "")
195 c.Check(resp.Header.Get("Access-Control-Allow-Origin"), check.Equals, "*")
196 for _, hdr := range []string{"Authorization", "Content-Type"} {
197 c.Check(resp.Header.Get("Access-Control-Allow-Headers"), check.Matches, ".*"+hdr+".*")
199 for _, method := range []string{"GET", "HEAD", "PUT", "POST", "DELETE"} {
200 c.Check(resp.Header.Get("Access-Control-Allow-Methods"), check.Matches, ".*"+method+".*")
204 func (s *FederationSuite) TestRemoteWithTokenInQuery(c *check.C) {
205 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zmock-", 1)+"?api_token="+arvadostest.ActiveToken, nil)
206 s.testRequest(req).Result()
207 c.Assert(s.remoteMockRequests, check.HasLen, 1)
208 pr := s.remoteMockRequests[0]
209 // Token is salted and moved from query to Authorization header.
210 c.Check(pr.URL.String(), check.Not(check.Matches), `.*api_token=.*`)
211 c.Check(pr.Header.Get("Authorization"), check.Equals, "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/7fd31b61f39c0e82a4155592163218272cedacdc")
214 func (s *FederationSuite) TestLocalTokenSalted(c *check.C) {
215 defer s.localServiceReturns404(c).Close()
216 for _, path := range []string{
217 // During the transition to the strongly typed
218 // controller implementation (#14287), workflows and
219 // collections test different code paths.
220 "/arvados/v1/workflows/" + strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zmock-", 1),
221 "/arvados/v1/collections/" + strings.Replace(arvadostest.UserAgreementCollection, "zzzzz-", "zmock-", 1),
223 c.Log("testing path ", path)
224 s.remoteMockRequests = nil
225 req := httptest.NewRequest("GET", path, nil)
226 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
227 s.testRequest(req).Result()
228 c.Assert(s.remoteMockRequests, check.HasLen, 1)
229 pr := s.remoteMockRequests[0]
230 // The salted token here has a "zzzzz-" UUID instead of a
231 // "ztest-" UUID because ztest's local database has the
232 // "zzzzz-" test fixtures. The "secret" part is HMAC(sha1,
233 // arvadostest.ActiveToken, "zmock") = "7fd3...".
234 c.Check(pr.Header.Get("Authorization"), check.Equals, "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/7fd31b61f39c0e82a4155592163218272cedacdc")
238 func (s *FederationSuite) TestRemoteTokenNotSalted(c *check.C) {
239 defer s.localServiceReturns404(c).Close()
240 // remoteToken can be any v1 token that doesn't appear in
242 remoteToken := "abcdef00000000000000000000000000000000000000000000"
244 for _, path := range []string{
245 // During the transition to the strongly typed
246 // controller implementation (#14287), workflows and
247 // collections test different code paths.
248 "/arvados/v1/workflows/" + strings.Replace(arvadostest.WorkflowWithDefinitionYAMLUUID, "zzzzz-", "zmock-", 1),
249 "/arvados/v1/collections/" + strings.Replace(arvadostest.UserAgreementCollection, "zzzzz-", "zmock-", 1),
251 c.Log("testing path ", path)
252 s.remoteMockRequests = nil
253 req := httptest.NewRequest("GET", path, nil)
254 req.Header.Set("Authorization", "Bearer "+remoteToken)
255 s.testRequest(req).Result()
256 c.Assert(s.remoteMockRequests, check.HasLen, 1)
257 pr := s.remoteMockRequests[0]
258 c.Check(pr.Header.Get("Authorization"), check.Equals, "Bearer "+remoteToken)
262 func (s *FederationSuite) TestWorkflowCRUD(c *check.C) {
263 wf := arvados.Workflow{
264 Description: "TestCRUD",
267 body := &strings.Builder{}
268 json.NewEncoder(body).Encode(&wf)
269 req := httptest.NewRequest("POST", "/arvados/v1/workflows", strings.NewReader(url.Values{
270 "workflow": {body.String()},
272 req.Header.Set("Content-type", "application/x-www-form-urlencoded")
273 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
274 rec := httptest.NewRecorder()
275 s.remoteServer.Server.Handler.ServeHTTP(rec, req) // direct to remote -- can't proxy a create req because no uuid
277 s.checkResponseOK(c, resp)
278 json.NewDecoder(resp.Body).Decode(&wf)
281 req := httptest.NewRequest("DELETE", "/arvados/v1/workflows/"+wf.UUID, nil)
282 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
283 s.remoteServer.Server.Handler.ServeHTTP(httptest.NewRecorder(), req)
285 c.Check(wf.UUID, check.Not(check.Equals), "")
287 c.Assert(wf.ModifiedAt, check.NotNil)
288 c.Logf("wf.ModifiedAt: %v", wf.ModifiedAt)
289 c.Check(time.Since(*wf.ModifiedAt) < time.Minute, check.Equals, true)
291 for _, method := range []string{"PATCH", "PUT", "POST"} {
293 "workflow": {`{"description": "Updated with ` + method + `"}`},
295 if method == "POST" {
296 form["_method"] = []string{"PATCH"}
298 req := httptest.NewRequest(method, "/arvados/v1/workflows/"+wf.UUID, strings.NewReader(form.Encode()))
299 req.Header.Set("Content-type", "application/x-www-form-urlencoded")
300 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
301 resp := s.testRequest(req).Result()
302 s.checkResponseOK(c, resp)
303 err := json.NewDecoder(resp.Body).Decode(&wf)
304 c.Check(err, check.IsNil)
306 c.Check(wf.Description, check.Equals, "Updated with "+method)
309 req := httptest.NewRequest("DELETE", "/arvados/v1/workflows/"+wf.UUID, nil)
310 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
311 resp := s.testRequest(req).Result()
312 s.checkResponseOK(c, resp)
313 err := json.NewDecoder(resp.Body).Decode(&wf)
314 c.Check(err, check.IsNil)
317 req := httptest.NewRequest("GET", "/arvados/v1/workflows/"+wf.UUID, nil)
318 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
319 resp := s.testRequest(req).Result()
320 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
324 func (s *FederationSuite) checkResponseOK(c *check.C, resp *http.Response) {
325 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
326 if resp.StatusCode != http.StatusOK {
327 body, err := ioutil.ReadAll(resp.Body)
328 c.Logf("... response body = %q, %v\n", body, err)
332 func (s *FederationSuite) checkJSONErrorMatches(c *check.C, resp *http.Response, re string) {
333 var jresp httpserver.ErrorResponse
334 err := json.NewDecoder(resp.Body).Decode(&jresp)
335 c.Check(err, check.IsNil)
336 c.Assert(jresp.Errors, check.HasLen, 1)
337 c.Check(jresp.Errors[0], check.Matches, re)
340 func (s *FederationSuite) localServiceHandler(c *check.C, h http.Handler) *httpserver.Server {
341 srv := &httpserver.Server{
346 c.Assert(srv.Start(), check.IsNil)
347 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "http://"+srv.Addr)
351 func (s *FederationSuite) localServiceReturns404(c *check.C) *httpserver.Server {
352 return s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
353 if req.URL.Path == "/arvados/v1/api_client_authorizations/current" {
354 if req.Header.Get("Authorization") == "Bearer "+arvadostest.ActiveToken {
355 json.NewEncoder(w).Encode(arvados.APIClientAuthorization{UUID: arvadostest.ActiveTokenUUID, APIToken: arvadostest.ActiveToken})
357 w.WriteHeader(http.StatusUnauthorized)
365 func (s *FederationSuite) TestGetLocalCollection(c *check.C) {
366 s.testHandler.Cluster.ClusterID = "zzzzz"
367 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
371 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementCollection, nil)
372 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
373 resp := s.testRequest(req).Result()
375 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
376 var col arvados.Collection
377 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
378 c.Check(col.UUID, check.Equals, arvadostest.UserAgreementCollection)
379 c.Check(col.ManifestText, check.Matches,
380 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
383 // HTTP POST with _method=GET as a form parameter
385 req = httptest.NewRequest("POST", "/arvados/v1/collections/"+arvadostest.UserAgreementCollection, bytes.NewBufferString((url.Values{
388 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
389 req.Header.Set("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
390 resp = s.testRequest(req).Result()
392 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
393 col = arvados.Collection{}
394 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
395 c.Check(col.UUID, check.Equals, arvadostest.UserAgreementCollection)
396 c.Check(col.ManifestText, check.Matches,
397 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
401 func (s *FederationSuite) TestGetRemoteCollection(c *check.C) {
402 defer s.localServiceReturns404(c).Close()
404 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementCollection, nil)
405 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
406 resp := s.testRequest(req).Result()
407 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
408 var col arvados.Collection
409 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
410 c.Check(col.UUID, check.Equals, arvadostest.UserAgreementCollection)
411 c.Check(col.ManifestText, check.Matches,
412 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+Rzzzzz-[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
416 func (s *FederationSuite) TestGetRemoteCollectionError(c *check.C) {
417 defer s.localServiceReturns404(c).Close()
419 req := httptest.NewRequest("GET", "/arvados/v1/collections/zzzzz-4zz18-fakefakefakefak", nil)
420 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
421 resp := s.testRequest(req).Result()
422 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
425 func (s *FederationSuite) TestSignedLocatorPattern(c *check.C) {
426 // Confirm the regular expression identifies other groups of hints correctly
427 c.Check(keepclient.SignedLocatorRe.FindStringSubmatch(`6a4ff0499484c6c79c95cd8c566bd25f+249025+B1+C2+A05227438989d04712ea9ca1c91b556cef01d5cc7@5ba5405b+D3+E4`),
429 []string{"6a4ff0499484c6c79c95cd8c566bd25f+249025+B1+C2+A05227438989d04712ea9ca1c91b556cef01d5cc7@5ba5405b+D3+E4",
430 "6a4ff0499484c6c79c95cd8c566bd25f",
433 "+A05227438989d04712ea9ca1c91b556cef01d5cc7@5ba5405b",
434 "05227438989d04712ea9ca1c91b556cef01d5cc7", "5ba5405b",
438 func (s *FederationSuite) TestGetLocalCollectionByPDH(c *check.C) {
439 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
441 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementPDH, nil)
442 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
443 resp := s.testRequest(req).Result()
445 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
446 var col arvados.Collection
447 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
448 c.Check(col.PortableDataHash, check.Equals, arvadostest.UserAgreementPDH)
449 c.Check(col.ManifestText, check.Matches,
450 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
454 func (s *FederationSuite) TestGetRemoteCollectionByPDH(c *check.C) {
455 defer s.localServiceReturns404(c).Close()
457 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementPDH, nil)
458 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
459 resp := s.testRequest(req).Result()
461 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
463 var col arvados.Collection
464 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
465 c.Check(col.PortableDataHash, check.Equals, arvadostest.UserAgreementPDH)
466 c.Check(col.ManifestText, check.Matches,
467 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+Rzzzzz-[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
471 func (s *FederationSuite) TestGetCollectionByPDHError(c *check.C) {
472 defer s.localServiceReturns404(c).Close()
474 req := httptest.NewRequest("GET", "/arvados/v1/collections/99999999999999999999999999999999+99", nil)
475 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
477 resp := s.testRequest(req).Result()
478 defer resp.Body.Close()
480 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
483 func (s *FederationSuite) TestGetCollectionByPDHErrorBadHash(c *check.C) {
484 defer s.localServiceReturns404(c).Close()
486 srv2 := &httpserver.Server{
488 Handler: http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
490 // Return a collection where the hash
491 // of the manifest text doesn't match
492 // PDH that was requested.
493 var col arvados.Collection
494 col.PortableDataHash = "99999999999999999999999999999999+99"
495 col.ManifestText = `. 6a4ff0499484c6c79c95cd8c566bd25f\+249025 0:249025:GNU_General_Public_License,_version_3.pdf
497 enc := json.NewEncoder(w)
503 c.Assert(srv2.Start(), check.IsNil)
506 // Direct zzzzz to service that returns a 200 result with a bogus manifest_text
507 s.testHandler.Cluster.RemoteClusters["zzzzz"] = arvados.RemoteCluster{
513 req := httptest.NewRequest("GET", "/arvados/v1/collections/99999999999999999999999999999999+99", nil)
514 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
516 resp := s.testRequest(req).Result()
517 defer resp.Body.Close()
519 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
522 func (s *FederationSuite) TestSaltedTokenGetCollectionByPDH(c *check.C) {
523 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
525 req := httptest.NewRequest("GET", "/arvados/v1/collections/"+arvadostest.UserAgreementPDH, nil)
526 req.Header.Set("Authorization", "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/282d7d172b6cfdce364c5ed12ddf7417b2d00065")
527 resp := s.testRequest(req).Result()
529 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
530 var col arvados.Collection
531 c.Check(json.NewDecoder(resp.Body).Decode(&col), check.IsNil)
532 c.Check(col.PortableDataHash, check.Equals, arvadostest.UserAgreementPDH)
533 c.Check(col.ManifestText, check.Matches,
534 `\. 6a4ff0499484c6c79c95cd8c566bd25f\+249025\+A[0-9a-f]{40}@[0-9a-f]{8} 0:249025:GNU_General_Public_License,_version_3.pdf
538 func (s *FederationSuite) TestSaltedTokenGetCollectionByPDHError(c *check.C) {
539 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
541 req := httptest.NewRequest("GET", "/arvados/v1/collections/99999999999999999999999999999999+99", nil)
542 req.Header.Set("Authorization", "Bearer v2/zzzzz-gj3su-077z32aux8dg2s1/282d7d172b6cfdce364c5ed12ddf7417b2d00065")
543 resp := s.testRequest(req).Result()
545 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
548 func (s *FederationSuite) TestGetRemoteContainerRequest(c *check.C) {
549 defer s.localServiceReturns404(c).Close()
550 req := httptest.NewRequest("GET", "/arvados/v1/container_requests/"+arvadostest.QueuedContainerRequestUUID, nil)
551 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
552 resp := s.testRequest(req).Result()
553 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
554 var cr arvados.ContainerRequest
555 c.Check(json.NewDecoder(resp.Body).Decode(&cr), check.IsNil)
556 c.Check(cr.UUID, check.Equals, arvadostest.QueuedContainerRequestUUID)
557 c.Check(cr.Priority, check.Equals, 1)
560 func (s *FederationSuite) TestUpdateRemoteContainerRequest(c *check.C) {
561 defer s.localServiceReturns404(c).Close()
562 setPri := func(pri int) {
563 req := httptest.NewRequest("PATCH", "/arvados/v1/container_requests/"+arvadostest.QueuedContainerRequestUUID,
564 strings.NewReader(fmt.Sprintf(`{"container_request": {"priority": %d}}`, pri)))
565 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
566 req.Header.Set("Content-type", "application/json")
567 resp := s.testRequest(req).Result()
568 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
569 var cr arvados.ContainerRequest
570 c.Check(json.NewDecoder(resp.Body).Decode(&cr), check.IsNil)
571 c.Check(cr.UUID, check.Equals, arvadostest.QueuedContainerRequestUUID)
572 c.Check(cr.Priority, check.Equals, pri)
575 setPri(1) // Reset fixture so side effect doesn't break other tests.
578 func (s *FederationSuite) TestCreateRemoteContainerRequest(c *check.C) {
579 defer s.localServiceReturns404(c).Close()
580 // pass cluster_id via query parameter, this allows arvados-controller
581 // to avoid parsing the body
582 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zzzzz",
584 "container_request": {
585 "name": "hello world",
586 "state": "Uncommitted",
588 "container_image": "123",
593 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
594 req.Header.Set("Content-type", "application/json")
595 resp := s.testRequest(req).Result()
596 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
597 var cr arvados.ContainerRequest
598 c.Check(json.NewDecoder(resp.Body).Decode(&cr), check.IsNil)
599 c.Check(cr.Name, check.Equals, "hello world")
600 c.Check(strings.HasPrefix(cr.UUID, "zzzzz-"), check.Equals, true)
603 func (s *FederationSuite) TestCreateRemoteContainerRequestCheckRuntimeToken(c *check.C) {
604 // Send request to zmock and check that outgoing request has
605 // runtime_token set with a new random v2 token.
607 defer s.localServiceReturns404(c).Close()
608 // pass cluster_id via query parameter, this allows arvados-controller
609 // to avoid parsing the body
610 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zmock",
612 "container_request": {
613 "name": "hello world",
614 "state": "Uncommitted",
616 "container_image": "123",
621 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveTokenV2)
622 req.Header.Set("Content-type", "application/json")
624 arvadostest.SetServiceURL(&s.testHandler.Cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
625 s.testHandler.Cluster.ClusterID = "zzzzz"
627 resp := s.testRequest(req).Result()
628 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
630 arvados.ContainerRequest `json:"container_request"`
632 c.Check(json.NewDecoder(s.remoteMockRequests[0].Body).Decode(&cr), check.IsNil)
633 c.Check(strings.HasPrefix(cr.ContainerRequest.RuntimeToken, "v2/zzzzz-gj3su-"), check.Equals, true)
634 c.Check(cr.ContainerRequest.RuntimeToken, check.Not(check.Equals), arvadostest.ActiveTokenV2)
637 func (s *FederationSuite) TestCreateRemoteContainerRequestCheckSetRuntimeToken(c *check.C) {
638 // Send request to zmock and check that outgoing request has
639 // runtime_token set with the explicitly provided token.
641 defer s.localServiceReturns404(c).Close()
642 // pass cluster_id via query parameter, this allows arvados-controller
643 // to avoid parsing the body
644 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zmock",
646 "container_request": {
647 "name": "hello world",
648 "state": "Uncommitted",
650 "container_image": "123",
652 "runtime_token": "xyz"
656 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
657 req.Header.Set("Content-type", "application/json")
658 resp := s.testRequest(req).Result()
659 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
661 arvados.ContainerRequest `json:"container_request"`
663 c.Check(json.NewDecoder(s.remoteMockRequests[0].Body).Decode(&cr), check.IsNil)
664 c.Check(cr.ContainerRequest.RuntimeToken, check.Equals, "xyz")
667 func (s *FederationSuite) TestCreateRemoteContainerRequestRuntimeTokenFromAuth(c *check.C) {
668 // Send request to zmock and check that outgoing request has
669 // runtime_token set using the Auth token because the user is remote.
671 defer s.localServiceReturns404(c).Close()
672 // pass cluster_id via query parameter, this allows arvados-controller
673 // to avoid parsing the body
674 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zmock",
676 "container_request": {
677 "name": "hello world",
678 "state": "Uncommitted",
680 "container_image": "123",
685 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveTokenV2+"/zzzzz-dz642-parentcontainer")
686 req.Header.Set("Content-type", "application/json")
687 resp := s.testRequest(req).Result()
688 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
690 arvados.ContainerRequest `json:"container_request"`
692 c.Check(json.NewDecoder(s.remoteMockRequests[0].Body).Decode(&cr), check.IsNil)
693 c.Check(cr.ContainerRequest.RuntimeToken, check.Equals, arvadostest.ActiveTokenV2)
696 func (s *FederationSuite) TestCreateRemoteContainerRequestError(c *check.C) {
697 defer s.localServiceReturns404(c).Close()
698 // pass cluster_id via query parameter, this allows arvados-controller
699 // to avoid parsing the body
700 req := httptest.NewRequest("POST", "/arvados/v1/container_requests?cluster_id=zz404",
702 "container_request": {
703 "name": "hello world",
704 "state": "Uncommitted",
706 "container_image": "123",
711 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
712 req.Header.Set("Content-type", "application/json")
713 resp := s.testRequest(req).Result()
714 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
717 func (s *FederationSuite) TestGetRemoteContainer(c *check.C) {
718 defer s.localServiceReturns404(c).Close()
719 req := httptest.NewRequest("GET", "/arvados/v1/containers/"+arvadostest.QueuedContainerUUID, nil)
720 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
721 resp := s.testRequest(req)
722 c.Check(resp.Code, check.Equals, http.StatusOK)
723 var cn arvados.Container
724 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
725 c.Check(cn.UUID, check.Equals, arvadostest.QueuedContainerUUID)
728 func (s *FederationSuite) TestListRemoteContainer(c *check.C) {
729 defer s.localServiceReturns404(c).Close()
730 req := httptest.NewRequest("GET", "/arvados/v1/containers?count=none&filters="+
731 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v"]]]`, arvadostest.QueuedContainerUUID)), nil)
732 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
733 resp := s.testRequest(req).Result()
734 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
735 var cn arvados.ContainerList
736 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
737 c.Assert(cn.Items, check.HasLen, 1)
738 c.Check(cn.Items[0].UUID, check.Equals, arvadostest.QueuedContainerUUID)
741 func (s *FederationSuite) TestListMultiRemoteContainers(c *check.C) {
742 defer s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
743 bd, _ := ioutil.ReadAll(req.Body)
744 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`)
746 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr5queuedcontnr", "command": ["abc"]}]}`))
748 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&select=%s",
749 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
750 arvadostest.QueuedContainerUUID)),
751 url.QueryEscape(`["uuid", "command"]`)),
753 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
754 resp := s.testRequest(req).Result()
755 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
756 var cn arvados.ContainerList
757 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
758 c.Check(cn.Items, check.HasLen, 2)
759 mp := make(map[string]arvados.Container)
760 for _, cr := range cn.Items {
763 c.Check(mp[arvadostest.QueuedContainerUUID].Command, check.DeepEquals, []string{"echo", "hello"})
764 c.Check(mp[arvadostest.QueuedContainerUUID].ContainerImage, check.Equals, "")
765 c.Check(mp["zhome-xvhdp-cr5queuedcontnr"].Command, check.DeepEquals, []string{"abc"})
766 c.Check(mp["zhome-xvhdp-cr5queuedcontnr"].ContainerImage, check.Equals, "")
769 func (s *FederationSuite) TestListMultiRemoteContainerError(c *check.C) {
770 defer s.localServiceReturns404(c).Close()
771 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&select=%s",
772 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
773 arvadostest.QueuedContainerUUID)),
774 url.QueryEscape(`["uuid", "command"]`)),
776 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
777 resp := s.testRequest(req).Result()
778 c.Check(resp.StatusCode, check.Equals, http.StatusBadGateway)
779 s.checkJSONErrorMatches(c, resp, `error fetching from zhome \(404 Not Found\): EOF`)
782 func (s *FederationSuite) TestListMultiRemoteContainersPaged(c *check.C) {
785 defer s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
786 bd, _ := ioutil.ReadAll(req.Body)
788 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`)
790 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr5queuedcontnr", "command": ["abc"]}]}`))
791 } else if callCount == 1 {
792 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`)
794 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr6queuedcontnr", "command": ["efg"]}]}`))
798 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s",
799 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr", "zhome-xvhdp-cr6queuedcontnr"]]]`,
800 arvadostest.QueuedContainerUUID))),
802 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
803 resp := s.testRequest(req).Result()
804 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
805 c.Check(callCount, check.Equals, 2)
806 var cn arvados.ContainerList
807 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
808 c.Check(cn.Items, check.HasLen, 3)
809 mp := make(map[string]arvados.Container)
810 for _, cr := range cn.Items {
813 c.Check(mp[arvadostest.QueuedContainerUUID].Command, check.DeepEquals, []string{"echo", "hello"})
814 c.Check(mp["zhome-xvhdp-cr5queuedcontnr"].Command, check.DeepEquals, []string{"abc"})
815 c.Check(mp["zhome-xvhdp-cr6queuedcontnr"].Command, check.DeepEquals, []string{"efg"})
818 func (s *FederationSuite) TestListMultiRemoteContainersMissing(c *check.C) {
821 defer s.localServiceHandler(c, http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
822 bd, _ := ioutil.ReadAll(req.Body)
824 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`)
826 w.Write([]byte(`{"kind": "arvados#containerList", "items": [{"uuid": "zhome-xvhdp-cr6queuedcontnr", "command": ["efg"]}]}`))
827 } else if callCount == 1 {
828 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`)
830 w.Write([]byte(`{"kind": "arvados#containerList", "items": []}`))
834 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s",
835 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr", "zhome-xvhdp-cr6queuedcontnr"]]]`,
836 arvadostest.QueuedContainerUUID))),
838 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
839 resp := s.testRequest(req).Result()
840 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
841 c.Check(callCount, check.Equals, 2)
842 var cn arvados.ContainerList
843 c.Check(json.NewDecoder(resp.Body).Decode(&cn), check.IsNil)
844 c.Check(cn.Items, check.HasLen, 2)
845 mp := make(map[string]arvados.Container)
846 for _, cr := range cn.Items {
849 c.Check(mp[arvadostest.QueuedContainerUUID].Command, check.DeepEquals, []string{"echo", "hello"})
850 c.Check(mp["zhome-xvhdp-cr6queuedcontnr"].Command, check.DeepEquals, []string{"efg"})
853 func (s *FederationSuite) TestListMultiRemoteContainerPageSizeError(c *check.C) {
854 s.testHandler.Cluster.API.MaxItemsPerResponse = 1
855 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s",
856 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
857 arvadostest.QueuedContainerUUID))),
859 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
860 resp := s.testRequest(req).Result()
861 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
862 s.checkJSONErrorMatches(c, resp, `Federated multi-object request for 2 objects which is more than max page size 1.`)
865 func (s *FederationSuite) TestListMultiRemoteContainerLimitError(c *check.C) {
866 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&limit=1",
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 may not provide 'limit', 'offset' or 'order'.`)
876 func (s *FederationSuite) TestListMultiRemoteContainerOffsetError(c *check.C) {
877 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&offset=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) TestListMultiRemoteContainerOrderError(c *check.C) {
888 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&order=uuid",
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) TestListMultiRemoteContainerSelectError(c *check.C) {
899 req := httptest.NewRequest("GET", fmt.Sprintf("/arvados/v1/containers?count=none&filters=%s&select=%s",
900 url.QueryEscape(fmt.Sprintf(`[["uuid", "in", ["%v", "zhome-xvhdp-cr5queuedcontnr"]]]`,
901 arvadostest.QueuedContainerUUID)),
902 url.QueryEscape(`["command"]`)),
904 req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
905 resp := s.testRequest(req).Result()
906 c.Check(resp.StatusCode, check.Equals, http.StatusBadRequest)
907 s.checkJSONErrorMatches(c, resp, `Federated multi-object request must include 'uuid' in 'select'`)