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/ctxlog"
  23         "git.arvados.org/arvados.git/sdk/go/httpserver"
  24         "github.com/prometheus/client_golang/prometheus"
  25         check "gopkg.in/check.v1"
  26 )
  27
  28 var forceLegacyAPI14 bool
  29
  30 // Gocheck boilerplate
  31 func Test(t *testing.T) {
  32         for _, forceLegacyAPI14 = range []bool{false, true} {
  33                 check.TestingT(t)
  34         }
  35 }
  36
  37 var _ = check.Suite(&HandlerSuite{})
  38
  39 type HandlerSuite struct {
  40         cluster *arvados.Cluster
  41         handler http.Handler
  42         ctx     context.Context
  43         cancel  context.CancelFunc
  44 }
  45
  46 func (s *HandlerSuite) SetUpTest(c *check.C) {
  47         s.ctx, s.cancel = context.WithCancel(context.Background())
  48         s.ctx = ctxlog.Context(s.ctx, ctxlog.New(os.Stderr, "json", "debug"))
  49         s.cluster = &arvados.Cluster{
  50                 ClusterID:        "zzzzz",
  51                 PostgreSQL:       integrationTestCluster().PostgreSQL,
  52                 ForceLegacyAPI14: forceLegacyAPI14,
  53         }
  54         s.cluster.TLS.Insecure = true
  55         arvadostest.SetServiceURL(&s.cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
  56         arvadostest.SetServiceURL(&s.cluster.Services.Controller, "http://localhost:/")
  57         s.handler = newHandler(s.ctx, s.cluster, "", prometheus.NewRegistry())
  58 }
  59
  60 func (s *HandlerSuite) TearDownTest(c *check.C) {
  61         s.cancel()
  62 }
  63
  64 func (s *HandlerSuite) TestConfigExport(c *check.C) {
  65         s.cluster.ManagementToken = "secret"
  66         s.cluster.SystemRootToken = "secret"
  67         s.cluster.Collections.BlobSigning = true
  68         s.cluster.Collections.BlobSigningTTL = arvados.Duration(23 * time.Second)
  69         for _, method := range []string{"GET", "OPTIONS"} {
  70                 req := httptest.NewRequest(method, "/arvados/v1/config", nil)
  71                 resp := httptest.NewRecorder()
  72                 s.handler.ServeHTTP(resp, req)
  73                 c.Check(resp.Code, check.Equals, http.StatusOK)
  74                 c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, `*`)
  75                 c.Check(resp.Header().Get("Access-Control-Allow-Methods"), check.Matches, `.*\bGET\b.*`)
  76                 c.Check(resp.Header().Get("Access-Control-Allow-Headers"), check.Matches, `.+`)
  77                 if method == "OPTIONS" {
  78                         c.Check(resp.Body.String(), check.HasLen, 0)
  79                         continue
  80                 }
  81                 var cluster arvados.Cluster
  82                 c.Log(resp.Body.String())
  83                 err := json.Unmarshal(resp.Body.Bytes(), &cluster)
  84                 c.Check(err, check.IsNil)
  85                 c.Check(cluster.ManagementToken, check.Equals, "")
  86                 c.Check(cluster.SystemRootToken, check.Equals, "")
  87                 c.Check(cluster.Collections.BlobSigning, check.DeepEquals, true)
  88                 c.Check(cluster.Collections.BlobSigningTTL, check.Equals, arvados.Duration(23*time.Second))
  89         }
  90 }
  91
  92 func (s *HandlerSuite) TestProxyDiscoveryDoc(c *check.C) {
  93         req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
  94         resp := httptest.NewRecorder()
  95         s.handler.ServeHTTP(resp, req)
  96         c.Check(resp.Code, check.Equals, http.StatusOK)
  97         var dd arvados.DiscoveryDocument
  98         err := json.Unmarshal(resp.Body.Bytes(), &dd)
  99         c.Check(err, check.IsNil)
 100         c.Check(dd.BlobSignatureTTL, check.Not(check.Equals), int64(0))
 101         c.Check(dd.BlobSignatureTTL > 0, check.Equals, true)
 102         c.Check(len(dd.Resources), check.Not(check.Equals), 0)
 103         c.Check(len(dd.Schemas), check.Not(check.Equals), 0)
 104 }
 105
 106 func (s *HandlerSuite) TestRequestTimeout(c *check.C) {
 107         s.cluster.API.RequestTimeout = arvados.Duration(time.Nanosecond)
 108         req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
 109         resp := httptest.NewRecorder()
 110         s.handler.ServeHTTP(resp, req)
 111         c.Check(resp.Code, check.Equals, http.StatusBadGateway)
 112         var jresp httpserver.ErrorResponse
 113         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 114         c.Check(err, check.IsNil)
 115         c.Assert(len(jresp.Errors), check.Equals, 1)
 116         c.Check(jresp.Errors[0], check.Matches, `.*context deadline exceeded.*`)
 117 }
 118
 119 func (s *HandlerSuite) TestProxyWithoutToken(c *check.C) {
 120         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 121         resp := httptest.NewRecorder()
 122         s.handler.ServeHTTP(resp, req)
 123         c.Check(resp.Code, check.Equals, http.StatusUnauthorized)
 124         jresp := map[string]interface{}{}
 125         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 126         c.Check(err, check.IsNil)
 127         c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
 128 }
 129
 130 func (s *HandlerSuite) TestProxyWithToken(c *check.C) {
 131         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 132         req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
 133         resp := httptest.NewRecorder()
 134         s.handler.ServeHTTP(resp, req)
 135         c.Check(resp.Code, check.Equals, http.StatusOK)
 136         var u arvados.User
 137         err := json.Unmarshal(resp.Body.Bytes(), &u)
 138         c.Check(err, check.IsNil)
 139         c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
 140 }
 141
 142 func (s *HandlerSuite) TestProxyWithTokenInRequestBody(c *check.C) {
 143         req := httptest.NewRequest("POST", "/arvados/v1/users/current", strings.NewReader(url.Values{
 144                 "_method":   {"GET"},
 145                 "api_token": {arvadostest.ActiveToken},
 146         }.Encode()))
 147         req.Header.Set("Content-type", "application/x-www-form-urlencoded")
 148         resp := httptest.NewRecorder()
 149         s.handler.ServeHTTP(resp, req)
 150         c.Check(resp.Code, check.Equals, http.StatusOK)
 151         var u arvados.User
 152         err := json.Unmarshal(resp.Body.Bytes(), &u)
 153         c.Check(err, check.IsNil)
 154         c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
 155 }
 156
 157 func (s *HandlerSuite) TestProxyNotFound(c *check.C) {
 158         req := httptest.NewRequest("GET", "/arvados/v1/xyzzy", nil)
 159         resp := httptest.NewRecorder()
 160         s.handler.ServeHTTP(resp, req)
 161         c.Check(resp.Code, check.Equals, http.StatusNotFound)
 162         jresp := map[string]interface{}{}
 163         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 164         c.Check(err, check.IsNil)
 165         c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
 166 }
 167
 168 func (s *HandlerSuite) TestProxyRedirect(c *check.C) {
 169         s.cluster.Login.ProviderAppID = "test"
 170         s.cluster.Login.ProviderAppSecret = "test"
 171         req := httptest.NewRequest("GET", "https://0.0.0.0:1/login?return_to=foo", nil)
 172         resp := httptest.NewRecorder()
 173         s.handler.ServeHTTP(resp, req)
 174         if !c.Check(resp.Code, check.Equals, http.StatusFound) {
 175                 c.Log(resp.Body.String())
 176         }
 177         // Old "proxy entire request" code path returns an absolute
 178         // URL. New lib/controller/federation code path returns a
 179         // relative URL.
 180         c.Check(resp.Header().Get("Location"), check.Matches, `(https://0.0.0.0:1)?/auth/joshid\?return_to=%2Cfoo&?`)
 181 }
 182
 183 func (s *HandlerSuite) TestLogoutSSO(c *check.C) {
 184         s.cluster.Login.ProviderAppID = "test"
 185         req := httptest.NewRequest("GET", "https://0.0.0.0:1/logout?return_to=https://example.com/foo", nil)
 186         resp := httptest.NewRecorder()
 187         s.handler.ServeHTTP(resp, req)
 188         if !c.Check(resp.Code, check.Equals, http.StatusFound) {
 189                 c.Log(resp.Body.String())
 190         }
 191         c.Check(resp.Header().Get("Location"), check.Equals, "http://localhost:3002/users/sign_out?"+url.Values{"redirect_uri": {"https://example.com/foo"}}.Encode())
 192 }
 193
 194 func (s *HandlerSuite) TestLogoutGoogle(c *check.C) {
 195         if s.cluster.ForceLegacyAPI14 {
 196                 // Google login N/A
 197                 return
 198         }
 199         s.cluster.Login.GoogleClientID = "test"
 200         req := httptest.NewRequest("GET", "https://0.0.0.0:1/logout?return_to=https://example.com/foo", nil)
 201         resp := httptest.NewRecorder()
 202         s.handler.ServeHTTP(resp, req)
 203         if !c.Check(resp.Code, check.Equals, http.StatusFound) {
 204                 c.Log(resp.Body.String())
 205         }
 206         c.Check(resp.Header().Get("Location"), check.Equals, "https://example.com/foo")
 207 }
 208
 209 func (s *HandlerSuite) TestValidateV1APIToken(c *check.C) {
 210         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 211         user, ok, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveToken)
 212         c.Assert(err, check.IsNil)
 213         c.Check(ok, check.Equals, true)
 214         c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
 215         c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
 216         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 217         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 218 }
 219
 220 func (s *HandlerSuite) TestValidateV2APIToken(c *check.C) {
 221         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 222         user, ok, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveTokenV2)
 223         c.Assert(err, check.IsNil)
 224         c.Check(ok, check.Equals, true)
 225         c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
 226         c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
 227         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 228         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 229         c.Check(user.Authorization.TokenV2(), check.Equals, arvadostest.ActiveTokenV2)
 230 }
 231
 232 func (s *HandlerSuite) TestCreateAPIToken(c *check.C) {
 233         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 234         auth, err := s.handler.(*Handler).createAPItoken(req, arvadostest.ActiveUserUUID, nil)
 235         c.Assert(err, check.IsNil)
 236         c.Check(auth.Scopes, check.DeepEquals, []string{"all"})
 237
 238         user, ok, err := s.handler.(*Handler).validateAPItoken(req, auth.TokenV2())
 239         c.Assert(err, check.IsNil)
 240         c.Check(ok, check.Equals, true)
 241         c.Check(user.Authorization.UUID, check.Equals, auth.UUID)
 242         c.Check(user.Authorization.APIToken, check.Equals, auth.APIToken)
 243         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 244         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 245         c.Check(user.Authorization.TokenV2(), check.Equals, auth.TokenV2())
 246 }
 247
 248 func (s *HandlerSuite) CheckObjectType(c *check.C, url string, token string, skippedFields map[string]bool) {
 249         var proxied, direct map[string]interface{}
 250         var err error
 251
 252         // Get collection from controller
 253         req := httptest.NewRequest("GET", url, nil)
 254         req.Header.Set("Authorization", "Bearer "+token)
 255         resp := httptest.NewRecorder()
 256         s.handler.ServeHTTP(resp, req)
 257         c.Assert(resp.Code, check.Equals, http.StatusOK,
 258                 check.Commentf("Wasn't able to get data from the controller at %q", url))
 259         err = json.Unmarshal(resp.Body.Bytes(), &proxied)
 260         c.Check(err, check.Equals, nil)
 261
 262         // Get collection directly from RailsAPI
 263         client := &http.Client{
 264                 Transport: &http.Transport{
 265                         TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
 266                 },
 267         }
 268         resp2, err := client.Get(s.cluster.Services.RailsAPI.ExternalURL.String() + url + "/?api_token=" + token)
 269         c.Check(err, check.Equals, nil)
 270         defer resp2.Body.Close()
 271         db, err := ioutil.ReadAll(resp2.Body)
 272         c.Check(err, check.Equals, nil)
 273         err = json.Unmarshal(db, &direct)
 274         c.Check(err, check.Equals, nil)
 275
 276         // Check that all RailsAPI provided keys exist on the controller response.
 277         for k := range direct {
 278                 if _, ok := skippedFields[k]; ok {
 279                         continue
 280                 } else if val, ok := proxied[k]; ok {
 281                         if direct["kind"] == "arvados#collection" && k == "manifest_text" {
 282                                 // Tokens differ from request to request
 283                                 c.Check(strings.Split(val.(string), "+A")[0], check.Equals, strings.Split(direct[k].(string), "+A")[0])
 284                         } else {
 285                                 c.Check(val, check.DeepEquals, direct[k],
 286                                         check.Commentf("RailsAPI %s key %q's value %q differs from controller's %q.", direct["kind"], k, direct[k], val))
 287                         }
 288                 } else {
 289                         c.Errorf("%s's key %q missing on controller's response.", direct["kind"], k)
 290                 }
 291         }
 292 }
 293
 294 func (s *HandlerSuite) TestGetObjects(c *check.C) {
 295         // Get the 1st keep service's uuid from the running test server.
 296         req := httptest.NewRequest("GET", "/arvados/v1/keep_services/", nil)
 297         req.Header.Set("Authorization", "Bearer "+arvadostest.AdminToken)
 298         resp := httptest.NewRecorder()
 299         s.handler.ServeHTTP(resp, req)
 300         c.Assert(resp.Code, check.Equals, http.StatusOK)
 301         var ksList arvados.KeepServiceList
 302         json.Unmarshal(resp.Body.Bytes(), &ksList)
 303         c.Assert(len(ksList.Items), check.Not(check.Equals), 0)
 304         ksUUID := ksList.Items[0].UUID
 305
 306         testCases := map[string]map[string]bool{
 307                 "api_clients/" + arvadostest.TrustedWorkbenchAPIClientUUID:     nil,
 308                 "api_client_authorizations/" + arvadostest.AdminTokenUUID:      nil,
 309                 "authorized_keys/" + arvadostest.AdminAuthorizedKeysUUID:       nil,
 310                 "collections/" + arvadostest.CollectionWithUniqueWordsUUID:     map[string]bool{"href": true},
 311                 "containers/" + arvadostest.RunningContainerUUID:               nil,
 312                 "container_requests/" + arvadostest.QueuedContainerRequestUUID: nil,
 313                 "groups/" + arvadostest.AProjectUUID:                           nil,
 314                 "keep_services/" + ksUUID:                                      nil,
 315                 "links/" + arvadostest.ActiveUserCanReadAllUsersLinkUUID:       nil,
 316                 "logs/" + arvadostest.CrunchstatForRunningJobLogUUID:           nil,
 317                 "nodes/" + arvadostest.IdleNodeUUID:                            nil,
 318                 "repositories/" + arvadostest.ArvadosRepoUUID:                  nil,
 319                 "users/" + arvadostest.ActiveUserUUID:                          map[string]bool{"href": true},
 320                 "virtual_machines/" + arvadostest.TestVMUUID:                   nil,
 321                 "workflows/" + arvadostest.WorkflowWithDefinitionYAMLUUID:      nil,
 322         }
 323         for url, skippedFields := range testCases {
 324                 s.CheckObjectType(c, "/arvados/v1/"+url, arvadostest.AdminToken, skippedFields)
 325         }
 326 }