1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
20 "git.arvados.org/arvados.git/sdk/go/arvados"
21 "git.arvados.org/arvados.git/sdk/go/ctxlog"
22 "github.com/sirupsen/logrus"
27 func (cmd Command) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
29 f := flag.NewFlagSet(prog, flag.ContinueOnError)
30 f.StringVar(&diag.projectName, "project-name", "scratch area for diagnostics", "name of project to find/create in home project and use for temporary/test objects")
31 f.StringVar(&diag.logLevel, "log-level", "info", "logging level (debug, info, warning, error)")
32 f.BoolVar(&diag.checkInternal, "internal-client", false, "check that this host is considered an \"internal\" client")
33 f.BoolVar(&diag.checkExternal, "external-client", false, "check that this host is considered an \"external\" client")
34 f.IntVar(&diag.priority, "priority", 500, "priority for test container (1..1000)")
35 f.DurationVar(&diag.timeout, "timeout", 10*time.Second, "timeout for http requests")
37 if err == flag.ErrHelp {
39 } else if err != nil {
40 fmt.Fprintln(stderr, err)
43 diag.logger = ctxlog.New(stdout, "text", diag.logLevel)
44 diag.logger.SetFormatter(&logrus.TextFormatter{DisableTimestamp: true, DisableLevelTruncation: true, PadLevelText: true})
46 if len(diag.errors) == 0 {
47 diag.logger.Info("--- no errors ---")
50 if diag.logger.Level > logrus.ErrorLevel {
51 fmt.Fprint(stdout, "\n--- cut here --- error summary ---\n\n")
52 for _, e := range diag.errors {
60 type diagnoser struct {
74 func (diag *diagnoser) debugf(f string, args ...interface{}) {
75 diag.logger.Debugf(f, args...)
78 func (diag *diagnoser) infof(f string, args ...interface{}) {
79 diag.logger.Infof(f, args...)
82 func (diag *diagnoser) warnf(f string, args ...interface{}) {
83 diag.logger.Warnf(f, args...)
86 func (diag *diagnoser) errorf(f string, args ...interface{}) {
87 diag.logger.Errorf(f, args...)
88 diag.errors = append(diag.errors, fmt.Sprintf(f, args...))
91 // Run the given func, logging appropriate messages before and after,
92 // adding timing info, etc.
94 // The id argument should be unique among tests, and shouldn't change
95 // when other tests are added/removed.
96 func (diag *diagnoser) dotest(id int, title string, fn func() error) {
98 diag.done = map[int]bool{}
99 } else if diag.done[id] {
100 diag.errorf("(bug) reused test id %d", id)
104 diag.infof("%4d: %s", id, title)
107 elapsed := fmt.Sprintf("%.0dms", time.Now().Sub(t0)/time.Millisecond)
109 diag.errorf("%4d: %s (%s): %s", id, title, elapsed, err)
111 diag.debugf("%4d: %s (%s): ok", id, title, elapsed)
115 func (diag *diagnoser) runtests() {
116 client := arvados.NewClientFromEnv()
118 if client.APIHost == "" || client.AuthToken == "" {
119 diag.errorf("ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are not set -- aborting without running any tests")
123 var dd arvados.DiscoveryDocument
124 ddpath := "discovery/v1/apis/arvados/v1/rest"
125 diag.dotest(10, fmt.Sprintf("getting discovery document from https://%s/%s", client.APIHost, ddpath), func() error {
126 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
128 err := client.RequestAndDecodeContext(ctx, &dd, "GET", ddpath, nil, nil)
132 diag.debugf("BlobSignatureTTL = %d", dd.BlobSignatureTTL)
136 var cluster arvados.Cluster
137 cfgpath := "arvados/v1/config"
138 diag.dotest(20, fmt.Sprintf("getting exported config from https://%s/%s", client.APIHost, cfgpath), func() error {
139 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
141 err := client.RequestAndDecodeContext(ctx, &cluster, "GET", cfgpath, nil, nil)
145 diag.debugf("Collections.BlobSigning = %v", cluster.Collections.BlobSigning)
149 var user arvados.User
150 diag.dotest(30, "getting current user record", func() error {
151 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
153 err := client.RequestAndDecodeContext(ctx, &user, "GET", "arvados/v1/users/current", nil, nil)
157 diag.debugf("user uuid = %s", user.UUID)
161 // uncomment to create some spurious errors
162 // cluster.Services.WebDAVDownload.ExternalURL.Host = "0.0.0.0:9"
164 // TODO: detect routing errors here, like finding wb2 at the
166 for i, svc := range []*arvados.Service{
167 &cluster.Services.Keepproxy,
168 &cluster.Services.WebDAV,
169 &cluster.Services.WebDAVDownload,
170 &cluster.Services.Websocket,
171 &cluster.Services.Workbench1,
172 &cluster.Services.Workbench2,
174 diag.dotest(40+i, fmt.Sprintf("connecting to service endpoint %s", svc.ExternalURL), func() error {
175 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
178 if strings.HasPrefix(u.Scheme, "ws") {
179 // We can do a real websocket test elsewhere,
180 // but for now we'll just check the https
182 u.Scheme = "http" + u.Scheme[2:]
184 if svc == &cluster.Services.WebDAV && strings.HasPrefix(u.Host, "*") {
185 u.Host = "d41d8cd98f00b204e9800998ecf8427e-0" + u.Host[1:]
187 req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
191 resp, err := http.DefaultClient.Do(req)
200 for i, url := range []string{
201 cluster.Services.Controller.ExternalURL.String(),
202 cluster.Services.Keepproxy.ExternalURL.String() + "d41d8cd98f00b204e9800998ecf8427e+0",
203 cluster.Services.WebDAVDownload.ExternalURL.String(),
205 diag.dotest(50+i, fmt.Sprintf("checking CORS headers at %s", url), func() error {
206 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
208 req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
212 req.Header.Set("Origin", "https://example.com")
213 resp, err := http.DefaultClient.Do(req)
217 if hdr := resp.Header.Get("Access-Control-Allow-Origin"); hdr != "*" {
218 return fmt.Errorf("expected \"Access-Control-Allow-Origin: *\", got %q", hdr)
224 var keeplist arvados.KeepServiceList
225 diag.dotest(60, "checking internal/external client detection", func() error {
226 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
228 err := client.RequestAndDecodeContext(ctx, &keeplist, "GET", "arvados/v1/keep_services/accessible", nil, arvados.ListOptions{Limit: 999999})
230 return fmt.Errorf("error getting keep services list: %s", err)
231 } else if len(keeplist.Items) == 0 {
232 return fmt.Errorf("controller did not return any keep services")
234 found := map[string]int{}
235 for _, ks := range keeplist.Items {
236 found[ks.ServiceType]++
238 isInternal := found["proxy"] == 0 && len(keeplist.Items) > 0
239 isExternal := found["proxy"] > 0 && found["proxy"] == len(keeplist.Items)
241 diag.debugf("controller returned only proxy services, this host is treated as \"external\"")
242 } else if isInternal {
243 diag.debugf("controller returned only non-proxy services, this host is treated as \"internal\"")
245 if (diag.checkInternal && !isInternal) || (diag.checkExternal && !isExternal) {
246 return fmt.Errorf("expecting internal=%v external=%v, but found internal=%v external=%v", diag.checkInternal, diag.checkExternal, isInternal, isExternal)
251 for i, ks := range keeplist.Items {
254 Host: net.JoinHostPort(ks.ServiceHost, fmt.Sprintf("%d", ks.ServicePort)),
257 if ks.ServiceSSLFlag {
260 diag.dotest(61+i, fmt.Sprintf("reading+writing via keep service at %s", u.String()), func() error {
261 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
263 req, err := http.NewRequestWithContext(ctx, "PUT", u.String()+"d41d8cd98f00b204e9800998ecf8427e", nil)
267 req.Header.Set("Authorization", "Bearer "+client.AuthToken)
268 resp, err := http.DefaultClient.Do(req)
272 defer resp.Body.Close()
273 body, err := ioutil.ReadAll(resp.Body)
275 return fmt.Errorf("reading response body: %s", err)
277 loc := strings.TrimSpace(string(body))
278 if !strings.HasPrefix(loc, "d41d8") {
279 return fmt.Errorf("unexpected response from write: %q", body)
282 req, err = http.NewRequestWithContext(ctx, "GET", u.String()+loc, nil)
286 req.Header.Set("Authorization", "Bearer "+client.AuthToken)
287 resp, err = http.DefaultClient.Do(req)
291 defer resp.Body.Close()
292 body, err = ioutil.ReadAll(resp.Body)
294 return fmt.Errorf("reading response body: %s", err)
297 return fmt.Errorf("unexpected response from read: %q", body)
304 var project arvados.Group
305 diag.dotest(80, fmt.Sprintf("finding/creating %q project", diag.projectName), func() error {
306 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
308 var grplist arvados.GroupList
309 err := client.RequestAndDecodeContext(ctx, &grplist, "GET", "arvados/v1/groups", nil, arvados.ListOptions{
310 Filters: []arvados.Filter{
311 {"name", "=", diag.projectName},
312 {"group_class", "=", "project"},
313 {"owner_uuid", "=", user.UUID}},
316 return fmt.Errorf("list groups: %s", err)
318 if len(grplist.Items) > 0 {
319 project = grplist.Items[0]
320 diag.debugf("using existing project, uuid = %s", project.UUID)
323 diag.debugf("list groups: ok, no results")
324 err = client.RequestAndDecodeContext(ctx, &project, "POST", "arvados/v1/groups", nil, map[string]interface{}{"group": map[string]interface{}{
325 "name": diag.projectName,
326 "group_class": "project",
329 return fmt.Errorf("create project: %s", err)
331 diag.debugf("created project, uuid = %s", project.UUID)
335 var collection arvados.Collection
336 diag.dotest(90, "creating temporary collection", func() error {
337 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
339 err := client.RequestAndDecodeContext(ctx, &collection, "POST", "arvados/v1/collections", nil, map[string]interface{}{
340 "ensure_unique_name": true,
341 "collection": map[string]interface{}{
342 "name": "test collection",
343 "trash_at": time.Now().Add(time.Hour)}})
347 diag.debugf("ok, uuid = %s", collection.UUID)
351 if collection.UUID != "" {
353 diag.dotest(9990, "deleting temporary collection", func() error {
354 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
356 return client.RequestAndDecodeContext(ctx, nil, "DELETE", "arvados/v1/collections/"+collection.UUID, nil, nil)
361 diag.dotest(100, "uploading file via webdav", func() error {
362 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
364 if collection.UUID == "" {
365 return fmt.Errorf("skipping, no test collection")
367 req, err := http.NewRequestWithContext(ctx, "PUT", cluster.Services.WebDAVDownload.ExternalURL.String()+"c="+collection.UUID+"/testfile", bytes.NewBufferString("testfiledata"))
369 return fmt.Errorf("BUG? http.NewRequest: %s", err)
371 req.Header.Set("Authorization", "Bearer "+client.AuthToken)
372 resp, err := http.DefaultClient.Do(req)
374 return fmt.Errorf("error performing http request: %s", err)
377 if resp.StatusCode != http.StatusCreated {
378 return fmt.Errorf("status %s", resp.Status)
380 diag.debugf("ok, status %s", resp.Status)
381 err = client.RequestAndDecodeContext(ctx, &collection, "GET", "arvados/v1/collections/"+collection.UUID, nil, nil)
383 return fmt.Errorf("get updated collection: %s", err)
385 diag.debugf("ok, pdh %s", collection.PortableDataHash)
389 davurl := cluster.Services.WebDAV.ExternalURL
390 diag.dotest(110, fmt.Sprintf("checking WebDAV ExternalURL wildcard (%s)", davurl), func() error {
391 if davurl.Host == "" {
392 return fmt.Errorf("host missing - content previews will not work")
394 if !strings.HasPrefix(davurl.Host, "*--") && !strings.HasPrefix(davurl.Host, "*.") && !cluster.Collections.TrustAllContent {
395 diag.warnf("WebDAV ExternalURL has no leading wildcard and TrustAllContent==false - content previews will not work")
400 for i, trial := range []struct {
405 {false, http.StatusNotFound, strings.Replace(davurl.String(), "*", "d41d8cd98f00b204e9800998ecf8427e-0", 1) + "foo"},
406 {false, http.StatusNotFound, strings.Replace(davurl.String(), "*", "d41d8cd98f00b204e9800998ecf8427e-0", 1) + "testfile"},
407 {false, http.StatusNotFound, cluster.Services.WebDAVDownload.ExternalURL.String() + "c=d41d8cd98f00b204e9800998ecf8427e+0/_/foo"},
408 {false, http.StatusNotFound, cluster.Services.WebDAVDownload.ExternalURL.String() + "c=d41d8cd98f00b204e9800998ecf8427e+0/_/testfile"},
409 {true, http.StatusOK, strings.Replace(davurl.String(), "*", strings.Replace(collection.PortableDataHash, "+", "-", -1), 1) + "testfile"},
410 {true, http.StatusOK, cluster.Services.WebDAVDownload.ExternalURL.String() + "c=" + collection.UUID + "/_/testfile"},
412 diag.dotest(120+i, fmt.Sprintf("downloading from webdav (%s)", trial.fileurl), func() error {
413 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
415 if trial.needcoll && collection.UUID == "" {
416 return fmt.Errorf("skipping, no test collection")
418 req, err := http.NewRequestWithContext(ctx, "GET", trial.fileurl, nil)
422 req.Header.Set("Authorization", "Bearer "+client.AuthToken)
423 resp, err := http.DefaultClient.Do(req)
427 defer resp.Body.Close()
428 body, err := ioutil.ReadAll(resp.Body)
430 return fmt.Errorf("reading response: %s", err)
432 if resp.StatusCode != trial.status {
433 return fmt.Errorf("unexpected response status: %s", resp.Status)
435 if trial.status == http.StatusOK && string(body) != "testfiledata" {
436 return fmt.Errorf("unexpected response content: %q", body)
442 var vm arvados.VirtualMachine
443 diag.dotest(130, "getting list of virtual machines", func() error {
444 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
446 var vmlist arvados.VirtualMachineList
447 err := client.RequestAndDecodeContext(ctx, &vmlist, "GET", "arvados/v1/virtual_machines", nil, arvados.ListOptions{Limit: 999999})
451 if len(vmlist.Items) < 1 {
452 return fmt.Errorf("no VMs found")
458 diag.dotest(140, "getting workbench1 webshell page", func() error {
459 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
462 return fmt.Errorf("skipping, no vm available")
464 webshelltermurl := cluster.Services.Workbench1.ExternalURL.String() + "virtual_machines/" + vm.UUID + "/webshell/testusername"
465 diag.debugf("url %s", webshelltermurl)
466 req, err := http.NewRequestWithContext(ctx, "GET", webshelltermurl, nil)
470 req.Header.Set("Authorization", "Bearer "+client.AuthToken)
471 resp, err := http.DefaultClient.Do(req)
475 defer resp.Body.Close()
476 body, err := ioutil.ReadAll(resp.Body)
478 return fmt.Errorf("reading response: %s", err)
480 if resp.StatusCode != http.StatusOK {
481 return fmt.Errorf("unexpected response status: %s %q", resp.Status, body)
486 diag.dotest(150, "connecting to webshell service", func() error {
487 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
490 return fmt.Errorf("skipping, no vm available")
492 u := cluster.Services.WebShell.ExternalURL
493 webshellurl := u.String() + vm.Hostname + "?"
494 if strings.HasPrefix(u.Host, "*") {
495 u.Host = vm.Hostname + u.Host[1:]
496 webshellurl = u.String() + "?"
498 diag.debugf("url %s", webshellurl)
499 req, err := http.NewRequestWithContext(ctx, "POST", webshellurl, bytes.NewBufferString(url.Values{
502 "session": {"xyzzy"},
503 "rooturl": {webshellurl},
508 req.Header.Set("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
509 resp, err := http.DefaultClient.Do(req)
513 defer resp.Body.Close()
514 diag.debugf("response status %s", resp.Status)
515 body, err := ioutil.ReadAll(resp.Body)
517 return fmt.Errorf("reading response: %s", err)
519 diag.debugf("response body %q", body)
520 // We don't speak the protocol, so we get a 400 error
521 // from the webshell server even if everything is
522 // OK. Anything else (404, 502, ???) indicates a
524 if resp.StatusCode != http.StatusBadRequest {
525 return fmt.Errorf("unexpected response status: %s, %q", resp.Status, body)
530 diag.dotest(160, "running a container", func() error {
531 if diag.priority < 1 {
532 diag.debugf("skipping, caller requested priority<1 (%d)", diag.priority)
536 var cr arvados.ContainerRequest
537 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(diag.timeout))
540 timestamp := time.Now().Format(time.RFC3339)
541 err := client.RequestAndDecodeContext(ctx, &cr, "POST", "arvados/v1/container_requests", nil, map[string]interface{}{"container_request": map[string]interface{}{
542 "owner_uuid": project.UUID,
543 "name": fmt.Sprintf("diagnostics container request %s", timestamp),
544 "container_image": "arvados/jobs",
545 "command": []string{"echo", timestamp},
546 "use_existing": false,
547 "output_path": "/mnt/output",
548 "output_name": fmt.Sprintf("diagnostics output %s", timestamp),
549 "priority": diag.priority,
550 "state": arvados.ContainerRequestStateCommitted,
551 "mounts": map[string]map[string]interface{}{
553 "kind": "collection",
557 "runtime_constraints": arvados.RuntimeConstraints{
560 KeepCacheRAM: 1 << 26,
566 diag.debugf("container request uuid = %s", cr.UUID)
567 diag.debugf("container uuid = %s", cr.ContainerUUID)
569 timeout := 10 * time.Minute
570 diag.infof("container request submitted, waiting up to %v for container to run", arvados.Duration(timeout))
571 ctx, cancel = context.WithDeadline(context.Background(), time.Now().Add(timeout))
574 var c arvados.Container
575 for ; cr.State != arvados.ContainerRequestStateFinal; time.Sleep(2 * time.Second) {
576 ctx, cancel := context.WithDeadline(ctx, time.Now().Add(diag.timeout))
579 crStateWas := cr.State
580 err := client.RequestAndDecodeContext(ctx, &cr, "GET", "arvados/v1/container_requests/"+cr.UUID, nil, nil)
584 if cr.State != crStateWas {
585 diag.debugf("container request state = %s", cr.State)
589 err = client.RequestAndDecodeContext(ctx, &c, "GET", "arvados/v1/containers/"+cr.ContainerUUID, nil, nil)
593 if c.State != cStateWas {
594 diag.debugf("container state = %s", c.State)
598 if c.State != arvados.ContainerStateComplete {
599 return fmt.Errorf("container request %s is final but container %s did not complete: container state = %q", cr.UUID, cr.ContainerUUID, c.State)
600 } else if c.ExitCode != 0 {
601 return fmt.Errorf("container exited %d", c.ExitCode)