Add template add command

Author: stuartleeks

cmd/devcontainer/template.go

@@ -2,10 +2,12 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
+	"sort"
 
 	"github.com/spf13/cobra"
+	"github.com/stuartleeks/devcontainer-cli/internal/pkg/devcontainers"
+	ioutil2 "github.com/stuartleeks/devcontainer-cli/internal/pkg/ioutil"
 )
 
 func createTemplateCommand() *cobra.Command {
@@ -15,38 +17,85 @@ func createTemplateCommand() *cobra.Command {
 		Long:  "Use subcommands to work with devcontainer templates",
 	}
 	cmd.AddCommand(createTemplateListCommand())
+	cmd.AddCommand(createTemplateAddCommand())
 	return cmd
 }
 
 func createTemplateListCommand() *cobra.Command {
-	isDevcontainerFolder := func(parentPath string, fi os.FileInfo) bool {
-		if !fi.IsDir() {
-			return false
-		}
-		devcontainerJsonPath := fmt.Sprintf("%s/%s/.devcontainer/devcontainer.json", parentPath, fi.Name())
-		devContainerJsonInfo, err := os.Stat(devcontainerJsonPath)
-		return err == nil && !devContainerJsonInfo.IsDir()
-	}
+
 	cmd := &cobra.Command{
 		Use:   "list",
 		Short: "list templates",
 		Long:  "List devcontainer templates",
 		Run: func(cmd *cobra.Command, args []string) {
-			const containerFolder string = "$HOME/source/vscode-dev-containers/containers" // TODO - make configurable!
 
-			folder := os.ExpandEnv(containerFolder)
-			c, err := ioutil.ReadDir(folder)
+			templates, err := devcontainers.GetTemplates()
+			if err != nil {
+				fmt.Println(err)
+				os.Exit(1)
+			}
+
+			for _, template := range templates {
+				fmt.Println(template.Name)
+			}
+		},
+	}
+	return cmd
+}
+
+func createTemplateAddCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "add TEMPLATE_NAME",
+		Short: "add devcontainer from template",
+		Long:  "Add a devcontainer definition to the current folder using the specified template",
+		Run: func(cmd *cobra.Command, args []string) {
+
+			if len(args) != 1 {
+				cmd.Usage()
+				os.Exit(1)
+			}
+			name := args[0]
+
+			template, err := devcontainers.GetTemplateByName(name)
 			if err != nil {
-				fmt.Printf("Error reading devcontainer definitions: %s\n", err)
+				fmt.Println(err)
 				os.Exit(1)
 			}
+			if template == nil {
+				fmt.Printf("Template '%s' not found\n", name)
+			}
 
-			for _, entry := range c {
-				if isDevcontainerFolder(folder, entry) {
-					fmt.Println(entry.Name())
-				}
+			info, err := os.Stat("./.devcontainer")
+			if info != nil && err == nil {
+				fmt.Println("Current folder already contains a .devcontainer folder - exiting")
+				os.Exit(1)
 			}
 
+			currentDirectory, err := os.Getwd()
+			if err != nil {
+				fmt.Printf("Error reading current directory: %s\n", err)
+			}
+			if err = ioutil2.CopyFolder(template.Path, currentDirectory+"/.devcontainer"); err != nil {
+				fmt.Printf("Error copying folder: %s\n", err)
+				os.Exit(1)
+			}
+		},
+		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+			// only completing the first arg  (template name)
+			if len(args) != 0 {
+				return nil, cobra.ShellCompDirectiveNoFileComp
+			}
+			templates, err := devcontainers.GetTemplates()
+			if err != nil {
+				fmt.Printf("Error: %v", err)
+				os.Exit(1)
+			}
+			names := []string{}
+			for _, template := range templates {
+				names = append(names, template.Name)
+			}
+			sort.Strings(names)
+			return names, cobra.ShellCompDirectiveNoFileComp
 		},
 	}
 	return cmd

