1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: Apache-2.0
5 /* Simple Arvados Go SDK for communicating with API server. */
26 "git.arvados.org/arvados.git/sdk/go/arvados"
29 type StringMatcher func(string) bool
31 var UUIDMatch StringMatcher = arvados.UUIDMatch
32 var PDHMatch StringMatcher = arvados.PDHMatch
34 var MissingArvadosApiHost = errors.New("Missing required environment variable ARVADOS_API_HOST")
35 var MissingArvadosApiToken = errors.New("Missing required environment variable ARVADOS_API_TOKEN")
36 var ErrInvalidArgument = errors.New("Invalid argument")
38 // A common failure mode is to reuse a keepalive connection that has been
39 // terminated (in a way that we can't detect) for being idle too long.
40 // POST and DELETE are not safe to retry automatically, so we minimize
41 // such failures by always using a new or recently active socket.
42 var MaxIdleConnectionDuration = 30 * time.Second
44 var RetryDelay = 2 * time.Second
47 defaultInsecureHTTPClient *http.Client
48 defaultSecureHTTPClient *http.Client
49 defaultHTTPClientMtx sync.Mutex
52 // APIServerError contains an error that was returned by the API server.
53 type APIServerError struct {
54 // Address of server returning error, of the form "host:port".
57 // Components of server response.
59 HttpStatusMessage string
61 // Additional error details from response body.
65 func (e APIServerError) Error() string {
66 if len(e.ErrorDetails) > 0 {
67 return fmt.Sprintf("arvados API server error: %s (%d: %s) returned by %s",
68 strings.Join(e.ErrorDetails, "; "),
73 return fmt.Sprintf("arvados API server error: %d: %s returned by %s",
79 // StringBool tests whether s is suggestive of true. It returns true
80 // if s is a mixed/uppoer/lower-case variant of "1", "yes", or "true".
81 func StringBool(s string) bool {
82 s = strings.ToLower(s)
83 return s == "1" || s == "yes" || s == "true"
86 // Dict is a helper type so we don't have to write out 'map[string]interface{}' every time.
87 type Dict map[string]interface{}
89 // ArvadosClient contains information about how to contact the Arvados server
90 type ArvadosClient struct {
94 // Arvados API server, form "host:port"
97 // Arvados API token for authentication
100 // Whether to require a valid SSL certificate or not
103 // Client object shared by client requests. Supports HTTP KeepAlive.
106 // Base URIs of Keep services, e.g., {"https://host1:8443",
107 // "https://host2:8443"}. If this is nil, Keep clients will
108 // use the arvados.v1.keep_services.accessible API to discover
109 // available services.
110 KeepServiceURIs []string
112 // Discovery document
115 lastClosedIdlesAt time.Time
120 // X-Request-Id for outgoing requests
124 var CertFiles = []string{
125 "/etc/arvados/ca-certificates.crt",
126 "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu/Gentoo etc.
127 "/etc/pki/tls/certs/ca-bundle.crt", // Fedora/RHEL
130 // MakeTLSConfig sets up TLS configuration for communicating with
131 // Arvados and Keep services.
132 func MakeTLSConfig(insecure bool) *tls.Config {
133 tlsconfig := tls.Config{InsecureSkipVerify: insecure}
136 // Use the first entry in CertFiles that we can read
137 // certificates from. If none of those work out, use
139 certs := x509.NewCertPool()
140 for _, file := range CertFiles {
141 data, err := ioutil.ReadFile(file)
143 if !os.IsNotExist(err) {
144 log.Printf("proceeding without loading cert file %q: %s", file, err)
148 if !certs.AppendCertsFromPEM(data) {
149 log.Printf("unable to load any certificates from %v", file)
152 tlsconfig.RootCAs = certs
160 // New returns an ArvadosClient using the given arvados.Client
161 // configuration. This is useful for callers who load arvados.Client
162 // fields from configuration files but still need to use the
163 // arvadosclient.ArvadosClient package.
164 func New(c *arvados.Client) (*ArvadosClient, error) {
168 Timeout: 5 * time.Minute,
169 Transport: &http.Transport{
170 TLSClientConfig: MakeTLSConfig(c.Insecure)},
173 ac := &ArvadosClient{
175 ApiServer: c.APIHost,
176 ApiToken: c.AuthToken,
177 ApiInsecure: c.Insecure,
180 KeepServiceURIs: c.KeepServiceURIs,
181 lastClosedIdlesAt: time.Now(),
187 // MakeArvadosClient creates a new ArvadosClient using the standard
188 // environment variables ARVADOS_API_HOST, ARVADOS_API_TOKEN,
189 // ARVADOS_API_HOST_INSECURE, and ARVADOS_KEEP_SERVICES.
190 func MakeArvadosClient() (*ArvadosClient, error) {
191 return New(arvados.NewClientFromEnv())
194 // CallRaw is the same as Call() but returns a Reader that reads the
195 // response body, instead of taking an output object.
196 func (c *ArvadosClient) CallRaw(method string, resourceType string, uuid string, action string, parameters Dict) (reader io.ReadCloser, err error) {
201 if c.ApiServer == "" {
202 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?")
208 if resourceType != ApiDiscoveryResource {
209 u.Path = "/arvados/v1"
212 if resourceType != "" {
213 u.Path = u.Path + "/" + resourceType
216 u.Path = u.Path + "/" + uuid
219 u.Path = u.Path + "/" + action
222 if parameters == nil {
223 parameters = make(Dict)
226 vals := make(url.Values)
227 for k, v := range parameters {
228 if s, ok := v.(string); ok {
230 } else if m, err := json.Marshal(v); err == nil {
231 vals.Set(k, string(m))
237 case "GET", "HEAD", "PUT", "OPTIONS", "DELETE":
241 // Non-retryable methods such as POST are not safe to retry automatically,
242 // so we minimize such failures by always using a new or recently active socket
244 if time.Since(c.lastClosedIdlesAt) > MaxIdleConnectionDuration {
245 c.lastClosedIdlesAt = time.Now()
246 c.Client.Transport.(*http.Transport).CloseIdleConnections()
251 var req *http.Request
252 var resp *http.Response
254 for attempt := 0; attempt <= c.Retries; attempt++ {
255 if method == "GET" || method == "HEAD" {
256 u.RawQuery = vals.Encode()
257 if req, err = http.NewRequest(method, u.String(), nil); err != nil {
261 if req, err = http.NewRequest(method, u.String(), bytes.NewBufferString(vals.Encode())); err != nil {
264 req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
267 // Add api token header
268 req.Header.Add("Authorization", fmt.Sprintf("OAuth2 %s", c.ApiToken))
269 if c.RequestID != "" {
270 req.Header.Add("X-Request-Id", c.RequestID)
273 resp, err = c.Client.Do(req)
276 time.Sleep(RetryDelay)
283 if resp.StatusCode == http.StatusOK {
284 return resp.Body, nil
287 defer resp.Body.Close()
289 switch resp.StatusCode {
290 case 408, 409, 422, 423, 500, 502, 503, 504:
291 time.Sleep(RetryDelay)
294 return nil, newAPIServerError(c.ApiServer, resp)
299 return nil, newAPIServerError(c.ApiServer, resp)
304 func newAPIServerError(ServerAddress string, resp *http.Response) APIServerError {
306 ase := APIServerError{
307 ServerAddress: ServerAddress,
308 HttpStatusCode: resp.StatusCode,
309 HttpStatusMessage: resp.Status}
311 // If the response body has {"errors":["reason1","reason2"]}
312 // then return those reasons.
314 if err := json.NewDecoder(resp.Body).Decode(&errInfo); err == nil {
315 if errorList, ok := errInfo["errors"]; ok {
316 if errArray, ok := errorList.([]interface{}); ok {
317 for _, errItem := range errArray {
318 // We expect an array of strings here.
319 // Non-strings will be passed along
321 if s, ok := errItem.(string); ok {
322 ase.ErrorDetails = append(ase.ErrorDetails, s)
323 } else if j, err := json.Marshal(errItem); err == nil {
324 ase.ErrorDetails = append(ase.ErrorDetails, string(j))
333 // Call an API endpoint and parse the JSON response into an object.
335 // method - HTTP method: GET, HEAD, PUT, POST, PATCH or DELETE.
336 // resourceType - the type of arvados resource to act on (e.g., "collections", "pipeline_instances").
337 // uuid - the uuid of the specific item to access. May be empty.
338 // action - API method name (e.g., "lock"). This is often empty if implied by method and uuid.
339 // parameters - method parameters.
340 // output - a map or annotated struct which is a legal target for encoding/json/Decoder.
342 // Returns a non-nil error if an error occurs making the API call, the
343 // API responds with a non-successful HTTP status, or an error occurs
344 // parsing the response body.
345 func (c *ArvadosClient) Call(method, resourceType, uuid, action string, parameters Dict, output interface{}) error {
346 reader, err := c.CallRaw(method, resourceType, uuid, action, parameters)
355 dec := json.NewDecoder(reader)
356 if err = dec.Decode(output); err != nil {
363 // Create a new resource. See Call for argument descriptions.
364 func (c *ArvadosClient) Create(resourceType string, parameters Dict, output interface{}) error {
365 return c.Call("POST", resourceType, "", "", parameters, output)
368 // Delete a resource. See Call for argument descriptions.
369 func (c *ArvadosClient) Delete(resource string, uuid string, parameters Dict, output interface{}) (err error) {
370 return c.Call("DELETE", resource, uuid, "", parameters, output)
373 // Update attributes of a resource. See Call for argument descriptions.
374 func (c *ArvadosClient) Update(resourceType string, uuid string, parameters Dict, output interface{}) (err error) {
375 return c.Call("PUT", resourceType, uuid, "", parameters, output)
378 // Get a resource. See Call for argument descriptions.
379 func (c *ArvadosClient) Get(resourceType string, uuid string, parameters Dict, output interface{}) (err error) {
380 if !UUIDMatch(uuid) && !(resourceType == "collections" && PDHMatch(uuid)) {
381 // No object has uuid == "": there is no need to make
382 // an API call. Furthermore, the HTTP request for such
383 // an API call would be "GET /arvados/v1/type/", which
384 // is liable to be misinterpreted as the List API.
385 return ErrInvalidArgument
387 return c.Call("GET", resourceType, uuid, "", parameters, output)
390 // List resources of a given type. See Call for argument descriptions.
391 func (c *ArvadosClient) List(resource string, parameters Dict, output interface{}) (err error) {
392 return c.Call("GET", resource, "", "", parameters, output)
395 const ApiDiscoveryResource = "discovery/v1/apis/arvados/v1/rest"
397 // Discovery returns the value of the given parameter in the discovery
398 // document. Returns a non-nil error if the discovery document cannot
399 // be retrieved/decoded. Returns ErrInvalidArgument if the requested
400 // parameter is not found in the discovery document.
401 func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err error) {
402 if len(c.DiscoveryDoc) == 0 {
403 c.DiscoveryDoc = make(Dict)
404 err = c.Call("GET", ApiDiscoveryResource, "", "", nil, &c.DiscoveryDoc)
411 value, found = c.DiscoveryDoc[parameter]
415 return value, ErrInvalidArgument
418 // ClusterConfig returns the value of the given key in the current cluster's
419 // exported config. If key is an empty string, it'll return the entire config.
420 func (c *ArvadosClient) ClusterConfig(key string) (config interface{}, err error) {
421 var clusterConfig interface{}
422 err = c.Call("GET", "config", "", "", nil, &clusterConfig)
427 return clusterConfig, nil
429 configData, ok := clusterConfig.(map[string]interface{})[key]
431 return nil, ErrInvalidArgument
433 return configData, nil
436 func (c *ArvadosClient) httpClient() *http.Client {
440 cl := &defaultSecureHTTPClient
442 cl = &defaultInsecureHTTPClient
445 defaultHTTPClientMtx.Lock()
446 defer defaultHTTPClientMtx.Unlock()
447 *cl = &http.Client{Transport: &http.Transport{
448 TLSClientConfig: MakeTLSConfig(c.ApiInsecure)}}