Fixing CI

- Added comment on why bzr tests are being skipped
- Fixed the git submodule handling on Windows

Signed-off-by: Matt Farina <matt@mattfarina.com>

Author: mattfarina

.github/workflows/windows-tests.yaml

@@ -25,4 +25,9 @@ jobs:
     - name: Test
       run: go test -v
       env:
+        # Skipping bzr tests on Windows as bzr does not install properly there.
+        # bzr development stopped in 2017 (when last change landed). The official
+        # windows installer is still bzr 2.5. The installer does not setup working
+        # cacerts. This needs to be manually modified to get working. Skipping
+        # tests in this environment as there are environment problems.
         SKIP_BZR: "true"

git.go

@@ -412,8 +412,8 @@ func (s *GitRepo) ExportDir(dir string) error {
 	}
 
 	// and now, the horror of submodules
-	path = EscapePathSeparator(dir + "$path" + string(os.PathSeparator))
-	out, err = s.RunFromDir("git", "submodule", "foreach", "--recursive", "git checkout-index -f -a --prefix="+path)
+	handleSubmodules(s, dir)
+
 	s.log(out)
 	if err != nil {
 		return NewLocalError("Error while exporting submodule sources", err, string(out))

git_test.go

@@ -573,6 +573,9 @@ func TestGitSubmoduleHandling2(t *testing.T) {
 
 	exportDir := filepath.Join(tempDir2, "src")
 
+	tl := testLogger(t)
+	repo.Logger = tl
+
 	err = repo.ExportDir(exportDir)
 	if err != nil {
 		t.Errorf("Unable to export Git repo. Err was %s", err)

git_unix.go

@@ -0,0 +1,13 @@
+//go:build !windows
+// +build !windows
+
+package vcs
+
+import "os"
+
+func handleSubmodules(g *GitRepo, dir string) ([]byte, error) {
+	// Generate path
+	path := EscapePathSeparator(dir + "$path" + string(os.PathSeparator))
+
+	return g.RunFromDir("git", "submodule", "foreach", "--recursive", "git checkout-index -f -a --prefix="+path)
+}

git_windows.go

@@ -0,0 +1,47 @@
+//go:build windows
+// +build windows
+
+package vcs
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+func handleSubmodules(g *GitRepo, dir string) ([]byte, error) {
+	// Get the submodule directories
+	out, err := g.RunFromDir("git", "submodule", "foreach", "--quiet", "--recursive", "echo $sm_path")
+	if err != nil {
+		return out, err
+	}
+	cleanOut := strings.TrimSpace(string(out))
+	pths := strings.Split(strings.ReplaceAll(cleanOut, "\r\n", "\n"), "\n")
+
+	// Create the new directories. Directories are sometimes not created under
+	// Windows
+	for _, pth := range pths {
+		fpth := filepath.Join(dir + pth)
+		os.MkdirAll(fpth, 0755)
+	}
+
+	// checkout-index for each submodule. Using $path or $sm_path while iterating
+	// over the submodules does not work in Windows when called from Go.
+	var cOut []byte
+	for _, pth := range pths {
+		// Get the path to the submodule in the exported location
+		fpth := EscapePathSeparator(filepath.Join(dir, pth) + string(os.PathSeparator))
+
+		// Call checkout-index directly in the submodule rather than in the
+		// parent project. This stils git submodule foreach that has trouble
+		// on Windows within Go where $sm_path isn't being handled properly
+		c := g.CmdFromDir("git", "checkout-index", "-f", "-a", "--prefix="+fpth)
+		c.Dir = filepath.Join(c.Dir, pth)
+		out, err := c.CombinedOutput()
+		cOut = append(cOut, out...)
+		if err != nil {
+			return cOut, err
+		}
+	}
+	return cOut, nil
+}

repo_test.go

@@ -3,6 +3,7 @@ package vcs
 import (
 	"fmt"
 	"io/ioutil"
+	"log"
 	"os"
 	"testing"
 )
@@ -72,3 +73,16 @@ func TestDepInstalled(t *testing.T) {
 		t.Error("depInstalled finding not installed dep.")
 	}
 }
+
+func testLogger(t *testing.T) *log.Logger {
+	return log.New(testWriter{t}, "test", log.LstdFlags)
+}
+
+type testWriter struct {
+	t *testing.T
+}
+
+func (tw testWriter) Write(p []byte) (n int, err error) {
+	tw.t.Log(string(p))
+	return len(p), nil
+}