Merge branch '21412-user-profile-bugs'
[arvados.git] / lib / install / deps.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package install
6
7 import (
8         "bufio"
9         "bytes"
10         "context"
11         _ "embed"
12         "errors"
13         "flag"
14         "fmt"
15         "io"
16         "os"
17         "os/exec"
18         "os/user"
19         "path/filepath"
20         "regexp"
21         "runtime"
22         "strconv"
23         "strings"
24         "syscall"
25         "time"
26
27         "git.arvados.org/arvados.git/lib/cmd"
28         "git.arvados.org/arvados.git/sdk/go/ctxlog"
29         "github.com/lib/pq"
30 )
31
32 var Command cmd.Handler = &installCommand{}
33
34 const goversion = "1.20.6"
35
36 const (
37         defaultRubyVersion        = "3.2.2"
38         defaultBundlerVersion     = "2.2.19"
39         defaultSingularityVersion = "3.10.4"
40         pjsversion                = "1.9.8"
41         geckoversion              = "0.24.0"
42         gradleversion             = "5.3.1"
43         defaultNodejsVersion      = "14.21.3"
44         devtestDatabasePassword   = "insecure_arvados_test"
45 )
46
47 //go:embed arvados.service
48 var arvadosServiceFile []byte
49
50 type installCommand struct {
51         ClusterType        string
52         SourcePath         string
53         Commit             string
54         PackageVersion     string
55         RubyVersion        string
56         BundlerVersion     string
57         SingularityVersion string
58         NodejsVersion      string
59         EatMyData          bool
60 }
61
62 func (inst *installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
63         logger := ctxlog.New(stderr, "text", "info")
64         ctx := ctxlog.Context(context.Background(), logger)
65         ctx, cancel := context.WithCancel(ctx)
66         defer cancel()
67
68         var err error
69         defer func() {
70                 if err != nil {
71                         logger.WithError(err).Info("exiting")
72                 }
73         }()
74
75         flags := flag.NewFlagSet(prog, flag.ContinueOnError)
76         flags.SetOutput(stderr)
77         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
78         flags.StringVar(&inst.ClusterType, "type", "production", "cluster `type`: development, test, production, or package")
79         flags.StringVar(&inst.SourcePath, "source", "/arvados", "source tree location (required for -type=package)")
80         flags.StringVar(&inst.Commit, "commit", "", "source commit `hash` to embed (blank means use 'git log' or all-zero placeholder)")
81         flags.StringVar(&inst.PackageVersion, "package-version", "0.0.0", "version string to embed in executable files")
82         flags.StringVar(&inst.RubyVersion, "ruby-version", defaultRubyVersion, "Ruby `version` to install (do not override in production mode)")
83         flags.StringVar(&inst.BundlerVersion, "bundler-version", defaultBundlerVersion, "Bundler `version` to install (do not override in production mode)")
84         flags.StringVar(&inst.SingularityVersion, "singularity-version", defaultSingularityVersion, "Singularity `version` to install (do not override in production mode)")
85         flags.StringVar(&inst.NodejsVersion, "nodejs-version", defaultNodejsVersion, "Nodejs `version` to install (not applicable in production mode)")
86         flags.BoolVar(&inst.EatMyData, "eatmydata", false, "use eatmydata to speed up install")
87
88         if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
89                 return code
90         } else if *versionFlag {
91                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
92         }
93
94         if inst.Commit == "" {
95                 if commit, err := exec.Command("env", "-C", inst.SourcePath, "git", "log", "-n1", "--format=%H").CombinedOutput(); err == nil {
96                         inst.Commit = strings.TrimSpace(string(commit))
97                 } else {
98                         inst.Commit = "0000000000000000000000000000000000000000"
99                 }
100         }
101
102         var dev, test, prod, pkg bool
103         switch inst.ClusterType {
104         case "development":
105                 dev = true
106         case "test":
107                 test = true
108         case "production":
109                 prod = true
110         case "package":
111                 pkg = true
112         default:
113                 err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', 'production', or 'package')", inst.ClusterType)
114                 return 2
115         }
116
117         if prod {
118                 err = errors.New("production install is not yet implemented")
119                 return 1
120         }
121
122         if ok, _ := regexp.MatchString(`^\d\.\d+\.\d+$`, inst.RubyVersion); !ok {
123                 fmt.Fprintf(stderr, "invalid argument %q for -ruby-version\n", inst.RubyVersion)
124                 return 2
125         }
126         if ok, _ := regexp.MatchString(`^\d`, inst.BundlerVersion); !ok {
127                 fmt.Fprintf(stderr, "invalid argument %q for -bundler-version\n", inst.BundlerVersion)
128                 return 2
129         }
130         if ok, _ := regexp.MatchString(`^\d`, inst.SingularityVersion); !ok {
131                 fmt.Fprintf(stderr, "invalid argument %q for -singularity-version\n", inst.SingularityVersion)
132                 return 2
133         }
134         if ok, _ := regexp.MatchString(`^\d`, inst.NodejsVersion); !ok {
135                 fmt.Fprintf(stderr, "invalid argument %q for -nodejs-version\n", inst.NodejsVersion)
136                 return 2
137         }
138
139         osv, err := identifyOS()
140         if err != nil {
141                 return 1
142         }
143
144         listdir, err := os.Open("/var/lib/apt/lists")
145         if err != nil {
146                 logger.Warnf("error while checking whether to run apt-get update: %s", err)
147         } else if names, _ := listdir.Readdirnames(1); len(names) == 0 {
148                 // Special case for a base docker image where the
149                 // package cache has been deleted and all "apt-get
150                 // install" commands will fail unless we fetch repos.
151                 cmd := exec.CommandContext(ctx, "apt-get", "update")
152                 cmd.Stdout = stdout
153                 cmd.Stderr = stderr
154                 err = cmd.Run()
155                 if err != nil {
156                         return 1
157                 }
158         }
159
160         if inst.EatMyData {
161                 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends", "eatmydata")
162                 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
163                 cmd.Stdout = stdout
164                 cmd.Stderr = stderr
165                 err = cmd.Run()
166                 if err != nil {
167                         return 1
168                 }
169         }
170
171         pkgs := prodpkgs(osv)
172
173         if pkg {
174                 pkgs = append(pkgs,
175                         "dpkg-dev",
176                         "eatmydata", // install it for later steps, even if we're not using it now
177                 )
178         }
179
180         if dev || test || pkg {
181                 pkgs = append(pkgs,
182                         "automake",
183                         "bison",
184                         "bsdmainutils",
185                         "build-essential",
186                         "cadaver",
187                         "curl",
188                         "cython3",
189                         "default-jdk-headless",
190                         "default-jre-headless",
191                         "gettext",
192                         "libattr1-dev",
193                         "libffi-dev",
194                         "libfuse-dev",
195                         "libgbm1", // cypress / workbench2 tests
196                         "libgnutls28-dev",
197                         "libpam-dev",
198                         "libpcre3-dev",
199                         "libpq-dev",
200                         "libreadline-dev",
201                         "libssl-dev",
202                         "libxml2-dev",
203                         "libxslt1-dev",
204                         "libyaml-dev",
205                         "linkchecker",
206                         "lsof",
207                         "make",
208                         "net-tools",
209                         "pandoc",
210                         "pkg-config",
211                         "postgresql",
212                         "postgresql-contrib",
213                         "python3-dev",
214                         "python3-venv",
215                         "python3-virtualenv",
216                         "r-base",
217                         "r-cran-testthat",
218                         "r-cran-devtools",
219                         "r-cran-knitr",
220                         "r-cran-markdown",
221                         "r-cran-roxygen2",
222                         "r-cran-xml",
223                         "rsync",
224                         "sudo",
225                         "uuid-dev",
226                         "wget",
227                         "xvfb",
228                         "zlib1g-dev", // services/api
229                 )
230                 if test {
231                         if osv.Debian && osv.Major <= 10 {
232                                 pkgs = append(pkgs, "iceweasel")
233                         } else if osv.Debian && osv.Major >= 11 {
234                                 pkgs = append(pkgs, "firefox-esr")
235                         } else {
236                                 pkgs = append(pkgs, "firefox")
237                         }
238                 }
239                 if dev || test {
240                         pkgs = append(pkgs,
241                                 "libglib2.0-dev", // singularity (conmon)
242                                 "libseccomp-dev", // singularity (seccomp)
243                                 "squashfs-tools", // singularity
244                                 "gnupg")          // docker install recipe
245                 }
246                 switch {
247                 case osv.Debian && osv.Major >= 10,
248                         osv.Ubuntu && osv.Major >= 22:
249                         pkgs = append(pkgs, "g++", "libcurl4", "libcurl4-openssl-dev")
250                 case osv.Debian || osv.Ubuntu:
251                         pkgs = append(pkgs, "g++", "libcurl3", "libcurl3-openssl-dev")
252                 case osv.RedHat:
253                         pkgs = append(pkgs, "gcc", "gcc-c++", "libcurl-devel", "postgresql-devel")
254                 }
255                 cmd := exec.CommandContext(ctx, "apt-get")
256                 if inst.EatMyData {
257                         cmd = exec.CommandContext(ctx, "eatmydata", "apt-get")
258                 }
259                 cmd.Args = append(cmd.Args, "install", "--yes", "--no-install-recommends")
260                 cmd.Args = append(cmd.Args, pkgs...)
261                 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
262                 cmd.Stdout = stdout
263                 cmd.Stderr = stderr
264                 err = cmd.Run()
265                 if err != nil {
266                         return 1
267                 }
268         }
269
270         if dev || test {
271                 if havedockerversion, err2 := exec.Command("docker", "--version").CombinedOutput(); err2 == nil {
272                         logger.Printf("%s installed, assuming that version is ok", bytes.TrimSuffix(havedockerversion, []byte("\n")))
273                 } else if osv.Debian {
274                         var codename string
275                         switch osv.Major {
276                         case 11:
277                                 codename = "bullseye"
278                         case 12:
279                                 codename = "bookworm"
280                         default:
281                                 err = fmt.Errorf("don't know how to install docker-ce for debian %d", osv.Major)
282                                 return 1
283                         }
284                         err = inst.runBash(`
285 rm -f /usr/share/keyrings/docker-archive-keyring.gpg
286 curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
287 echo 'deb [arch=`+runtime.GOARCH+` signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian/ `+codename+` stable' | \
288     tee /etc/apt/sources.list.d/docker.list
289 apt-get update
290 DEBIAN_FRONTEND=noninteractive apt-get --yes --no-install-recommends install docker-ce
291 `, stdout, stderr)
292                         if err != nil {
293                                 return 1
294                         }
295                 } else {
296                         err = fmt.Errorf("don't know how to install docker for osversion %v", osv)
297                         return 1
298                 }
299
300                 err = inst.runBash(`
301 key=fs.inotify.max_user_watches
302 min=524288
303 if [[ "$(sysctl --values "${key}")" -lt "${min}" ]]; then
304     sysctl "${key}=${min}"
305     # writing sysctl worked, so we should make it permanent
306     echo "${key}=${min}" | tee -a /etc/sysctl.conf
307     sysctl -p
308 fi
309 `, stdout, stderr)
310                 if err != nil {
311                         err = fmt.Errorf("couldn't set fs.inotify.max_user_watches value. (Is this a docker container? Fix this on the docker host by adding fs.inotify.max_user_watches=524288 to /etc/sysctl.conf and running `sysctl -p`)")
312                         return 1
313                 }
314         }
315
316         os.Mkdir("/var/lib/arvados", 0755)
317         os.Mkdir("/var/lib/arvados/tmp", 0700)
318         if prod || pkg {
319                 u, er := user.Lookup("www-data")
320                 if er != nil {
321                         err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
322                         return 1
323                 }
324                 uid, _ := strconv.Atoi(u.Uid)
325                 gid, _ := strconv.Atoi(u.Gid)
326                 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
327                 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
328                 if err != nil {
329                         return 1
330                 }
331         }
332         rubyminorversion := inst.RubyVersion[:strings.LastIndex(inst.RubyVersion, ".")]
333         if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+inst.RubyVersion)) {
334                 logger.Print("ruby " + inst.RubyVersion + " already installed")
335         } else {
336                 err = inst.runBash(`
337 rubyversion="`+inst.RubyVersion+`"
338 rubyminorversion="`+rubyminorversion+`"
339 tmp="$(mktemp -d)"
340 trap 'rm -r "${tmp}"' ERR EXIT
341 wget --progress=dot:giga -O- "https://cache.ruby-lang.org/pub/ruby/$rubyminorversion/ruby-$rubyversion.tar.gz" | tar -C "${tmp}" -xzf -
342 cd "${tmp}/ruby-$rubyversion"
343 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
344 make -j8
345 rm -f /var/lib/arvados/bin/erb
346 make install
347 if [[ "$rubyversion" > "3" ]]; then
348   /var/lib/arvados/bin/gem update --no-document --system 3.4.21
349 fi
350 /var/lib/arvados/bin/gem install bundler --no-document
351 `, stdout, stderr)
352                 if err != nil {
353                         return 1
354                 }
355         }
356
357         if !prod {
358                 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
359                         logger.Print("go " + goversion + " already installed")
360                 } else {
361                         err = inst.runBash(`
362 cd /tmp
363 rm -rf /var/lib/arvados/go/
364 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-`+runtime.GOARCH+`.tar.gz | tar -C /var/lib/arvados -xzf -
365 ln -sfv /var/lib/arvados/go/bin/* /usr/local/bin/
366 `, stdout, stderr)
367                         if err != nil {
368                                 return 1
369                         }
370                 }
371         }
372
373         if !prod && !pkg {
374                 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
375                         logger.Print("gradle " + gradleversion + " already installed")
376                 } else {
377                         err = inst.runBash(`
378 G=`+gradleversion+`
379 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
380 trap "rm ${zip}" ERR
381 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
382 unzip -o -d /var/lib/arvados ${zip}
383 ln -sfv /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
384 rm ${zip}
385 `, stdout, stderr)
386                         if err != nil {
387                                 return 1
388                         }
389                 }
390
391                 if havesingularityversion, err := exec.Command("/var/lib/arvados/bin/singularity", "--version").CombinedOutput(); err == nil && strings.Contains(string(havesingularityversion), inst.SingularityVersion) {
392                         logger.Print("singularity " + inst.SingularityVersion + " already installed")
393                 } else if dev || test {
394                         err = inst.runBash(`
395 S=`+inst.SingularityVersion+`
396 tmp=/var/lib/arvados/tmp/singularity
397 trap "rm -r ${tmp}" ERR EXIT
398 cd /var/lib/arvados/tmp
399 git clone --recurse-submodules https://github.com/sylabs/singularity
400 cd singularity
401 git checkout v${S}
402 ./mconfig --prefix=/var/lib/arvados
403 make -C ./builddir
404 make -C ./builddir install
405 `, stdout, stderr)
406                         if err != nil {
407                                 return 1
408                         }
409                 }
410
411                 err = inst.runBash(`
412 install /usr/bin/nsenter /var/lib/arvados/bin/nsenter
413 setcap "cap_sys_admin+pei cap_sys_chroot+pei" /var/lib/arvados/bin/nsenter
414 `, stdout, stderr)
415                 if err != nil {
416                         return 1
417                 }
418
419                 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
420                 // it's installed, locale -a reports it as
421                 // "en_US.utf8".
422                 wantlocale := "en_US.UTF-8"
423                 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
424                         logger.Print("locale " + wantlocale + " already installed")
425                 } else {
426                         err = inst.runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
427                         if err != nil {
428                                 return 1
429                         }
430                 }
431
432                 var pgc struct {
433                         Version       string
434                         Cluster       string
435                         Port          int
436                         Status        string
437                         Owner         string
438                         DataDirectory string
439                         LogFile       string
440                 }
441                 if pgLsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
442                         err = fmt.Errorf("pg_lsclusters: %s", err2)
443                         return 1
444                 } else if pgclusters := strings.Split(strings.TrimSpace(string(pgLsclusters)), "\n"); len(pgclusters) != 1 {
445                         logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
446                 } else if _, err = fmt.Sscanf(pgclusters[0], "%s %s %d %s %s %s %s", &pgc.Version, &pgc.Cluster, &pgc.Port, &pgc.Status, &pgc.Owner, &pgc.DataDirectory, &pgc.LogFile); err != nil {
447                         err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
448                         return 1
449                 } else if pgc.Status == "online" {
450                         logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
451                 } else {
452                         logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
453                         cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
454                         cmd.Stdout = stdout
455                         cmd.Stderr = stderr
456                         err = cmd.Start()
457                         if err != nil {
458                                 return 1
459                         }
460                         defer func() {
461                                 cmd.Process.Signal(syscall.SIGTERM)
462                                 logger.Info("sent SIGTERM; waiting for postgres to shut down")
463                                 cmd.Wait()
464                         }()
465                         err = waitPostgreSQLReady()
466                         if err != nil {
467                                 return 1
468                         }
469                 }
470
471                 if os.Getpid() == 1 {
472                         // We are the init process (presumably in a
473                         // docker container) so although postgresql is
474                         // installed, it's not running, and initdb
475                         // might never have been run.
476                 }
477
478                 var needcoll []string
479                 // If the en_US.UTF-8 locale wasn't installed when
480                 // postgresql initdb ran, it needs to be added
481                 // explicitly before we can use it in our test suite.
482                 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
483                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-t", "-c", "SELECT 1 FROM pg_catalog.pg_collation WHERE collname='"+collname+"' AND collcollate IN ('en_US.UTF-8', 'en_US.utf8')")
484                         cmd.Dir = "/"
485                         out, err2 := cmd.CombinedOutput()
486                         if err != nil {
487                                 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
488                                 return 1
489                         }
490                         if strings.Contains(string(out), "1") {
491                                 logger.Infof("postgresql supports collation %s", collname)
492                         } else {
493                                 needcoll = append(needcoll, collname)
494                         }
495                 }
496                 if len(needcoll) > 0 && os.Getpid() != 1 {
497                         // In order for the CREATE COLLATION statement
498                         // below to work, the locale must have existed
499                         // when PostgreSQL started up. If we're
500                         // running as init, we must have started
501                         // PostgreSQL ourselves after installing the
502                         // locales. Otherwise, it might need a
503                         // restart, so we attempt to restart it with
504                         // systemd.
505                         if err = inst.runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
506                                 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
507                         } else if err = waitPostgreSQLReady(); err != nil {
508                                 return 1
509                         }
510                 }
511                 for _, collname := range needcoll {
512                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
513                         cmd.Stdout = stdout
514                         cmd.Stderr = stderr
515                         cmd.Dir = "/"
516                         err = cmd.Run()
517                         if err != nil {
518                                 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
519                                 return 1
520                         }
521                 }
522
523                 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
524                 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
525                 cmd.Dir = "/"
526                 if err := cmd.Run(); err == nil {
527                         logger.Print("arvados role exists; superuser privileges added, password updated")
528                 } else {
529                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
530                         cmd.Dir = "/"
531                         cmd.Stdout = stdout
532                         cmd.Stderr = stderr
533                         err = cmd.Run()
534                         if err != nil {
535                                 return 1
536                         }
537                 }
538         }
539
540         var njsArch string
541         switch runtime.GOARCH {
542         case "amd64":
543                 njsArch = "x64"
544         default:
545                 njsArch = runtime.GOARCH
546         }
547
548         if !prod {
549                 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == "v"+inst.NodejsVersion+"\n" {
550                         logger.Print("nodejs " + inst.NodejsVersion + " already installed")
551                 } else {
552                         err = inst.runBash(`
553 NJS=v`+inst.NodejsVersion+`
554 rm -rf /var/lib/arvados/node-*-linux-`+njsArch+`
555 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-`+njsArch+`.tar.xz | sudo tar -C /var/lib/arvados -xJf -
556 ln -sfv /var/lib/arvados/node-${NJS}-linux-`+njsArch+`/bin/{node,npm} /usr/local/bin/
557 `, stdout, stderr)
558                         if err != nil {
559                                 return 1
560                         }
561                 }
562
563                 if haveyarnversion, err := exec.Command("/usr/local/bin/yarn", "--version").CombinedOutput(); err == nil && len(haveyarnversion) > 0 {
564                         logger.Print("yarn " + strings.TrimSpace(string(haveyarnversion)) + " already installed")
565                 } else {
566                         err = inst.runBash(`
567 npm install -g yarn
568 ln -sfv /var/lib/arvados/node-v`+inst.NodejsVersion+`-linux-`+njsArch+`/bin/{yarn,yarnpkg} /usr/local/bin/
569 `, stdout, stderr)
570                         if err != nil {
571                                 return 1
572                         }
573                 }
574         }
575
576         if prod || pkg {
577                 // Install Go programs to /var/lib/arvados/bin/
578                 for _, srcdir := range []string{
579                         "cmd/arvados-client",
580                         "cmd/arvados-server",
581                 } {
582                         fmt.Fprintf(stderr, "building %s...\n", srcdir)
583                         // -buildvcs=false here avoids a fatal "error
584                         // obtaining VCS status" when git refuses to
585                         // run (for example) as root in a docker
586                         // container using a non-root-owned git tree
587                         // mounted from the host -- as in
588                         // "arvados-package build".
589                         cmd := exec.Command("go", "install", "-buildvcs=false",
590                                 "-ldflags", "-s -w"+
591                                         " -X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+
592                                         " -X git.arvados.org/arvados.git/lib/cmd.commit="+inst.Commit)
593                         cmd.Env = append(cmd.Env, os.Environ()...)
594                         cmd.Env = append(cmd.Env, "GOBIN=/var/lib/arvados/bin")
595                         cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
596                         cmd.Stdout = stdout
597                         cmd.Stderr = stderr
598                         err = cmd.Run()
599                         if err != nil {
600                                 return 1
601                         }
602                 }
603
604                 // Copy assets from source tree to /var/lib/arvados/share
605                 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
606                 cmd.Stdout = stdout
607                 cmd.Stderr = stderr
608                 err = cmd.Run()
609                 if err != nil {
610                         return 1
611                 }
612
613                 // Install python SDK and arv-mount in
614                 // /var/lib/arvados/lib/python.
615                 //
616                 // setup.py writes a file in the source directory in
617                 // order to include the version number in the package
618                 // itself.  We don't want to write to the source tree
619                 // (in "arvados-package" context it's mounted
620                 // readonly) so we run setup.py in a temporary copy of
621                 // the source dir.
622                 if err = inst.runBash(`
623 v=/var/lib/arvados/lib/python
624 tmp=/var/lib/arvados/tmp/python
625 python3 -m venv "$v"
626 . "$v/bin/activate"
627 pip3 install --no-cache-dir 'setuptools>=68' 'pip>=20'
628 export ARVADOS_BUILDING_VERSION="`+inst.PackageVersion+`"
629 for src in "`+inst.SourcePath+`/sdk/python" "`+inst.SourcePath+`/services/fuse"; do
630   rsync -a --delete-after "$src/" "$tmp/"
631   env -C "$tmp" python3 setup.py build
632   pip3 install "$tmp"
633   rm -rf "$tmp"
634 done
635 `, stdout, stderr); err != nil {
636                         return 1
637                 }
638
639                 // Install RailsAPI to /var/lib/arvados/railsapi/
640                 fmt.Fprintln(stderr, "building railsapi...")
641                 cmd = exec.Command("rsync",
642                         "-a", "--no-owner", "--no-group", "--delete-after", "--delete-excluded",
643                         "--exclude", "/coverage",
644                         "--exclude", "/log",
645                         "--exclude", "/node_modules",
646                         "--exclude", "/tmp",
647                         "--exclude", "/public/assets",
648                         "--exclude", "/vendor",
649                         "--exclude", "/config/environments",
650                         "./", "/var/lib/arvados/railsapi/")
651                 cmd.Dir = filepath.Join(inst.SourcePath, "services", "api")
652                 cmd.Stdout = stdout
653                 cmd.Stderr = stderr
654                 err = cmd.Run()
655                 if err != nil {
656                         return 1
657                 }
658                 for _, cmdline := range [][]string{
659                         {"mkdir", "-p", "log", "public/assets", "tmp", "vendor", ".bundle", "/var/www/.bundle", "/var/www/.gem", "/var/www/.npm", "/var/www/.passenger"},
660                         {"touch", "log/production.log"},
661                         {"chown", "-R", "--from=root", "www-data:www-data", "/var/www/.bundle", "/var/www/.gem", "/var/www/.npm", "/var/www/.passenger", "log", "tmp", "vendor", ".bundle", "Gemfile.lock", "config.ru", "config/environment.rb"},
662                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:" + inst.BundlerVersion},
663                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "deployment", "true"},
664                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "path", "/var/www/.gem"},
665                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "without", "development test diagnostics performance"},
666                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--jobs", fmt.Sprintf("%d", runtime.NumCPU())},
667
668                         {"chown", "www-data:www-data", ".", "public/assets"},
669                         // {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "system", "true"},
670                         {"sudo", "-u", "www-data", "ARVADOS_CONFIG=none", "RAILS_GROUPS=assets", "RAILS_ENV=production", "PATH=/var/lib/arvados/bin:" + os.Getenv("PATH"), "/var/lib/arvados/bin/bundle", "exec", "rake", "npm:install"},
671                         {"sudo", "-u", "www-data", "ARVADOS_CONFIG=none", "RAILS_GROUPS=assets", "RAILS_ENV=production", "PATH=/var/lib/arvados/bin:" + os.Getenv("PATH"), "/var/lib/arvados/bin/bundle", "exec", "rake", "assets:precompile"},
672                         {"chown", "root:root", "."},
673                         {"chown", "-R", "root:root", "public/assets", "vendor"},
674
675                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
676                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
677                 } {
678                         if cmdline[len(cmdline)-2] == "rake" {
679                                 continue
680                         }
681                         cmd = exec.Command(cmdline[0], cmdline[1:]...)
682                         cmd.Dir = "/var/lib/arvados/railsapi"
683                         cmd.Stdout = stdout
684                         cmd.Stderr = stderr
685                         fmt.Fprintf(stderr, "... %s\n", cmd.Args)
686                         err = cmd.Run()
687                         if err != nil {
688                                 return 1
689                         }
690                 }
691                 cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
692                 cmd.Dir = "/var/lib/arvados/railsapi"
693                 cmd.Stdout = stdout
694                 cmd.Stderr = stderr
695                 err = cmd.Run()
696                 if err != nil && !strings.Contains(err.Error(), "exit status 2") {
697                         // Exit code 2 indicates there were warnings (like
698                         // "other passenger installations have been detected",
699                         // which we can't expect to avoid) but no errors.
700                         // Other non-zero exit codes (1, 9) indicate errors.
701                         return 1
702                 }
703
704                 // Install workbench2 app to
705                 // /var/lib/arvados/workbench2/.
706                 //
707                 // We copy the source tree from the (possibly
708                 // readonly) source tree into a temp dir because `yarn
709                 // build` writes to {source-tree}/build/. When we
710                 // upgrade to react-scripts >= 4.0.2 we may be able to
711                 // build from the source dir and write directly to the
712                 // final destination (using
713                 // YARN_INSTALL_STATE_PATH=/dev/null
714                 // BUILD_PATH=/var/lib/arvados/workbench2) instead of
715                 // using two rsync steps here.
716                 if err = inst.runBash(`
717 src="`+inst.SourcePath+`/services/workbench2"
718 tmp=/var/lib/arvados/tmp/workbench2
719 trap "rm -r ${tmp}" ERR EXIT
720 dst=/var/lib/arvados/workbench2
721 rsync -a --delete-after "$src/" "$tmp/"
722 env -C "$tmp" VERSION="`+inst.PackageVersion+`" BUILD_NUMBER=1 GIT_COMMIT="`+inst.Commit[:9]+`" yarn build
723 rsync -a --delete-after "$tmp/build/" "$dst/"
724 `, stdout, stderr); err != nil {
725                         return 1
726                 }
727
728                 // Install arvados-cli gem (binaries go in
729                 // /var/lib/arvados/bin)
730                 if err = inst.runBash(`
731 /var/lib/arvados/bin/gem install --conservative --no-document arvados-cli
732 `, stdout, stderr); err != nil {
733                         return 1
734                 }
735
736                 err = os.WriteFile("/lib/systemd/system/arvados.service", arvadosServiceFile, 0777)
737                 if err != nil {
738                         return 1
739                 }
740                 if prod {
741                         // (fpm will do this for us in the pkg case)
742                         // This is equivalent to "systemd enable", but
743                         // does not depend on the systemctl program
744                         // being available:
745                         symlink := "/etc/systemd/system/multi-user.target.wants/arvados.service"
746                         err = os.Remove(symlink)
747                         if err != nil && !errors.Is(err, os.ErrNotExist) {
748                                 return 1
749                         }
750                         err = os.Symlink("/lib/systemd/system/arvados.service", symlink)
751                         if err != nil {
752                                 return 1
753                         }
754                 }
755
756                 // Add symlinks in /usr/bin for user-facing programs
757                 for _, srcdst := range [][]string{
758                         // go
759                         {"bin/arvados-client"},
760                         {"bin/arvados-client", "arv"},
761                         {"bin/arvados-server"},
762                         // sdk/cli
763                         {"bin/arv", "arv-ruby"},
764                         {"bin/arv-tag"},
765                         // sdk/python
766                         {"lib/python/bin/arv-copy"},
767                         {"lib/python/bin/arv-federation-migrate"},
768                         {"lib/python/bin/arv-get"},
769                         {"lib/python/bin/arv-keepdocker"},
770                         {"lib/python/bin/arv-ls"},
771                         {"lib/python/bin/arv-migrate-docker19"},
772                         {"lib/python/bin/arv-normalize"},
773                         {"lib/python/bin/arv-put"},
774                         {"lib/python/bin/arv-ws"},
775                         // services/fuse
776                         {"lib/python/bin/arv-mount"},
777                 } {
778                         src := "/var/lib/arvados/" + srcdst[0]
779                         if _, err = os.Stat(src); err != nil {
780                                 return 1
781                         }
782                         dst := srcdst[len(srcdst)-1]
783                         _, dst = filepath.Split(dst)
784                         dst = "/usr/bin/" + dst
785                         err = os.Remove(dst)
786                         if err != nil && !errors.Is(err, os.ErrNotExist) {
787                                 return 1
788                         }
789                         err = os.Symlink(src, dst)
790                         if err != nil {
791                                 return 1
792                         }
793                 }
794         }
795
796         return 0
797 }
798
799 type osversion struct {
800         Debian bool
801         Ubuntu bool
802         RedHat bool
803         Major  int
804 }
805
806 func identifyOS() (osversion, error) {
807         var osv osversion
808         f, err := os.Open("/etc/os-release")
809         if err != nil {
810                 return osv, err
811         }
812         defer f.Close()
813
814         kv := map[string]string{}
815         scanner := bufio.NewScanner(f)
816         for scanner.Scan() {
817                 line := strings.TrimSpace(scanner.Text())
818                 if strings.HasPrefix(line, "#") {
819                         continue
820                 }
821                 toks := strings.SplitN(line, "=", 2)
822                 if len(toks) != 2 {
823                         return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
824                 }
825                 k := toks[0]
826                 v := strings.Trim(toks[1], `"`)
827                 if v == toks[1] {
828                         v = strings.Trim(v, `'`)
829                 }
830                 kv[k] = v
831         }
832         if err = scanner.Err(); err != nil {
833                 return osv, err
834         }
835         switch kv["ID"] {
836         case "ubuntu":
837                 osv.Ubuntu = true
838         case "debian":
839                 osv.Debian = true
840         default:
841                 idLikeMatched := false
842                 for _, idLike := range strings.Split(kv["ID_LIKE"], " ") {
843                         switch idLike {
844                         case "debian":
845                                 osv.Debian = true
846                                 idLikeMatched = true
847                         case "rhel":
848                                 osv.RedHat = true
849                                 idLikeMatched = true
850                         }
851                         if idLikeMatched {
852                                 break
853                         }
854                 }
855                 if !idLikeMatched {
856                         return osv, fmt.Errorf("no supported ID found in /etc/os-release")
857                 }
858         }
859         vstr := kv["VERSION_ID"]
860         if i := strings.Index(vstr, "."); i > 0 {
861                 vstr = vstr[:i]
862         }
863         osv.Major, err = strconv.Atoi(vstr)
864         if err != nil {
865                 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
866         }
867         return osv, nil
868 }
869
870 func waitPostgreSQLReady() error {
871         for deadline := time.Now().Add(10 * time.Second); ; {
872                 output, err := exec.Command("pg_isready").CombinedOutput()
873                 if err == nil {
874                         return nil
875                 } else if time.Now().After(deadline) {
876                         return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
877                 } else {
878                         time.Sleep(time.Second)
879                 }
880         }
881 }
882
883 func (inst *installCommand) runBash(script string, stdout, stderr io.Writer) error {
884         cmd := exec.Command("bash", "-")
885         if inst.EatMyData {
886                 cmd = exec.Command("eatmydata", "bash", "-")
887         }
888         cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
889         cmd.Stdout = stdout
890         cmd.Stderr = stderr
891         return cmd.Run()
892 }
893
894 func prodpkgs(osv osversion) []string {
895         pkgs := []string{
896                 "ca-certificates",
897                 "curl",
898                 "fuse",
899                 "git",
900                 "gitolite3",
901                 "graphviz",
902                 "haveged",
903                 "libcurl3-gnutls",
904                 "libxslt1.1",
905                 "nginx",
906                 "python3",
907                 "sudo",
908         }
909         if osv.Debian || osv.Ubuntu {
910                 if osv.Debian && osv.Major == 8 {
911                         pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
912                 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
913                         pkgs = append(pkgs, "python3-distutils") // sdk/cwl
914                 }
915                 return append(pkgs,
916                         "mime-support", // keep-web
917                 )
918         } else if osv.RedHat {
919                 return append(pkgs,
920                         "fuse-libs", // services/fuse
921                         "mailcap",   // keep-web
922                 )
923         } else {
924                 panic("os version not supported")
925         }
926 }
927
928 func ProductionDependencies() ([]string, error) {
929         osv, err := identifyOS()
930         if err != nil {
931                 return nil, err
932         }
933         return prodpkgs(osv), nil
934 }