X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/123153139bbee3674c81325653d87fa19ffbe0e4..7602078b5c8f56f6dddfd89a36cf65cb2e1c88d0:/sdk/go/arvadosclient/arvadosclient.go diff --git a/sdk/go/arvadosclient/arvadosclient.go b/sdk/go/arvadosclient/arvadosclient.go index 4cfda94581..13b3a30ac4 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 @@ -15,18 +19,17 @@ import ( "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") @@ -46,7 +49,7 @@ var ( defaultHTTPClientMtx sync.Mutex ) -// Indicates an error that was returned by the API server. +// 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 @@ -66,12 +69,11 @@ 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) } // StringBool tests whether s is suggestive of true. It returns true @@ -81,10 +83,10 @@ func StringBool(s string) bool { return s == "1" || s == "yes" || s == "true" } -// Helper type so we don't have to write out 'map[string]interface{}' every time. +// 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 @@ -101,10 +103,6 @@ type ArvadosClient struct { // Client object shared by client requests. Supports HTTP KeepAlive. Client *http.Client - // If true, sets the X-External-Client header to indicate - // the client is outside the cluster. - External bool - // Base URIs of Keep services, e.g., {"https://host1:8443", // "https://host2:8443"}. If this is nil, Keep clients will // use the arvados.v1.keep_services.accessible API to discover @@ -118,6 +116,9 @@ type ArvadosClient struct { // Number of retries Retries int + + // X-Request-Id for outgoing requests + RequestID string } var CertFiles = []string{ @@ -140,7 +141,7 @@ func MakeTLSConfig(insecure bool) *tls.Config { data, err := ioutil.ReadFile(file) if err != nil { if !os.IsNotExist(err) { - log.Printf("error reading %q: %s", file, err) + log.Printf("proceeding without loading cert file %q: %s", file, err) } continue } @@ -161,14 +162,20 @@ func MakeTLSConfig(insecure bool) *tls.Config { // fields from configuration files but still need to use the // arvadosclient.ArvadosClient package. func New(c *arvados.Client) (*ArvadosClient, error) { + hc := c.Client + if hc == nil { + hc = &http.Client{ + Timeout: 5 * time.Minute, + Transport: &http.Transport{ + TLSClientConfig: MakeTLSConfig(c.Insecure)}, + } + } ac := &ArvadosClient{ - Scheme: "https", - ApiServer: c.APIHost, - ApiToken: c.AuthToken, - ApiInsecure: c.Insecure, - Client: &http.Client{Transport: &http.Transport{ - TLSClientConfig: MakeTLSConfig(c.Insecure)}}, - External: false, + Scheme: "https", + ApiServer: c.APIHost, + ApiToken: c.AuthToken, + ApiInsecure: c.Insecure, + Client: hc, Retries: 2, KeepServiceURIs: c.KeepServiceURIs, lastClosedIdlesAt: time.Now(), @@ -179,15 +186,9 @@ func New(c *arvados.Client) (*ArvadosClient, error) { // MakeArvadosClient creates a new ArvadosClient using the standard // environment variables ARVADOS_API_HOST, ARVADOS_API_TOKEN, -// ARVADOS_API_HOST_INSECURE, ARVADOS_EXTERNAL_CLIENT, and -// ARVADOS_KEEP_SERVICES. -func MakeArvadosClient() (ac *ArvadosClient, err error) { - ac, err = New(arvados.NewClientFromEnv()) - if err != nil { - return - } - ac.External = StringBool(os.Getenv("ARVADOS_EXTERNAL_CLIENT")) - return +// ARVADOS_API_HOST_INSECURE, and ARVADOS_KEEP_SERVICES. +func MakeArvadosClient() (*ArvadosClient, error) { + return New(arvados.NewClientFromEnv()) } // CallRaw is the same as Call() but returns a Reader that reads the @@ -197,11 +198,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" } @@ -262,8 +266,8 @@ 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.External { - req.Header.Add("X-External-Client", "1") + if c.RequestID != "" { + req.Header.Add("X-Request-Id", c.RequestID) } resp, err = c.Client.Do(req) @@ -366,7 +370,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) } @@ -388,7 +392,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 @@ -397,7 +401,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 } @@ -407,24 +411,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 (ac *ArvadosClient) httpClient() *http.Client { - if ac.Client != nil { - return ac.Client +func (c *ArvadosClient) httpClient() *http.Client { + if c.Client != nil { + return c.Client } - c := &defaultSecureHTTPClient - if ac.ApiInsecure { - c = &defaultInsecureHTTPClient + cl := &defaultSecureHTTPClient + if c.ApiInsecure { + cl = &defaultInsecureHTTPClient } - if *c == nil { + if *cl == nil { defaultHTTPClientMtx.Lock() defer defaultHTTPClientMtx.Unlock() - *c = &http.Client{Transport: &http.Transport{ - TLSClientConfig: MakeTLSConfig(ac.ApiInsecure)}} + *cl = &http.Client{Transport: &http.Transport{ + TLSClientConfig: MakeTLSConfig(c.ApiInsecure)}} } - return *c + return *cl }