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