20540: Use arvados.Client for arvadosclient.ArvadosClient reqs.
[arvados.git] / sdk / go / arvadosclient / arvadosclient.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: Apache-2.0
4
5 /* Simple Arvados Go SDK for communicating with API server. */
6
7 package arvadosclient
8
9 import (
10         "bytes"
11         "crypto/tls"
12         "crypto/x509"
13         "encoding/json"
14         "errors"
15         "fmt"
16         "io"
17         "io/ioutil"
18         "log"
19         "net/http"
20         "net/url"
21         "os"
22         "strings"
23         "sync"
24         "time"
25
26         "git.arvados.org/arvados.git/sdk/go/arvados"
27 )
28
29 type StringMatcher func(string) bool
30
31 var UUIDMatch StringMatcher = arvados.UUIDMatch
32 var PDHMatch StringMatcher = arvados.PDHMatch
33
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")
37
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
43
44 var RetryDelay = 2 * time.Second
45
46 var (
47         defaultInsecureHTTPClient *http.Client
48         defaultSecureHTTPClient   *http.Client
49         defaultHTTPClientMtx      sync.Mutex
50 )
51
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".
55         ServerAddress string
56
57         // Components of server response.
58         HttpStatusCode    int
59         HttpStatusMessage string
60
61         // Additional error details from response body.
62         ErrorDetails []string
63 }
64
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, "; "),
69                         e.HttpStatusCode,
70                         e.HttpStatusMessage,
71                         e.ServerAddress)
72         }
73         return fmt.Sprintf("arvados API server error: %d: %s returned by %s",
74                 e.HttpStatusCode,
75                 e.HttpStatusMessage,
76                 e.ServerAddress)
77 }
78
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"
84 }
85
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{}
88
89 // ArvadosClient contains information about how to contact the Arvados server
90 type ArvadosClient struct {
91         // https
92         Scheme string
93
94         // Arvados API server, form "host:port"
95         ApiServer string
96
97         // Arvados API token for authentication
98         ApiToken string
99
100         // Whether to require a valid SSL certificate or not
101         ApiInsecure bool
102
103         // Client object shared by client requests.  Supports HTTP KeepAlive.
104         Client *http.Client
105
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
111
112         // Discovery document
113         DiscoveryDoc Dict
114
115         lastClosedIdlesAt time.Time
116
117         // Number of retries
118         Retries int
119
120         // X-Request-Id for outgoing requests
121         RequestID string
122 }
123
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
128 }
129
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}
134
135         if !insecure {
136                 // Use the first entry in CertFiles that we can read
137                 // certificates from. If none of those work out, use
138                 // the Go defaults.
139                 certs := x509.NewCertPool()
140                 for _, file := range CertFiles {
141                         data, err := ioutil.ReadFile(file)
142                         if err != nil {
143                                 if !os.IsNotExist(err) {
144                                         log.Printf("proceeding without loading cert file %q: %s", file, err)
145                                 }
146                                 continue
147                         }
148                         if !certs.AppendCertsFromPEM(data) {
149                                 log.Printf("unable to load any certificates from %v", file)
150                                 continue
151                         }
152                         tlsconfig.RootCAs = certs
153                         break
154                 }
155         }
156
157         return &tlsconfig
158 }
159
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) {
165         hc := c.Client
166         if hc == nil {
167                 hc = &http.Client{
168                         Timeout: 5 * time.Minute,
169                         Transport: &http.Transport{
170                                 TLSClientConfig: MakeTLSConfig(c.Insecure)},
171                 }
172         }
173         ac := &ArvadosClient{
174                 Scheme:            "https",
175                 ApiServer:         c.APIHost,
176                 ApiToken:          c.AuthToken,
177                 ApiInsecure:       c.Insecure,
178                 Client:            hc,
179                 Retries:           2,
180                 KeepServiceURIs:   c.KeepServiceURIs,
181                 lastClosedIdlesAt: time.Now(),
182         }
183
184         return ac, nil
185 }
186
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())
192 }
193
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) {
197         scheme := c.Scheme
198         if scheme == "" {
199                 scheme = "https"
200         }
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?")
203         }
204         u := url.URL{
205                 Scheme: scheme,
206                 Host:   c.ApiServer}
207
208         if resourceType != ApiDiscoveryResource {
209                 u.Path = "/arvados/v1"
210         }
211
212         if resourceType != "" {
213                 u.Path = u.Path + "/" + resourceType
214         }
215         if uuid != "" {
216                 u.Path = u.Path + "/" + uuid
217         }
218         if action != "" {
219                 u.Path = u.Path + "/" + action
220         }
221
222         if parameters == nil {
223                 parameters = make(Dict)
224         }
225
226         vals := make(url.Values)
227         for k, v := range parameters {
228                 if s, ok := v.(string); ok {
229                         vals.Set(k, s)
230                 } else if m, err := json.Marshal(v); err == nil {
231                         vals.Set(k, string(m))
232                 }
233         }
234         var req *http.Request
235         if method == "GET" || method == "HEAD" {
236                 u.RawQuery = vals.Encode()
237                 if req, err = http.NewRequest(method, u.String(), nil); err != nil {
238                         return nil, err
239                 }
240         } else {
241                 if req, err = http.NewRequest(method, u.String(), bytes.NewBufferString(vals.Encode())); err != nil {
242                         return nil, err
243                 }
244                 req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
245         }
246         if c.RequestID != "" {
247                 req.Header.Add("X-Request-Id", c.RequestID)
248         }
249         client := arvados.Client{
250                 Client:    c.Client,
251                 APIHost:   c.ApiServer,
252                 AuthToken: c.ApiToken,
253                 Insecure:  c.ApiInsecure,
254                 Timeout:   30 * RetryDelay * time.Duration(c.Retries),
255         }
256         resp, err := client.Do(req)
257         if err != nil {
258                 return nil, err
259         }
260         if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusNoContent {
261                 defer resp.Body.Close()
262                 return nil, newAPIServerError(c.ApiServer, resp)
263         }
264         return resp.Body, nil
265 }
266
267 func newAPIServerError(ServerAddress string, resp *http.Response) APIServerError {
268
269         ase := APIServerError{
270                 ServerAddress:     ServerAddress,
271                 HttpStatusCode:    resp.StatusCode,
272                 HttpStatusMessage: resp.Status}
273
274         // If the response body has {"errors":["reason1","reason2"]}
275         // then return those reasons.
276         var errInfo = Dict{}
277         if err := json.NewDecoder(resp.Body).Decode(&errInfo); err == nil {
278                 if errorList, ok := errInfo["errors"]; ok {
279                         if errArray, ok := errorList.([]interface{}); ok {
280                                 for _, errItem := range errArray {
281                                         // We expect an array of strings here.
282                                         // Non-strings will be passed along
283                                         // JSON-encoded.
284                                         if s, ok := errItem.(string); ok {
285                                                 ase.ErrorDetails = append(ase.ErrorDetails, s)
286                                         } else if j, err := json.Marshal(errItem); err == nil {
287                                                 ase.ErrorDetails = append(ase.ErrorDetails, string(j))
288                                         }
289                                 }
290                         }
291                 }
292         }
293         return ase
294 }
295
296 // Call an API endpoint and parse the JSON response into an object.
297 //
298 //      method - HTTP method: GET, HEAD, PUT, POST, PATCH or DELETE.
299 //      resourceType - the type of arvados resource to act on (e.g., "collections", "pipeline_instances").
300 //      uuid - the uuid of the specific item to access. May be empty.
301 //      action - API method name (e.g., "lock"). This is often empty if implied by method and uuid.
302 //      parameters - method parameters.
303 //      output - a map or annotated struct which is a legal target for encoding/json/Decoder.
304 //
305 // Returns a non-nil error if an error occurs making the API call, the
306 // API responds with a non-successful HTTP status, or an error occurs
307 // parsing the response body.
308 func (c *ArvadosClient) Call(method, resourceType, uuid, action string, parameters Dict, output interface{}) error {
309         reader, err := c.CallRaw(method, resourceType, uuid, action, parameters)
310         if reader != nil {
311                 defer reader.Close()
312         }
313         if err != nil {
314                 return err
315         }
316
317         if output != nil {
318                 dec := json.NewDecoder(reader)
319                 if err = dec.Decode(output); err != nil {
320                         return err
321                 }
322         }
323         return nil
324 }
325
326 // Create a new resource. See Call for argument descriptions.
327 func (c *ArvadosClient) Create(resourceType string, parameters Dict, output interface{}) error {
328         return c.Call("POST", resourceType, "", "", parameters, output)
329 }
330
331 // Delete a resource. See Call for argument descriptions.
332 func (c *ArvadosClient) Delete(resource string, uuid string, parameters Dict, output interface{}) (err error) {
333         return c.Call("DELETE", resource, uuid, "", parameters, output)
334 }
335
336 // Update attributes of a resource. See Call for argument descriptions.
337 func (c *ArvadosClient) Update(resourceType string, uuid string, parameters Dict, output interface{}) (err error) {
338         return c.Call("PUT", resourceType, uuid, "", parameters, output)
339 }
340
341 // Get a resource. See Call for argument descriptions.
342 func (c *ArvadosClient) Get(resourceType string, uuid string, parameters Dict, output interface{}) (err error) {
343         if !UUIDMatch(uuid) && !(resourceType == "collections" && PDHMatch(uuid)) {
344                 // No object has uuid == "": there is no need to make
345                 // an API call. Furthermore, the HTTP request for such
346                 // an API call would be "GET /arvados/v1/type/", which
347                 // is liable to be misinterpreted as the List API.
348                 return ErrInvalidArgument
349         }
350         return c.Call("GET", resourceType, uuid, "", parameters, output)
351 }
352
353 // List resources of a given type. See Call for argument descriptions.
354 func (c *ArvadosClient) List(resource string, parameters Dict, output interface{}) (err error) {
355         return c.Call("GET", resource, "", "", parameters, output)
356 }
357
358 const ApiDiscoveryResource = "discovery/v1/apis/arvados/v1/rest"
359
360 // Discovery returns the value of the given parameter in the discovery
361 // document. Returns a non-nil error if the discovery document cannot
362 // be retrieved/decoded. Returns ErrInvalidArgument if the requested
363 // parameter is not found in the discovery document.
364 func (c *ArvadosClient) Discovery(parameter string) (value interface{}, err error) {
365         if len(c.DiscoveryDoc) == 0 {
366                 c.DiscoveryDoc = make(Dict)
367                 err = c.Call("GET", ApiDiscoveryResource, "", "", nil, &c.DiscoveryDoc)
368                 if err != nil {
369                         return nil, err
370                 }
371         }
372
373         var found bool
374         value, found = c.DiscoveryDoc[parameter]
375         if found {
376                 return value, nil
377         }
378         return value, ErrInvalidArgument
379 }
380
381 // ClusterConfig returns the value of the given key in the current cluster's
382 // exported config. If key is an empty string, it'll return the entire config.
383 func (c *ArvadosClient) ClusterConfig(key string) (config interface{}, err error) {
384         var clusterConfig interface{}
385         err = c.Call("GET", "config", "", "", nil, &clusterConfig)
386         if err != nil {
387                 return nil, err
388         }
389         if key == "" {
390                 return clusterConfig, nil
391         }
392         configData, ok := clusterConfig.(map[string]interface{})[key]
393         if !ok {
394                 return nil, ErrInvalidArgument
395         }
396         return configData, nil
397 }
398
399 func (c *ArvadosClient) httpClient() *http.Client {
400         if c.Client != nil {
401                 return c.Client
402         }
403         cl := &defaultSecureHTTPClient
404         if c.ApiInsecure {
405                 cl = &defaultInsecureHTTPClient
406         }
407         if *cl == nil {
408                 defaultHTTPClientMtx.Lock()
409                 defer defaultHTTPClientMtx.Unlock()
410                 *cl = &http.Client{Transport: &http.Transport{
411                         TLSClientConfig: MakeTLSConfig(c.ApiInsecure)}}
412         }
413         return *cl
414 }