16306: Add "install -type package" and "buildpackage".
authorTom Clegg <tom@tomclegg.ca>
Wed, 1 Jul 2020 13:42:48 +0000 (09:42 -0400)
committerTom Clegg <tom@tomclegg.ca>
Fri, 21 Aug 2020 17:53:39 +0000 (13:53 -0400)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@tomclegg.ca>

cmd/arvados-dev/buildpackage.go [new file with mode: 0644]
cmd/arvados-dev/buildpackage_test.go [new file with mode: 0644]
cmd/arvados-dev/cmd.go [new file with mode: 0644]
cmd/arvados-dev/example.sh [new file with mode: 0755]
lib/install/deps.go

diff --git a/cmd/arvados-dev/buildpackage.go b/cmd/arvados-dev/buildpackage.go
new file mode 100644 (file)
index 0000000..4b395c4
--- /dev/null
@@ -0,0 +1,98 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+package main
+
+import (
+       "context"
+       "flag"
+       "fmt"
+       "io"
+       "os/exec"
+
+       "git.arvados.org/arvados.git/lib/install"
+       "git.arvados.org/arvados.git/sdk/go/ctxlog"
+       "github.com/sirupsen/logrus"
+)
+
+type buildPackage struct{}
+
+func (bld buildPackage) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
+       logger := ctxlog.New(stderr, "text", "info")
+       err := (&builder{
+               PackageVersion: "0.0.0",
+               logger:         logger,
+       }).run(context.Background(), prog, args, stdin, stdout, stderr)
+       if err != nil {
+               logger.WithError(err).Error("failed")
+               return 1
+       }
+       return 0
+}
+
+type builder struct {
+       PackageVersion string
+       SourcePath     string
+       OutputDir      string
+       SkipInstall    bool
+       logger         logrus.FieldLogger
+}
+
+func (bldr *builder) run(ctx context.Context, prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) error {
+       flags := flag.NewFlagSet("", flag.ContinueOnError)
+       flags.StringVar(&bldr.PackageVersion, "package-version", bldr.PackageVersion, "package version")
+       flags.StringVar(&bldr.SourcePath, "source", bldr.SourcePath, "source tree location")
+       flags.StringVar(&bldr.OutputDir, "output-directory", bldr.OutputDir, "destination directory for new package (default is cwd)")
+       flags.BoolVar(&bldr.SkipInstall, "skip-install", bldr.SkipInstall, "skip install step, assume you have already run 'arvados-server install -type package'")
+       err := flags.Parse(args)
+       if err != nil {
+               return err
+       }
+       if len(flags.Args()) > 0 {
+               return fmt.Errorf("unrecognized command line arguments: %v", flags.Args())
+       }
+       if !bldr.SkipInstall {
+               exitcode := install.Command.RunCommand("arvados-server install", []string{
+                       "-type", "package",
+                       "-package-version", bldr.PackageVersion,
+                       "-source", bldr.SourcePath,
+               }, stdin, stdout, stderr)
+               if exitcode != 0 {
+                       return fmt.Errorf("arvados-server install failed: exit code %d", exitcode)
+               }
+       }
+       cmd := exec.Command("/var/lib/arvados/bin/gem", "install", "--user", "--no-rdoc", "--no-ri", "fpm")
+       cmd.Stdout = stdout
+       cmd.Stderr = stderr
+       err = cmd.Run()
+       if err != nil {
+               return fmt.Errorf("gem install fpm: %w", err)
+       }
+
+       format := "deb" // TODO: rpm
+
+       cmd = exec.Command("/root/.gem/ruby/2.5.0/bin/fpm",
+               "--name", "arvados-server-easy",
+               "--version", bldr.PackageVersion,
+               "--input-type", "dir",
+               "--output-type", format)
+       deps, err := install.ProductionDependencies()
+       if err != nil {
+               return err
+       }
+       for _, pkg := range deps {
+               cmd.Args = append(cmd.Args, "--depends", pkg)
+       }
+       cmd.Args = append(cmd.Args,
+               "--exclude", "/var/lib/arvados/go",
+               "/var/lib/arvados",
+               "/var/www/.gem",
+               "/var/www/.passenger",
+       )
+       fmt.Fprintf(stderr, "%s...\n", cmd.Args)
+       cmd.Dir = bldr.OutputDir
+       cmd.Stdout = stdout
+       cmd.Stderr = stderr
+       return cmd.Run()
+}
diff --git a/cmd/arvados-dev/buildpackage_test.go b/cmd/arvados-dev/buildpackage_test.go
new file mode 100644 (file)
index 0000000..61bdeae
--- /dev/null
@@ -0,0 +1,77 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+package main
+
+import (
+       "flag"
+       "os"
+       "os/exec"
+       "path/filepath"
+       "testing"
+
+       "gopkg.in/check.v1"
+)
+
+var buildimage string
+
+func init() {
+       os.Args = append(os.Args, "-test.timeout=30m") // kludge
+
+       // This enables a hack to speed up repeated tests: hit "docker
+       // commit --pause {containername} checkpointtag" after the
+       // test container has downloaded/compiled some stuff, then run
+       // tests with "-test.buildimage=checkpointtag" next time to
+       // retry/resume/update from that point.
+       flag.StringVar(&buildimage, "test.buildimage", "debian:10", "docker image to use when running buildpackage")
+}
+
+type BuildpackageSuite struct{}
+
+var _ = check.Suite(&BuildpackageSuite{})
+
+func Test(t *testing.T) { check.TestingT(t) }
+
+func (s *BuildpackageSuite) TestBuildAndInstall(c *check.C) {
+       if testing.Short() {
+               c.Skip("skipping docker tests in short mode")
+       } else if _, err := exec.Command("docker", "info").CombinedOutput(); err != nil {
+               c.Skip("skipping docker tests because docker is not available")
+       }
+       tmpdir := c.MkDir()
+       defer os.RemoveAll(tmpdir)
+
+       err := os.Mkdir(tmpdir+"/pkg", 0755)
+       c.Assert(err, check.IsNil)
+       err = os.Mkdir(tmpdir+"/bin", 0755)
+       c.Assert(err, check.IsNil)
+
+       cmd := exec.Command("go", "install")
+       cmd.Env = append(append([]string(nil), os.Environ()...), "GOPATH="+tmpdir)
+       cmd.Stdout = os.Stdout
+       cmd.Stderr = os.Stderr
+       err = cmd.Run()
+       c.Assert(err, check.IsNil)
+
+       srctree, err := filepath.Abs("../..")
+       c.Assert(err, check.IsNil)
+
+       cmd = exec.Command("docker", "run", "--rm",
+               "-v", tmpdir+"/pkg:/pkg",
+               "-v", tmpdir+"/bin/arvados-dev:/arvados-dev:ro",
+               "-v", srctree+":/usr/local/src/arvados:ro",
+               buildimage,
+               "/arvados-dev", "buildpackage",
+               "-package-version", "0.9.99",
+               "-source", "/usr/local/src/arvados",
+               "-output-directory", "/pkg")
+       cmd.Stdout = os.Stdout
+       cmd.Stderr = os.Stderr
+       err = cmd.Run()
+       c.Assert(err, check.IsNil)
+
+       fi, err := os.Stat(tmpdir + "/pkg/arvados-server_0.9.99_amd64.deb")
+       c.Assert(err, check.IsNil)
+       c.Logf("%#v", fi)
+}
diff --git a/cmd/arvados-dev/cmd.go b/cmd/arvados-dev/cmd.go
new file mode 100644 (file)
index 0000000..e0d5144
--- /dev/null
@@ -0,0 +1,25 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+package main
+
+import (
+       "os"
+
+       "git.arvados.org/arvados.git/lib/cmd"
+)
+
+var (
+       handler = cmd.Multi(map[string]cmd.Handler{
+               "version":   cmd.Version,
+               "-version":  cmd.Version,
+               "--version": cmd.Version,
+
+               "buildpackage": buildPackage{},
+       })
+)
+
+func main() {
+       os.Exit(handler.RunCommand(os.Args[0], os.Args[1:], os.Stdin, os.Stdout, os.Stderr))
+}
diff --git a/cmd/arvados-dev/example.sh b/cmd/arvados-dev/example.sh
new file mode 100755 (executable)
index 0000000..072dfcf
--- /dev/null
@@ -0,0 +1,35 @@
+#!/bin/bash
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: AGPL-3.0
+
+set -e -o pipefail
+
+version="${PACKAGE_VERSION:-0.9.99}"
+
+# mkdir -p /tmp/pkg
+# (
+#     cd cmd/arvados-dev
+#     go install
+# )
+# docker run --rm \
+#        -v /tmp/pkg:/pkg \
+#        -v "${GOPATH:-${HOME}/go}"/bin/arvados-dev:/arvados-dev:ro \
+#        -v "$(pwd)":/arvados:ro "${BUILDIMAGE:-debian:10}" \
+#        /arvados-dev buildpackage \
+#        -source /arvados \
+#        -package-version "${version}" \
+#        -output-directory /pkg
+pkgfile=/tmp/pkg/arvados-server-easy_${version}_amd64.deb
+# ls -l ${pkgfile}
+# (
+#     cd /tmp/pkg
+#     dpkg-scanpackages . | gzip > Packages.gz
+# )
+sourcesfile=/tmp/sources.conf.d-arvados
+echo >$sourcesfile "deb [trusted=yes] file:///pkg ./"
+docker run -it --rm \
+       -v /tmp/pkg:/pkg:ro \
+       -v ${sourcesfile}:/etc/apt/sources.list.d/arvados-local.list:ro \
+       ${INSTALLIMAGE:-debian:10} \
+       bash -c 'apt update && DEBIAN_FRONTEND=noninteractive apt install -y arvados-server-easy && bash -login'
index ba57c20c357baeab68d92a5e41d52f8dc208606f..d28823f4ac1ff56838304c1b6c3af39debb498f6 100644 (file)
@@ -14,6 +14,7 @@ import (
        "io"
        "os"
        "os/exec"
+       "path/filepath"
        "strconv"
        "strings"
        "syscall"
@@ -24,13 +25,17 @@ import (
        "github.com/lib/pq"
 )
 
-var Command cmd.Handler = installCommand{}
+var Command cmd.Handler = &installCommand{}
 
 const devtestDatabasePassword = "insecure_arvados_test"
 
-type installCommand struct{}
+type installCommand struct {
+       ClusterType    string
+       SourcePath     string
+       PackageVersion string
+}
 
-func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
+func (inst *installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
        logger := ctxlog.New(stderr, "text", "info")
        ctx := ctxlog.Context(context.Background(), logger)
        ctx, cancel := context.WithCancel(ctx)
@@ -46,7 +51,9 @@ func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, st
        flags := flag.NewFlagSet(prog, flag.ContinueOnError)
        flags.SetOutput(stderr)
        versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
-       clusterType := flags.String("type", "production", "cluster `type`: development, test, or production")
+       flags.StringVar(&inst.ClusterType, "type", "production", "cluster `type`: development, test, production, or package")
+       flags.StringVar(&inst.SourcePath, "source", "/arvados", "source tree location (required for -type=package)")
+       flags.StringVar(&inst.PackageVersion, "package-version", "0.0.0", "version string to embed in executable files")
        err = flags.Parse(args)
        if err == flag.ErrHelp {
                err = nil
@@ -55,18 +62,23 @@ func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, st
                return 2
        } else if *versionFlag {
                return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
+       } else if len(flags.Args()) > 0 {
+               err = fmt.Errorf("unrecognized command line arguments: %v", flags.Args())
+               return 2
        }
 
-       var dev, test, prod bool
-       switch *clusterType {
+       var dev, test, prod, pkg bool
+       switch inst.ClusterType {
        case "development":
                dev = true
        case "test":
                test = true
        case "production":
                prod = true
+       case "package":
+               pkg = true
        default:
-               err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', or 'production')", *clusterType)
+               err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', 'production', or 'package')", inst.ClusterType)
                return 2
        }
 
@@ -96,53 +108,47 @@ func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, st
                }
        }
 
-       if dev || test {
-               debs := []string{
-                       "bison",
+       pkgs := prodpkgs(osv)
+
+       if pkg {
+               pkgs = append(pkgs,
+                       "dpkg-dev",
+                       "rsync",
+               )
+       }
+
+       if dev || test || pkg {
+               pkgs = append(pkgs,
                        "bsdmainutils",
                        "build-essential",
-                       "ca-certificates",
                        "cadaver",
-                       "curl",
                        "cython",
                        "daemontools", // lib/boot uses setuidgid to drop privileges when running as root
                        "default-jdk-headless",
                        "default-jre-headless",
-                       "fuse",
                        "gettext",
-                       "git",
-                       "gitolite3",
-                       "graphviz",
-                       "haveged",
                        "iceweasel",
                        "libattr1-dev",
                        "libcrypt-ssleay-perl",
-                       "libcrypt-ssleay-perl",
-                       "libcurl3-gnutls",
-                       "libcurl4-openssl-dev",
                        "libfuse-dev",
                        "libgnutls28-dev",
                        "libjson-perl",
-                       "libjson-perl",
                        "libpam-dev",
                        "libpcre3-dev",
-                       "libpq-dev",
                        "libpython2.7-dev",
                        "libreadline-dev",
                        "libssl-dev",
                        "libwww-perl",
                        "libxml2-dev",
-                       "libxslt1.1",
+                       "libxslt1-dev",
                        "linkchecker",
                        "lsof",
                        "net-tools",
-                       "nginx",
                        "pandoc",
                        "perl-modules",
                        "pkg-config",
                        "postgresql",
                        "postgresql-contrib",
-                       "python",
                        "python3-dev",
                        "python-epydoc",
                        "r-base",
@@ -151,16 +157,15 @@ func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, st
                        "virtualenv",
                        "wget",
                        "xvfb",
-                       "zlib1g-dev",
-               }
+               )
                switch {
                case osv.Debian && osv.Major >= 10:
-                       debs = append(debs, "libcurl4")
+                       pkgs = append(pkgs, "libcurl4")
                default:
-                       debs = append(debs, "libcurl3")
+                       pkgs = append(pkgs, "libcurl3")
                }
                cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends")
-               cmd.Args = append(cmd.Args, debs...)
+               cmd.Args = append(cmd.Args, pkgs...)
                cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
                cmd.Stdout = stdout
                cmd.Stderr = stderr
@@ -182,7 +187,7 @@ trap "rm -r ${tmp}" ERR
 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 -
 cd ${tmp}
 ./configure --disable-install-doc --prefix /var/lib/arvados
-make -j4
+make -j8
 make install
 /var/lib/arvados/bin/gem install bundler
 rm -r ${tmp}
@@ -206,7 +211,9 @@ ln -sf /var/lib/arvados/go/bin/* /usr/local/bin/
                                return 1
                        }
                }
+       }
 
+       if !prod && !pkg {
                pjsversion := "1.9.8"
                if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
                        logger.Print("phantomjs " + pjsversion + " already installed")
@@ -389,12 +396,89 @@ rm ${zip}
                }
        }
 
+       if pkg {
+               // Install Rails apps to /var/lib/arvados/{railsapi,workbench1}/
+               for dstdir, srcdir := range map[string]string{
+                       "railsapi":   "services/api",
+                       "workbench1": "apps/workbench",
+               } {
+                       fmt.Fprintf(stderr, "building %s...\n", srcdir)
+                       cmd := exec.Command("rsync", "-a", "--no-owner", "--delete-after", "--exclude", "/tmp", "--exclude", "/log", "--exclude", "/vendor", "./", "/var/lib/arvados/"+dstdir+"/")
+                       cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
+                       cmd.Stdout = stdout
+                       cmd.Stderr = stderr
+                       err = cmd.Run()
+                       if err != nil {
+                               return 1
+                       }
+                       for _, cmdline := range [][]string{
+                               {"mkdir", "-p", "log", "tmp", ".bundle", "/var/www/.gem", "/var/www/.passenger"},
+                               {"touch", "log/production.log"},
+                               // {"chown", "-R", "root:root", "."},
+                               {"chown", "-R", "www-data:www-data", "/var/www/.gem", "/var/www/.passenger", "log", "tmp", ".bundle", "Gemfile.lock", "config.ru", "config/environment.rb"},
+                               {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--no-rdoc", "--no-ri", "--conservative", "bundler:1.11", "bundler:1.17.3", "bundler:2.0.2"},
+                               {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--deployment", "--jobs", "8", "--path", "/var/www/.gem"},
+                               {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
+                               {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
+                       } {
+                               cmd = exec.Command(cmdline[0], cmdline[1:]...)
+                               cmd.Env = append([]string{}, os.Environ()...)
+                               cmd.Dir = "/var/lib/arvados/" + dstdir
+                               cmd.Stdout = stdout
+                               cmd.Stderr = stderr
+                               err = cmd.Run()
+                               if err != nil {
+                                       return 1
+                               }
+                       }
+                       cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
+                       cmd.Dir = "/var/lib/arvados/" + dstdir
+                       cmd.Stdout = stdout
+                       cmd.Stderr = stderr
+                       err = cmd.Run()
+                       if err != nil && !strings.Contains(err.Error(), "exit status 2") {
+                               // Exit code 2 indicates there were warnings (like
+                               // "other passenger installations have been detected",
+                               // which we can't expect to avoid) but no errors.
+                               // Other non-zero exit codes (1, 9) indicate errors.
+                               return 1
+                       }
+               }
+
+               // Install Go programs to /var/lib/arvados/bin/
+               for _, srcdir := range []string{
+                       "cmd/arvados-client",
+                       "cmd/arvados-server",
+                       "services/arv-git-httpd",
+                       "services/crunch-dispatch-local",
+                       "services/crunch-dispatch-slurm",
+                       "services/health",
+                       "services/keep-balance",
+                       "services/keep-web",
+                       "services/keepproxy",
+                       "services/keepstore",
+                       "services/ws",
+               } {
+                       fmt.Fprintf(stderr, "building %s...\n", srcdir)
+                       cmd := exec.Command("go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+" -X main.version="+inst.PackageVersion)
+                       cmd.Env = append([]string{"GOBIN=/var/lib/arvados/bin"}, os.Environ()...)
+                       cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
+                       cmd.Stdout = stdout
+                       cmd.Stderr = stderr
+                       err = cmd.Run()
+                       if err != nil {
+                               return 1
+                       }
+               }
+       }
+
        return 0
 }
 
 type osversion struct {
        Debian bool
        Ubuntu bool
+       Centos bool
        Major  int
 }
 
@@ -432,6 +516,8 @@ func identifyOS() (osversion, error) {
                osv.Ubuntu = true
        case "debian":
                osv.Debian = true
+       case "centos":
+               osv.Centos = true
        default:
                return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
        }
@@ -466,3 +552,56 @@ func runBash(script string, stdout, stderr io.Writer) error {
        cmd.Stderr = stderr
        return cmd.Run()
 }
+
+func prodpkgs(osv osversion) []string {
+       pkgs := []string{
+               "automake",
+               "bison",
+               "ca-certificates",
+               "curl",
+               "fuse",
+               "git",
+               "gitolite3",
+               "graphviz",
+               "haveged",
+               "libcurl3-gnutls",
+               "libxslt1.1",
+               "make",
+               "nginx",
+               "python",
+       }
+       if osv.Debian || osv.Ubuntu {
+               if osv.Debian && osv.Major == 8 {
+                       pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
+               } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
+                       pkgs = append(pkgs, "python3-distutils") // sdk/cwl
+               }
+               return append(pkgs,
+                       "g++",
+                       "libcurl4-openssl-dev", // services/api
+                       "libpq-dev",
+                       "libpython2.7", // services/fuse
+                       "mime-support", // keep-web
+                       "zlib1g-dev",   // services/api
+               )
+       } else if osv.Centos {
+               return append(pkgs,
+                       "fuse-libs", // services/fuse
+                       "gcc",
+                       "gcc-c++",
+                       "libcurl-devel",    // services/api
+                       "mailcap",          // keep-web
+                       "postgresql-devel", // services/api
+               )
+       } else {
+               panic("os version not supported")
+       }
+}
+
+func ProductionDependencies() ([]string, error) {
+       osv, err := identifyOS()
+       if err != nil {
+               return nil, err
+       }
+       return prodpkgs(osv), nil
+}