internal/pkg/devcontainers/template.go

@@ -0,0 +1,61 @@
+package devcontainers
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+)
+
+// DevcontainerTemplate holds info on templates for list/add etc
+type DevcontainerTemplate struct {
+	Name string
+	// Path is the path including the .devcontainer folder
+	Path string
+}
+
+// GetTemplateByName returns the template with the specified name or nil if not found
+func GetTemplateByName(name string) (*DevcontainerTemplate, error) {
+	// TODO - could possibly make this quicker by searching using the name rather than listing all and filtering
+	templates, err := GetTemplates()
+	if err != nil {
+		return nil, err
+	}
+	for _, template := range templates {
+		if template.Name == name {
+			return &template, nil
+		}
+	}
+	return nil, nil
+}
+
+// GetTemplates returns a list of discovered templates
+func GetTemplates() ([]DevcontainerTemplate, error) {
+	const containerFolder string = "$HOME/source/vscode-dev-containers/containers" // TODO - make configurable!
+
+	isDevcontainerFolder := func(parentPath string, fi os.FileInfo) bool {
+		if !fi.IsDir() {
+			return false
+		}
+		devcontainerJsonPath := fmt.Sprintf("%s/%s/.devcontainer/devcontainer.json", parentPath, fi.Name())
+		devContainerJsonInfo, err := os.Stat(devcontainerJsonPath)
+		return err == nil && !devContainerJsonInfo.IsDir()
+	}
+
+	folder := os.ExpandEnv(containerFolder)
+	c, err := ioutil.ReadDir(folder)
+	if err != nil {
+		return []DevcontainerTemplate{}, fmt.Errorf("Error reading devcontainer definitions: %s\n", err)
+	}
+
+	templates := []DevcontainerTemplate{}
+	for _, entry := range c {
+		if isDevcontainerFolder(folder, entry) {
+			template := DevcontainerTemplate{
+				Name: entry.Name(),
+				Path: fmt.Sprintf("%s/%s/.devcontainer", folder, entry.Name()),
+			}
+			templates = append(templates, template)
+		}
+	}
+	return templates, nil
+}

internal/pkg/ioutil/files.go

@@ -0,0 +1,49 @@
+package ioutil
+
+import (
+	"fmt"
+	"io"
+	"io/ioutil"
+	"os"
+)
+
+// TODO - recursive copy folder (also add recursive symlink)
+
+func CopyFolder(source string, target string) error {
+	sourceItem, err := os.Stat(source)
+	if err != nil {
+		return fmt.Errorf("Error reading source folder: %s\n", err)
+	}
+	if err = os.Mkdir(target, sourceItem.Mode()); err != nil {
+		return fmt.Errorf("Error creating directory '%s': %s", target, err)
+	}
+
+	sourceSubItems, err := ioutil.ReadDir(source)
+	if err != nil {
+		return fmt.Errorf("Error reading source folder contents: %s\n", err)
+	}
+
+	for _, sourceSubItem := range sourceSubItems {
+		if sourceSubItem.IsDir() {
+			CopyFolder(source+"/"+sourceSubItem.Name(), target+"/"+sourceSubItem.Name())
+		} else {
+			CopyFile(source+"/"+sourceSubItem.Name(), target+"/"+sourceSubItem.Name(), sourceSubItem.Mode())
+		}
+	}
+	return nil
+}
+func CopyFile(source string, target string, perm os.FileMode) error {
+	sourceFile, err := os.Open(source)
+	if err != nil {
+		return err
+	}
+	defer sourceFile.Close()
+
+	targetFile, err := os.OpenFile(target, os.O_RDWR|os.O_CREATE|os.O_EXCL|os.O_TRUNC, perm)
+	if err != nil {
+		return err
+	}
+	defer targetFile.Close()
+	_, err = io.Copy(targetFile, sourceFile)
+	return err
+}