16306: Fixup nginx in arvados-boot production mode.
[arvados.git] / lib / boot / supervisor.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package boot
6
7 import (
8         "bytes"
9         "context"
10         "crypto/rand"
11         "encoding/json"
12         "errors"
13         "fmt"
14         "io"
15         "io/ioutil"
16         "net"
17         "net/url"
18         "os"
19         "os/exec"
20         "os/signal"
21         "os/user"
22         "path/filepath"
23         "reflect"
24         "strings"
25         "sync"
26         "syscall"
27         "time"
28
29         "git.arvados.org/arvados.git/lib/config"
30         "git.arvados.org/arvados.git/lib/service"
31         "git.arvados.org/arvados.git/sdk/go/arvados"
32         "git.arvados.org/arvados.git/sdk/go/ctxlog"
33         "git.arvados.org/arvados.git/sdk/go/health"
34         "github.com/fsnotify/fsnotify"
35         "github.com/sirupsen/logrus"
36 )
37
38 type Supervisor struct {
39         SourcePath           string // e.g., /home/username/src/arvados
40         SourceVersion        string // e.g., acbd1324...
41         ClusterType          string // e.g., production
42         ListenHost           string // e.g., localhost
43         ControllerAddr       string // e.g., 127.0.0.1:8000
44         OwnTemporaryDatabase bool
45         Stderr               io.Writer
46
47         logger  logrus.FieldLogger
48         cluster *arvados.Cluster
49
50         ctx           context.Context
51         cancel        context.CancelFunc
52         done          chan struct{} // closed when child procs/services have shut down
53         err           error         // error that caused shutdown (valid when done is closed)
54         healthChecker *health.Aggregator
55         tasksReady    map[string]chan bool
56         waitShutdown  sync.WaitGroup
57
58         bindir     string
59         tempdir    string
60         wwwtempdir string
61         configfile string
62         environ    []string // for child processes
63 }
64
65 func (super *Supervisor) Start(ctx context.Context, cfg *arvados.Config, cfgPath string) {
66         super.ctx, super.cancel = context.WithCancel(ctx)
67         super.done = make(chan struct{})
68
69         go func() {
70                 defer close(super.done)
71
72                 sigch := make(chan os.Signal)
73                 signal.Notify(sigch, syscall.SIGINT, syscall.SIGTERM)
74                 defer signal.Stop(sigch)
75                 go func() {
76                         for sig := range sigch {
77                                 super.logger.WithField("signal", sig).Info("caught signal")
78                                 if super.err == nil {
79                                         super.err = fmt.Errorf("caught signal %s", sig)
80                                 }
81                                 super.cancel()
82                         }
83                 }()
84
85                 hupch := make(chan os.Signal)
86                 signal.Notify(hupch, syscall.SIGHUP)
87                 defer signal.Stop(hupch)
88                 go func() {
89                         for sig := range hupch {
90                                 super.logger.WithField("signal", sig).Info("caught signal")
91                                 if super.err == nil {
92                                         super.err = errNeedConfigReload
93                                 }
94                                 super.cancel()
95                         }
96                 }()
97
98                 if cfgPath != "" && cfgPath != "-" && cfg.AutoReloadConfig {
99                         go watchConfig(super.ctx, super.logger, cfgPath, copyConfig(cfg), func() {
100                                 if super.err == nil {
101                                         super.err = errNeedConfigReload
102                                 }
103                                 super.cancel()
104                         })
105                 }
106
107                 err := super.run(cfg)
108                 if err != nil {
109                         super.logger.WithError(err).Warn("supervisor shut down")
110                         if super.err == nil {
111                                 super.err = err
112                         }
113                 }
114         }()
115 }
116
117 func (super *Supervisor) Wait() error {
118         <-super.done
119         return super.err
120 }
121
122 func (super *Supervisor) run(cfg *arvados.Config) error {
123         defer super.cancel()
124
125         cwd, err := os.Getwd()
126         if err != nil {
127                 return err
128         }
129         if !strings.HasPrefix(super.SourcePath, "/") {
130                 super.SourcePath = filepath.Join(cwd, super.SourcePath)
131         }
132         super.SourcePath, err = filepath.EvalSymlinks(super.SourcePath)
133         if err != nil {
134                 return err
135         }
136
137         // Choose bin and temp dirs: /var/lib/arvados/... in
138         // production, transient tempdir otherwise.
139         if super.ClusterType == "production" {
140                 // These dirs have already been created by
141                 // "arvados-server install" (or by extracting a
142                 // package).
143                 super.tempdir = "/var/lib/arvados/tmp"
144                 super.wwwtempdir = "/var/lib/arvados/wwwtmp"
145                 super.bindir = "/var/lib/arvados/bin"
146         } else {
147                 super.tempdir, err = ioutil.TempDir("", "arvados-server-boot-")
148                 if err != nil {
149                         return err
150                 }
151                 defer os.RemoveAll(super.tempdir)
152                 super.wwwtempdir = super.tempdir
153                 super.bindir = filepath.Join(super.tempdir, "bin")
154                 if err := os.Mkdir(super.bindir, 0755); err != nil {
155                         return err
156                 }
157         }
158
159         // Fill in any missing config keys, and write the resulting
160         // config in the temp dir for child services to use.
161         err = super.autofillConfig(cfg)
162         if err != nil {
163                 return err
164         }
165         conffile, err := os.OpenFile(filepath.Join(super.tempdir, "config.yml"), os.O_CREATE|os.O_WRONLY, 0644)
166         if err != nil {
167                 return err
168         }
169         defer conffile.Close()
170         err = json.NewEncoder(conffile).Encode(cfg)
171         if err != nil {
172                 return err
173         }
174         err = conffile.Close()
175         if err != nil {
176                 return err
177         }
178         super.configfile = conffile.Name()
179
180         super.environ = os.Environ()
181         super.cleanEnv([]string{"ARVADOS_"})
182         super.setEnv("ARVADOS_CONFIG", super.configfile)
183         super.setEnv("RAILS_ENV", super.ClusterType)
184         super.setEnv("TMPDIR", super.tempdir)
185         super.prependEnv("PATH", "/var/lib/arvados/bin:")
186         if super.ClusterType != "production" {
187                 super.prependEnv("PATH", super.tempdir+"/bin:")
188         }
189
190         super.cluster, err = cfg.GetCluster("")
191         if err != nil {
192                 return err
193         }
194         // Now that we have the config, replace the bootstrap logger
195         // with a new one according to the logging config.
196         loglevel := super.cluster.SystemLogs.LogLevel
197         if s := os.Getenv("ARVADOS_DEBUG"); s != "" && s != "0" {
198                 loglevel = "debug"
199         }
200         super.logger = ctxlog.New(super.Stderr, super.cluster.SystemLogs.Format, loglevel).WithFields(logrus.Fields{
201                 "PID": os.Getpid(),
202         })
203
204         if super.SourceVersion == "" && super.ClusterType == "production" {
205                 // don't need SourceVersion
206         } else if super.SourceVersion == "" {
207                 // Find current source tree version.
208                 var buf bytes.Buffer
209                 err = super.RunProgram(super.ctx, ".", &buf, nil, "git", "diff", "--shortstat")
210                 if err != nil {
211                         return err
212                 }
213                 dirty := buf.Len() > 0
214                 buf.Reset()
215                 err = super.RunProgram(super.ctx, ".", &buf, nil, "git", "log", "-n1", "--format=%H")
216                 if err != nil {
217                         return err
218                 }
219                 super.SourceVersion = strings.TrimSpace(buf.String())
220                 if dirty {
221                         super.SourceVersion += "+uncommitted"
222                 }
223         } else {
224                 return errors.New("specifying a version to run is not yet supported")
225         }
226
227         _, err = super.installGoProgram(super.ctx, "cmd/arvados-server")
228         if err != nil {
229                 return err
230         }
231         err = super.setupRubyEnv()
232         if err != nil {
233                 return err
234         }
235
236         tasks := []supervisedTask{
237                 createCertificates{},
238                 runPostgreSQL{},
239                 runNginx{},
240                 runServiceCommand{name: "controller", svc: super.cluster.Services.Controller, depends: []supervisedTask{runPostgreSQL{}}},
241                 runGoProgram{src: "services/arv-git-httpd", svc: super.cluster.Services.GitHTTP},
242                 runGoProgram{src: "services/health", svc: super.cluster.Services.Health},
243                 runGoProgram{src: "services/keepproxy", svc: super.cluster.Services.Keepproxy, depends: []supervisedTask{runPassenger{src: "services/api"}}},
244                 runGoProgram{src: "services/keepstore", svc: super.cluster.Services.Keepstore},
245                 runGoProgram{src: "services/keep-web", svc: super.cluster.Services.WebDAV},
246                 runServiceCommand{name: "ws", svc: super.cluster.Services.Websocket, depends: []supervisedTask{runPostgreSQL{}}},
247                 installPassenger{src: "services/api"},
248                 runPassenger{src: "services/api", varlibdir: "railsapi", svc: super.cluster.Services.RailsAPI, depends: []supervisedTask{createCertificates{}, runPostgreSQL{}, installPassenger{src: "services/api"}}},
249                 installPassenger{src: "apps/workbench", depends: []supervisedTask{installPassenger{src: "services/api"}}}, // dependency ensures workbench doesn't delay api startup
250                 runPassenger{src: "apps/workbench", varlibdir: "workbench1", svc: super.cluster.Services.Workbench1, depends: []supervisedTask{installPassenger{src: "apps/workbench"}}},
251                 seedDatabase{},
252         }
253         if super.ClusterType != "test" {
254                 tasks = append(tasks,
255                         runServiceCommand{name: "dispatch-cloud", svc: super.cluster.Services.DispatchCloud},
256                         runGoProgram{src: "services/keep-balance", svc: super.cluster.Services.Keepbalance},
257                 )
258         }
259         super.tasksReady = map[string]chan bool{}
260         for _, task := range tasks {
261                 super.tasksReady[task.String()] = make(chan bool)
262         }
263         for _, task := range tasks {
264                 task := task
265                 fail := func(err error) {
266                         if super.ctx.Err() != nil {
267                                 return
268                         }
269                         super.cancel()
270                         super.logger.WithField("task", task.String()).WithError(err).Error("task failed")
271                 }
272                 go func() {
273                         super.logger.WithField("task", task.String()).Info("starting")
274                         err := task.Run(super.ctx, fail, super)
275                         if err != nil {
276                                 fail(err)
277                                 return
278                         }
279                         close(super.tasksReady[task.String()])
280                 }()
281         }
282         err = super.wait(super.ctx, tasks...)
283         if err != nil {
284                 return err
285         }
286         super.logger.Info("all startup tasks are complete; starting health checks")
287         super.healthChecker = &health.Aggregator{Cluster: super.cluster}
288         <-super.ctx.Done()
289         super.logger.Info("shutting down")
290         super.waitShutdown.Wait()
291         return super.ctx.Err()
292 }
293
294 func (super *Supervisor) wait(ctx context.Context, tasks ...supervisedTask) error {
295         for _, task := range tasks {
296                 ch, ok := super.tasksReady[task.String()]
297                 if !ok {
298                         return fmt.Errorf("no such task: %s", task)
299                 }
300                 super.logger.WithField("task", task.String()).Info("waiting")
301                 select {
302                 case <-ch:
303                         super.logger.WithField("task", task.String()).Info("ready")
304                 case <-ctx.Done():
305                         super.logger.WithField("task", task.String()).Info("task was never ready")
306                         return ctx.Err()
307                 }
308         }
309         return nil
310 }
311
312 func (super *Supervisor) Stop() {
313         super.cancel()
314         <-super.done
315 }
316
317 func (super *Supervisor) WaitReady() (*arvados.URL, bool) {
318         ticker := time.NewTicker(time.Second)
319         defer ticker.Stop()
320         for waiting := "all"; waiting != ""; {
321                 select {
322                 case <-ticker.C:
323                 case <-super.ctx.Done():
324                         return nil, false
325                 }
326                 if super.healthChecker == nil {
327                         // not set up yet
328                         continue
329                 }
330                 resp := super.healthChecker.ClusterHealth()
331                 // The overall health check (resp.Health=="OK") might
332                 // never pass due to missing components (like
333                 // arvados-dispatch-cloud in a test cluster), so
334                 // instead we wait for all configured components to
335                 // pass.
336                 waiting = ""
337                 for target, check := range resp.Checks {
338                         if check.Health != "OK" {
339                                 waiting += " " + target
340                         }
341                 }
342                 if waiting != "" {
343                         super.logger.WithField("targets", waiting[1:]).Info("waiting")
344                 }
345         }
346         u := super.cluster.Services.Controller.ExternalURL
347         return &u, true
348 }
349
350 func (super *Supervisor) prependEnv(key, prepend string) {
351         for i, s := range super.environ {
352                 if strings.HasPrefix(s, key+"=") {
353                         super.environ[i] = key + "=" + prepend + s[len(key)+1:]
354                         return
355                 }
356         }
357         super.environ = append(super.environ, key+"="+prepend)
358 }
359
360 func (super *Supervisor) cleanEnv(prefixes []string) {
361         var cleaned []string
362         for _, s := range super.environ {
363                 drop := false
364                 for _, p := range prefixes {
365                         if strings.HasPrefix(s, p) {
366                                 drop = true
367                                 break
368                         }
369                 }
370                 if !drop {
371                         cleaned = append(cleaned, s)
372                 }
373         }
374         super.environ = cleaned
375 }
376
377 func (super *Supervisor) setEnv(key, val string) {
378         for i, s := range super.environ {
379                 if strings.HasPrefix(s, key+"=") {
380                         super.environ[i] = key + "=" + val
381                         return
382                 }
383         }
384         super.environ = append(super.environ, key+"="+val)
385 }
386
387 // Remove all but the first occurrence of each env var.
388 func dedupEnv(in []string) []string {
389         saw := map[string]bool{}
390         var out []string
391         for _, kv := range in {
392                 if split := strings.Index(kv, "="); split < 1 {
393                         panic("invalid environment var: " + kv)
394                 } else if saw[kv[:split]] {
395                         continue
396                 } else {
397                         saw[kv[:split]] = true
398                         out = append(out, kv)
399                 }
400         }
401         return out
402 }
403
404 func (super *Supervisor) installGoProgram(ctx context.Context, srcpath string) (string, error) {
405         _, basename := filepath.Split(srcpath)
406         binfile := filepath.Join(super.bindir, basename)
407         if super.ClusterType == "production" {
408                 return binfile, nil
409         }
410         err := super.RunProgram(ctx, filepath.Join(super.SourcePath, srcpath), nil, []string{"GOBIN=" + super.bindir}, "go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+super.SourceVersion+" -X main.version="+super.SourceVersion)
411         return binfile, err
412 }
413
414 func (super *Supervisor) usingRVM() bool {
415         return os.Getenv("rvm_path") != ""
416 }
417
418 func (super *Supervisor) setupRubyEnv() error {
419         if !super.usingRVM() {
420                 // (If rvm is in use, assume the caller has everything
421                 // set up as desired)
422                 super.cleanEnv([]string{
423                         "GEM_HOME=",
424                         "GEM_PATH=",
425                 })
426                 gem := "gem"
427                 if _, err := os.Stat("/var/lib/arvados/bin/gem"); err == nil || super.ClusterType == "production" {
428                         gem = "/var/lib/arvados/bin/gem"
429                 }
430                 cmd := exec.Command(gem, "env", "gempath")
431                 if super.ClusterType == "production" {
432                         cmd.Args = append([]string{"sudo", "-u", "www-data", "-E", "HOME=/var/www"}, cmd.Args...)
433                         path, err := exec.LookPath("sudo")
434                         if err != nil {
435                                 return fmt.Errorf("LookPath(\"sudo\"): %w", err)
436                         }
437                         cmd.Path = path
438                 }
439                 cmd.Stderr = super.Stderr
440                 cmd.Env = super.environ
441                 buf, err := cmd.Output() // /var/lib/arvados/.gem/ruby/2.5.0/bin:...
442                 if err != nil || len(buf) == 0 {
443                         return fmt.Errorf("gem env gempath: %v", err)
444                 }
445                 gempath := string(bytes.Split(buf, []byte{':'})[0])
446                 super.prependEnv("PATH", gempath+"/bin:")
447                 super.setEnv("GEM_HOME", gempath)
448                 super.setEnv("GEM_PATH", gempath)
449         }
450         // Passenger install doesn't work unless $HOME is ~user
451         u, err := user.Current()
452         if err != nil {
453                 return err
454         }
455         super.setEnv("HOME", u.HomeDir)
456         return nil
457 }
458
459 func (super *Supervisor) lookPath(prog string) string {
460         for _, val := range super.environ {
461                 if strings.HasPrefix(val, "PATH=") {
462                         for _, dir := range filepath.SplitList(val[5:]) {
463                                 path := filepath.Join(dir, prog)
464                                 if fi, err := os.Stat(path); err == nil && fi.Mode()&0111 != 0 {
465                                         return path
466                                 }
467                         }
468                 }
469         }
470         return prog
471 }
472
473 // Run prog with args, using dir as working directory. If ctx is
474 // cancelled while the child is running, RunProgram terminates the
475 // child, waits for it to exit, then returns.
476 //
477 // Child's environment will have our env vars, plus any given in env.
478 //
479 // Child's stdout will be written to output if non-nil, otherwise the
480 // boot command's stderr.
481 func (super *Supervisor) RunProgram(ctx context.Context, dir string, output io.Writer, env []string, prog string, args ...string) error {
482         cmdline := fmt.Sprintf("%s", append([]string{prog}, args...))
483         super.logger.WithField("command", cmdline).WithField("dir", dir).Info("executing")
484
485         logprefix := prog
486         {
487                 if logprefix == "setuidgid" && len(args) >= 3 {
488                         logprefix = args[2]
489                 }
490                 innerargs := args
491                 if logprefix == "sudo" {
492                         for i := 0; i < len(args); i++ {
493                                 if args[i] == "-u" {
494                                         i++
495                                 } else if args[i] == "-E" || strings.Contains(args[i], "=") {
496                                 } else {
497                                         logprefix = args[i]
498                                         innerargs = args[i+1:]
499                                         break
500                                 }
501                         }
502                 }
503                 logprefix = strings.TrimPrefix(logprefix, "/var/lib/arvados/bin/")
504                 logprefix = strings.TrimPrefix(logprefix, super.tempdir+"/bin/")
505                 if logprefix == "bundle" && len(innerargs) > 2 && innerargs[0] == "exec" {
506                         _, dirbase := filepath.Split(dir)
507                         logprefix = innerargs[1] + "@" + dirbase
508                 } else if logprefix == "arvados-server" && len(args) > 1 {
509                         logprefix = args[0]
510                 }
511                 if !strings.HasPrefix(dir, "/") {
512                         logprefix = dir + ": " + logprefix
513                 }
514         }
515
516         cmd := exec.Command(super.lookPath(prog), args...)
517         stdout, err := cmd.StdoutPipe()
518         if err != nil {
519                 return err
520         }
521         stderr, err := cmd.StderrPipe()
522         if err != nil {
523                 return err
524         }
525         logwriter := &service.LogPrefixer{Writer: super.Stderr, Prefix: []byte("[" + logprefix + "] ")}
526         var copiers sync.WaitGroup
527         copiers.Add(1)
528         go func() {
529                 io.Copy(logwriter, stderr)
530                 copiers.Done()
531         }()
532         copiers.Add(1)
533         go func() {
534                 if output == nil {
535                         io.Copy(logwriter, stdout)
536                 } else {
537                         io.Copy(output, stdout)
538                 }
539                 copiers.Done()
540         }()
541
542         if strings.HasPrefix(dir, "/") {
543                 cmd.Dir = dir
544         } else {
545                 cmd.Dir = filepath.Join(super.SourcePath, dir)
546         }
547         env = append([]string(nil), env...)
548         env = append(env, super.environ...)
549         cmd.Env = dedupEnv(env)
550
551         exited := false
552         defer func() { exited = true }()
553         go func() {
554                 <-ctx.Done()
555                 log := ctxlog.FromContext(ctx).WithFields(logrus.Fields{"dir": dir, "cmdline": cmdline})
556                 for !exited {
557                         if cmd.Process == nil {
558                                 log.Debug("waiting for child process to start")
559                                 time.Sleep(time.Second / 2)
560                         } else {
561                                 log.WithField("PID", cmd.Process.Pid).Debug("sending SIGTERM")
562                                 cmd.Process.Signal(syscall.SIGTERM)
563                                 time.Sleep(5 * time.Second)
564                                 if !exited {
565                                         stdout.Close()
566                                         stderr.Close()
567                                         log.WithField("PID", cmd.Process.Pid).Warn("still waiting for child process to exit 5s after SIGTERM")
568                                 }
569                         }
570                 }
571         }()
572
573         err = cmd.Start()
574         if err != nil {
575                 return err
576         }
577         copiers.Wait()
578         err = cmd.Wait()
579         if ctx.Err() != nil {
580                 // Return "context canceled", instead of the "killed"
581                 // error that was probably caused by the context being
582                 // canceled.
583                 return ctx.Err()
584         } else if err != nil {
585                 return fmt.Errorf("%s: error: %v", cmdline, err)
586         }
587         return nil
588 }
589
590 func (super *Supervisor) autofillConfig(cfg *arvados.Config) error {
591         cluster, err := cfg.GetCluster("")
592         if err != nil {
593                 return err
594         }
595         usedPort := map[string]bool{}
596         nextPort := func(host string) string {
597                 for {
598                         port, err := availablePort(host)
599                         if err != nil {
600                                 panic(err)
601                         }
602                         if usedPort[port] {
603                                 continue
604                         }
605                         usedPort[port] = true
606                         return port
607                 }
608         }
609         if cluster.Services.Controller.ExternalURL.Host == "" {
610                 h, p, err := net.SplitHostPort(super.ControllerAddr)
611                 if err != nil {
612                         return err
613                 }
614                 if h == "" {
615                         h = super.ListenHost
616                 }
617                 if p == "0" {
618                         p = nextPort(h)
619                 }
620                 cluster.Services.Controller.ExternalURL = arvados.URL{Scheme: "https", Host: net.JoinHostPort(h, p), Path: "/"}
621         }
622         for _, svc := range []*arvados.Service{
623                 &cluster.Services.Controller,
624                 &cluster.Services.DispatchCloud,
625                 &cluster.Services.GitHTTP,
626                 &cluster.Services.Health,
627                 &cluster.Services.Keepproxy,
628                 &cluster.Services.Keepstore,
629                 &cluster.Services.RailsAPI,
630                 &cluster.Services.WebDAV,
631                 &cluster.Services.WebDAVDownload,
632                 &cluster.Services.Websocket,
633                 &cluster.Services.Workbench1,
634         } {
635                 if svc == &cluster.Services.DispatchCloud && super.ClusterType == "test" {
636                         continue
637                 }
638                 if svc.ExternalURL.Host == "" {
639                         if svc == &cluster.Services.Controller ||
640                                 svc == &cluster.Services.GitHTTP ||
641                                 svc == &cluster.Services.Health ||
642                                 svc == &cluster.Services.Keepproxy ||
643                                 svc == &cluster.Services.WebDAV ||
644                                 svc == &cluster.Services.WebDAVDownload ||
645                                 svc == &cluster.Services.Workbench1 {
646                                 svc.ExternalURL = arvados.URL{Scheme: "https", Host: fmt.Sprintf("%s:%s", super.ListenHost, nextPort(super.ListenHost)), Path: "/"}
647                         } else if svc == &cluster.Services.Websocket {
648                                 svc.ExternalURL = arvados.URL{Scheme: "wss", Host: fmt.Sprintf("%s:%s", super.ListenHost, nextPort(super.ListenHost)), Path: "/websocket"}
649                         }
650                 }
651                 if len(svc.InternalURLs) == 0 {
652                         svc.InternalURLs = map[arvados.URL]arvados.ServiceInstance{
653                                 arvados.URL{Scheme: "http", Host: fmt.Sprintf("%s:%s", super.ListenHost, nextPort(super.ListenHost)), Path: "/"}: arvados.ServiceInstance{},
654                         }
655                 }
656         }
657         if cluster.SystemRootToken == "" {
658                 cluster.SystemRootToken = randomHexString(64)
659         }
660         if cluster.ManagementToken == "" {
661                 cluster.ManagementToken = randomHexString(64)
662         }
663         if cluster.API.RailsSessionSecretToken == "" {
664                 cluster.API.RailsSessionSecretToken = randomHexString(64)
665         }
666         if cluster.Collections.BlobSigningKey == "" {
667                 cluster.Collections.BlobSigningKey = randomHexString(64)
668         }
669         if super.ClusterType != "production" && cluster.Containers.DispatchPrivateKey == "" {
670                 buf, err := ioutil.ReadFile(filepath.Join(super.SourcePath, "lib", "dispatchcloud", "test", "sshkey_dispatch"))
671                 if err != nil {
672                         return err
673                 }
674                 cluster.Containers.DispatchPrivateKey = string(buf)
675         }
676         if super.ClusterType != "production" {
677                 cluster.TLS.Insecure = true
678         }
679         if super.ClusterType == "test" {
680                 // Add a second keepstore process.
681                 cluster.Services.Keepstore.InternalURLs[arvados.URL{Scheme: "http", Host: fmt.Sprintf("%s:%s", super.ListenHost, nextPort(super.ListenHost)), Path: "/"}] = arvados.ServiceInstance{}
682
683                 // Create a directory-backed volume for each keepstore
684                 // process.
685                 cluster.Volumes = map[string]arvados.Volume{}
686                 for url := range cluster.Services.Keepstore.InternalURLs {
687                         volnum := len(cluster.Volumes)
688                         datadir := fmt.Sprintf("%s/keep%d.data", super.tempdir, volnum)
689                         if _, err = os.Stat(datadir + "/."); err == nil {
690                         } else if !os.IsNotExist(err) {
691                                 return err
692                         } else if err = os.Mkdir(datadir, 0755); err != nil {
693                                 return err
694                         }
695                         cluster.Volumes[fmt.Sprintf(cluster.ClusterID+"-nyw5e-%015d", volnum)] = arvados.Volume{
696                                 Driver:           "Directory",
697                                 DriverParameters: json.RawMessage(fmt.Sprintf(`{"Root":%q}`, datadir)),
698                                 AccessViaHosts: map[arvados.URL]arvados.VolumeAccess{
699                                         url: {},
700                                 },
701                         }
702                 }
703         }
704         if super.OwnTemporaryDatabase {
705                 cluster.PostgreSQL.Connection = arvados.PostgreSQLConnection{
706                         "client_encoding": "utf8",
707                         "host":            "localhost",
708                         "port":            nextPort(super.ListenHost),
709                         "dbname":          "arvados_test",
710                         "user":            "arvados",
711                         "password":        "insecure_arvados_test",
712                 }
713         }
714
715         cfg.Clusters[cluster.ClusterID] = *cluster
716         return nil
717 }
718
719 func addrIsLocal(addr string) (bool, error) {
720         return true, nil
721         listener, err := net.Listen("tcp", addr)
722         if err == nil {
723                 listener.Close()
724                 return true, nil
725         } else if strings.Contains(err.Error(), "cannot assign requested address") {
726                 return false, nil
727         } else {
728                 return false, err
729         }
730 }
731
732 func randomHexString(chars int) string {
733         b := make([]byte, chars/2)
734         _, err := rand.Read(b)
735         if err != nil {
736                 panic(err)
737         }
738         return fmt.Sprintf("%x", b)
739 }
740
741 func internalPort(svc arvados.Service) (string, error) {
742         if len(svc.InternalURLs) > 1 {
743                 return "", errors.New("internalPort() doesn't work with multiple InternalURLs")
744         }
745         for u := range svc.InternalURLs {
746                 u := url.URL(u)
747                 if p := u.Port(); p != "" {
748                         return p, nil
749                 } else if u.Scheme == "https" || u.Scheme == "ws" {
750                         return "443", nil
751                 } else {
752                         return "80", nil
753                 }
754         }
755         return "", fmt.Errorf("service has no InternalURLs")
756 }
757
758 func externalPort(svc arvados.Service) (string, error) {
759         u := url.URL(svc.ExternalURL)
760         if p := u.Port(); p != "" {
761                 return p, nil
762         } else if u.Scheme == "https" || u.Scheme == "wss" {
763                 return "443", nil
764         } else {
765                 return "80", nil
766         }
767 }
768
769 func availablePort(host string) (string, error) {
770         ln, err := net.Listen("tcp", net.JoinHostPort(host, "0"))
771         if err != nil {
772                 return "", err
773         }
774         defer ln.Close()
775         _, port, err := net.SplitHostPort(ln.Addr().String())
776         if err != nil {
777                 return "", err
778         }
779         return port, nil
780 }
781
782 // Try to connect to addr until it works, then close ch. Give up if
783 // ctx cancels.
784 func waitForConnect(ctx context.Context, addr string) error {
785         dialer := net.Dialer{Timeout: time.Second}
786         for ctx.Err() == nil {
787                 conn, err := dialer.DialContext(ctx, "tcp", addr)
788                 if err != nil {
789                         time.Sleep(time.Second / 10)
790                         continue
791                 }
792                 conn.Close()
793                 return nil
794         }
795         return ctx.Err()
796 }
797
798 func copyConfig(cfg *arvados.Config) *arvados.Config {
799         pr, pw := io.Pipe()
800         go func() {
801                 err := json.NewEncoder(pw).Encode(cfg)
802                 if err != nil {
803                         panic(err)
804                 }
805                 pw.Close()
806         }()
807         cfg2 := new(arvados.Config)
808         err := json.NewDecoder(pr).Decode(cfg2)
809         if err != nil {
810                 panic(err)
811         }
812         return cfg2
813 }
814
815 func watchConfig(ctx context.Context, logger logrus.FieldLogger, cfgPath string, prevcfg *arvados.Config, fn func()) {
816         watcher, err := fsnotify.NewWatcher()
817         if err != nil {
818                 logger.WithError(err).Error("fsnotify setup failed")
819                 return
820         }
821         defer watcher.Close()
822
823         err = watcher.Add(cfgPath)
824         if err != nil {
825                 logger.WithError(err).Error("fsnotify watcher failed")
826                 return
827         }
828
829         for {
830                 select {
831                 case <-ctx.Done():
832                         return
833                 case err, ok := <-watcher.Errors:
834                         if !ok {
835                                 return
836                         }
837                         logger.WithError(err).Warn("fsnotify watcher reported error")
838                 case _, ok := <-watcher.Events:
839                         if !ok {
840                                 return
841                         }
842                         for len(watcher.Events) > 0 {
843                                 <-watcher.Events
844                         }
845                         loader := config.NewLoader(&bytes.Buffer{}, &logrus.Logger{Out: ioutil.Discard})
846                         loader.Path = cfgPath
847                         loader.SkipAPICalls = true
848                         cfg, err := loader.Load()
849                         if err != nil {
850                                 logger.WithError(err).Warn("error reloading config file after change detected; ignoring new config for now")
851                         } else if reflect.DeepEqual(cfg, prevcfg) {
852                                 logger.Debug("config file changed but is still DeepEqual to the existing config")
853                         } else {
854                                 logger.Debug("config changed, notifying supervisor")
855                                 fn()
856                                 prevcfg = cfg
857                         }
858                 }
859         }
860 }