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         "flag"
  12         "fmt"
  13         "io"
  14         "os"
  15         "os/exec"
  16         "strconv"
  17         "strings"
  18         "syscall"
  19         "time"
  20
  21         "git.arvados.org/arvados.git/lib/cmd"
  22         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  23         "github.com/lib/pq"
  24 )
  25
  26 var Command cmd.Handler = installCommand{}
  27
  28 const devtestDatabasePassword = "insecure_arvados_test"
  29
  30 type installCommand struct{}
  31
  32 func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  33         logger := ctxlog.New(stderr, "text", "info")
  34         ctx := ctxlog.Context(context.Background(), logger)
  35         ctx, cancel := context.WithCancel(ctx)
  36         defer cancel()
  37
  38         var err error
  39         defer func() {
  40                 if err != nil {
  41                         logger.WithError(err).Info("exiting")
  42                 }
  43         }()
  44
  45         flags := flag.NewFlagSet(prog, flag.ContinueOnError)
  46         flags.SetOutput(stderr)
  47         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
  48         clusterType := flags.String("type", "production", "cluster `type`: development, test, or production")
  49         err = flags.Parse(args)
  50         if err == flag.ErrHelp {
  51                 err = nil
  52                 return 0
  53         } else if err != nil {
  54                 return 2
  55         } else if *versionFlag {
  56                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
  57         }
  58
  59         var dev, test, prod bool
  60         switch *clusterType {
  61         case "development":
  62                 dev = true
  63         case "test":
  64                 test = true
  65         case "production":
  66                 prod = true
  67         default:
  68                 err = fmt.Errorf("cluster type must be 'development', 'test', or 'production'")
  69                 return 2
  70         }
  71
  72         osv, err := identifyOS()
  73         if err != nil {
  74                 return 1
  75         }
  76
  77         listdir, err := os.Open("/var/lib/apt/lists")
  78         if err != nil {
  79                 logger.Warnf("error while checking whether to run apt-get update: %s", err)
  80         } else if names, _ := listdir.Readdirnames(1); len(names) == 0 {
  81                 // Special case for a base docker image where the
  82                 // package cache has been deleted and all "apt-get
  83                 // install" commands will fail unless we fetch repos.
  84                 cmd := exec.CommandContext(ctx, "apt-get", "update")
  85                 cmd.Stdout = stdout
  86                 cmd.Stderr = stderr
  87                 err = cmd.Run()
  88                 if err != nil {
  89                         return 1
  90                 }
  91         }
  92
  93         if dev || test {
  94                 debs := []string{
  95                         "bison",
  96                         "bsdmainutils",
  97                         "build-essential",
  98                         "cadaver",
  99                         "curl",
 100                         "cython",
 101                         "daemontools", // lib/boot uses setuidgid to drop privileges when running as root
 102                         "default-jdk-headless",
 103                         "default-jre-headless",
 104                         "fuse",
 105                         "gettext",
 106                         "git",
 107                         "gitolite3",
 108                         "graphviz",
 109                         "haveged",
 110                         "iceweasel",
 111                         "libattr1-dev",
 112                         "libcrypt-ssleay-perl",
 113                         "libcrypt-ssleay-perl",
 114                         "libcurl3-gnutls",
 115                         "libcurl4-openssl-dev",
 116                         "libfuse-dev",
 117                         "libgnutls28-dev",
 118                         "libjson-perl",
 119                         "libjson-perl",
 120                         "libpam-dev",
 121                         "libpcre3-dev",
 122                         "libpq-dev",
 123                         "libpython2.7-dev",
 124                         "libreadline-dev",
 125                         "libssl-dev",
 126                         "libwww-perl",
 127                         "libxml2-dev",
 128                         "libxslt1.1",
 129                         "linkchecker",
 130                         "lsof",
 131                         "net-tools",
 132                         "nginx",
 133                         "pandoc",
 134                         "perl-modules",
 135                         "pkg-config",
 136                         "postgresql",
 137                         "postgresql-contrib",
 138                         "python",
 139                         "python3-dev",
 140                         "python-epydoc",
 141                         "r-base",
 142                         "r-cran-testthat",
 143                         "sudo",
 144                         "virtualenv",
 145                         "wget",
 146                         "xvfb",
 147                         "zlib1g-dev",
 148                 }
 149                 switch {
 150                 case osv.Debian && osv.Major >= 10:
 151                         debs = append(debs, "libcurl4")
 152                 default:
 153                         debs = append(debs, "libcurl3")
 154                 }
 155                 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends")
 156                 cmd.Args = append(cmd.Args, debs...)
 157                 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
 158                 cmd.Stdout = stdout
 159                 cmd.Stderr = stderr
 160                 err = cmd.Run()
 161                 if err != nil {
 162                         return 1
 163                 }
 164         }
 165
 166         os.Mkdir("/var/lib/arvados", 0755)
 167         rubyversion := "2.5.7"
 168         if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
 169                 logger.Print("ruby " + rubyversion + " already installed")
 170         } else {
 171                 err = runBash(`
 172 mkdir -p /var/lib/arvados/tmp
 173 tmp=/var/lib/arvados/tmp/ruby-`+rubyversion+`
 174 trap "rm -r ${tmp}" ERR
 175 wget --progress=dot:giga -O- https://cache.ruby-lang.org/pub/ruby/2.5/ruby-`+rubyversion+`.tar.gz | tar -C /var/lib/arvados/tmp -xzf -
 176 cd ${tmp}
 177 ./configure --disable-install-doc --prefix /var/lib/arvados
 178 make -j4
 179 make install
 180 /var/lib/arvados/bin/gem install bundler
 181 rm -r ${tmp}
 182 `, stdout, stderr)
 183                 if err != nil {
 184                         return 1
 185                 }
 186         }
 187
 188         if !prod {
 189                 goversion := "1.14"
 190                 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
 191                         logger.Print("go " + goversion + " already installed")
 192                 } else {
 193                         err = runBash(`
 194 cd /tmp
 195 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
 196 ln -sf /var/lib/arvados/go/bin/* /usr/local/bin/
 197 `, stdout, stderr)
 198                         if err != nil {
 199                                 return 1
 200                         }
 201                 }
 202
 203                 pjsversion := "1.9.8"
 204                 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
 205                         logger.Print("phantomjs " + pjsversion + " already installed")
 206                 } else {
 207                         err = runBash(`
 208 PJS=phantomjs-`+pjsversion+`-linux-x86_64
 209 wget --progress=dot:giga -O- https://bitbucket.org/ariya/phantomjs/downloads/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
 210 ln -sf /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
 211 `, stdout, stderr)
 212                         if err != nil {
 213                                 return 1
 214                         }
 215                 }
 216
 217                 geckoversion := "0.24.0"
 218                 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
 219                         logger.Print("geckodriver " + geckoversion + " already installed")
 220                 } else {
 221                         err = runBash(`
 222 GD=v`+geckoversion+`
 223 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
 224 ln -sf /var/lib/arvados/bin/geckodriver /usr/local/bin/
 225 `, stdout, stderr)
 226                         if err != nil {
 227                                 return 1
 228                         }
 229                 }
 230
 231                 nodejsversion := "v8.15.1"
 232                 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
 233                         logger.Print("nodejs " + nodejsversion + " already installed")
 234                 } else {
 235                         err = runBash(`
 236 NJS=`+nodejsversion+`
 237 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
 238 ln -sf /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
 239 `, stdout, stderr)
 240                         if err != nil {
 241                                 return 1
 242                         }
 243                 }
 244
 245                 gradleversion := "5.3.1"
 246                 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
 247                         logger.Print("gradle " + gradleversion + " already installed")
 248                 } else {
 249                         err = runBash(`
 250 G=`+gradleversion+`
 251 mkdir -p /var/lib/arvados/tmp
 252 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
 253 trap "rm ${zip}" ERR
 254 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
 255 unzip -o -d /var/lib/arvados ${zip}
 256 ln -sf /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
 257 rm ${zip}
 258 `, stdout, stderr)
 259                         if err != nil {
 260                                 return 1
 261                         }
 262                 }
 263
 264                 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
 265                 // it's installed, locale -a reports it as
 266                 // "en_US.utf8".
 267                 wantlocale := "en_US.UTF-8"
 268                 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
 269                         logger.Print("locale " + wantlocale + " already installed")
 270                 } else {
 271                         err = runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
 272                         if err != nil {
 273                                 return 1
 274                         }
 275                 }
 276
 277                 var pgc struct {
 278                         Version       string
 279                         Cluster       string
 280                         Port          int
 281                         Status        string
 282                         Owner         string
 283                         DataDirectory string
 284                         LogFile       string
 285                 }
 286                 if pg_lsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
 287                         err = fmt.Errorf("pg_lsclusters: %s", err2)
 288                         return 1
 289                 } else if pgclusters := strings.Split(strings.TrimSpace(string(pg_lsclusters)), "\n"); len(pgclusters) != 1 {
 290                         logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
 291                 } 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 {
 292                         err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
 293                         return 1
 294                 } else if pgc.Status == "online" {
 295                         logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
 296                 } else {
 297                         logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
 298                         cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
 299                         cmd.Stdout = stdout
 300                         cmd.Stderr = stderr
 301                         err = cmd.Start()
 302                         if err != nil {
 303                                 return 1
 304                         }
 305                         defer func() {
 306                                 cmd.Process.Signal(syscall.SIGTERM)
 307                                 logger.Infof("sent SIGTERM; waiting for postgres to shut down")
 308                                 cmd.Wait()
 309                         }()
 310                         for deadline := time.Now().Add(10 * time.Second); ; {
 311                                 output, err2 := exec.Command("pg_isready").CombinedOutput()
 312                                 if err2 == nil {
 313                                         break
 314                                 } else if time.Now().After(deadline) {
 315                                         err = fmt.Errorf("timed out waiting for pg_isready (%q)", output)
 316                                         return 1
 317                                 } else {
 318                                         time.Sleep(time.Second)
 319                                 }
 320                         }
 321                 }
 322
 323                 if os.Getpid() == 1 {
 324                         // We are the init process (presumably in a
 325                         // docker container) so although postgresql is
 326                         // installed, it's not running, and initdb
 327                         // might never have been run.
 328                 }
 329
 330                 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
 331                 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
 332                 cmd.Dir = "/"
 333                 if err := cmd.Run(); err == nil {
 334                         logger.Print("arvados role exists; superuser privileges added, password updated")
 335                 } else {
 336                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
 337                         cmd.Dir = "/"
 338                         cmd.Stdout = stdout
 339                         cmd.Stderr = stderr
 340                         err = cmd.Run()
 341                         if err != nil {
 342                                 return 1
 343                         }
 344                 }
 345         }
 346
 347         return 0
 348 }
 349
 350 type osversion struct {
 351         Debian bool
 352         Ubuntu bool
 353         Major  int
 354 }
 355
 356 func identifyOS() (osversion, error) {
 357         var osv osversion
 358         f, err := os.Open("/etc/os-release")
 359         if err != nil {
 360                 return osv, err
 361         }
 362         defer f.Close()
 363
 364         kv := map[string]string{}
 365         scanner := bufio.NewScanner(f)
 366         for scanner.Scan() {
 367                 line := strings.TrimSpace(scanner.Text())
 368                 if strings.HasPrefix(line, "#") {
 369                         continue
 370                 }
 371                 toks := strings.SplitN(line, "=", 2)
 372                 if len(toks) != 2 {
 373                         return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
 374                 }
 375                 k := toks[0]
 376                 v := strings.Trim(toks[1], `"`)
 377                 if v == toks[1] {
 378                         v = strings.Trim(v, `'`)
 379                 }
 380                 kv[k] = v
 381         }
 382         if err = scanner.Err(); err != nil {
 383                 return osv, err
 384         }
 385         switch kv["ID"] {
 386         case "ubuntu":
 387                 osv.Ubuntu = true
 388         case "debian":
 389                 osv.Debian = true
 390         default:
 391                 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
 392         }
 393         vstr := kv["VERSION_ID"]
 394         if i := strings.Index(vstr, "."); i > 0 {
 395                 vstr = vstr[:i]
 396         }
 397         osv.Major, err = strconv.Atoi(vstr)
 398         if err != nil {
 399                 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os/release: %q", kv["VERSION_ID"])
 400         }
 401         return osv, nil
 402 }
 403
 404 func runBash(script string, stdout, stderr io.Writer) error {
 405         cmd := exec.Command("bash", "-")
 406         cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
 407         cmd.Stdout = stdout
 408         cmd.Stderr = stderr
 409         return cmd.Run()
 410 }