feat(compute): add install-viceroy command to pre-install Viceroy

CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Bug Fixes:
 
 - fix(auth): accept SSO JWT audiences with or without a trailing slash when validating the Fastly API endpoint. ([#1837](https://github.com/fastly/cli/pull/1837))
+- feat(compute): add `install-tools` command to pre-install the Viceroy binary ([#1833](https://github.com/fastly/cli/pull/1833))
 
 ### Enhancements:
 - feat(ngwaf/timeseries): add support for account and workspace times series commands ([#1823](https://github.com/fastly/cli/pull/1823))

Dockerfile-go

@@ -13,6 +13,13 @@ RUN apt-get update && apt-get install -y curl jq && apt-get -y clean && rm -rf /
 
 USER fastly
 
+# Pre-install Viceroy so the image is self-contained (no download at runtime).
+# Must run as the `fastly` user, since Viceroy installs into that user's config
+# directory (where `compute serve` later looks for it).
+#
+# TODO: Enable once https://github.com/fastly/cli/pull/1833 was released
+# RUN fastly compute install-tools
+
 WORKDIR /app
 ENTRYPOINT ["/usr/bin/fastly"]
 CMD ["--help"]

Dockerfile-node

@@ -13,6 +13,13 @@ RUN apt-get update && apt-get install -y curl jq && apt-get -y clean && rm -rf /
 
 USER fastly
 
+# Pre-install Viceroy so the image is self-contained (no download at runtime).
+# Must run as the `fastly` user, since Viceroy installs into that user's config
+# directory (where `compute serve` later looks for it).
+#
+# TODO: Enable once https://github.com/fastly/cli/pull/1833 was released
+# RUN fastly compute install-tools
+
 WORKDIR /app
 ENTRYPOINT ["/usr/bin/fastly"]
 CMD ["--help"]

Dockerfile-rust

@@ -16,6 +16,13 @@ RUN rustup target add wasm32-wasip1 \
 
 USER fastly
 
+# Pre-install Viceroy so the image is self-contained (no download at runtime).
+# Must run as the `fastly` user, since Viceroy installs into that user's config
+# directory (where `compute serve` later looks for it).
+#
+# TODO: Enable once https://github.com/fastly/cli/pull/1833 was released
+# RUN fastly compute install-tools
+
 WORKDIR /app
 ENTRYPOINT ["/usr/bin/fastly"]
 CMD ["--help"]

pkg/app/run.go

@@ -753,7 +753,7 @@ func commandRequiresToken(command argparser.Command) bool {
 			return text.IsFastlyID(initCmd.CloneFrom)
 		}
 		return false
-	case "compute build", "compute hash-files", "compute metadata", "compute pack", "compute serve", "compute validate":
+	case "compute build", "compute hash-files", "compute install-tools", "compute metadata", "compute pack", "compute serve", "compute validate":
 		return false
 	}
 	commandName = strings.Split(commandName, " ")[0]

pkg/commands/commands.go

@@ -256,6 +256,7 @@ func Define( // nolint:revive // function-length
 	computeDeploy := compute.NewDeployCommand(computeCmdRoot.CmdClause, data)
 	computeHashFiles := compute.NewHashFilesCommand(computeCmdRoot.CmdClause, data, computeBuild)
 	computeInit := compute.NewInitCommand(computeCmdRoot.CmdClause, data)
+	computeInstallTools := compute.NewInstallCommand(computeCmdRoot.CmdClause, data)
 	computeMetadata := compute.NewMetadataCommand(computeCmdRoot.CmdClause, data)
 	computePack := compute.NewPackCommand(computeCmdRoot.CmdClause, data)
 	computePublish := compute.NewPublishCommand(computeCmdRoot.CmdClause, data, computeBuild, computeDeploy)
@@ -1147,6 +1148,7 @@ func Define( // nolint:revive // function-length
 		computeDeploy,
 		computeHashFiles,
 		computeInit,
+		computeInstallTools,
 		computeMetadata,
 		computePack,
 		computePublish,

pkg/commands/compute/install.go

@@ -0,0 +1,60 @@
+package compute
+
+import (
+	"errors"
+	"io"
+	"runtime"
+
+	"github.com/fastly/cli/pkg/argparser"
+	fsterr "github.com/fastly/cli/pkg/errors"
+	"github.com/fastly/cli/pkg/global"
+	"github.com/fastly/cli/pkg/manifest"
+	"github.com/fastly/cli/pkg/text"
+)
+
+// InstallCommand pre-installs the tools that `compute` subcommands otherwise
+// download on first use. Today that's the Viceroy binary used by
+// `compute serve` (installed via viceroyInstaller, see viceroy.go); it's
+// intended to be extended to cover other tooling (e.g. wasm-tools for
+// `compute build`) so container images can be pre-warmed and don't need
+// network access at runtime.
+type InstallCommand struct {
+	argparser.Base
+}
+
+// NewInstallCommand returns a usable command registered under the parent.
+func NewInstallCommand(parent argparser.Registerer, g *global.Data) *InstallCommand {
+	var c InstallCommand
+	c.Globals = g
+	c.CmdClause = parent.Command("install-tools", "Download and install the tools used by `compute` subcommands (currently the Viceroy binary used by `compute serve`)")
+	return &c
+}
+
+// Exec implements the command interface.
+func (c *InstallCommand) Exec(_ io.Reader, out io.Writer) error {
+	if runtime.GOARCH == "386" {
+		return fsterr.RemediationError{
+			Inner:       errors.New("this command doesn't support the '386' architecture"),
+			Remediation: "Although the Fastly CLI supports '386', https://github.com/fastly/Viceroy does not.",
+		}
+	}
+
+	spinner, err := text.NewSpinner(out)
+	if err != nil {
+		return err
+	}
+
+	// The versioner is already seeded from the manifest's viceroy_version at
+	// startup, so a pinned version is honored when run inside a project. The
+	// manifest path is only used in messages, hence the default filename.
+	bin, err := viceroyInstaller{
+		Globals:   c.Globals,
+		Versioner: c.Globals.Versioners.Viceroy,
+	}.get(spinner, out, manifest.Filename)
+	if err != nil {
+		return err
+	}
+
+	text.Success(out, "Installed Viceroy to: %s", bin)
+	return nil
+}

pkg/commands/compute/install_test.go

@@ -0,0 +1,106 @@
+package compute_test
+
+import (
+	"bytes"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/fastly/cli/pkg/argparser"
+	"github.com/fastly/cli/pkg/commands/compute"
+	"github.com/fastly/cli/pkg/config"
+	fsterr "github.com/fastly/cli/pkg/errors"
+	"github.com/fastly/cli/pkg/github"
+	"github.com/fastly/cli/pkg/global"
+	"github.com/fastly/cli/pkg/mock"
+	"github.com/fastly/cli/pkg/testutil"
+)
+
+// TestInstallTools validates that `compute install-tools` installs Viceroy
+// to the appropriate directory using the same install path as `compute serve`.
+//
+// As with TestGetViceroy, there isn't an executable binary in the test
+// environment, so the `<binary> --version` subprocess call errors and the
+// installer downloads the (mocked) latest release, which `os.Rename()` then
+// moves into the install directory.
+func TestInstallTools(t *testing.T) {
+	wd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	viceroyBinName := "foo"
+	installDirName := "install"
+
+	rootdir := testutil.NewEnv(testutil.EnvOpts{
+		T: t,
+		Dirs: []string{
+			installDirName,
+		},
+		Write: []testutil.FileIO{
+			{Src: "...", Dst: viceroyBinName},
+
+			// NOTE: Created so the in-memory config can be written back to disk
+			// without failing because no such file existed.
+			{Src: "", Dst: config.FileName},
+		},
+	})
+	installDir := filepath.Join(rootdir, installDirName)
+	binPath := filepath.Join(rootdir, viceroyBinName)
+	configPath := filepath.Join(rootdir, config.FileName)
+	defer os.RemoveAll(rootdir)
+
+	if err := os.Chdir(rootdir); err != nil {
+		t.Fatal(err)
+	}
+	defer func() {
+		_ = os.Chdir(wd)
+	}()
+
+	github.InstallDir = installDir
+
+	var out bytes.Buffer
+
+	av := mock.AssetVersioner{
+		AssetVersion:   "1.2.3",
+		BinaryFilename: viceroyBinName,
+		DownloadOK:     true,
+		DownloadedFile: binPath,
+	}
+
+	var file config.File
+
+	// NOTE: We purposefully provide a nonsensical path, which we expect to fail,
+	// but the function call should fallback to using the stubbed static config.
+	err = file.Read("example", strings.NewReader("yes"), &out, fsterr.MockLog{}, false)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	cmd := &compute.InstallCommand{
+		Base: argparser.Base{
+			Globals: &global.Data{
+				Config:     file,
+				ConfigPath: configPath,
+				ErrLog:     fsterr.MockLog{},
+				Versioners: global.Versioners{
+					Viceroy: av,
+				},
+			},
+		},
+	}
+	if err := cmd.Exec(nil, &out); err != nil {
+		t.Fatal(err)
+	}
+
+	if !strings.Contains(out.String(), "Fetching Viceroy release: ") {
+		t.Fatalf("expected Viceroy to be downloaded successfully")
+	}
+
+	movedPath := filepath.Join(installDir, viceroyBinName)
+
+	if _, err := os.Stat(movedPath); err != nil {
+		t.Fatalf("binary was not moved to the install directory: %s", err)
+	}
+}