[pull] Implement pull tar (#1043)

## Summary

This implements:

```bash
devbox global pull https://example.com/file.tar.gz
```

Since this can generate conflicts (because of existing files), there's a
new `--force` flag that automatically overwrites.

If flag is not specified and there's a conflict, we ask the user if they
wan to overwrite.

TODO:

- [x] We should do an install after a successful pull

TODO in follow up:

- [ ] Currently we always ask the survey question because `devbox.json`
is created by default. So ideally if the devbox.json is empty, we always
overwrite. This requires some refactoring that I would prefer not to
include in this PR.

cc: @bketelsen

## How was it tested?

```bash
devbox global pull https://fleekgen.fly.dev/high
devbox global pull https://fleekgen.fly.dev/high --force
```

Author: mikeland73

devbox.go

@@ -33,7 +33,7 @@ type Devbox interface {
 	PrintEnv(ctx context.Context, includeHooks bool) (string, error)
 	PrintGlobalList() error
 	PrintEnvrcContent(w io.Writer) error
-	PullGlobal(ctx context.Context, path string) error
+	PullGlobal(ctx context.Context, overwrite bool, path string) error
 	// Remove removes Nix packages from the config so that it no longer exists in
 	// the devbox environment.
 	Remove(ctx context.Context, pkgs ...string) error

devbox.json

@@ -23,4 +23,4 @@
   "nixpkgs": {
     "commit": "3364b5b117f65fe1ce65a3cdd5612a078a3b31e3"
   }
-}
+}

internal/boxcli/global.go

@@ -5,14 +5,19 @@ package boxcli
 
 import (
 	"fmt"
+	"io/fs"
 
+	"github.com/AlecAivazis/survey/v2"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
-
 	"go.jetpack.io/devbox"
 	"go.jetpack.io/devbox/internal/ux"
 )
 
