fix: check working tree is clean before upgrading

Author: grezle

pkg/commands/template/upgrade.go

@@ -148,14 +148,20 @@ func createUpgradeCommand(
 			// Create a gitClient for upgrade process
 			gitClient := template.NewGitClient()
 
+			// Check if working tree is clean before upgrading
+			clean, err := gitClient.GitIsClean()
+			if err != nil {
+				return fmt.Errorf("failed to check .git working tree state: %w", err)
+			}
+			if !clean {
+				return fmt.Errorf("uncommitted changes found, please commit or stash them before upgrading")
+			}
+
 			// Ensure .gitignore entry is present for tempExternal
 			tempExternal := "temp_external"
 			if err := gitClient.EnsureGitignoreEntry(".gitignore", tempExternal); err != nil {
 				return fmt.Errorf("failed to add entry to .gitignore %s: %w", tempExternal, err)
 			}
-			if err := gitClient.Commit(".gitignore", fmt.Sprintf("chore: ensure %s is in .gitignore", tempExternal)); err != nil {
-				return fmt.Errorf("failed to commit entry to .gitignore %s: %w", tempExternal, err)
-			}
 
 			// Ensure parent exists
 			tempParent := filepath.Join(absProjectPath, tempExternal)

pkg/commands/template/upgrade_test.go

@@ -103,6 +103,11 @@ func TestUpgradeCommand(t *testing.T) {
 		t.Fatalf("Failed to write config file: %v", err)
 	}
 
+	// Create git repo in temp dir
+	if err := testutils.TestGitInit(testProjectsDir); err != nil {
+		t.Fatalf("Failed init git repo: %v", err)
+	}
+
 	// Create mock template info getter
 	mockTemplateInfoGetter := &MockTemplateInfoGetter{
 		projectName:      "template-upgrade-test",
@@ -137,6 +142,11 @@ func TestUpgradeCommand(t *testing.T) {
 
 	// Test upgrade command with version flag
 	t.Run("Upgrade command with version", func(t *testing.T) {
+		// Discard changes between runs
+		if err := testutils.TestGitDiscardChanges(testProjectsDir); err != nil {
+			t.Fatalf("Failed to clean working tree: %v", err)
+		}
+
 		// Create a flag set and context with no-op logger
 		set := flag.NewFlagSet("test", 0)
 		set.String("version", "v0.0.4", "")
@@ -186,6 +196,11 @@ func TestUpgradeCommand(t *testing.T) {
 
 	// Test upgrade command without version flag
 	t.Run("Upgrade command without version", func(t *testing.T) {
+		// Discard changes between runs
+		if err := testutils.TestGitDiscardChanges(testProjectsDir); err != nil {
+			t.Fatalf("Failed to clean working tree: %v", err)
+		}
+
 		// Create a flag set and context without version flag, with no-op logger
 		set := flag.NewFlagSet("test", 0)
 
@@ -233,6 +248,11 @@ func TestUpgradeCommand(t *testing.T) {
 
 	// Test upgrade command with incompatible to devkit version
 	t.Run("Upgrade command with incompatible version", func(t *testing.T) {
+		// Discard changes between runs
+		if err := testutils.TestGitDiscardChanges(testProjectsDir); err != nil {
+			t.Fatalf("Failed to clean working tree: %v", err)
+		}
+
 		// Create a flag set and context with no-op logger
 		set := flag.NewFlagSet("test", 0)
 		set.String("version", "v0.0.5", "")
@@ -258,6 +278,11 @@ func TestUpgradeCommand(t *testing.T) {
 
 	// Test with missing config file
 	t.Run("No config file", func(t *testing.T) {
+		// Discard changes between runs
+		if err := testutils.TestGitDiscardChanges(testProjectsDir); err != nil {
+			t.Fatalf("Failed to clean working tree: %v", err)
+		}
+
 		// Create a separate directory without a config file
 		noConfigDir := filepath.Join(testProjectsDir, "no-config")
 		err = os.MkdirAll(noConfigDir, 0755)

pkg/template/git_client.go

@@ -2,6 +2,7 @@ package template
 
 import (
 	"bufio"
+	"bytes"
 	"context"
 	"fmt"
 	"io"
@@ -240,6 +241,17 @@ func (g *GitClient) ParseCloneOutput(r io.Reader, rep Reporter, dest string, ref
 	return nil
 }
 
+func (g *GitClient) GitIsClean() (bool, error) {
+	cmd := exec.Command("git", "status", "--porcelain")
+	var out bytes.Buffer
+	cmd.Stdout = &out
+	cmd.Stderr = &out
+	if err := cmd.Run(); err != nil {
+		return false, fmt.Errorf("git status failed: %w\n%s", err, out.String())
+	}
+	return strings.TrimSpace(out.String()) == "", nil
+}
+
 func (g *GitClient) EnsureGitignoreEntry(path, entry string) error {
 	// Create .gitignore if missing
 	f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE, 0o644)
@@ -263,6 +275,11 @@ func (g *GitClient) EnsureGitignoreEntry(path, entry string) error {
 	if _, err := f.WriteString("\n" + entry + "\n"); err != nil {
 		return fmt.Errorf("write %s: %w", path, err)
 	}
+
+	if err := g.Commit(".gitignore", fmt.Sprintf("chore: ensure %s is in .gitignore", entry)); err != nil {
+		return fmt.Errorf("failed to commit entry to .gitignore %s: %w", entry, err)
+	}
+
 	return nil
 }
 

pkg/testutils/utils.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"testing"
 
@@ -249,3 +250,36 @@ func CaptureOutput(fn func()) (stdout string, stderr string) {
 
 	return stdout, stderr
 }
+
+func TestGitCall(repoDir string, cmds [][]string) error {
+	for _, args := range cmds {
+		cmd := exec.Command(args[0], args[1:]...)
+		cmd.Dir = repoDir
+		out, err := cmd.CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("git command %v failed: %v\n%s", args, err, out)
+		}
+	}
+	return nil
+}
+
+func TestGitInit(repoDir string) error {
+	// Init git repo
+	cmds := [][]string{
+		{"git", "init"},
+		{"git", "config", "user.name", "Test User"},
+		{"git", "config", "user.email", "test@example.com"},
+		{"git", "add", "."},
+		{"git", "commit", "--allow-empty", "-m", "initial commit"},
+	}
+	return TestGitCall(repoDir, cmds)
+}
+
+func TestGitDiscardChanges(repoDir string) error {
+	// Discard changes in working tree
+	cmds := [][]string{
+		{"git", "reset", "--hard"},
+		{"git", "clean", "-fdx"},
+	}
+	return TestGitCall(repoDir, cmds)
+}