Use embedded zip to add Hugo submodule

Note:
- golang/go#45197

Author: metafeather

devenv/.gitignore

@@ -1 +1,2 @@
 dist/
+publish.zip

devenv/.goreleaser.yaml

@@ -15,7 +15,7 @@ before:
     # You may remove this if you don't use go modules.
     - go mod tidy
     # you may remove this if you don't need go generate
-    # - go generate ./...
+    - go generate ./...
 
 builds:
   - env:

devenv/Taskfile.yaml

@@ -22,6 +22,7 @@ tasks:
     - goreleaser build --clean --snapshot --single-target
 
   run:
+    - go generate ./...
     - go run main.go {{.CLI_ARGS}}
 
   stdlib:

devenv/cmd/doctor.go

@@ -21,7 +21,8 @@ If everything is working fine: please don't worry or
 file an issue; just ignore this.`,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		cacheDir := viper.GetString("cache-dir")
-		args = append([]string{"--taskfile", path.Join(cacheDir, "stdlib", "Taskfile.yaml"), "global:doctor"}, args...)
+		taskfile := path.Join(cacheDir, "embed", "stdlib", "Taskfile.yaml")
+		args = append([]string{"--taskfile", taskfile, "global:doctor"}, args...)
 		log.Debug("doctor called:", args)
 		return task.Run(args...)
 	},

devenv/cmd/init.go

@@ -19,14 +19,21 @@ var initCmd = &cobra.Command{
 		dir := viper.GetString("cache-dir")
 		log.Debug("cache-dir:", dir)
 
+		// Extract stdlib
 		stdlib := internal.NewStdlib(StdlibFS)
 		err := stdlib.Write(dir)
 		cobra.CheckErr(err)
-		log.Debug("stdlib written")
+		log.Debug("stdlib extracted")
 
-		// Prompt to check tools installed
+		// Uncompress submodules
+		err = internal.Unzip(path.Join(dir, "embed", "stdlib", "global", "publish.zip"), path.Join(dir))
+		cobra.CheckErr(err)
+		log.Debug("publish expanded")
+
+		// Run additional init tasks
 		cacheDir := viper.GetString("cache-dir")
-		args = append([]string{"--taskfile", path.Join(cacheDir, "stdlib", "Taskfile.yaml"), "global:init"}, args...)
+		taskfile := path.Join(cacheDir, "embed", "stdlib", "Taskfile.yaml")
+		args = append([]string{"--taskfile", taskfile, "global:init"}, args...)
 		log.Debug("init called:", args)
 		return task.Run(args...)
 	},

devenv/cmd/run.go

@@ -24,8 +24,9 @@ var runCmd = &cobra.Command{
 		// Use global tasks from stdlib
 		global := viper.GetBool("global")
 		cacheDir := viper.GetString("cache-dir")
+		taskfile := path.Join(cacheDir, "embed", "stdlib", "Taskfile.yaml")
 		if global {
-			args = append([]string{"--taskfile", path.Join(cacheDir, "stdlib", "Taskfile.yaml")}, args...)
+			args = append([]string{"--taskfile", taskfile}, args...)
 		}
 
 		log.Debug("run called:", args)

devenv/internal/stdlib.go

@@ -8,7 +8,6 @@ import (
 	"os"
 	"path"
 	"path/filepath"
-	"strings"
 
 	"github.com/metafeather/tools/devenv/internal/log"
 )
@@ -58,8 +57,6 @@ func (sl *Stdlib) Write(p string) error {
 		if err != nil {
 			return err
 		}
-		// embed/ is the prefix for embedded files, so we need to remove it
-		file = strings.TrimPrefix(file, "embed/")
 		fullpath := path.Join(p, file)
 		err = os.MkdirAll(filepath.Dir(fullpath), 0700)
 		if err != nil {

devenv/internal/unzip.go

@@ -0,0 +1,84 @@
+package internal
+
+import (
+	"archive/zip"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+func Unzip(src, dest string) error {
+	dest = filepath.Clean(dest) + string(os.PathSeparator)
+
+	r, err := zip.OpenReader(src)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		if err := r.Close(); err != nil {
+			panic(err)
+		}
+	}()
+
+	err = os.MkdirAll(dest, 0755)
+	if err != nil {
+		return err
+	}
+
+	// Closure to address file descriptors issue with all the deferred .Close() methods
+	extractAndWriteFile := func(f *zip.File) error {
+		path := filepath.Join(dest, f.Name)
+		// Check for ZipSlip: https://snyk.io/research/zip-slip-vulnerability
+		if !strings.HasPrefix(path, dest) {
+			return fmt.Errorf("%s: illegal file path", path)
+		}
+
+		rc, err := f.Open()
+		if err != nil {
+			return err
+		}
+		defer func() {
+			if err := rc.Close(); err != nil {
+				panic(err)
+			}
+		}()
+
+		if f.FileInfo().IsDir() {
+			err := os.MkdirAll(path, f.Mode())
+			if err != nil {
+				return err
+			}
+		} else {
+			err := os.MkdirAll(filepath.Dir(path), f.Mode())
+			if err != nil {
+				return err
+			}
+			f, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
+			if err != nil {
+				return err
+			}
+			defer func() {
+				if err := f.Close(); err != nil {
+					panic(err)
+				}
+			}()
+
+			_, err = io.Copy(f, rc)
+			if err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+
+	for _, f := range r.File {
+		err := extractAndWriteFile(f)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}

devenv/main.go

@@ -23,6 +23,9 @@ import (
 	"github.com/metafeather/tools/devenv/cmd"
 )
 
+// Submodules cannot be embedded directly so zip them up
+//
+//go:generate zip -r embed/stdlib/global/publish.zip embed/stdlib/global/publish
 //go:embed all:embed/stdlib
 var stdlib embed.FS