+type globalPullCmdFlags struct {
+	force bool
+}
+
 func globalCmd() *cobra.Command {
 
 	globalCmd := &cobra.Command{}
@@ -52,14 +57,24 @@ func globalListCmd() *cobra.Command {
 }
 
 func globalPullCmd() *cobra.Command {
-	return &cobra.Command{
+	flags := globalPullCmdFlags{}
+	cmd := &cobra.Command{
 		Use:     "pull <file> | <url>",
 		Short:   "Pull a global config from a file or URL",
 		Long:    "Pull a global config from a file or URL. URLs must be prefixed with 'http://' or 'https://'.",
 		PreRunE: ensureNixInstalled,
-		RunE:    pullGlobalCmdFunc,
-		Args:    cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return pullGlobalCmdFunc(cmd, args, flags.force)
+		},
+		Args: cobra.ExactArgs(1),
 	}
+
+	cmd.Flags().BoolVarP(
+		&flags.force, "force", "f", false,
+		"Force overwrite of existing global config files",
+	)
+
+	return cmd
 }
 
 func listGlobalCmdFunc(cmd *cobra.Command, args []string) error {
@@ -75,7 +90,11 @@ func listGlobalCmdFunc(cmd *cobra.Command, args []string) error {
 	return box.PrintGlobalList()
 }
 
-func pullGlobalCmdFunc(cmd *cobra.Command, args []string) error {
+func pullGlobalCmdFunc(
+	cmd *cobra.Command,
+	args []string,
+	overwrite bool,
+) error {
 	path, err := ensureGlobalConfig(cmd)
 	if err != nil {
 		return errors.WithStack(err)
@@ -85,7 +104,23 @@ func pullGlobalCmdFunc(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return errors.WithStack(err)
 	}
-	return box.PullGlobal(cmd.Context(), args[0])
+	err = box.PullGlobal(cmd.Context(), overwrite, args[0])
+	if errors.Is(err, fs.ErrExist) {
+		prompt := &survey.Confirm{
+			Message: "File(s) already exists. Overwrite?",
+		}
+		if err = survey.AskOne(prompt, &overwrite); err != nil {
+			return errors.WithStack(err)
+		}
+		if overwrite {
+			err = box.PullGlobal(cmd.Context(), overwrite, args[0])
+		}
+	}
+	if err != nil {
+		return err
+	}
+
+	return installCmdFunc(cmd, runCmdFlags{config: configFlags{path: path}})
 }
 
 var globalConfigPath string

internal/impl/global.go

@@ -15,16 +15,21 @@ import (
 	"github.com/pkg/errors"
 	"github.com/samber/lo"
 
+	"go.jetpack.io/devbox/internal/pullbox"
 	"go.jetpack.io/devbox/internal/xdg"
 )
 
 // In the future we will support multiple global profiles
 const currentGlobalProfile = "default"
 
-func (d *Devbox) PullGlobal(ctx context.Context, path string) error {
+func (d *Devbox) PullGlobal(
+	ctx context.Context,
+	force bool,
+	path string,
+) error {
 	u, err := url.Parse(path)
 	if err == nil && u.Scheme != "" {
-		return d.pullGlobalFromURL(ctx, u)
+		return d.pullGlobalFromURL(ctx, force, u)
 	}
 	return d.pullGlobalFromPath(ctx, path)
 }
@@ -36,9 +41,25 @@ func (d *Devbox) PrintGlobalList() error {
 	return nil
 }
 
-func (d *Devbox) pullGlobalFromURL(ctx context.Context, u *url.URL) error {
-	fmt.Fprintf(d.writer, "Pulling global config from %s\n", u)
-	cfg, err := readConfigFromURL(u)
+func (d *Devbox) pullGlobalFromURL(
+	ctx context.Context,
+	overwrite bool,
+	configURL *url.URL,
+) error {
+	fmt.Fprintf(d.writer, "Pulling global config from %s\n", configURL)
+	puller := pullbox.New()
+	if ok, err := puller.URLIsArchive(configURL.String()); ok {
+		fmt.Fprintf(
+			d.writer,
+			"%s is an archive, extracting to %s\n",
+			configURL,
+			d.ProjectDir(),
+		)
+		return puller.DownloadAndExtract(overwrite, configURL.String(), d.projectDir)
+	} else if err != nil {
+		return err
+	}
+	cfg, err := readConfigFromURL(configURL)
 	if err != nil {
 		return err
 	}

internal/pullbox/download.go

@@ -0,0 +1,30 @@
+// Copyright 2023 Jetpack Technologies Inc and contributors. All rights reserved.
+// Use of this source code is governed by the license in the LICENSE file.
+
+package pullbox
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+)
+
+// Download downloads a file from the specified URL
+func download(url string) ([]byte, error) {
+	response, err := http.Get(url)
+	if err != nil {
+		return nil, err
+	}
+	defer response.Body.Close()
+
+	if response.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("failed to download file: %s", response.Status)
+	}
+
+	data, err := io.ReadAll(response.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	return data, nil
+}

internal/pullbox/pullbox.go

@@ -0,0 +1,42 @@
+// Copyright 2023 Jetpack Technologies Inc and contributors. All rights reserved.
+// Use of this source code is governed by the license in the LICENSE file.
+
+package pullbox
+
+import (
+	"net/http"
+	"strings"
+)
+
+type pullbox struct {
+}
+
+func New() *pullbox {
+	return &pullbox{}
+}
+
+func (p *pullbox) DownloadAndExtract(overwrite bool, url, target string) error {
+	data, err := download(url)
+	if err != nil {
+		return err
+	}
+	tmpDir, err := extract(data)
+	if err != nil {
+		return err
+	}
+
+	return p.copy(overwrite, tmpDir, target)
+}
+
+// URLIsArchive checks if a file URL points to an archive file
+func (p *pullbox) URLIsArchive(url string) (bool, error) {
+	response, err := http.Head(url)
+	if err != nil {
+		return false, err
+	}
+	defer response.Body.Close()
+	contentType := response.Header.Get("Content-Type")
+	return strings.Contains(contentType, "tar") ||
+		strings.Contains(contentType, "zip") ||
+		strings.Contains(contentType, "octet-stream"), nil
+}

internal/pullbox/tar.go

@@ -0,0 +1,74 @@
+// Copyright 2023 Jetpack Technologies Inc and contributors. All rights reserved.
+// Use of this source code is governed by the license in the LICENSE file.
+
+package pullbox
+
+import (
+	"fmt"
+	"io/fs"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"syscall"
+
+	"github.com/pkg/errors"
+)
+
+// extract decompresses a tar file and saves it to a tmp directory
+func extract(data []byte) (string, error) {
+	tempFile, err := os.CreateTemp("", "temp.tar.gz")
+	if err != nil {
+		return "", err
+	}
+	defer os.Remove(tempFile.Name())
+	defer tempFile.Close()
+
+	_, err = tempFile.Write(data)
+	if err != nil {
+		return "", err
+	}
+
+	tempDir, err := os.MkdirTemp("", "temp")
+	if err != nil {
+		return "", err
+	}
+
+	cmd := exec.Command("tar", "-xf", tempFile.Name(), "-C", tempDir)
+
+	if err = cmd.Run(); err != nil {
+		var exitErr *exec.ExitError
+		if errors.As(err, &exitErr) {
+			waitStatus := exitErr.Sys().(syscall.WaitStatus)
+			return "", fmt.Errorf(
+				"tar extraction failed with exit code: %d",
+				waitStatus.ExitStatus(),
+			)
+		}
+		return "", err
+	}
+
+	return tempDir, nil
+}
+
+func (p *pullbox) copy(overwrite bool, src, dst string) error {
+	srcFiles, err := os.ReadDir(src)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	if !overwrite {
+		for _, srcFile := range srcFiles {
+			if _, err := os.Stat(filepath.Join(dst, srcFile.Name())); err == nil {
+				return fs.ErrExist
+			}
+		}
+	}
+
+	for _, srcFile := range srcFiles {
+		srcPath := filepath.Join(src, srcFile.Name())
+		if err := exec.Command("cp", "-rf", srcPath, dst).Run(); err != nil {
+			return err
+		}
+	}
+	return nil
+}