[push] Add devbox global push (#1064)

## Summary

Stacked on #1061

This allows users to push global config (and any other files) to a repo.
Pushing applies the current global profile on top of the latest commit
in the repo (clone, commit, and push). It does not require force because
it always applies on the latest commit.

## How was it tested?

```bash
devbox global pull [email protected]:mikeland86/global.git
devbox global push [email protected]:mikeland86/global.git
devbox global add curl
devbox global push [email protected]:mikeland86/global.git
```

Author: mikeland73

devbox.go

@@ -35,6 +35,7 @@ type Devbox interface {
 	PrintGlobalList() error
 	PrintEnvrcContent(w io.Writer) error
 	Pull(ctx context.Context, overwrite bool, path string) error
+	Push(url 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

internal/boxcli/global.go

@@ -27,6 +27,7 @@ func globalCmd() *cobra.Command {
 	addCommandAndHideConfigFlag(globalCmd, installCmd())
 	addCommandAndHideConfigFlag(globalCmd, pathCmd())
 	addCommandAndHideConfigFlag(globalCmd, pullCmd())
+	addCommandAndHideConfigFlag(globalCmd, pushCmd())
 	addCommandAndHideConfigFlag(globalCmd, removeCmd())
 	addCommandAndHideConfigFlag(globalCmd, runCmd())
 	addCommandAndHideConfigFlag(globalCmd, servicesCmd())

internal/boxcli/push.go

@@ -0,0 +1,39 @@
+// 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 boxcli
+
+import (
+	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
+	"go.jetpack.io/devbox"
+)
+
+type pushCmdFlags struct {
+	config configFlags
+}
+
+func pushCmd() *cobra.Command {
+	flags := pushCmdFlags{}
+	cmd := &cobra.Command{
+		Use:     "push <git-repo>",
+		Short:   "Push a [global] config to a git repo",
+		PreRunE: ensureNixInstalled,
+		Args:    cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return pushCmdFunc(cmd, args[0], flags)
+		},
+	}
+
+	flags.config.register(cmd)
+
+	return cmd
+}
+
+func pushCmdFunc(cmd *cobra.Command, url string, flags pushCmdFlags) error {
+	box, err := devbox.Open(flags.config.path, cmd.ErrOrStderr())
+	if err != nil {
+		return errors.WithStack(err)
+	}
+	return box.Push(url)
+}

internal/cmdutil/exec.go

@@ -0,0 +1,36 @@
+// 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 cmdutil
+
+import (
+	"bytes"
+	"io"
+	"os"
+	"os/exec"
+)
+
+func CommandTTY(name string, arg ...string) *exec.Cmd {
+	cmd := exec.Command(name, arg...)
+	cmd.Stdin = os.Stdin
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	return cmd
+}
+
+// CommandTTYWithBuffer returns a command with stdin, stdout, and stderr
+// and a buffer that contains stdout and stderr combined.
+func CommandTTYWithBuffer(
+	name string,
+	arg ...string,
+) (*exec.Cmd, *bytes.Buffer) {
+	cmd := exec.Command(name, arg...)
+	cmd.Stdin = os.Stdin
+
+	errBuf := bytes.NewBuffer(nil)
+	outBuf := bytes.NewBuffer(nil)
+	cmd.Stderr = io.MultiWriter(os.Stderr, errBuf)
+	cmd.Stdout = io.MultiWriter(os.Stdout, outBuf)
+	outBuf.Write(errBuf.Bytes())
+	return cmd, outBuf
+}

internal/fileutil/dir.go

@@ -0,0 +1,33 @@
+// 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 fileutil
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/pkg/errors"
+	"go.jetpack.io/devbox/internal/cmdutil"
+)
+
+func CopyAll(src, dst string) error {
+	entries, err := os.ReadDir(src)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+	for _, entry := range entries {
+		cmd := cmdutil.CommandTTY("cp", "-rf", filepath.Join(src, entry.Name()), dst)
+		if err := cmd.Run(); err != nil {
+			return errors.WithStack(err)
+		}
+	}
+	return nil
+}
+
+func ClearDir(dir string) error {
+	if err := os.RemoveAll(dir); err != nil {
+		return errors.WithStack(err)
+	}
+	return errors.WithStack(os.MkdirAll(dir, 0755))
+}

internal/impl/global.go

@@ -4,30 +4,19 @@
 package impl
 
 import (
-	"context"
 	"fmt"
 	"io/fs"
 	"os"
 	"path/filepath"
 
 	"github.com/pkg/errors"
 
-	"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) Pull(
-	ctx context.Context,
-	force bool,
-	path string,
-) error {
-	fmt.Fprintf(d.writer, "Pulling global config from %s\n", path)
-	return pullbox.New(d, path, force).Pull()
-}
-
 func (d *Devbox) PrintGlobalList() error {
 	for _, p := range d.cfg.Packages {
 		fmt.Fprintf(d.writer, "* %s\n", p)

internal/impl/pushpull.go

@@ -0,0 +1,22 @@
+package impl
+
+import (
+	"context"
+	"fmt"
+
+	"go.jetpack.io/devbox/internal/pullbox"
+)
+
+func (d *Devbox) Pull(
+	ctx context.Context,
+	force bool,
+	path string,
+) error {
+	fmt.Fprintf(d.writer, "Pulling global config from %s\n", path)
+	return pullbox.New(d, path, force).Pull()
+}
+
+func (d *Devbox) Push(url string) error {
+	fmt.Fprintf(d.writer, "Pushing global config\n")
+	return pullbox.New(d, url, false).Push()
+}

internal/pullbox/git/git.go

@@ -5,11 +5,10 @@ package git
 
 import (
 	"os"
-	"os/exec"
-	"path/filepath"
 	"strings"
 
 	"github.com/pkg/errors"
+	"go.jetpack.io/devbox/internal/cmdutil"
 )
 
 func CloneToTmp(repo string) (string, error) {
@@ -20,21 +19,17 @@ func CloneToTmp(repo string) (string, error) {
 	if err := clone(repo, tmpDir); err != nil {
 		return "", errors.WithStack(err)
 	}
-	if err := os.RemoveAll(filepath.Join(tmpDir, ".git")); err != nil {
-		return "", errors.WithStack(err)
-	}
 	return tmpDir, nil
 }
 
 func IsRepoURL(url string) bool {
 	// For now only support ssh
-	return strings.HasPrefix(url, "git@")
+	return strings.HasPrefix(url, "git@") ||
+		(strings.HasPrefix(url, "https://") && strings.HasSuffix(url, ".git"))
 }
 
 func clone(repo, dir string) error {
-	cmd := exec.Command("git", "clone", repo, dir)
-	cmd.Stderr = os.Stderr
-	cmd.Stdout = os.Stdout
+	cmd := cmdutil.CommandTTY("git", "clone", repo, dir)
 	cmd.Dir = dir
 	err := cmd.Run()
 	return errors.WithStack(err)

internal/pullbox/git/push.go

@@ -0,0 +1,72 @@
+package git
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/pkg/errors"
+	"go.jetpack.io/devbox/internal/cmdutil"
+	"go.jetpack.io/devbox/internal/fileutil"
+)
+
+const nothingToCommitErrorText = "nothing to commit"
+
+func Push(dir, url string) error {
+	tmpDir, err := CloneToTmp(url)
+	if err != nil {
+		return err
+	}
+	if err := removeNonGitFiles(tmpDir); err != nil {
+		return err
+	}
+
+	if err := fileutil.CopyAll(dir, tmpDir); err != nil {
+		return err
+	}
+
+	if err := createCommit(tmpDir); err != nil {
+		return err
+	}
+
+	return push(tmpDir)
+}
+
+func createCommit(dir string) error {
+	cmd := cmdutil.CommandTTY("git", "add", ".")
+	cmd.Dir = dir
+	if err := cmd.Run(); err != nil {
+		return errors.WithStack(err)
+	}
+	cmd, buf := cmdutil.CommandTTYWithBuffer(
+		"git", "commit", "-m", "devbox commit")
+	cmd.Dir = dir
+	err := cmd.Run()
+	if strings.Contains(buf.String(), nothingToCommitErrorText) {
+		return nil
+	}
+	return errors.WithStack(err)
+}
+
+func push(dir string) error {
+	cmd := cmdutil.CommandTTY("git", "push")
+	cmd.Dir = dir
+	err := cmd.Run()
+	return errors.WithStack(err)
+}
+
+func removeNonGitFiles(dir string) error {
+	entries, err := os.ReadDir(dir)
+	if err != nil {
+		return err
+	}
+	for _, entry := range entries {
+		if entry.Name() == ".git" {
+			continue
+		}
+		if err := os.RemoveAll(filepath.Join(dir, entry.Name())); err != nil {
+			return err
+		}
+	}
+	return nil
+}

internal/pullbox/pullbox.go

@@ -4,6 +4,10 @@
 package pullbox
 
 import (
+	"os"
+	"path/filepath"
+
+	"github.com/pkg/errors"
 	"go.jetpack.io/devbox/internal/boxcli/usererr"
 	"go.jetpack.io/devbox/internal/pullbox/git"
 )
@@ -28,6 +32,10 @@ func (p *pullbox) Pull() error {
 		if err != nil {
 			return err
 		}
+		// Remove the .git directory, we don't want to keep state
+		if err := os.RemoveAll(filepath.Join(tmpDir, ".git")); err != nil {
+			return errors.WithStack(err)
+		}
 		return p.copy(p.overwrite, tmpDir, p.ProjectDir())
 	}
 
@@ -52,3 +60,7 @@ func (p *pullbox) Pull() error {
 
 	return usererr.New("Could not determine how to pull %s", p.url)
 }
+
+func (p *pullbox) Push() error {
+	return git.Push(p.ProjectDir(), p.url)
+}