1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
25 "git.arvados.org/arvados.git/lib/boot"
26 "git.arvados.org/arvados.git/lib/config"
27 "git.arvados.org/arvados.git/sdk/go/arvados"
28 "git.arvados.org/arvados.git/sdk/go/arvadostest"
29 "git.arvados.org/arvados.git/sdk/go/ctxlog"
30 "git.arvados.org/arvados.git/sdk/go/httpserver"
31 check "gopkg.in/check.v1"
34 var _ = check.Suite(&IntegrationSuite{})
36 type IntegrationSuite struct {
37 testClusters map[string]*boot.TestCluster
38 oidcprovider *arvadostest.OIDCProvider
41 func (s *IntegrationSuite) SetUpSuite(c *check.C) {
44 s.oidcprovider = arvadostest.NewOIDCProvider(c)
45 s.oidcprovider.AuthEmail = "user@example.com"
46 s.oidcprovider.AuthEmailVerified = true
47 s.oidcprovider.AuthName = "Example User"
48 s.oidcprovider.ValidClientID = "clientid"
49 s.oidcprovider.ValidClientSecret = "clientsecret"
51 s.testClusters = map[string]*boot.TestCluster{
56 hostport := map[string]string{}
57 for id := range s.testClusters {
58 hostport[id] = func() string {
59 // TODO: Instead of expecting random ports on
60 // 127.0.0.11, 22, 33 to be race-safe, try
61 // different 127.x.y.z until finding one that
63 ln, err := net.Listen("tcp", ":0")
64 c.Assert(err, check.IsNil)
66 _, port, err := net.SplitHostPort(ln.Addr().String())
67 c.Assert(err, check.IsNil)
68 return "127.0.0." + id[3:] + ":" + port
71 for id := range s.testClusters {
76 ExternalURL: https://` + hostport[id] + `
83 Host: ` + hostport["z1111"] + `
91 Host: ` + hostport["z2222"] + `
100 Host: ` + hostport["z3333"] + `
113 Issuer: ` + s.oidcprovider.Issuer.URL + `
114 ClientID: ` + s.oidcprovider.ValidClientID + `
115 ClientSecret: ` + s.oidcprovider.ValidClientSecret + `
117 EmailVerifiedClaim: email_verified
118 AcceptAccessToken: true
119 AcceptAccessTokenScope: ""
128 loader := config.NewLoader(bytes.NewBufferString(yaml), ctxlog.TestLogger(c))
130 loader.SkipLegacy = true
131 loader.SkipAPICalls = true
132 cfg, err := loader.Load()
133 c.Assert(err, check.IsNil)
134 tc := boot.NewTestCluster(
135 filepath.Join(cwd, "..", ".."),
136 id, cfg, "127.0.0."+id[3:], c.Log)
137 tc.Super.NoWorkbench1 = true
139 s.testClusters[id] = tc
141 for _, tc := range s.testClusters {
143 c.Assert(ok, check.Equals, true)
147 func (s *IntegrationSuite) TearDownSuite(c *check.C) {
148 for _, c := range s.testClusters {
153 func (s *IntegrationSuite) TestDefaultStorageClassesOnCollections(c *check.C) {
154 conn := s.testClusters["z1111"].Conn()
155 rootctx, _, _ := s.testClusters["z1111"].RootClients()
156 userctx, _, kc, _ := s.testClusters["z1111"].UserClients(rootctx, c, conn, s.oidcprovider.AuthEmail, true)
157 c.Assert(len(kc.DefaultStorageClasses) > 0, check.Equals, true)
158 coll, err := conn.CollectionCreate(userctx, arvados.CreateOptions{})
159 c.Assert(err, check.IsNil)
160 c.Assert(coll.StorageClassesDesired, check.DeepEquals, kc.DefaultStorageClasses)
163 func (s *IntegrationSuite) TestGetCollectionByPDH(c *check.C) {
164 conn1 := s.testClusters["z1111"].Conn()
165 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
166 conn3 := s.testClusters["z3333"].Conn()
167 userctx1, ac1, kc1, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, s.oidcprovider.AuthEmail, true)
169 // Create the collection to find its PDH (but don't save it
171 var coll1 arvados.Collection
172 fs1, err := coll1.FileSystem(ac1, kc1)
173 c.Assert(err, check.IsNil)
174 f, err := fs1.OpenFile("test.txt", os.O_CREATE|os.O_RDWR, 0777)
175 c.Assert(err, check.IsNil)
176 _, err = io.WriteString(f, "IntegrationSuite.TestGetCollectionByPDH")
177 c.Assert(err, check.IsNil)
179 c.Assert(err, check.IsNil)
180 mtxt, err := fs1.MarshalManifest(".")
181 c.Assert(err, check.IsNil)
182 pdh := arvados.PortableDataHash(mtxt)
184 // Looking up the PDH before saving returns 404 if cycle
185 // detection is working.
186 _, err = conn1.CollectionGet(userctx1, arvados.GetOptions{UUID: pdh})
187 c.Assert(err, check.ErrorMatches, `.*404 Not Found.*`)
189 // Save the collection on cluster z1111.
190 coll1, err = conn1.CollectionCreate(userctx1, arvados.CreateOptions{Attrs: map[string]interface{}{
191 "manifest_text": mtxt,
193 c.Assert(err, check.IsNil)
195 // Retrieve the collection from cluster z3333.
196 coll, err := conn3.CollectionGet(userctx1, arvados.GetOptions{UUID: pdh})
197 c.Check(err, check.IsNil)
198 c.Check(coll.PortableDataHash, check.Equals, pdh)
202 func (s *IntegrationSuite) TestRemoteUserAndTokenCacheRace(c *check.C) {
203 conn1 := s.testClusters["z1111"].Conn()
204 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
205 rootctx2, _, _ := s.testClusters["z2222"].RootClients()
206 conn2 := s.testClusters["z2222"].Conn()
207 userctx1, _, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, "user2@example.com", true)
209 var wg1, wg2 sync.WaitGroup
212 // Make concurrent requests to z2222 with a local token to make sure more
213 // than one worker is listening.
215 for i := 0; i < creqs; i++ {
220 _, err := conn2.UserGetCurrent(rootctx2, arvados.GetOptions{})
221 c.Check(err, check.IsNil, check.Commentf("warm up phase failed"))
227 // Real test pass -- use a new remote token than the one used in the warm-up
230 for i := 0; i < creqs; i++ {
235 // Retrieve the remote collection from cluster z2222.
236 _, err := conn2.UserGetCurrent(userctx1, arvados.GetOptions{})
237 c.Check(err, check.IsNil, check.Commentf("testing phase failed"))
244 func (s *IntegrationSuite) TestS3WithFederatedToken(c *check.C) {
245 if _, err := exec.LookPath("s3cmd"); err != nil {
246 c.Skip("s3cmd not in PATH")
250 testText := "IntegrationSuite.TestS3WithFederatedToken"
252 conn1 := s.testClusters["z1111"].Conn()
253 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
254 userctx1, ac1, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, s.oidcprovider.AuthEmail, true)
255 conn3 := s.testClusters["z3333"].Conn()
257 createColl := func(clusterID string) arvados.Collection {
258 _, ac, kc := s.testClusters[clusterID].ClientsWithToken(ac1.AuthToken)
259 var coll arvados.Collection
260 fs, err := coll.FileSystem(ac, kc)
261 c.Assert(err, check.IsNil)
262 f, err := fs.OpenFile("test.txt", os.O_CREATE|os.O_RDWR, 0777)
263 c.Assert(err, check.IsNil)
264 _, err = io.WriteString(f, testText)
265 c.Assert(err, check.IsNil)
267 c.Assert(err, check.IsNil)
268 mtxt, err := fs.MarshalManifest(".")
269 c.Assert(err, check.IsNil)
270 coll, err = s.testClusters[clusterID].Conn().CollectionCreate(userctx1, arvados.CreateOptions{Attrs: map[string]interface{}{
271 "manifest_text": mtxt,
273 c.Assert(err, check.IsNil)
277 for _, trial := range []struct {
278 clusterID string // create the collection on this cluster (then use z3333 to access it)
281 // Try the hardest test first: z3333 hasn't seen
282 // z1111's token yet, and we're just passing the
283 // opaque secret part, so z3333 has to guess that it
285 {"z1111", strings.Split(ac1.AuthToken, "/")[2]},
286 {"z3333", strings.Split(ac1.AuthToken, "/")[2]},
287 {"z1111", strings.Replace(ac1.AuthToken, "/", "_", -1)},
288 {"z3333", strings.Replace(ac1.AuthToken, "/", "_", -1)},
290 c.Logf("================ %v", trial)
291 coll := createColl(trial.clusterID)
293 cfgjson, err := conn3.ConfigGet(userctx1)
294 c.Assert(err, check.IsNil)
295 var cluster arvados.Cluster
296 err = json.Unmarshal(cfgjson, &cluster)
297 c.Assert(err, check.IsNil)
299 c.Logf("TokenV2 is %s", ac1.AuthToken)
300 host := cluster.Services.WebDAV.ExternalURL.Host
302 "--ssl", "--no-check-certificate",
303 "--host=" + host, "--host-bucket=" + host,
304 "--access_key=" + trial.token, "--secret_key=" + trial.token,
306 buf, err := exec.Command("s3cmd", append(s3args, "ls", "s3://"+coll.UUID)...).CombinedOutput()
307 c.Check(err, check.IsNil)
308 c.Check(string(buf), check.Matches, `.* `+fmt.Sprintf("%d", len(testText))+` +s3://`+coll.UUID+`/test.txt\n`)
310 buf, _ = exec.Command("s3cmd", append(s3args, "get", "s3://"+coll.UUID+"/test.txt", c.MkDir()+"/tmpfile")...).CombinedOutput()
311 // Command fails because we don't return Etag header.
312 flen := strconv.Itoa(len(testText))
313 c.Check(string(buf), check.Matches, `(?ms).*`+flen+` (bytes in|of `+flen+`).*`)
317 func (s *IntegrationSuite) TestGetCollectionAsAnonymous(c *check.C) {
318 conn1 := s.testClusters["z1111"].Conn()
319 conn3 := s.testClusters["z3333"].Conn()
320 rootctx1, rootac1, rootkc1 := s.testClusters["z1111"].RootClients()
321 anonctx3, anonac3, _ := s.testClusters["z3333"].AnonymousClients()
323 // Make sure anonymous token was set
324 c.Assert(anonac3.AuthToken, check.Not(check.Equals), "")
326 // Create the collection to find its PDH (but don't save it
328 var coll1 arvados.Collection
329 fs1, err := coll1.FileSystem(rootac1, rootkc1)
330 c.Assert(err, check.IsNil)
331 f, err := fs1.OpenFile("test.txt", os.O_CREATE|os.O_RDWR, 0777)
332 c.Assert(err, check.IsNil)
333 _, err = io.WriteString(f, "IntegrationSuite.TestGetCollectionAsAnonymous")
334 c.Assert(err, check.IsNil)
336 c.Assert(err, check.IsNil)
337 mtxt, err := fs1.MarshalManifest(".")
338 c.Assert(err, check.IsNil)
339 pdh := arvados.PortableDataHash(mtxt)
341 // Save the collection on cluster z1111.
342 coll1, err = conn1.CollectionCreate(rootctx1, arvados.CreateOptions{Attrs: map[string]interface{}{
343 "manifest_text": mtxt,
345 c.Assert(err, check.IsNil)
347 // Share it with the anonymous users group.
348 var outLink arvados.Link
349 err = rootac1.RequestAndDecode(&outLink, "POST", "/arvados/v1/links", nil,
350 map[string]interface{}{"link": map[string]interface{}{
351 "link_class": "permission",
353 "tail_uuid": "z1111-j7d0g-anonymouspublic",
354 "head_uuid": coll1.UUID,
357 c.Check(err, check.IsNil)
359 // Current user should be z3 anonymous user
360 outUser, err := anonac3.CurrentUser()
361 c.Check(err, check.IsNil)
362 c.Check(outUser.UUID, check.Equals, "z3333-tpzed-anonymouspublic")
364 // Get the token uuid
365 var outAuth arvados.APIClientAuthorization
366 err = anonac3.RequestAndDecode(&outAuth, "GET", "/arvados/v1/api_client_authorizations/current", nil, nil)
367 c.Check(err, check.IsNil)
369 // Make a v2 token of the z3 anonymous user, and use it on z1
370 _, anonac1, _ := s.testClusters["z1111"].ClientsWithToken(outAuth.TokenV2())
371 outUser2, err := anonac1.CurrentUser()
372 c.Check(err, check.IsNil)
373 // z3 anonymous user will be mapped to the z1 anonymous user
374 c.Check(outUser2.UUID, check.Equals, "z1111-tpzed-anonymouspublic")
376 // Retrieve the collection (which is on z1) using anonymous from cluster z3333.
377 coll, err := conn3.CollectionGet(anonctx3, arvados.GetOptions{UUID: coll1.UUID})
378 c.Check(err, check.IsNil)
379 c.Check(coll.PortableDataHash, check.Equals, pdh)
382 // z3333 should forward the locally-issued anonymous user token to its login
383 // cluster z1111. That is no problem because the login cluster controller will
384 // map any anonymous user token to its local anonymous user.
386 // This needs to work because wb1 has a tendency to slap the local anonymous
387 // user token on every request as a reader_token, which gets folded into the
388 // request token list controller.
390 // Use a z1111 user token and the anonymous token from z3333 passed in as a
391 // reader_token to do a request on z3333, asking for the z1111 anonymous user
392 // object. The request will be forwarded to the z1111 cluster. The presence of
393 // the z3333 anonymous user token should not prohibit the request from being
395 func (s *IntegrationSuite) TestForwardAnonymousTokenToLoginCluster(c *check.C) {
396 conn1 := s.testClusters["z1111"].Conn()
397 s.testClusters["z3333"].Conn()
399 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
400 _, anonac3, _ := s.testClusters["z3333"].AnonymousClients()
402 // Make a user connection to z3333 (using a z1111 user, because that's the login cluster)
403 _, userac1, _, _ := s.testClusters["z3333"].UserClients(rootctx1, c, conn1, "user@example.com", true)
405 // Get the anonymous user token for z3333
406 var anon3Auth arvados.APIClientAuthorization
407 err := anonac3.RequestAndDecode(&anon3Auth, "GET", "/arvados/v1/api_client_authorizations/current", nil, nil)
408 c.Check(err, check.IsNil)
410 var userList arvados.UserList
411 where := make(map[string]string)
412 where["uuid"] = "z1111-tpzed-anonymouspublic"
413 err = userac1.RequestAndDecode(&userList, "GET", "/arvados/v1/users", nil,
414 map[string]interface{}{
415 "reader_tokens": []string{anon3Auth.TokenV2()},
419 // The local z3333 anonymous token must be allowed to be forwarded to the login cluster
420 c.Check(err, check.IsNil)
423 // Get a token from the login cluster (z1111), use it to submit a
424 // container request on z2222.
425 func (s *IntegrationSuite) TestCreateContainerRequestWithFedToken(c *check.C) {
426 conn1 := s.testClusters["z1111"].Conn()
427 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
428 _, ac1, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, s.oidcprovider.AuthEmail, true)
430 // Use ac2 to get the discovery doc with a blank token, so the
431 // SDK doesn't magically pass the z1111 token to z2222 before
432 // we're ready to start our test.
433 _, ac2, _ := s.testClusters["z2222"].ClientsWithToken("")
434 var dd map[string]interface{}
435 err := ac2.RequestAndDecode(&dd, "GET", "discovery/v1/apis/arvados/v1/rest", nil, nil)
436 c.Assert(err, check.IsNil)
443 cr arvados.ContainerRequest
445 json.NewEncoder(&body).Encode(map[string]interface{}{
446 "container_request": map[string]interface{}{
447 "command": []string{"echo"},
448 "container_image": "d41d8cd98f00b204e9800998ecf8427e+0",
453 ac2.AuthToken = ac1.AuthToken
455 c.Log("...post CR with good (but not yet cached) token")
456 cr = arvados.ContainerRequest{}
457 req, err = http.NewRequest("POST", "https://"+ac2.APIHost+"/arvados/v1/container_requests", bytes.NewReader(body.Bytes()))
458 c.Assert(err, check.IsNil)
459 req.Header.Set("Content-Type", "application/json")
460 err = ac2.DoAndDecode(&cr, req)
461 c.Assert(err, check.IsNil)
462 c.Logf("err == %#v", err)
464 c.Log("...get user with good token")
466 req, err = http.NewRequest("GET", "https://"+ac2.APIHost+"/arvados/v1/users/current", nil)
467 c.Assert(err, check.IsNil)
468 err = ac2.DoAndDecode(&u, req)
469 c.Check(err, check.IsNil)
470 c.Check(u.UUID, check.Matches, "z1111-tpzed-.*")
472 c.Log("...post CR with good cached token")
473 cr = arvados.ContainerRequest{}
474 req, err = http.NewRequest("POST", "https://"+ac2.APIHost+"/arvados/v1/container_requests", bytes.NewReader(body.Bytes()))
475 c.Assert(err, check.IsNil)
476 req.Header.Set("Content-Type", "application/json")
477 err = ac2.DoAndDecode(&cr, req)
478 c.Check(err, check.IsNil)
479 c.Check(cr.UUID, check.Matches, "z2222-.*")
481 c.Log("...post with good cached token ('OAuth2 ...')")
482 cr = arvados.ContainerRequest{}
483 req, err = http.NewRequest("POST", "https://"+ac2.APIHost+"/arvados/v1/container_requests", bytes.NewReader(body.Bytes()))
484 c.Assert(err, check.IsNil)
485 req.Header.Set("Content-Type", "application/json")
486 req.Header.Set("Authorization", "OAuth2 "+ac2.AuthToken)
487 resp, err = arvados.InsecureHTTPClient.Do(req)
488 c.Assert(err, check.IsNil)
489 err = json.NewDecoder(resp.Body).Decode(&cr)
490 c.Check(err, check.IsNil)
491 c.Check(cr.UUID, check.Matches, "z2222-.*")
494 func (s *IntegrationSuite) TestCreateContainerRequestWithBadToken(c *check.C) {
495 conn1 := s.testClusters["z1111"].Conn()
496 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
497 _, ac1, _, au := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, "user@example.com", true)
504 {"Good token", ac1.AuthToken, http.StatusOK},
505 {"Bogus token", "abcdef", http.StatusUnauthorized},
506 {"v1-looking token", "badtoken00badtoken00badtoken00badtoken00b", http.StatusUnauthorized},
507 {"v2-looking token", "v2/" + au.UUID + "/badtoken00badtoken00badtoken00badtoken00b", http.StatusUnauthorized},
510 body, _ := json.Marshal(map[string]interface{}{
511 "container_request": map[string]interface{}{
512 "command": []string{"echo"},
513 "container_image": "d41d8cd98f00b204e9800998ecf8427e+0",
519 for _, tt := range tests {
520 c.Log(c.TestName() + " " + tt.name)
521 ac1.AuthToken = tt.token
522 req, err := http.NewRequest("POST", "https://"+ac1.APIHost+"/arvados/v1/container_requests", bytes.NewReader(body))
523 c.Assert(err, check.IsNil)
524 req.Header.Set("Content-Type", "application/json")
525 resp, err := ac1.Do(req)
526 c.Assert(err, check.IsNil)
527 c.Assert(resp.StatusCode, check.Equals, tt.expectedCode)
531 func (s *IntegrationSuite) TestRequestIDHeader(c *check.C) {
532 conn1 := s.testClusters["z1111"].Conn()
533 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
534 userctx1, ac1, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, "user@example.com", true)
536 coll, err := conn1.CollectionCreate(userctx1, arvados.CreateOptions{})
537 c.Check(err, check.IsNil)
538 specimen, err := conn1.SpecimenCreate(userctx1, arvados.CreateOptions{})
539 c.Check(err, check.IsNil)
546 {"/arvados/v1/collections", false, false},
547 {"/arvados/v1/collections", true, false},
548 {"/arvados/v1/nonexistant", false, true},
549 {"/arvados/v1/nonexistant", true, true},
550 {"/arvados/v1/collections/" + coll.UUID, false, false},
551 {"/arvados/v1/collections/" + coll.UUID, true, false},
552 {"/arvados/v1/specimens/" + specimen.UUID, false, false},
553 {"/arvados/v1/specimens/" + specimen.UUID, true, false},
554 // new code path (lib/controller/router etc) - single-cluster request
555 {"/arvados/v1/collections/z1111-4zz18-0123456789abcde", false, true},
556 {"/arvados/v1/collections/z1111-4zz18-0123456789abcde", true, true},
557 // new code path (lib/controller/router etc) - federated request
558 {"/arvados/v1/collections/z2222-4zz18-0123456789abcde", false, true},
559 {"/arvados/v1/collections/z2222-4zz18-0123456789abcde", true, true},
560 // old code path (proxyRailsAPI) - single-cluster request
561 {"/arvados/v1/specimens/z1111-j58dm-0123456789abcde", false, true},
562 {"/arvados/v1/specimens/z1111-j58dm-0123456789abcde", true, true},
563 // old code path (setupProxyRemoteCluster) - federated request
564 {"/arvados/v1/workflows/z2222-7fd4e-0123456789abcde", false, true},
565 {"/arvados/v1/workflows/z2222-7fd4e-0123456789abcde", true, true},
568 for _, tt := range tests {
569 c.Log(c.TestName() + " " + tt.path)
570 req, err := http.NewRequest("GET", "https://"+ac1.APIHost+tt.path, nil)
571 c.Assert(err, check.IsNil)
572 customReqId := "abcdeG"
573 if !tt.reqIdProvided {
574 c.Assert(req.Header.Get("X-Request-Id"), check.Equals, "")
576 req.Header.Set("X-Request-Id", customReqId)
578 resp, err := ac1.Do(req)
579 c.Assert(err, check.IsNil)
580 if tt.notFoundRequest {
581 c.Check(resp.StatusCode, check.Equals, http.StatusNotFound)
583 c.Check(resp.StatusCode, check.Equals, http.StatusOK)
585 respHdr := resp.Header.Get("X-Request-Id")
586 if tt.reqIdProvided {
587 c.Check(respHdr, check.Equals, customReqId)
589 c.Check(respHdr, check.Matches, `req-[0-9a-zA-Z]{20}`)
591 if tt.notFoundRequest {
592 var jresp httpserver.ErrorResponse
593 err := json.NewDecoder(resp.Body).Decode(&jresp)
594 c.Check(err, check.IsNil)
595 c.Assert(jresp.Errors, check.HasLen, 1)
596 c.Check(jresp.Errors[0], check.Matches, `.*\(`+respHdr+`\).*`)
601 // We test the direct access to the database
602 // normally an integration test would not have a database access, but in this case we need
603 // to test tokens that are secret, so there is no API response that will give them back
604 func (s *IntegrationSuite) dbConn(c *check.C, clusterID string) (*sql.DB, *sql.Conn) {
605 ctx := context.Background()
606 db, err := sql.Open("postgres", s.testClusters[clusterID].Super.Cluster().PostgreSQL.Connection.String())
607 c.Assert(err, check.IsNil)
609 conn, err := db.Conn(ctx)
610 c.Assert(err, check.IsNil)
612 rows, err := conn.ExecContext(ctx, `SELECT 1`)
613 c.Assert(err, check.IsNil)
614 n, err := rows.RowsAffected()
615 c.Assert(err, check.IsNil)
616 c.Assert(n, check.Equals, int64(1))
620 // TestRuntimeTokenInCR will test several different tokens in the runtime attribute
621 // and check the expected results accessing directly to the database if needed.
622 func (s *IntegrationSuite) TestRuntimeTokenInCR(c *check.C) {
623 db, dbconn := s.dbConn(c, "z1111")
626 conn1 := s.testClusters["z1111"].Conn()
627 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
628 userctx1, ac1, _, au := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, "user@example.com", true)
633 expectAToGetAValidCR bool
634 expectedToken *string
636 {"Good token z1111 user", ac1.AuthToken, true, &ac1.AuthToken},
637 {"Bogus token", "abcdef", false, nil},
638 {"v1-looking token", "badtoken00badtoken00badtoken00badtoken00b", false, nil},
639 {"v2-looking token", "v2/" + au.UUID + "/badtoken00badtoken00badtoken00badtoken00b", false, nil},
642 for _, tt := range tests {
643 c.Log(c.TestName() + " " + tt.name)
645 rq := map[string]interface{}{
646 "command": []string{"echo"},
647 "container_image": "d41d8cd98f00b204e9800998ecf8427e+0",
650 "runtime_token": tt.token,
652 cr, err := conn1.ContainerRequestCreate(userctx1, arvados.CreateOptions{Attrs: rq})
653 if tt.expectAToGetAValidCR {
654 c.Check(err, check.IsNil)
655 c.Check(cr, check.NotNil)
656 c.Check(cr.UUID, check.Not(check.Equals), "")
659 if tt.expectedToken == nil {
663 c.Logf("cr.UUID: %s", cr.UUID)
664 row := dbconn.QueryRowContext(rootctx1, `SELECT runtime_token from container_requests where uuid=$1`, cr.UUID)
665 c.Check(row, check.NotNil)
666 var token sql.NullString
668 if c.Check(token.Valid, check.Equals, true) {
669 c.Check(token.String, check.Equals, *tt.expectedToken)
674 // TestIntermediateCluster will send a container request to
675 // one cluster with another cluster as the destination
676 // and check the tokens are being handled properly
677 func (s *IntegrationSuite) TestIntermediateCluster(c *check.C) {
678 conn1 := s.testClusters["z1111"].Conn()
679 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
680 uctx1, ac1, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, "user@example.com", true)
685 expectedRuntimeToken string
686 expectedUUIDprefix string
688 {"Good token z1111 user sending a CR to z2222", ac1.AuthToken, "", "z2222-xvhdp-"},
691 for _, tt := range tests {
692 c.Log(c.TestName() + " " + tt.name)
693 rq := map[string]interface{}{
694 "command": []string{"echo"},
695 "container_image": "d41d8cd98f00b204e9800998ecf8427e+0",
698 "runtime_token": tt.token,
700 cr, err := conn1.ContainerRequestCreate(uctx1, arvados.CreateOptions{ClusterID: "z2222", Attrs: rq})
702 c.Check(err, check.IsNil)
703 c.Check(strings.HasPrefix(cr.UUID, tt.expectedUUIDprefix), check.Equals, true)
704 c.Check(cr.RuntimeToken, check.Equals, tt.expectedRuntimeToken)
709 func (s *IntegrationSuite) TestFederatedApiClientAuthHandling(c *check.C) {
710 rootctx1, rootclnt1, _ := s.testClusters["z1111"].RootClients()
711 conn1 := s.testClusters["z1111"].Conn()
713 // Make sure LoginCluster is properly configured
714 for _, cls := range []string{"z1111", "z3333"} {
716 s.testClusters[cls].Config.Clusters[cls].Login.LoginCluster,
717 check.Equals, "z1111",
718 check.Commentf("incorrect LoginCluster config on cluster %q", cls))
720 // Get user's UUID & attempt to create a token for it on the remote cluster
721 _, _, _, user := s.testClusters["z1111"].UserClients(rootctx1, c, conn1,
722 "user@example.com", true)
723 _, rootclnt3, _ := s.testClusters["z3333"].ClientsWithToken(rootclnt1.AuthToken)
724 var resp arvados.APIClientAuthorization
725 err := rootclnt3.RequestAndDecode(
726 &resp, "POST", "arvados/v1/api_client_authorizations", nil,
727 map[string]interface{}{
728 "api_client_authorization": map[string]string{
729 "owner_uuid": user.UUID,
733 c.Assert(err, check.IsNil)
734 c.Assert(resp.APIClientID, check.Not(check.Equals), 0)
735 newTok := resp.TokenV2()
736 c.Assert(newTok, check.Not(check.Equals), "")
738 // Confirm the token is from z1111
739 c.Assert(strings.HasPrefix(newTok, "v2/z1111-gj3su-"), check.Equals, true)
741 // Confirm the token works and is from the correct user
742 _, rootclnt3bis, _ := s.testClusters["z3333"].ClientsWithToken(newTok)
743 var curUser arvados.User
744 err = rootclnt3bis.RequestAndDecode(
745 &curUser, "GET", "arvados/v1/users/current", nil, nil,
747 c.Assert(err, check.IsNil)
748 c.Assert(curUser.UUID, check.Equals, user.UUID)
750 // Request the ApiClientAuthorization list using the new token
751 _, userClient, _ := s.testClusters["z3333"].ClientsWithToken(newTok)
752 var acaLst arvados.APIClientAuthorizationList
753 err = userClient.RequestAndDecode(
754 &acaLst, "GET", "arvados/v1/api_client_authorizations", nil, nil,
756 c.Assert(err, check.IsNil)
759 // Test for bug #18076
760 func (s *IntegrationSuite) TestStaleCachedUserRecord(c *check.C) {
761 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
762 _, rootclnt3, _ := s.testClusters["z3333"].RootClients()
763 conn1 := s.testClusters["z1111"].Conn()
764 conn3 := s.testClusters["z3333"].Conn()
766 // Make sure LoginCluster is properly configured
767 for _, cls := range []string{"z1111", "z3333"} {
769 s.testClusters[cls].Config.Clusters[cls].Login.LoginCluster,
770 check.Equals, "z1111",
771 check.Commentf("incorrect LoginCluster config on cluster %q", cls))
774 for testCaseNr, testCase := range []struct {
778 {"User without local repository", false},
779 {"User with local repository", true},
781 c.Log(c.TestName() + " " + testCase.name)
782 // Create some users, request them on the federated cluster so they're cached.
783 var users []arvados.User
784 for userNr := 0; userNr < 2; userNr++ {
785 _, _, _, user := s.testClusters["z1111"].UserClients(
789 fmt.Sprintf("user%d%d@example.com", testCaseNr, userNr),
791 c.Assert(user.Username, check.Not(check.Equals), "")
792 users = append(users, user)
794 lst, err := conn3.UserList(rootctx1, arvados.ListOptions{Limit: -1})
795 c.Assert(err, check.Equals, nil)
797 for _, fedUser := range lst.Items {
798 if fedUser.UUID == user.UUID {
799 c.Assert(fedUser.Username, check.Equals, user.Username)
804 c.Assert(userFound, check.Equals, true)
806 if testCase.withRepository {
808 err = rootclnt3.RequestAndDecode(
809 &repo, "POST", "arvados/v1/repositories", nil,
810 map[string]interface{}{
811 "repository": map[string]string{
812 "name": fmt.Sprintf("%s/test", user.Username),
813 "owner_uuid": user.UUID,
817 c.Assert(err, check.IsNil)
821 // Swap the usernames
822 _, err := conn1.UserUpdate(rootctx1, arvados.UpdateOptions{
824 Attrs: map[string]interface{}{
828 c.Assert(err, check.Equals, nil)
829 _, err = conn1.UserUpdate(rootctx1, arvados.UpdateOptions{
831 Attrs: map[string]interface{}{
832 "username": users[0].Username,
835 c.Assert(err, check.Equals, nil)
836 _, err = conn1.UserUpdate(rootctx1, arvados.UpdateOptions{
838 Attrs: map[string]interface{}{
839 "username": users[1].Username,
842 c.Assert(err, check.Equals, nil)
844 // Re-request the list on the federated cluster & check for updates
845 lst, err := conn3.UserList(rootctx1, arvados.ListOptions{Limit: -1})
846 c.Assert(err, check.Equals, nil)
847 var user0Found, user1Found bool
848 for _, user := range lst.Items {
849 if user.UUID == users[0].UUID {
851 c.Assert(user.Username, check.Equals, users[1].Username)
852 } else if user.UUID == users[1].UUID {
854 c.Assert(user.Username, check.Equals, users[0].Username)
857 c.Assert(user0Found, check.Equals, true)
858 c.Assert(user1Found, check.Equals, true)
862 // Test for bug #16263
863 func (s *IntegrationSuite) TestListUsers(c *check.C) {
864 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
865 conn1 := s.testClusters["z1111"].Conn()
866 conn3 := s.testClusters["z3333"].Conn()
867 userctx1, _, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, s.oidcprovider.AuthEmail, true)
869 // Make sure LoginCluster is properly configured
870 for cls := range s.testClusters {
872 s.testClusters[cls].Config.Clusters[cls].Login.LoginCluster,
873 check.Equals, "z1111",
874 check.Commentf("incorrect LoginCluster config on cluster %q", cls))
876 // Make sure z1111 has users with NULL usernames
877 lst, err := conn1.UserList(rootctx1, arvados.ListOptions{
878 Limit: math.MaxInt64, // check that large limit works (see #16263)
880 nullUsername := false
881 c.Assert(err, check.IsNil)
882 c.Assert(len(lst.Items), check.Not(check.Equals), 0)
883 for _, user := range lst.Items {
884 if user.Username == "" {
889 c.Assert(nullUsername, check.Equals, true)
891 user1, err := conn1.UserGetCurrent(userctx1, arvados.GetOptions{})
892 c.Assert(err, check.IsNil)
893 c.Check(user1.IsActive, check.Equals, true)
895 // Ask for the user list on z3333 using z1111's system root token
896 lst, err = conn3.UserList(rootctx1, arvados.ListOptions{Limit: -1})
897 c.Assert(err, check.IsNil)
899 for _, user := range lst.Items {
900 if user.UUID == user1.UUID {
901 c.Check(user.IsActive, check.Equals, true)
906 c.Check(found, check.Equals, true)
908 // Deactivate user acct on z1111
909 _, err = conn1.UserUnsetup(rootctx1, arvados.GetOptions{UUID: user1.UUID})
910 c.Assert(err, check.IsNil)
912 // Get user list from z3333, check the returned z1111 user is
914 lst, err = conn3.UserList(rootctx1, arvados.ListOptions{Limit: -1})
915 c.Assert(err, check.IsNil)
917 for _, user := range lst.Items {
918 if user.UUID == user1.UUID {
919 c.Check(user.IsActive, check.Equals, false)
924 c.Check(found, check.Equals, true)
926 // Deactivated user no longer has working token
927 user1, err = conn3.UserGetCurrent(userctx1, arvados.GetOptions{})
928 c.Assert(err, check.ErrorMatches, `.*401 Unauthorized.*`)
931 func (s *IntegrationSuite) TestSetupUserWithVM(c *check.C) {
932 conn1 := s.testClusters["z1111"].Conn()
933 conn3 := s.testClusters["z3333"].Conn()
934 rootctx1, rootac1, _ := s.testClusters["z1111"].RootClients()
936 // Create user on LoginCluster z1111
937 _, _, _, user := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, s.oidcprovider.AuthEmail, true)
939 // Make a new root token (because rootClients() uses SystemRootToken)
940 var outAuth arvados.APIClientAuthorization
941 err := rootac1.RequestAndDecode(&outAuth, "POST", "/arvados/v1/api_client_authorizations", nil, nil)
942 c.Check(err, check.IsNil)
944 // Make a v2 root token to communicate with z3333
945 rootctx3, rootac3, _ := s.testClusters["z3333"].ClientsWithToken(outAuth.TokenV2())
947 // Create VM on z3333
948 var outVM arvados.VirtualMachine
949 err = rootac3.RequestAndDecode(&outVM, "POST", "/arvados/v1/virtual_machines", nil,
950 map[string]interface{}{"virtual_machine": map[string]interface{}{
951 "hostname": "example",
954 c.Check(outVM.UUID[0:5], check.Equals, "z3333")
955 c.Check(err, check.IsNil)
957 // Make sure z3333 user list is up to date
958 _, err = conn3.UserList(rootctx3, arvados.ListOptions{Limit: 1000})
959 c.Check(err, check.IsNil)
961 // Try to set up user on z3333 with the VM
962 _, err = conn3.UserSetup(rootctx3, arvados.UserSetupOptions{UUID: user.UUID, VMUUID: outVM.UUID})
963 c.Check(err, check.IsNil)
965 var outLinks arvados.LinkList
966 err = rootac3.RequestAndDecode(&outLinks, "GET", "/arvados/v1/links", nil,
969 Filters: []arvados.Filter{
983 Operand: "can_login",
988 Operand: "permission",
990 c.Check(err, check.IsNil)
992 c.Check(len(outLinks.Items), check.Equals, 1)
995 func (s *IntegrationSuite) TestOIDCAccessTokenAuth(c *check.C) {
996 conn1 := s.testClusters["z1111"].Conn()
997 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
998 s.testClusters["z1111"].UserClients(rootctx1, c, conn1, s.oidcprovider.AuthEmail, true)
1000 accesstoken := s.oidcprovider.ValidAccessToken()
1002 for _, clusterID := range []string{"z1111", "z2222"} {
1004 var coll arvados.Collection
1006 // Write some file data and create a collection
1008 c.Logf("save collection to %s", clusterID)
1010 conn := s.testClusters[clusterID].Conn()
1011 ctx, ac, kc := s.testClusters[clusterID].ClientsWithToken(accesstoken)
1013 fs, err := coll.FileSystem(ac, kc)
1014 c.Assert(err, check.IsNil)
1015 f, err := fs.OpenFile("test.txt", os.O_CREATE|os.O_RDWR, 0777)
1016 c.Assert(err, check.IsNil)
1017 _, err = io.WriteString(f, "IntegrationSuite.TestOIDCAccessTokenAuth")
1018 c.Assert(err, check.IsNil)
1020 c.Assert(err, check.IsNil)
1021 mtxt, err := fs.MarshalManifest(".")
1022 c.Assert(err, check.IsNil)
1023 coll, err = conn.CollectionCreate(ctx, arvados.CreateOptions{Attrs: map[string]interface{}{
1024 "manifest_text": mtxt,
1026 c.Assert(err, check.IsNil)
1029 // Read the collection & file data -- both from the
1030 // cluster where it was created, and from the other
1032 for _, readClusterID := range []string{"z1111", "z2222", "z3333"} {
1033 c.Logf("retrieve %s from %s", coll.UUID, readClusterID)
1035 conn := s.testClusters[readClusterID].Conn()
1036 ctx, ac, kc := s.testClusters[readClusterID].ClientsWithToken(accesstoken)
1038 user, err := conn.UserGetCurrent(ctx, arvados.GetOptions{})
1039 c.Assert(err, check.IsNil)
1040 c.Check(user.FullName, check.Equals, "Example User")
1041 readcoll, err := conn.CollectionGet(ctx, arvados.GetOptions{UUID: coll.UUID})
1042 c.Assert(err, check.IsNil)
1043 c.Check(readcoll.ManifestText, check.Not(check.Equals), "")
1044 fs, err := readcoll.FileSystem(ac, kc)
1045 c.Assert(err, check.IsNil)
1046 f, err := fs.Open("test.txt")
1047 c.Assert(err, check.IsNil)
1048 buf, err := ioutil.ReadAll(f)
1049 c.Assert(err, check.IsNil)
1050 c.Check(buf, check.DeepEquals, []byte("IntegrationSuite.TestOIDCAccessTokenAuth"))
1055 // z3333 should not forward a locally-issued container runtime token,
1056 // associated with a z1111 user, to its login cluster z1111. z1111
1057 // would only call back to z3333 and then reject the response because
1058 // the user ID does not match the token prefix. See
1059 // dev.arvados.org/issues/18346
1060 func (s *IntegrationSuite) TestForwardRuntimeTokenToLoginCluster(c *check.C) {
1061 db3, db3conn := s.dbConn(c, "z3333")
1063 defer db3conn.Close()
1064 rootctx1, _, _ := s.testClusters["z1111"].RootClients()
1065 rootctx3, _, _ := s.testClusters["z3333"].RootClients()
1066 conn1 := s.testClusters["z1111"].Conn()
1067 conn3 := s.testClusters["z3333"].Conn()
1068 userctx1, _, _, _ := s.testClusters["z1111"].UserClients(rootctx1, c, conn1, "user@example.com", true)
1070 user1, err := conn1.UserGetCurrent(userctx1, arvados.GetOptions{})
1071 c.Assert(err, check.IsNil)
1072 c.Logf("user1 %+v", user1)
1074 imageColl, err := conn3.CollectionCreate(userctx1, arvados.CreateOptions{Attrs: map[string]interface{}{
1075 "manifest_text": ". d41d8cd98f00b204e9800998ecf8427e+0 0:0:sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.tar\n",
1077 c.Assert(err, check.IsNil)
1078 c.Logf("imageColl %+v", imageColl)
1080 cr, err := conn3.ContainerRequestCreate(userctx1, arvados.CreateOptions{Attrs: map[string]interface{}{
1081 "state": "Committed",
1082 "command": []string{"echo"},
1083 "container_image": imageColl.PortableDataHash,
1087 "runtime_constraints": arvados.RuntimeConstraints{
1092 c.Assert(err, check.IsNil)
1093 c.Logf("container request %+v", cr)
1094 ctr, err := conn3.ContainerLock(rootctx3, arvados.GetOptions{UUID: cr.ContainerUUID})
1095 c.Assert(err, check.IsNil)
1096 c.Logf("container %+v", ctr)
1098 // We could use conn3.ContainerAuth() here, but that API
1099 // hasn't been added to sdk/go/arvados/api.go yet.
1100 row := db3conn.QueryRowContext(context.Background(), `SELECT api_token from api_client_authorizations where uuid=$1`, ctr.AuthUUID)
1101 c.Check(row, check.NotNil)
1102 var val sql.NullString
1104 c.Assert(val.Valid, check.Equals, true)
1105 runtimeToken := "v2/" + ctr.AuthUUID + "/" + val.String
1106 ctrctx, _, _ := s.testClusters["z3333"].ClientsWithToken(runtimeToken)
1107 c.Logf("container runtime token %+v", runtimeToken)
1109 _, err = conn3.UserGet(ctrctx, arvados.GetOptions{UUID: user1.UUID})
1110 c.Assert(err, check.NotNil)
1111 c.Check(err, check.ErrorMatches, `request failed: .* 401 Unauthorized: cannot use a locally issued token to forward a request to our login cluster \(z1111\)`)
1112 c.Check(err, check.Not(check.ErrorMatches), `(?ms).*127\.0\.0\.11.*`)