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