lib/controller/handler_test.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package controller
   6
   7 import (
   8         "context"
   9         "crypto/tls"
  10         "encoding/json"
  11         "io/ioutil"
  12         "net/http"
  13         "net/http/httptest"
  14         "net/url"
  15         "os"
  16         "strings"
  17         "testing"
  18         "time"
  19
  20         "git.arvados.org/arvados.git/sdk/go/arvados"
  21         "git.arvados.org/arvados.git/sdk/go/arvadostest"
  22         "git.arvados.org/arvados.git/sdk/go/auth"
  23         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  24         "git.arvados.org/arvados.git/sdk/go/httpserver"
  25         "github.com/prometheus/client_golang/prometheus"
  26         check "gopkg.in/check.v1"
  27 )
  28
  29 // Gocheck boilerplate
  30 func Test(t *testing.T) {
  31         check.TestingT(t)
  32 }
  33
  34 var _ = check.Suite(&HandlerSuite{})
  35
  36 type HandlerSuite struct {
  37         cluster *arvados.Cluster
  38         handler http.Handler
  39         ctx     context.Context
  40         cancel  context.CancelFunc
  41 }
  42
  43 func (s *HandlerSuite) SetUpTest(c *check.C) {
  44         s.ctx, s.cancel = context.WithCancel(context.Background())
  45         s.ctx = ctxlog.Context(s.ctx, ctxlog.New(os.Stderr, "json", "debug"))
  46         s.cluster = &arvados.Cluster{
  47                 ClusterID:  "zzzzz",
  48                 PostgreSQL: integrationTestCluster().PostgreSQL,
  49         }
  50         s.cluster.API.RequestTimeout = arvados.Duration(5 * time.Minute)
  51         s.cluster.TLS.Insecure = true
  52         arvadostest.SetServiceURL(&s.cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
  53         arvadostest.SetServiceURL(&s.cluster.Services.Controller, "http://localhost:/")
  54         s.handler = newHandler(s.ctx, s.cluster, "", prometheus.NewRegistry())
  55 }
  56
  57 func (s *HandlerSuite) TearDownTest(c *check.C) {
  58         s.cancel()
  59 }
  60
  61 func (s *HandlerSuite) TestConfigExport(c *check.C) {
  62         s.cluster.ManagementToken = "secret"
  63         s.cluster.SystemRootToken = "secret"
  64         s.cluster.Collections.BlobSigning = true
  65         s.cluster.Collections.BlobSigningTTL = arvados.Duration(23 * time.Second)
  66         for _, method := range []string{"GET", "OPTIONS"} {
  67                 req := httptest.NewRequest(method, "/arvados/v1/config", nil)
  68                 resp := httptest.NewRecorder()
  69                 s.handler.ServeHTTP(resp, req)
  70                 c.Log(resp.Body.String())
  71                 if !c.Check(resp.Code, check.Equals, http.StatusOK) {
  72                         continue
  73                 }
  74                 c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, `*`)
  75                 c.Check(resp.Header().Get("Access-Control-Allow-Methods"), check.Matches, `.*\bGET\b.*`)
  76                 c.Check(resp.Header().Get("Access-Control-Allow-Headers"), check.Matches, `.+`)
  77                 if method == "OPTIONS" {
  78                         c.Check(resp.Body.String(), check.HasLen, 0)
  79                         continue
  80                 }
  81                 var cluster arvados.Cluster
  82                 err := json.Unmarshal(resp.Body.Bytes(), &cluster)
  83                 c.Check(err, check.IsNil)
  84                 c.Check(cluster.ManagementToken, check.Equals, "")
  85                 c.Check(cluster.SystemRootToken, check.Equals, "")
  86                 c.Check(cluster.Collections.BlobSigning, check.Equals, true)
  87                 c.Check(cluster.Collections.BlobSigningTTL, check.Equals, arvados.Duration(23*time.Second))
  88         }
  89 }
  90
  91 func (s *HandlerSuite) TestVocabularyExport(c *check.C) {
  92         voc := `{
  93                 "strict_tags": false,
  94                 "tags": {
  95                         "IDTAGIMPORTANCE": {
  96                                 "strict": false,
  97                                 "labels": [{"label": "Importance"}],
  98                                 "values": {
  99                                         "HIGH": {
 100                                                 "labels": [{"label": "High"}]
 101                                         },
 102                                         "LOW": {
 103                                                 "labels": [{"label": "Low"}]
 104                                         }
 105                                 }
 106                         }
 107                 }
 108         }`
 109         f, err := os.CreateTemp("", "test-vocabulary-*.json")
 110         c.Assert(err, check.IsNil)
 111         defer os.Remove(f.Name())
 112         _, err = f.WriteString(voc)
 113         c.Assert(err, check.IsNil)
 114         f.Close()
 115         s.cluster.API.VocabularyPath = f.Name()
 116         for _, method := range []string{"GET", "OPTIONS"} {
 117                 c.Log(c.TestName()+" ", method)
 118                 req := httptest.NewRequest(method, "/arvados/v1/vocabulary", nil)
 119                 resp := httptest.NewRecorder()
 120                 s.handler.ServeHTTP(resp, req)
 121                 c.Log(resp.Body.String())
 122                 if !c.Check(resp.Code, check.Equals, http.StatusOK) {
 123                         continue
 124                 }
 125                 c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, `*`)
 126                 c.Check(resp.Header().Get("Access-Control-Allow-Methods"), check.Matches, `.*\bGET\b.*`)
 127                 c.Check(resp.Header().Get("Access-Control-Allow-Headers"), check.Matches, `.+`)
 128                 if method == "OPTIONS" {
 129                         c.Check(resp.Body.String(), check.HasLen, 0)
 130                         continue
 131                 }
 132                 var expectedVoc, receivedVoc *arvados.Vocabulary
 133                 err := json.Unmarshal([]byte(voc), &expectedVoc)
 134                 c.Check(err, check.IsNil)
 135                 err = json.Unmarshal(resp.Body.Bytes(), &receivedVoc)
 136                 c.Check(err, check.IsNil)
 137                 c.Check(receivedVoc, check.DeepEquals, expectedVoc)
 138         }
 139 }
 140
 141 func (s *HandlerSuite) TestProxyDiscoveryDoc(c *check.C) {
 142         req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
 143         resp := httptest.NewRecorder()
 144         s.handler.ServeHTTP(resp, req)
 145         c.Check(resp.Code, check.Equals, http.StatusOK)
 146         var dd arvados.DiscoveryDocument
 147         err := json.Unmarshal(resp.Body.Bytes(), &dd)
 148         c.Check(err, check.IsNil)
 149         c.Check(dd.BlobSignatureTTL, check.Not(check.Equals), int64(0))
 150         c.Check(dd.BlobSignatureTTL > 0, check.Equals, true)
 151         c.Check(len(dd.Resources), check.Not(check.Equals), 0)
 152         c.Check(len(dd.Schemas), check.Not(check.Equals), 0)
 153 }
 154
 155 func (s *HandlerSuite) TestRequestTimeout(c *check.C) {
 156         s.cluster.API.RequestTimeout = arvados.Duration(time.Nanosecond)
 157         req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
 158         resp := httptest.NewRecorder()
 159         s.handler.ServeHTTP(resp, req)
 160         c.Check(resp.Code, check.Equals, http.StatusBadGateway)
 161         var jresp httpserver.ErrorResponse
 162         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 163         c.Check(err, check.IsNil)
 164         c.Assert(len(jresp.Errors), check.Equals, 1)
 165         c.Check(jresp.Errors[0], check.Matches, `.*context deadline exceeded.*`)
 166 }
 167
 168 func (s *HandlerSuite) TestProxyWithoutToken(c *check.C) {
 169         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 170         resp := httptest.NewRecorder()
 171         s.handler.ServeHTTP(resp, req)
 172         c.Check(resp.Code, check.Equals, http.StatusUnauthorized)
 173         jresp := map[string]interface{}{}
 174         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 175         c.Check(err, check.IsNil)
 176         c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
 177 }
 178
 179 func (s *HandlerSuite) TestProxyWithToken(c *check.C) {
 180         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 181         req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
 182         resp := httptest.NewRecorder()
 183         s.handler.ServeHTTP(resp, req)
 184         c.Check(resp.Code, check.Equals, http.StatusOK)
 185         var u arvados.User
 186         err := json.Unmarshal(resp.Body.Bytes(), &u)
 187         c.Check(err, check.IsNil)
 188         c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
 189 }
 190
 191 func (s *HandlerSuite) TestProxyWithTokenInRequestBody(c *check.C) {
 192         req := httptest.NewRequest("POST", "/arvados/v1/users/current", strings.NewReader(url.Values{
 193                 "_method":   {"GET"},
 194                 "api_token": {arvadostest.ActiveToken},
 195         }.Encode()))
 196         req.Header.Set("Content-type", "application/x-www-form-urlencoded")
 197         resp := httptest.NewRecorder()
 198         s.handler.ServeHTTP(resp, req)
 199         c.Check(resp.Code, check.Equals, http.StatusOK)
 200         var u arvados.User
 201         err := json.Unmarshal(resp.Body.Bytes(), &u)
 202         c.Check(err, check.IsNil)
 203         c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
 204 }
 205
 206 func (s *HandlerSuite) TestProxyNotFound(c *check.C) {
 207         req := httptest.NewRequest("GET", "/arvados/v1/xyzzy", nil)
 208         resp := httptest.NewRecorder()
 209         s.handler.ServeHTTP(resp, req)
 210         c.Check(resp.Code, check.Equals, http.StatusNotFound)
 211         jresp := map[string]interface{}{}
 212         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 213         c.Check(err, check.IsNil)
 214         c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
 215 }
 216
 217 func (s *HandlerSuite) TestLogoutGoogle(c *check.C) {
 218         s.cluster.Login.Google.Enable = true
 219         s.cluster.Login.Google.ClientID = "test"
 220         req := httptest.NewRequest("GET", "https://0.0.0.0:1/logout?return_to=https://example.com/foo", nil)
 221         resp := httptest.NewRecorder()
 222         s.handler.ServeHTTP(resp, req)
 223         if !c.Check(resp.Code, check.Equals, http.StatusFound) {
 224                 c.Log(resp.Body.String())
 225         }
 226         c.Check(resp.Header().Get("Location"), check.Equals, "https://example.com/foo")
 227 }
 228
 229 func (s *HandlerSuite) TestValidateV1APIToken(c *check.C) {
 230         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 231         user, ok, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveToken)
 232         c.Assert(err, check.IsNil)
 233         c.Check(ok, check.Equals, true)
 234         c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
 235         c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
 236         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 237         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 238 }
 239
 240 func (s *HandlerSuite) TestValidateV2APIToken(c *check.C) {
 241         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 242         user, ok, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveTokenV2)
 243         c.Assert(err, check.IsNil)
 244         c.Check(ok, check.Equals, true)
 245         c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
 246         c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
 247         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 248         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 249         c.Check(user.Authorization.TokenV2(), check.Equals, arvadostest.ActiveTokenV2)
 250 }
 251
 252 func (s *HandlerSuite) TestValidateRemoteToken(c *check.C) {
 253         saltedToken, err := auth.SaltToken(arvadostest.ActiveTokenV2, "abcde")
 254         c.Assert(err, check.IsNil)
 255         for _, trial := range []struct {
 256                 code  int
 257                 token string
 258         }{
 259                 {http.StatusOK, saltedToken},
 260                 {http.StatusUnauthorized, "bogus"},
 261         } {
 262                 req := httptest.NewRequest("GET", "https://0.0.0.0:1/arvados/v1/users/current?remote=abcde", nil)
 263                 req.Header.Set("Authorization", "Bearer "+trial.token)
 264                 resp := httptest.NewRecorder()
 265                 s.handler.ServeHTTP(resp, req)
 266                 if !c.Check(resp.Code, check.Equals, trial.code) {
 267                         c.Logf("HTTP %d: %s", resp.Code, resp.Body.String())
 268                 }
 269         }
 270 }
 271
 272 func (s *HandlerSuite) TestCreateAPIToken(c *check.C) {
 273         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 274         auth, err := s.handler.(*Handler).createAPItoken(req, arvadostest.ActiveUserUUID, nil)
 275         c.Assert(err, check.IsNil)
 276         c.Check(auth.Scopes, check.DeepEquals, []string{"all"})
 277
 278         user, ok, err := s.handler.(*Handler).validateAPItoken(req, auth.TokenV2())
 279         c.Assert(err, check.IsNil)
 280         c.Check(ok, check.Equals, true)
 281         c.Check(user.Authorization.UUID, check.Equals, auth.UUID)
 282         c.Check(user.Authorization.APIToken, check.Equals, auth.APIToken)
 283         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 284         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 285         c.Check(user.Authorization.TokenV2(), check.Equals, auth.TokenV2())
 286 }
 287
 288 func (s *HandlerSuite) CheckObjectType(c *check.C, url string, token string, skippedFields map[string]bool) {
 289         var proxied, direct map[string]interface{}
 290         var err error
 291
 292         // Get collection from controller
 293         req := httptest.NewRequest("GET", url, nil)
 294         req.Header.Set("Authorization", "Bearer "+token)
 295         resp := httptest.NewRecorder()
 296         s.handler.ServeHTTP(resp, req)
 297         c.Assert(resp.Code, check.Equals, http.StatusOK,
 298                 check.Commentf("Wasn't able to get data from the controller at %q", url))
 299         err = json.Unmarshal(resp.Body.Bytes(), &proxied)
 300         c.Check(err, check.Equals, nil)
 301
 302         // Get collection directly from RailsAPI
 303         client := &http.Client{
 304                 Transport: &http.Transport{
 305                         TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
 306                 },
 307         }
 308         resp2, err := client.Get(s.cluster.Services.RailsAPI.ExternalURL.String() + url + "/?api_token=" + token)
 309         c.Check(err, check.Equals, nil)
 310         c.Assert(resp2.StatusCode, check.Equals, http.StatusOK,
 311                 check.Commentf("Wasn't able to get data from the RailsAPI at %q", url))
 312         defer resp2.Body.Close()
 313         db, err := ioutil.ReadAll(resp2.Body)
 314         c.Check(err, check.Equals, nil)
 315         err = json.Unmarshal(db, &direct)
 316         c.Check(err, check.Equals, nil)
 317
 318         // Check that all RailsAPI provided keys exist on the controller response.
 319         for k := range direct {
 320                 if _, ok := skippedFields[k]; ok {
 321                         continue
 322                 } else if val, ok := proxied[k]; ok {
 323                         if direct["kind"] == "arvados#collection" && k == "manifest_text" {
 324                                 // Tokens differ from request to request
 325                                 c.Check(strings.Split(val.(string), "+A")[0], check.Equals, strings.Split(direct[k].(string), "+A")[0])
 326                         } else {
 327                                 c.Check(val, check.DeepEquals, direct[k],
 328                                         check.Commentf("RailsAPI %s key %q's value %q differs from controller's %q.", direct["kind"], k, direct[k], val))
 329                         }
 330                 } else {
 331                         c.Errorf("%s's key %q missing on controller's response.", direct["kind"], k)
 332                 }
 333         }
 334 }
 335
 336 func (s *HandlerSuite) TestGetObjects(c *check.C) {
 337         // Get the 1st keep service's uuid from the running test server.
 338         req := httptest.NewRequest("GET", "/arvados/v1/keep_services/", nil)
 339         req.Header.Set("Authorization", "Bearer "+arvadostest.AdminToken)
 340         resp := httptest.NewRecorder()
 341         s.handler.ServeHTTP(resp, req)
 342         c.Assert(resp.Code, check.Equals, http.StatusOK)
 343         var ksList arvados.KeepServiceList
 344         json.Unmarshal(resp.Body.Bytes(), &ksList)
 345         c.Assert(len(ksList.Items), check.Not(check.Equals), 0)
 346         ksUUID := ksList.Items[0].UUID
 347
 348         testCases := map[string]map[string]bool{
 349                 "api_clients/" + arvadostest.TrustedWorkbenchAPIClientUUID:     nil,
 350                 "api_client_authorizations/" + arvadostest.AdminTokenUUID:      nil,
 351                 "authorized_keys/" + arvadostest.AdminAuthorizedKeysUUID:       nil,
 352                 "collections/" + arvadostest.CollectionWithUniqueWordsUUID:     {"href": true},
 353                 "containers/" + arvadostest.RunningContainerUUID:               nil,
 354                 "container_requests/" + arvadostest.QueuedContainerRequestUUID: nil,
 355                 "groups/" + arvadostest.AProjectUUID:                           nil,
 356                 "keep_services/" + ksUUID:                                      nil,
 357                 "links/" + arvadostest.ActiveUserCanReadAllUsersLinkUUID:       nil,
 358                 "logs/" + arvadostest.CrunchstatForRunningJobLogUUID:           nil,
 359                 "nodes/" + arvadostest.IdleNodeUUID:                            nil,
 360                 "repositories/" + arvadostest.ArvadosRepoUUID:                  nil,
 361                 "users/" + arvadostest.ActiveUserUUID:                          {"href": true},
 362                 "virtual_machines/" + arvadostest.TestVMUUID:                   nil,
 363                 "workflows/" + arvadostest.WorkflowWithDefinitionYAMLUUID:      nil,
 364         }
 365         for url, skippedFields := range testCases {
 366                 s.CheckObjectType(c, "/arvados/v1/"+url, arvadostest.AdminToken, skippedFields)
 367         }
 368 }
 369
 370 func (s *HandlerSuite) TestRedactRailsAPIHostFromErrors(c *check.C) {
 371         req := httptest.NewRequest("GET", "https://0.0.0.0:1/arvados/v1/collections/zzzzz-4zz18-abcdefghijklmno", nil)
 372         req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
 373         resp := httptest.NewRecorder()
 374         s.handler.ServeHTTP(resp, req)
 375         c.Check(resp.Code, check.Equals, http.StatusNotFound)
 376         var jresp struct {
 377                 Errors []string
 378         }
 379         c.Log(resp.Body.String())
 380         c.Assert(json.NewDecoder(resp.Body).Decode(&jresp), check.IsNil)
 381         c.Assert(jresp.Errors, check.HasLen, 1)
 382         c.Check(jresp.Errors[0], check.Matches, `.*//railsapi\.internal/arvados/v1/collections/.*: 404 Not Found.*`)
 383         c.Check(jresp.Errors[0], check.Not(check.Matches), `(?ms).*127.0.0.1.*`)
 384 }