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         "encoding/json"
  10         "net/http"
  11         "net/http/httptest"
  12         "net/url"
  13         "os"
  14         "strings"
  15         "testing"
  16         "time"
  17
  18         "git.curoverse.com/arvados.git/sdk/go/arvados"
  19         "git.curoverse.com/arvados.git/sdk/go/arvadostest"
  20         "git.curoverse.com/arvados.git/sdk/go/ctxlog"
  21         "git.curoverse.com/arvados.git/sdk/go/httpserver"
  22         "github.com/prometheus/client_golang/prometheus"
  23         check "gopkg.in/check.v1"
  24 )
  25
  26 var enableBetaController14287 bool
  27
  28 // Gocheck boilerplate
  29 func Test(t *testing.T) {
  30         for _, enableBetaController14287 = range []bool{false, true} {
  31                 check.TestingT(t)
  32         }
  33 }
  34
  35 var _ = check.Suite(&HandlerSuite{})
  36
  37 type HandlerSuite struct {
  38         cluster *arvados.Cluster
  39         handler http.Handler
  40         ctx     context.Context
  41         cancel  context.CancelFunc
  42 }
  43
  44 func (s *HandlerSuite) SetUpTest(c *check.C) {
  45         s.ctx, s.cancel = context.WithCancel(context.Background())
  46         s.ctx = ctxlog.Context(s.ctx, ctxlog.New(os.Stderr, "json", "debug"))
  47         s.cluster = &arvados.Cluster{
  48                 ClusterID:  "zzzzz",
  49                 PostgreSQL: integrationTestCluster().PostgreSQL,
  50
  51                 EnableBetaController14287: enableBetaController14287,
  52         }
  53         s.cluster.TLS.Insecure = true
  54         arvadostest.SetServiceURL(&s.cluster.Services.RailsAPI, "https://"+os.Getenv("ARVADOS_TEST_API_HOST"))
  55         arvadostest.SetServiceURL(&s.cluster.Services.Controller, "http://localhost:/")
  56         s.handler = newHandler(s.ctx, s.cluster, "", prometheus.NewRegistry())
  57 }
  58
  59 func (s *HandlerSuite) TearDownTest(c *check.C) {
  60         s.cancel()
  61 }
  62
  63 func (s *HandlerSuite) TestConfigExport(c *check.C) {
  64         s.cluster.ManagementToken = "secret"
  65         s.cluster.SystemRootToken = "secret"
  66         s.cluster.Collections.BlobSigning = true
  67         s.cluster.Collections.BlobSigningTTL = arvados.Duration(23 * time.Second)
  68         req := httptest.NewRequest("GET", "/arvados/v1/config", nil)
  69         resp := httptest.NewRecorder()
  70         s.handler.ServeHTTP(resp, req)
  71         c.Check(resp.Code, check.Equals, http.StatusOK)
  72         c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, `*`)
  73         c.Check(resp.Header().Get("Access-Control-Allow-Methods"), check.Matches, `.*\bGET\b.*`)
  74         c.Check(resp.Header().Get("Access-Control-Allow-Headers"), check.Matches, `.+`)
  75         var cluster arvados.Cluster
  76         c.Log(resp.Body.String())
  77         err := json.Unmarshal(resp.Body.Bytes(), &cluster)
  78         c.Check(err, check.IsNil)
  79         c.Check(cluster.ManagementToken, check.Equals, "")
  80         c.Check(cluster.SystemRootToken, check.Equals, "")
  81         c.Check(cluster.Collections.BlobSigning, check.DeepEquals, true)
  82         c.Check(cluster.Collections.BlobSigningTTL, check.Equals, arvados.Duration(23*time.Second))
  83 }
  84
  85 func (s *HandlerSuite) TestProxyDiscoveryDoc(c *check.C) {
  86         req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
  87         resp := httptest.NewRecorder()
  88         s.handler.ServeHTTP(resp, req)
  89         c.Check(resp.Code, check.Equals, http.StatusOK)
  90         var dd arvados.DiscoveryDocument
  91         err := json.Unmarshal(resp.Body.Bytes(), &dd)
  92         c.Check(err, check.IsNil)
  93         c.Check(dd.BlobSignatureTTL, check.Not(check.Equals), int64(0))
  94         c.Check(dd.BlobSignatureTTL > 0, check.Equals, true)
  95         c.Check(len(dd.Resources), check.Not(check.Equals), 0)
  96         c.Check(len(dd.Schemas), check.Not(check.Equals), 0)
  97 }
  98
  99 func (s *HandlerSuite) TestRequestTimeout(c *check.C) {
 100         s.cluster.API.RequestTimeout = arvados.Duration(time.Nanosecond)
 101         req := httptest.NewRequest("GET", "/discovery/v1/apis/arvados/v1/rest", nil)
 102         resp := httptest.NewRecorder()
 103         s.handler.ServeHTTP(resp, req)
 104         c.Check(resp.Code, check.Equals, http.StatusBadGateway)
 105         var jresp httpserver.ErrorResponse
 106         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 107         c.Check(err, check.IsNil)
 108         c.Assert(len(jresp.Errors), check.Equals, 1)
 109         c.Check(jresp.Errors[0], check.Matches, `.*context deadline exceeded.*`)
 110 }
 111
 112 func (s *HandlerSuite) TestProxyWithoutToken(c *check.C) {
 113         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 114         resp := httptest.NewRecorder()
 115         s.handler.ServeHTTP(resp, req)
 116         c.Check(resp.Code, check.Equals, http.StatusUnauthorized)
 117         jresp := map[string]interface{}{}
 118         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 119         c.Check(err, check.IsNil)
 120         c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
 121 }
 122
 123 func (s *HandlerSuite) TestProxyWithToken(c *check.C) {
 124         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 125         req.Header.Set("Authorization", "Bearer "+arvadostest.ActiveToken)
 126         resp := httptest.NewRecorder()
 127         s.handler.ServeHTTP(resp, req)
 128         c.Check(resp.Code, check.Equals, http.StatusOK)
 129         var u arvados.User
 130         err := json.Unmarshal(resp.Body.Bytes(), &u)
 131         c.Check(err, check.IsNil)
 132         c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
 133 }
 134
 135 func (s *HandlerSuite) TestProxyWithTokenInRequestBody(c *check.C) {
 136         req := httptest.NewRequest("POST", "/arvados/v1/users/current", strings.NewReader(url.Values{
 137                 "_method":   {"GET"},
 138                 "api_token": {arvadostest.ActiveToken},
 139         }.Encode()))
 140         req.Header.Set("Content-type", "application/x-www-form-urlencoded")
 141         resp := httptest.NewRecorder()
 142         s.handler.ServeHTTP(resp, req)
 143         c.Check(resp.Code, check.Equals, http.StatusOK)
 144         var u arvados.User
 145         err := json.Unmarshal(resp.Body.Bytes(), &u)
 146         c.Check(err, check.IsNil)
 147         c.Check(u.UUID, check.Equals, arvadostest.ActiveUserUUID)
 148 }
 149
 150 func (s *HandlerSuite) TestProxyNotFound(c *check.C) {
 151         req := httptest.NewRequest("GET", "/arvados/v1/xyzzy", nil)
 152         resp := httptest.NewRecorder()
 153         s.handler.ServeHTTP(resp, req)
 154         c.Check(resp.Code, check.Equals, http.StatusNotFound)
 155         jresp := map[string]interface{}{}
 156         err := json.Unmarshal(resp.Body.Bytes(), &jresp)
 157         c.Check(err, check.IsNil)
 158         c.Check(jresp["errors"], check.FitsTypeOf, []interface{}{})
 159 }
 160
 161 func (s *HandlerSuite) TestProxyRedirect(c *check.C) {
 162         req := httptest.NewRequest("GET", "https://0.0.0.0:1/login?return_to=foo", nil)
 163         resp := httptest.NewRecorder()
 164         s.handler.ServeHTTP(resp, req)
 165         c.Check(resp.Code, check.Equals, http.StatusFound)
 166         c.Check(resp.Header().Get("Location"), check.Matches, `https://0.0.0.0:1/auth/joshid\?return_to=%2Cfoo&?`)
 167 }
 168
 169 func (s *HandlerSuite) TestValidateV1APIToken(c *check.C) {
 170         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 171         user, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveToken)
 172         c.Assert(err, check.IsNil)
 173         c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
 174         c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
 175         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 176         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 177 }
 178
 179 func (s *HandlerSuite) TestValidateV2APIToken(c *check.C) {
 180         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 181         user, err := s.handler.(*Handler).validateAPItoken(req, arvadostest.ActiveTokenV2)
 182         c.Assert(err, check.IsNil)
 183         c.Check(user.Authorization.UUID, check.Equals, arvadostest.ActiveTokenUUID)
 184         c.Check(user.Authorization.APIToken, check.Equals, arvadostest.ActiveToken)
 185         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 186         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 187         c.Check(user.Authorization.TokenV2(), check.Equals, arvadostest.ActiveTokenV2)
 188 }
 189
 190 func (s *HandlerSuite) TestCreateAPIToken(c *check.C) {
 191         req := httptest.NewRequest("GET", "/arvados/v1/users/current", nil)
 192         auth, err := s.handler.(*Handler).createAPItoken(req, arvadostest.ActiveUserUUID, nil)
 193         c.Assert(err, check.IsNil)
 194         c.Check(auth.Scopes, check.DeepEquals, []string{"all"})
 195
 196         user, err := s.handler.(*Handler).validateAPItoken(req, auth.TokenV2())
 197         c.Assert(err, check.IsNil)
 198         c.Check(user.Authorization.UUID, check.Equals, auth.UUID)
 199         c.Check(user.Authorization.APIToken, check.Equals, auth.APIToken)
 200         c.Check(user.Authorization.Scopes, check.DeepEquals, []string{"all"})
 201         c.Check(user.UUID, check.Equals, arvadostest.ActiveUserUUID)
 202         c.Check(user.Authorization.TokenV2(), check.Equals, auth.TokenV2())
 203 }