Merge branch '20846-ubuntu2204'
[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      = "12.22.12"
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.Centos:
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 10:
277                                 codename = "buster"
278                         case 11:
279                                 codename = "bullseye"
280                         case 12:
281                                 codename = "bookworm"
282                         default:
283                                 err = fmt.Errorf("don't know how to install docker-ce for debian %d", osv.Major)
284                                 return 1
285                         }
286                         err = inst.runBash(`
287 rm -f /usr/share/keyrings/docker-archive-keyring.gpg
288 curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
289 echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian/ `+codename+` stable' | \
290     tee /etc/apt/sources.list.d/docker.list
291 apt-get update
292 DEBIAN_FRONTEND=noninteractive apt-get --yes --no-install-recommends install docker-ce
293 `, stdout, stderr)
294                         if err != nil {
295                                 return 1
296                         }
297                 } else {
298                         err = fmt.Errorf("don't know how to install docker for osversion %v", osv)
299                         return 1
300                 }
301
302                 err = inst.runBash(`
303 key=fs.inotify.max_user_watches
304 min=524288
305 if [[ "$(sysctl --values "${key}")" -lt "${min}" ]]; then
306     sysctl "${key}=${min}"
307     # writing sysctl worked, so we should make it permanent
308     echo "${key}=${min}" | tee -a /etc/sysctl.conf
309     sysctl -p
310 fi
311 `, stdout, stderr)
312                 if err != nil {
313                         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`)")
314                         return 1
315                 }
316         }
317
318         os.Mkdir("/var/lib/arvados", 0755)
319         os.Mkdir("/var/lib/arvados/tmp", 0700)
320         if prod || pkg {
321                 u, er := user.Lookup("www-data")
322                 if er != nil {
323                         err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
324                         return 1
325                 }
326                 uid, _ := strconv.Atoi(u.Uid)
327                 gid, _ := strconv.Atoi(u.Gid)
328                 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
329                 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
330                 if err != nil {
331                         return 1
332                 }
333         }
334         rubyminorversion := inst.RubyVersion[:strings.LastIndex(inst.RubyVersion, ".")]
335         if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+inst.RubyVersion)) {
336                 logger.Print("ruby " + inst.RubyVersion + " already installed")
337         } else {
338                 err = inst.runBash(`
339 rubyversion="`+inst.RubyVersion+`"
340 rubyminorversion="`+rubyminorversion+`"
341 tmp="$(mktemp -d)"
342 trap 'rm -r "${tmp}"' ERR EXIT
343 wget --progress=dot:giga -O- "https://cache.ruby-lang.org/pub/ruby/$rubyminorversion/ruby-$rubyversion.tar.gz" | tar -C "${tmp}" -xzf -
344 cd "${tmp}/ruby-$rubyversion"
345 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
346 make -j8
347 rm -f /var/lib/arvados/bin/erb
348 make install
349 if [[ "$rubyversion" > "3" ]]; then
350   /var/lib/arvados/bin/gem update --no-document --system 3.4.21
351 fi
352 /var/lib/arvados/bin/gem install bundler --no-document
353 `, stdout, stderr)
354                 if err != nil {
355                         return 1
356                 }
357         }
358
359         if !prod {
360                 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
361                         logger.Print("go " + goversion + " already installed")
362                 } else {
363                         err = inst.runBash(`
364 cd /tmp
365 rm -rf /var/lib/arvados/go/
366 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
367 ln -sfv /var/lib/arvados/go/bin/* /usr/local/bin/
368 `, stdout, stderr)
369                         if err != nil {
370                                 return 1
371                         }
372                 }
373         }
374
375         if !prod && !pkg {
376                 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
377                         logger.Print("gradle " + gradleversion + " already installed")
378                 } else {
379                         err = inst.runBash(`
380 G=`+gradleversion+`
381 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
382 trap "rm ${zip}" ERR
383 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
384 unzip -o -d /var/lib/arvados ${zip}
385 ln -sfv /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
386 rm ${zip}
387 `, stdout, stderr)
388                         if err != nil {
389                                 return 1
390                         }
391                 }
392
393                 if havesingularityversion, err := exec.Command("/var/lib/arvados/bin/singularity", "--version").CombinedOutput(); err == nil && strings.Contains(string(havesingularityversion), inst.SingularityVersion) {
394                         logger.Print("singularity " + inst.SingularityVersion + " already installed")
395                 } else if dev || test {
396                         err = inst.runBash(`
397 S=`+inst.SingularityVersion+`
398 tmp=/var/lib/arvados/tmp/singularity
399 trap "rm -r ${tmp}" ERR EXIT
400 cd /var/lib/arvados/tmp
401 git clone --recurse-submodules https://github.com/sylabs/singularity
402 cd singularity
403 git checkout v${S}
404 ./mconfig --prefix=/var/lib/arvados
405 make -C ./builddir
406 make -C ./builddir install
407 `, stdout, stderr)
408                         if err != nil {
409                                 return 1
410                         }
411                 }
412
413                 err = inst.runBash(`
414 install /usr/bin/nsenter /var/lib/arvados/bin/nsenter
415 setcap "cap_sys_admin+pei cap_sys_chroot+pei" /var/lib/arvados/bin/nsenter
416 `, stdout, stderr)
417                 if err != nil {
418                         return 1
419                 }
420
421                 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
422                 // it's installed, locale -a reports it as
423                 // "en_US.utf8".
424                 wantlocale := "en_US.UTF-8"
425                 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
426                         logger.Print("locale " + wantlocale + " already installed")
427                 } else {
428                         err = inst.runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
429                         if err != nil {
430                                 return 1
431                         }
432                 }
433
434                 var pgc struct {
435                         Version       string
436                         Cluster       string
437                         Port          int
438                         Status        string
439                         Owner         string
440                         DataDirectory string
441                         LogFile       string
442                 }
443                 if pgLsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
444                         err = fmt.Errorf("pg_lsclusters: %s", err2)
445                         return 1
446                 } else if pgclusters := strings.Split(strings.TrimSpace(string(pgLsclusters)), "\n"); len(pgclusters) != 1 {
447                         logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
448                 } 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 {
449                         err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
450                         return 1
451                 } else if pgc.Status == "online" {
452                         logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
453                 } else {
454                         logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
455                         cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
456                         cmd.Stdout = stdout
457                         cmd.Stderr = stderr
458                         err = cmd.Start()
459                         if err != nil {
460                                 return 1
461                         }
462                         defer func() {
463                                 cmd.Process.Signal(syscall.SIGTERM)
464                                 logger.Info("sent SIGTERM; waiting for postgres to shut down")
465                                 cmd.Wait()
466                         }()
467                         err = waitPostgreSQLReady()
468                         if err != nil {
469                                 return 1
470                         }
471                 }
472
473                 if os.Getpid() == 1 {
474                         // We are the init process (presumably in a
475                         // docker container) so although postgresql is
476                         // installed, it's not running, and initdb
477                         // might never have been run.
478                 }
479
480                 var needcoll []string
481                 // If the en_US.UTF-8 locale wasn't installed when
482                 // postgresql initdb ran, it needs to be added
483                 // explicitly before we can use it in our test suite.
484                 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
485                         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')")
486                         cmd.Dir = "/"
487                         out, err2 := cmd.CombinedOutput()
488                         if err != nil {
489                                 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
490                                 return 1
491                         }
492                         if strings.Contains(string(out), "1") {
493                                 logger.Infof("postgresql supports collation %s", collname)
494                         } else {
495                                 needcoll = append(needcoll, collname)
496                         }
497                 }
498                 if len(needcoll) > 0 && os.Getpid() != 1 {
499                         // In order for the CREATE COLLATION statement
500                         // below to work, the locale must have existed
501                         // when PostgreSQL started up. If we're
502                         // running as init, we must have started
503                         // PostgreSQL ourselves after installing the
504                         // locales. Otherwise, it might need a
505                         // restart, so we attempt to restart it with
506                         // systemd.
507                         if err = inst.runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
508                                 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
509                         } else if err = waitPostgreSQLReady(); err != nil {
510                                 return 1
511                         }
512                 }
513                 for _, collname := range needcoll {
514                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
515                         cmd.Stdout = stdout
516                         cmd.Stderr = stderr
517                         cmd.Dir = "/"
518                         err = cmd.Run()
519                         if err != nil {
520                                 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
521                                 return 1
522                         }
523                 }
524
525                 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
526                 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
527                 cmd.Dir = "/"
528                 if err := cmd.Run(); err == nil {
529                         logger.Print("arvados role exists; superuser privileges added, password updated")
530                 } else {
531                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
532                         cmd.Dir = "/"
533                         cmd.Stdout = stdout
534                         cmd.Stderr = stderr
535                         err = cmd.Run()
536                         if err != nil {
537                                 return 1
538                         }
539                 }
540         }
541
542         if !prod {
543                 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == "v"+inst.NodejsVersion+"\n" {
544                         logger.Print("nodejs " + inst.NodejsVersion + " already installed")
545                 } else {
546                         err = inst.runBash(`
547 NJS=v`+inst.NodejsVersion+`
548 rm -rf /var/lib/arvados/node-*-linux-x64
549 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
550 ln -sfv /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
551 `, stdout, stderr)
552                         if err != nil {
553                                 return 1
554                         }
555                 }
556
557                 if haveyarnversion, err := exec.Command("/usr/local/bin/yarn", "--version").CombinedOutput(); err == nil && len(haveyarnversion) > 0 {
558                         logger.Print("yarn " + strings.TrimSpace(string(haveyarnversion)) + " already installed")
559                 } else {
560                         err = inst.runBash(`
561 npm install -g yarn
562 ln -sfv /var/lib/arvados/node-v`+inst.NodejsVersion+`-linux-x64/bin/{yarn,yarnpkg} /usr/local/bin/
563 `, stdout, stderr)
564                         if err != nil {
565                                 return 1
566                         }
567                 }
568         }
569
570         if prod || pkg {
571                 // Install Go programs to /var/lib/arvados/bin/
572                 for _, srcdir := range []string{
573                         "cmd/arvados-client",
574                         "cmd/arvados-server",
575                 } {
576                         fmt.Fprintf(stderr, "building %s...\n", srcdir)
577                         // -buildvcs=false here avoids a fatal "error
578                         // obtaining VCS status" when git refuses to
579                         // run (for example) as root in a docker
580                         // container using a non-root-owned git tree
581                         // mounted from the host -- as in
582                         // "arvados-package build".
583                         cmd := exec.Command("go", "install", "-buildvcs=false",
584                                 "-ldflags", "-s -w"+
585                                         " -X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+
586                                         " -X git.arvados.org/arvados.git/lib/cmd.commit="+inst.Commit)
587                         cmd.Env = append(cmd.Env, os.Environ()...)
588                         cmd.Env = append(cmd.Env, "GOBIN=/var/lib/arvados/bin")
589                         cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
590                         cmd.Stdout = stdout
591                         cmd.Stderr = stderr
592                         err = cmd.Run()
593                         if err != nil {
594                                 return 1
595                         }
596                 }
597
598                 // Copy assets from source tree to /var/lib/arvados/share
599                 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
600                 cmd.Stdout = stdout
601                 cmd.Stderr = stderr
602                 err = cmd.Run()
603                 if err != nil {
604                         return 1
605                 }
606
607                 // Install python SDK and arv-mount in
608                 // /var/lib/arvados/lib/python.
609                 //
610                 // setup.py writes a file in the source directory in
611                 // order to include the version number in the package
612                 // itself.  We don't want to write to the source tree
613                 // (in "arvados-package" context it's mounted
614                 // readonly) so we run setup.py in a temporary copy of
615                 // the source dir.
616                 if err = inst.runBash(`
617 v=/var/lib/arvados/lib/python
618 tmp=/var/lib/arvados/tmp/python
619 python3 -m venv "$v"
620 . "$v/bin/activate"
621 pip3 install --no-cache-dir 'setuptools>=68' 'pip>=20'
622 export ARVADOS_BUILDING_VERSION="`+inst.PackageVersion+`"
623 for src in "`+inst.SourcePath+`/sdk/python" "`+inst.SourcePath+`/services/fuse"; do
624   rsync -a --delete-after "$src/" "$tmp/"
625   env -C "$tmp" python3 setup.py build
626   pip3 install "$tmp"
627   rm -rf "$tmp"
628 done
629 `, stdout, stderr); err != nil {
630                         return 1
631                 }
632
633                 // Install RailsAPI to /var/lib/arvados/railsapi/
634                 fmt.Fprintln(stderr, "building railsapi...")
635                 cmd = exec.Command("rsync",
636                         "-a", "--no-owner", "--no-group", "--delete-after", "--delete-excluded",
637                         "--exclude", "/coverage",
638                         "--exclude", "/log",
639                         "--exclude", "/node_modules",
640                         "--exclude", "/tmp",
641                         "--exclude", "/public/assets",
642                         "--exclude", "/vendor",
643                         "--exclude", "/config/environments",
644                         "./", "/var/lib/arvados/railsapi/")
645                 cmd.Dir = filepath.Join(inst.SourcePath, "services", "api")
646                 cmd.Stdout = stdout
647                 cmd.Stderr = stderr
648                 err = cmd.Run()
649                 if err != nil {
650                         return 1
651                 }
652                 for _, cmdline := range [][]string{
653                         {"mkdir", "-p", "log", "public/assets", "tmp", "vendor", ".bundle", "/var/www/.bundle", "/var/www/.gem", "/var/www/.npm", "/var/www/.passenger"},
654                         {"touch", "log/production.log"},
655                         {"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"},
656                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:" + inst.BundlerVersion},
657                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "deployment", "true"},
658                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "path", "/var/www/.gem"},
659                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "without", "development test diagnostics performance"},
660                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--jobs", fmt.Sprintf("%d", runtime.NumCPU())},
661
662                         {"chown", "www-data:www-data", ".", "public/assets"},
663                         // {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "system", "true"},
664                         {"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"},
665                         {"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"},
666                         {"chown", "root:root", "."},
667                         {"chown", "-R", "root:root", "public/assets", "vendor"},
668
669                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
670                         {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
671                 } {
672                         if cmdline[len(cmdline)-2] == "rake" {
673                                 continue
674                         }
675                         cmd = exec.Command(cmdline[0], cmdline[1:]...)
676                         cmd.Dir = "/var/lib/arvados/railsapi"
677                         cmd.Stdout = stdout
678                         cmd.Stderr = stderr
679                         fmt.Fprintf(stderr, "... %s\n", cmd.Args)
680                         err = cmd.Run()
681                         if err != nil {
682                                 return 1
683                         }
684                 }
685                 cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
686                 cmd.Dir = "/var/lib/arvados/railsapi"
687                 cmd.Stdout = stdout
688                 cmd.Stderr = stderr
689                 err = cmd.Run()
690                 if err != nil && !strings.Contains(err.Error(), "exit status 2") {
691                         // Exit code 2 indicates there were warnings (like
692                         // "other passenger installations have been detected",
693                         // which we can't expect to avoid) but no errors.
694                         // Other non-zero exit codes (1, 9) indicate errors.
695                         return 1
696                 }
697
698                 // Install workbench2 app to
699                 // /var/lib/arvados/workbench2/.
700                 //
701                 // We copy the source tree from the (possibly
702                 // readonly) source tree into a temp dir because `yarn
703                 // build` writes to {source-tree}/build/. When we
704                 // upgrade to react-scripts >= 4.0.2 we may be able to
705                 // build from the source dir and write directly to the
706                 // final destination (using
707                 // YARN_INSTALL_STATE_PATH=/dev/null
708                 // BUILD_PATH=/var/lib/arvados/workbench2) instead of
709                 // using two rsync steps here.
710                 if err = inst.runBash(`
711 src="`+inst.SourcePath+`/services/workbench2"
712 tmp=/var/lib/arvados/tmp/workbench2
713 trap "rm -r ${tmp}" ERR EXIT
714 dst=/var/lib/arvados/workbench2
715 rsync -a --delete-after "$src/" "$tmp/"
716 env -C "$tmp" VERSION="`+inst.PackageVersion+`" BUILD_NUMBER=1 GIT_COMMIT="`+inst.Commit[:9]+`" yarn build
717 rsync -a --delete-after "$tmp/build/" "$dst/"
718 `, stdout, stderr); err != nil {
719                         return 1
720                 }
721
722                 // Install arvados-cli gem (binaries go in
723                 // /var/lib/arvados/bin)
724                 if err = inst.runBash(`
725 /var/lib/arvados/bin/gem install --conservative --no-document arvados-cli
726 `, stdout, stderr); err != nil {
727                         return 1
728                 }
729
730                 err = os.WriteFile("/lib/systemd/system/arvados.service", arvadosServiceFile, 0777)
731                 if err != nil {
732                         return 1
733                 }
734                 if prod {
735                         // (fpm will do this for us in the pkg case)
736                         // This is equivalent to "systemd enable", but
737                         // does not depend on the systemctl program
738                         // being available:
739                         symlink := "/etc/systemd/system/multi-user.target.wants/arvados.service"
740                         err = os.Remove(symlink)
741                         if err != nil && !errors.Is(err, os.ErrNotExist) {
742                                 return 1
743                         }
744                         err = os.Symlink("/lib/systemd/system/arvados.service", symlink)
745                         if err != nil {
746                                 return 1
747                         }
748                 }
749
750                 // Add symlinks in /usr/bin for user-facing programs
751                 for _, srcdst := range [][]string{
752                         // go
753                         {"bin/arvados-client"},
754                         {"bin/arvados-client", "arv"},
755                         {"bin/arvados-server"},
756                         // sdk/cli
757                         {"bin/arv", "arv-ruby"},
758                         {"bin/arv-tag"},
759                         // sdk/python
760                         {"lib/python/bin/arv-copy"},
761                         {"lib/python/bin/arv-federation-migrate"},
762                         {"lib/python/bin/arv-get"},
763                         {"lib/python/bin/arv-keepdocker"},
764                         {"lib/python/bin/arv-ls"},
765                         {"lib/python/bin/arv-migrate-docker19"},
766                         {"lib/python/bin/arv-normalize"},
767                         {"lib/python/bin/arv-put"},
768                         {"lib/python/bin/arv-ws"},
769                         // services/fuse
770                         {"lib/python/bin/arv-mount"},
771                 } {
772                         src := "/var/lib/arvados/" + srcdst[0]
773                         if _, err = os.Stat(src); err != nil {
774                                 return 1
775                         }
776                         dst := srcdst[len(srcdst)-1]
777                         _, dst = filepath.Split(dst)
778                         dst = "/usr/bin/" + dst
779                         err = os.Remove(dst)
780                         if err != nil && !errors.Is(err, os.ErrNotExist) {
781                                 return 1
782                         }
783                         err = os.Symlink(src, dst)
784                         if err != nil {
785                                 return 1
786                         }
787                 }
788         }
789
790         return 0
791 }
792
793 type osversion struct {
794         Debian bool
795         Ubuntu bool
796         Centos bool
797         Major  int
798 }
799
800 func identifyOS() (osversion, error) {
801         var osv osversion
802         f, err := os.Open("/etc/os-release")
803         if err != nil {
804                 return osv, err
805         }
806         defer f.Close()
807
808         kv := map[string]string{}
809         scanner := bufio.NewScanner(f)
810         for scanner.Scan() {
811                 line := strings.TrimSpace(scanner.Text())
812                 if strings.HasPrefix(line, "#") {
813                         continue
814                 }
815                 toks := strings.SplitN(line, "=", 2)
816                 if len(toks) != 2 {
817                         return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
818                 }
819                 k := toks[0]
820                 v := strings.Trim(toks[1], `"`)
821                 if v == toks[1] {
822                         v = strings.Trim(v, `'`)
823                 }
824                 kv[k] = v
825         }
826         if err = scanner.Err(); err != nil {
827                 return osv, err
828         }
829         switch kv["ID"] {
830         case "ubuntu":
831                 osv.Ubuntu = true
832         case "debian":
833                 osv.Debian = true
834         case "centos":
835                 osv.Centos = true
836         default:
837                 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
838         }
839         vstr := kv["VERSION_ID"]
840         if i := strings.Index(vstr, "."); i > 0 {
841                 vstr = vstr[:i]
842         }
843         osv.Major, err = strconv.Atoi(vstr)
844         if err != nil {
845                 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
846         }
847         return osv, nil
848 }
849
850 func waitPostgreSQLReady() error {
851         for deadline := time.Now().Add(10 * time.Second); ; {
852                 output, err := exec.Command("pg_isready").CombinedOutput()
853                 if err == nil {
854                         return nil
855                 } else if time.Now().After(deadline) {
856                         return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
857                 } else {
858                         time.Sleep(time.Second)
859                 }
860         }
861 }
862
863 func (inst *installCommand) runBash(script string, stdout, stderr io.Writer) error {
864         cmd := exec.Command("bash", "-")
865         if inst.EatMyData {
866                 cmd = exec.Command("eatmydata", "bash", "-")
867         }
868         cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
869         cmd.Stdout = stdout
870         cmd.Stderr = stderr
871         return cmd.Run()
872 }
873
874 func prodpkgs(osv osversion) []string {
875         pkgs := []string{
876                 "ca-certificates",
877                 "curl",
878                 "fuse",
879                 "git",
880                 "gitolite3",
881                 "graphviz",
882                 "haveged",
883                 "libcurl3-gnutls",
884                 "libxslt1.1",
885                 "nginx",
886                 "python3",
887                 "sudo",
888         }
889         if osv.Debian || osv.Ubuntu {
890                 if osv.Debian && osv.Major == 8 {
891                         pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
892                 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
893                         pkgs = append(pkgs, "python3-distutils") // sdk/cwl
894                 }
895                 return append(pkgs,
896                         "mime-support", // keep-web
897                 )
898         } else if osv.Centos {
899                 return append(pkgs,
900                         "fuse-libs", // services/fuse
901                         "mailcap",   // keep-web
902                 )
903         } else {
904                 panic("os version not supported")
905         }
906 }
907
908 func ProductionDependencies() ([]string, error) {
909         osv, err := identifyOS()
910         if err != nil {
911                 return nil, err
912         }
913         return prodpkgs(osv), nil
914 }