garnet/tests/system_ota_tests/upgrade_test/config.go

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package upgrade

import (
	"flag"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"strings"

	"fuchsia.googlesource.com/host_target_testing/artifacts"
	"fuchsia.googlesource.com/host_target_testing/device"
	"fuchsia.googlesource.com/host_target_testing/packages"
	"fuchsia.googlesource.com/host_target_testing/util"
)

type Config struct {
	OutputDir              string
	FuchsiaDir             string
	SshKeyFile             string
	netaddrPath            string
	localHostname          string
	DeviceName             string
	deviceHostname         string
	LkgbPath               string
	ArtifactsPath          string
	PackagesPath           string
	downgradeBuilderName   string
	downgradeBuildID       string
	downgradeAmberFilesDir string
	upgradeBuilderName     string
	upgradeBuildID         string
	upgradeAmberFilesDir   string
	archive                *artifacts.Archive
}

func NewConfig(fs *flag.FlagSet) (*Config, error) {
	outputDir, err := ioutil.TempDir("", "system_ota_tests")
	if err != nil {
		return nil, fmt.Errorf("failed to create a temporary directory: %s", err)
	}
	c := &Config{
		OutputDir: outputDir,
	}

	testDataPath := filepath.Join(filepath.Dir(os.Args[0]), "test_data", "system_ota_tests")

	fs.StringVar(&c.FuchsiaDir, "fuchsia-dir", os.Getenv("FUCHSIA_DIR"), "fuchsia dir")
	fs.StringVar(&c.SshKeyFile, "ssh-private-key", os.Getenv("FUCHSIA_SSH_KEY"), "SSH private key file that can access the device")
	fs.StringVar(&c.netaddrPath, "netaddr-path", filepath.Join(testDataPath, "netaddr"), "zircon netaddr tool path")
	fs.StringVar(&c.localHostname, "local-hostname", "", "local hostname")
	fs.StringVar(&c.DeviceName, "device", os.Getenv("FUCHSIA_NODENAME"), "device name")
	fs.StringVar(&c.deviceHostname, "device-hostname", os.Getenv("FUCHSIA_IPV4_ADDR"), "device hostname or IPv4/IPv6 address")
	fs.StringVar(&c.LkgbPath, "lkgb", filepath.Join(testDataPath, "lkgb"), "path to lkgb, default is $FUCHSIA_DIR/prebuilt/tools/lkgb/lkgb")
	fs.StringVar(&c.ArtifactsPath, "artifacts", filepath.Join(testDataPath, "artifacts"), "path to the artifacts binary, default is $FUCHSIA_DIR/prebuilt/tools/artifacts/artifacts")
	fs.StringVar(&c.downgradeBuilderName, "downgrade-builder-name", "", "downgrade to the latest version of this builder")
	fs.StringVar(&c.downgradeBuildID, "downgrade-build-id", "", "downgrade to this specific build id")
	fs.StringVar(&c.downgradeAmberFilesDir, "downgrade-amber-files", "", "Path to the downgrade amber-files repository")
	fs.StringVar(&c.upgradeBuilderName, "upgrade-builder-name", "", "upgrade to the latest version of this builder")
	fs.StringVar(&c.upgradeBuildID, "upgrade-build-id", os.Getenv("BUILDBUCKET_ID"), "upgrade to this build id (default is $BUILDBUCKET_ID)")
	fs.StringVar(&c.upgradeAmberFilesDir, "upgrade-amber-files", "", "Path to the upgrade amber-files repository")

	return c, nil
}

func (c *Config) Validate() error {
	defined := 0
	for _, s := range []string{c.downgradeBuilderName, c.downgradeBuildID, c.downgradeAmberFilesDir} {
		if s != "" {
			defined += 1
		}
	}
	if defined != 1 {
		return fmt.Errorf("exactly one of -downgrade-builder-name, -downgrade-build-id, or -downgrade-amber-files must be specified")
	}

	defined = 0
	for _, s := range []string{c.upgradeBuilderName, c.upgradeBuildID, c.upgradeAmberFilesDir} {
		if s != "" {
			defined += 1
		}
	}
	if defined != 1 {
		return fmt.Errorf("exactly one of -upgrade-builder-name, -upgrade-build-id, or -upgrade-amber-files must be specified")
	}

	return nil
}

func (c *Config) Close() {
	os.RemoveAll(c.OutputDir)
}

func (c *Config) NewDeviceClient() (*device.Client, error) {
	deviceHostname, err := c.DeviceHostname()
	if err != nil {
		return nil, err
	}
	if c.SshKeyFile == "" {
		return nil, fmt.Errorf("ssh private key cannot be empty")
	}

	return device.NewClient(deviceHostname, c.SshKeyFile)
}

func (c *Config) BuildArchive() *artifacts.Archive {
	if c.archive == nil {
		// Connect to the build archive service.
		c.archive = artifacts.NewArchive(c.LkgbPath, c.ArtifactsPath, c.OutputDir)
	}

	return c.archive
}

func (c *Config) GetDowngradeRepository() (*packages.Repository, error) {
	if c.downgradeBuilderName != "" && c.downgradeBuildID == "" {
		a := c.BuildArchive()
		id, err := a.LookupBuildID(c.downgradeBuilderName)
		if err != nil {
			return nil, fmt.Errorf("failed to lookup build id: %s", err)
		}
		c.downgradeBuildID = id
	}

	if c.downgradeBuildID != "" {
		build, err := c.BuildArchive().GetBuildByID(c.downgradeBuildID)
		if err != nil {
			return nil, err
		}

		return build.GetPackageRepository()
	}

	return packages.NewRepository(c.downgradeAmberFilesDir)
}

func (c *Config) GetUpgradeRepository() (*packages.Repository, error) {
	if c.upgradeBuilderName != "" && c.upgradeBuildID == "" {
		a := c.BuildArchive()
		id, err := a.LookupBuildID(c.upgradeBuilderName)
		if err != nil {
			return nil, fmt.Errorf("failed to lookup build id: %s", err)
		}
		c.upgradeBuildID = id
	}

	if c.upgradeBuildID != "" {
		build, err := c.BuildArchive().GetBuildByID(c.upgradeBuildID)
		if err != nil {
			return nil, err
		}

		return build.GetPackageRepository()
	}

	return packages.NewRepository(c.upgradeAmberFilesDir)
}

func (c *Config) LocalHostname() (string, error) {
	if c.localHostname == "" {
		var err error
		c.localHostname, err = c.netaddr("--local", c.DeviceName)
		if err != nil {
			return "", fmt.Errorf("ERROR: netaddr failed: %s", err)
		}
		if c.localHostname == "" {
			return "", fmt.Errorf("unable to determine the local hostname")
		}
	}

	return c.localHostname, nil
}

func (c *Config) DeviceHostname() (string, error) {
	if c.deviceHostname == "" {
		var err error
		c.deviceHostname, err = c.netaddr("--nowait", "--timeout=1000", "--fuchsia", c.DeviceName)
		if err != nil {
			return "", fmt.Errorf("ERROR: netaddr failed: %s", err)
		}
		if c.deviceHostname == "" {
			return "", fmt.Errorf("unable to determine the device hostname")
		}
	}

	return c.deviceHostname, nil
}

func (c *Config) netaddr(arg ...string) (string, error) {
	stdout, stderr, err := util.RunCommand(c.netaddrPath, arg...)
	if err != nil {
		return "", fmt.Errorf("netaddr failed: %s: %s", err, string(stderr))
	}
	return strings.TrimRight(string(stdout), "\n"), nil
}