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