[CLI] Added http url handling to create template (#1346)

## Summary
Added arbitrary git repo url handling to `devbox create` by adding
`--repo` and `--subdir` flags. The behavior is as follows:
Either `--template` or `--repo` are required flags.
When `--template` is provided, we clone from devbox and use the mapping
(no change)
When `--repo` is provided we clone that repo and if `--subdir` is
provided, we copy over only the contents of the `subdir` otherwise, the
whole repo is copied over.

Update: marked the 2 new flags (`--repo` and `--subdir`) hidden.

## How was it tested?
See unit tests

Author: mohsenari

internal/boxcli/create.go

@@ -10,13 +10,16 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"go.jetpack.io/devbox/internal/boxcli/usererr"
 	"go.jetpack.io/devbox/internal/templates"
 	"go.jetpack.io/devbox/internal/ux"
 )
 
 type createCmdFlags struct {
 	showAll  bool
 	template string
+	repo     string
+	subdir   string
 }
 
 func createCmd() *cobra.Command {
@@ -26,7 +29,7 @@ func createCmd() *cobra.Command {
 		Short: "Initialize a directory as a devbox project using a template",
 		Args:  cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			if flags.template == "" {
+			if flags.template == "" && flags.repo == "" {
 				fmt.Fprintf(
 					cmd.ErrOrStderr(),
 					"Usage: devbox create [dir] --template <template>\n\n",
@@ -52,18 +55,32 @@ func createCmd() *cobra.Command {
 		&flags.showAll, "show-all", false,
 		"show all available templates",
 	)
+	command.Flags().StringVarP(
+		&flags.repo, "repo", "r", "",
+		"Git repository HTTPS URL to import template files from. Example: https://github.com/jetpack-io/devbox",
+	)
+	command.Flags().StringVarP(
+		&flags.subdir, "subdir", "s", "",
+		"Subdirectory of the Git repository in which the template files reside. Example: examples/tutorial",
+	)
+	// this command marks a flag as hidden. Error handling for it is not necessary.
+	_ = command.Flags().MarkHidden("repo")
+	_ = command.Flags().MarkHidden("subdir")
 
 	return command
 }
 
 func runCreateCmd(cmd *cobra.Command, args []string, flags *createCmdFlags) error {
-	path := pathArg(args)
-	if path == "" {
-		wd, _ := os.Getwd()
-		path = filepath.Join(wd, flags.template)
-	}
+	path := handlePath(args, flags)
 
-	err := templates.Init(cmd.ErrOrStderr(), flags.template, path)
+	var err error
+	if flags.template != "" {
+		err = templates.InitFromName(cmd.ErrOrStderr(), flags.template, path)
+	} else if flags.repo != "" {
+		err = templates.InitFromRepo(cmd.ErrOrStderr(), flags.repo, flags.subdir, path)
+	} else {
+		err = usererr.New("either --template or --repo need to be specified")
+	}
 	if err != nil {
 		return err
 	}
@@ -76,3 +93,18 @@ func runCreateCmd(cmd *cobra.Command, args []string, flags *createCmdFlags) erro
 
 	return nil
 }
+
+func handlePath(args []string, flags *createCmdFlags) string {
+	path := pathArg(args)
+	wd, _ := os.Getwd()
+	if path == "" {
+		if flags.template != "" {
+			path = filepath.Join(wd, flags.template)
+		} else if flags.repo != "" && flags.subdir == "" {
+			path = filepath.Join(wd, filepath.Base(flags.repo))
+		} else if flags.repo != "" && flags.subdir != "" {
+			path = filepath.Join(wd, filepath.Base(flags.subdir))
+		}
+	}
+	return path
+}

internal/templates/template.go

@@ -6,9 +6,11 @@ package templates
 import (
 	"fmt"
 	"io"
+	"net/url"
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strings"
 
 	"github.com/pkg/errors"
 	"github.com/samber/lo"
@@ -17,23 +19,28 @@ import (
 	"go.jetpack.io/devbox/internal/boxcli/usererr"
 )
 
-func Init(w io.Writer, template, dir string) error {
-	if err := createDirAndEnsureEmpty(dir); err != nil {
-		return err
-	}
-
+func InitFromName(w io.Writer, template string, target string) error {
 	templatePath, ok := templates[template]
 	if !ok {
-		return usererr.New("unknown template %q", template)
+		return usererr.New("unknown template name or format %q", template)
+	}
+	return InitFromRepo(w, "https://github.com/jetpack-io/devbox", templatePath, target)
+}
+
+func InitFromRepo(w io.Writer, repo string, subdir string, target string) error {
+	if err := createDirAndEnsureEmpty(target); err != nil {
+		return err
+	}
+	parsedRepoURL, err := ParseRepoURL(repo)
+	if err != nil {
+		return errors.WithStack(err)
 	}
 
 	tmp, err := os.MkdirTemp("", "devbox-template")
 	if err != nil {
 		return errors.WithStack(err)
 	}
-	cmd := exec.Command(
-		"git", "clone", "https://github.com/jetpack-io/devbox.git", tmp,
-	)
+	cmd := exec.Command("git", "clone", parsedRepoURL, tmp)
 	fmt.Fprintf(w, "%s\n", cmd)
 	cmd.Stderr = os.Stderr
 	cmd.Stdout = os.Stdout
@@ -43,7 +50,7 @@ func Init(w io.Writer, template, dir string) error {
 
 	cmd = exec.Command(
 		"sh", "-c",
-		fmt.Sprintf("cp -r %s %s", filepath.Join(tmp, templatePath, "*"), dir),
+		fmt.Sprintf("cp -r %s %s", filepath.Join(tmp, subdir, "*"), target),
 	)
 	fmt.Fprintf(w, "%s\n", cmd)
 	cmd.Stderr = os.Stderr
@@ -80,3 +87,13 @@ func createDirAndEnsureEmpty(dir string) error {
 
 	return nil
 }
+
+func ParseRepoURL(repo string) (string, error) {
+	u, err := url.Parse(repo)
+	if err != nil || u.Scheme == "" || u.Host == "" {
+		return "", usererr.New("Invalid URL format for --repo %s", repo)
+	}
+	// this is to handle cases where user puts repo url with .git at the end
+	// like: https://github.com/jetpack-io/devbox.git
+	return strings.TrimSuffix(repo, ".git"), nil
+}

internal/templates/templates_test.go

@@ -8,6 +8,7 @@ import (
 	"testing"
 
 	"github.com/pkg/errors"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestTemplatesExist(t *testing.T) {
@@ -26,3 +27,22 @@ func TestTemplatesExist(t *testing.T) {
 		}
 	}
 }
+
+func TestParseRepoURL(t *testing.T) {
+	// devbox create --repo="http:::/not.valid/a//a??a?b=&&c#hi"
+	_, err := ParseRepoURL("http:::/not.valid/a//a??a?b=&&c#hi")
+	assert.Error(t, err)
+	_, err = ParseRepoURL("http//github.com")
+	assert.Error(t, err)
+	_, err = ParseRepoURL("github.com")
+	assert.Error(t, err)
+	_, err = ParseRepoURL("/foo/bar")
+	assert.Error(t, err)
+	_, err = ParseRepoURL("http://")
+	assert.Error(t, err)
+	_, err = ParseRepoURL("[email protected]:jetpack-io/devbox.git")
+	assert.Error(t, err)
+	u, err := ParseRepoURL("http://github.com")
+	assert.NoError(t, err)
+	assert.Equal(t, "http://github.com", u)
+}