X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/609646134bcd8fc3a7fd500848220741ecc4a9d2..9acc8cb9cd9ca4429712b0d31b647e9a6ecf2d96:/sdk/go/arvadosclient/arvadosclient.go diff --git a/sdk/go/arvadosclient/arvadosclient.go b/sdk/go/arvadosclient/arvadosclient.go index 021b9471ff..24070c5b06 100644 --- a/sdk/go/arvadosclient/arvadosclient.go +++ b/sdk/go/arvadosclient/arvadosclient.go @@ -1,3 +1,7 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: Apache-2.0 + /* Simple Arvados Go SDK for communicating with API server. */ package arvadosclient @@ -11,20 +15,21 @@ import ( "fmt" "io" "io/ioutil" + "log" "net/http" "net/url" "os" - "regexp" "strings" + "sync" "time" - "git.curoverse.com/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvados" ) type StringMatcher func(string) bool -var UUIDMatch StringMatcher = regexp.MustCompile(`^[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}$`).MatchString -var PDHMatch StringMatcher = regexp.MustCompile(`^[0-9a-f]{32}\+\d+$`).MatchString +var UUIDMatch StringMatcher = arvados.UUIDMatch +var PDHMatch StringMatcher = arvados.PDHMatch var MissingArvadosApiHost = errors.New("Missing required environment variable ARVADOS_API_HOST") var MissingArvadosApiToken = errors.New("Missing required environment variable ARVADOS_API_TOKEN") @@ -38,7 +43,13 @@ var MaxIdleConnectionDuration = 30 * time.Second var RetryDelay = 2 * time.Second -// Indicates an error that was returned by the API server. +var ( + defaultInsecureHTTPClient *http.Client + defaultSecureHTTPClient *http.Client + defaultHTTPClientMtx sync.Mutex +) + +// APIServerError contains an error that was returned by the API server. type APIServerError struct { // Address of server returning error, of the form "host:port". ServerAddress string @@ -58,18 +69,24 @@ func (e APIServerError) Error() string { e.HttpStatusCode, e.HttpStatusMessage, e.ServerAddress) - } else { - return fmt.Sprintf("arvados API server error: %d: %s returned by %s", - e.HttpStatusCode, - e.HttpStatusMessage, - e.ServerAddress) } + return fmt.Sprintf("arvados API server error: %d: %s returned by %s", + e.HttpStatusCode, + e.HttpStatusMessage, + e.ServerAddress) } -// Helper type so we don't have to write out 'map[string]interface{}' every time. +// StringBool tests whether s is suggestive of true. It returns true +// if s is a mixed/uppoer/lower-case variant of "1", "yes", or "true". +func StringBool(s string) bool { + s = strings.ToLower(s) + return s == "1" || s == "yes" || s == "true" +} + +// Dict is a helper type so we don't have to write out 'map[string]interface{}' every time. type Dict map[string]interface{} -// Information about how to contact the Arvados server +// ArvadosClient contains information about how to contact the Arvados server type ArvadosClient struct { // https Scheme string @@ -103,6 +120,9 @@ type ArvadosClient struct { // Number of retries Retries int + + // X-Request-Id for outgoing requests + RequestID string } var CertFiles = []string{ @@ -111,26 +131,31 @@ var CertFiles = []string{ "/etc/pki/tls/certs/ca-bundle.crt", // Fedora/RHEL } -// MakeTLSConfig sets up TLS configuration for communicating with Arvados and Keep services. +// MakeTLSConfig sets up TLS configuration for communicating with +// Arvados and Keep services. func MakeTLSConfig(insecure bool) *tls.Config { tlsconfig := tls.Config{InsecureSkipVerify: insecure} if !insecure { - // Look for /etc/arvados/ca-certificates.crt in addition to normal system certs. + // Use the first entry in CertFiles that we can read + // certificates from. If none of those work out, use + // the Go defaults. certs := x509.NewCertPool() for _, file := range CertFiles { data, err := ioutil.ReadFile(file) - if err == nil { - success := certs.AppendCertsFromPEM(data) - if !success { - fmt.Printf("Unable to load any certificates from %v", file) - } else { - tlsconfig.RootCAs = certs - break + if err != nil { + if !os.IsNotExist(err) { + log.Printf("proceeding without loading cert file %q: %s", file, err) } + continue + } + if !certs.AppendCertsFromPEM(data) { + log.Printf("unable to load any certificates from %v", file) + continue } + tlsconfig.RootCAs = certs + break } - // Will use system default CA roots instead. } return &tlsconfig @@ -146,10 +171,14 @@ func New(c *arvados.Client) (*ArvadosClient, error) { ApiServer: c.APIHost, ApiToken: c.AuthToken, ApiInsecure: c.Insecure, - Client: &http.Client{Transport: &http.Transport{ - TLSClientConfig: MakeTLSConfig(c.Insecure)}}, + Client: &http.Client{ + Timeout: 5 * time.Minute, + Transport: &http.Transport{ + TLSClientConfig: MakeTLSConfig(c.Insecure)}, + }, External: false, Retries: 2, + KeepServiceURIs: c.KeepServiceURIs, lastClosedIdlesAt: time.Now(), } @@ -161,42 +190,12 @@ func New(c *arvados.Client) (*ArvadosClient, error) { // ARVADOS_API_HOST_INSECURE, ARVADOS_EXTERNAL_CLIENT, and // ARVADOS_KEEP_SERVICES. func MakeArvadosClient() (ac *ArvadosClient, err error) { - var matchTrue = regexp.MustCompile("^(?i:1|yes|true)$") - insecure := matchTrue.MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE")) - external := matchTrue.MatchString(os.Getenv("ARVADOS_EXTERNAL_CLIENT")) - - ac = &ArvadosClient{ - Scheme: "https", - ApiServer: os.Getenv("ARVADOS_API_HOST"), - ApiToken: os.Getenv("ARVADOS_API_TOKEN"), - ApiInsecure: insecure, - Client: &http.Client{Transport: &http.Transport{ - TLSClientConfig: MakeTLSConfig(insecure)}}, - External: external, - Retries: 2} - - for _, s := range strings.Split(os.Getenv("ARVADOS_KEEP_SERVICES"), " ") { - if s == "" { - continue - } - if u, err := url.Parse(s); err != nil { - return ac, fmt.Errorf("ARVADOS_KEEP_SERVICES: %q: %s", s, err) - } else if !u.IsAbs() { - return ac, fmt.Errorf("ARVADOS_KEEP_SERVICES: %q: not an absolute URI", s) - } - ac.KeepServiceURIs = append(ac.KeepServiceURIs, s) - } - - if ac.ApiServer == "" { - return ac, MissingArvadosApiHost - } - if ac.ApiToken == "" { - return ac, MissingArvadosApiToken + ac, err = New(arvados.NewClientFromEnv()) + if err != nil { + return } - - ac.lastClosedIdlesAt = time.Now() - - return ac, err + ac.External = StringBool(os.Getenv("ARVADOS_EXTERNAL_CLIENT")) + return } // CallRaw is the same as Call() but returns a Reader that reads the @@ -206,11 +205,14 @@ func (c *ArvadosClient) CallRaw(method string, resourceType string, uuid string, if scheme == "" { scheme = "https" } + if c.ApiServer == "" { + return nil, fmt.Errorf("Arvados client is not configured (target API host is not set). Maybe env var ARVADOS_API_HOST should be set first?") + } u := url.URL{ Scheme: scheme, Host: c.ApiServer} - if resourceType != API_DISCOVERY_RESOURCE { + if resourceType != ApiDiscoveryResource { u.Path = "/arvados/v1" } @@ -271,6 +273,9 @@ func (c *ArvadosClient) CallRaw(method string, resourceType string, uuid string, // Add api token header req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", c.ApiToken)) + if c.RequestID != "" { + req.Header.Add("X-Request-Id", c.RequestID) + } if c.External { req.Header.Add("X-External-Client", "1") } @@ -375,7 +380,7 @@ func (c *ArvadosClient) Delete(resource string, uuid string, parameters Dict, ou return c.Call("DELETE", resource, uuid, "", parameters, output) } -// Modify attributes of a resource. See Call for argument descriptions. +// Update attributes of a resource. See Call for argument descriptions. func (c *ArvadosClient) Update(resourceType string, uuid string, parameters Dict, output interface{}) (err error) { return c.Call("PUT", resourceType, uuid, "", parameters, output) } @@ -397,7 +402,7 @@ func (c *ArvadosClient) List(resource string, parameters Dict, output interface{ return c.Call("GET", resource, "", "", parameters, output) } -const API_DISCOVERY_RESOURCE = "discovery/v1/apis/arvados/v1/rest" +const ApiDiscoveryResource = "discovery/v1/apis/arvados/v1/rest" // Discovery returns the value of the given parameter in the discovery // document. Returns a non-nil error if the discovery document cannot @@ -406,7 +411,7 @@ const API_DISCOVERY_RESOURCE = "discovery/v1/apis/arvados/v1/rest" func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err error) { if len(c.DiscoveryDoc) == 0 { c.DiscoveryDoc = make(Dict) - err = c.Call("GET", API_DISCOVERY_RESOURCE, "", "", nil, &c.DiscoveryDoc) + err = c.Call("GET", ApiDiscoveryResource, "", "", nil, &c.DiscoveryDoc) if err != nil { return nil, err } @@ -416,7 +421,41 @@ func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err erro value, found = c.DiscoveryDoc[parameter] if found { return value, nil - } else { - return value, ErrInvalidArgument } + return value, ErrInvalidArgument +} + +// ClusterConfig returns the value of the given key in the current cluster's +// exported config. If key is an empty string, it'll return the entire config. +func (c *ArvadosClient) ClusterConfig(key string) (config interface{}, err error) { + var clusterConfig interface{} + err = c.Call("GET", "config", "", "", nil, &clusterConfig) + if err != nil { + return nil, err + } + if key == "" { + return clusterConfig, nil + } + configData, ok := clusterConfig.(map[string]interface{})[key] + if !ok { + return nil, ErrInvalidArgument + } + return configData, nil +} + +func (c *ArvadosClient) httpClient() *http.Client { + if c.Client != nil { + return c.Client + } + cl := &defaultSecureHTTPClient + if c.ApiInsecure { + cl = &defaultInsecureHTTPClient + } + if *cl == nil { + defaultHTTPClientMtx.Lock() + defer defaultHTTPClientMtx.Unlock() + *cl = &http.Client{Transport: &http.Transport{ + TLSClientConfig: MakeTLSConfig(c.ApiInsecure)}} + } + return *cl }