[project-clone] Initialize and update submodules when present in project

If a cloned-and-checked-out project has a .gitmodules file in the root
of the repo, run 'git submodule update --init --recursive' inside the
project to clone all submodules.

Failures in setting up submodules result only in a warning log and do
not prevent the project from being 'set up', as the user can later
initialize submodules manually.

Signed-off-by: Angel Misevski <[email protected]>

project-clone/internal/git/operations.go

@@ -18,6 +18,8 @@ package git
 import (
 	"fmt"
 	"log"
+	"os"
+	"path"
 
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	"github.com/go-git/go-git/v5"
@@ -118,6 +120,18 @@ func SetupRemotes(repo *git.Repository, project *dw.Project, projectPath string)
 	return nil
 }
 
+func SetupSubmodules(project *dw.Project, projectPath string) error {
+	if _, err := os.Stat(path.Join(projectPath, ".gitmodules")); os.IsNotExist(err) {
+		// No submodules; do nothing
+		return nil
+	}
+	log.Printf("Initializing submodules for project %s", project.Name)
+	if err := shell.GitInitSubmodules(projectPath); err != nil {
+		return fmt.Errorf("git submodule update --init --recursive failed: %s", err)
+	}
+	return nil
+}
+
 // CheckoutReference sets the current HEAD in repo to point at the revision and remote referenced by checkoutFrom
 func CheckoutReference(project *dw.Project, projectPath string) error {
 	checkoutFrom := project.Git.CheckoutFrom

project-clone/internal/git/setup.go

@@ -71,6 +71,10 @@ func doInitialGitClone(project *dw.Project) error {
 		return fmt.Errorf("failed to checkout revision: %s", err)
 	}
 
+	if err := SetupSubmodules(project, tmpClonePath); err != nil {
+		log.Printf("Failed to set up submodules in project: %s", err)
+	}
+
 	if err := copyProjectFromTmpDir(project, tmpClonePath); err != nil {
 		return err
 	}

project-clone/internal/shell/execute.go

@@ -99,6 +99,10 @@ func GitResolveReference(projectPath, remote, revision string) (GitRefType, erro
 	return GitRefUnknown, nil
 }
 
+func GitInitSubmodules(projectPath string) error {
+	return executeCommand("git", "-C", projectPath, "submodule", "update", "--init", "--recursive")
+}
+
 func executeCommand(name string, args ...string) error {
 	cmd := exec.Command(name, args...)
 	cmd.Stderr = log.Writer()