Add tests using git command actually

.github/workflows/ci.yml

@@ -36,5 +36,11 @@ jobs:
       - name: lint
         run: make lint
 
+      - name: setup git
+        run: |-
+          git config --global user.email foo@example.com && \
+          git config --global user.name "Foo Bar" && \
+          git config --global init.defaultBranch main
+
       - name: test
         run: make test

Makefile

@@ -7,7 +7,7 @@ build:
 
 .PHONY: test
 test:
-	go test -v .
+	go test -v ./...
 
 GOLANGCI_LINT_VERSION=v1.61.0
 GOLANGCI_LINT = $(shell go env GOPATH)/bin/golangci-lint

core/help.go

@@ -19,7 +19,7 @@ func Help() {
 * Use interactive mode for command which requires input such as "npx sv create" for SvelteKit.
 	git exec -i npx sv create my-app
 `
-	optionItems, envVarItems := opts.HelpItemsAndEnvVarMappings[Options](defaultOptions, optionTypes)
+	optionItems, envVarItems := opts.HelpItemsAndEnvVarMappings[Options](DefaultOptions, optionTypes)
 
 	options := "Options:\n" + strings.Join(optionItems, "\n")
 	envVars := "Environment variable mapping:\n" + strings.Join(envVarItems, "\n")

core/options.go

@@ -19,7 +19,7 @@ type Options struct {
 	Interactive bool
 }
 
-var defaultOptions = &Options{
+var DefaultOptions = &Options{
 	Help:        false,
 	Version:     false,
 	Directory:   "",
@@ -79,9 +79,9 @@ var optionTypes = func() []*opts.Definition[Options] {
 }()
 
 func newOptions() *Options {
-	return opts.NewOptions(optionTypes, defaultOptions)
+	return opts.NewOptions(optionTypes, DefaultOptions)
 }
 
 func ParseOptions(args []string) (*Options, []string, error) {
-	return opts.Parse(defaultOptions, optionTypes, args...)
+	return opts.Parse(DefaultOptions, optionTypes, args...)
 }

testdir/git.go

@@ -0,0 +1,58 @@
+package testdir
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+// GitRoot searches for the directory containing the .git directory starting from the current directory and moving upwards.
+// If the .git directory is found, it returns the path to that directory.
+// If the .git directory is not found, it fails the test.
+func GitRoot(t *testing.T) string {
+	dir, err := os.Getwd()
+	if err != nil {
+		t.Fatalf("Failed to get current directory: %v", err)
+	}
+
+	for {
+		if _, err := os.Stat(filepath.Join(dir, ".git")); err == nil {
+			return dir
+		}
+
+		parent := filepath.Dir(dir)
+		if parent == dir {
+			t.Fatalf(".git directory not found")
+		}
+		dir = parent
+	}
+}
+
+// FromGitRoot returns the absolute path by joining the Git root directory with the provided relative path.
+// If the .git directory is not found, it fails the test.
+func FromGitRoot(t *testing.T, relpath string) string {
+	return filepath.Join(GitRoot(t), relpath)
+}
+
+func GoModRoot(t *testing.T) string {
+	dir, err := os.Getwd()
+	if err != nil {
+		t.Fatalf("Failed to get current directory: %v", err)
+	}
+
+	for {
+		if _, err := os.Stat(filepath.Join(dir, "go.mod")); err == nil {
+			return dir
+		}
+
+		parent := filepath.Dir(dir)
+		if parent == dir {
+			t.Fatalf("go.mod file not found")
+		}
+		dir = parent
+	}
+}
+
+func FromGoModRoot(t *testing.T, relpath string) string {
+	return filepath.Join(GoModRoot(t), relpath)
+}

testdir/setup.go

@@ -0,0 +1,107 @@
+package testdir
+
+import (
+	"io"
+	"io/fs"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func Setup(t testing.TB, srcDir, destDir string) func() {
+	// srcDir を destDir にコピーして、コピーされたディレクトリにカレントディレクトリを移動する
+	// 戻り値は カレントディレクトリを元のディレクトリに戻し、コピーされたディレクトリを削除する関数
+	t.Logf("srcDir: %s\n", srcDir)
+	t.Logf("destDir: %s\n", destDir)
+
+	absSrcDir, err := filepath.Abs(srcDir)
+	if err != nil {
+		t.Fatalf("Failed to get absolute path: %v", err)
+	}
+	t.Logf("absSrcDir: %s\n", absSrcDir)
+
+	groundDir := filepath.Join(destDir, filepath.Base(absSrcDir)) // srcDir に . が指定された場合でもそのディレクトリ名を取得する
+	t.Logf("groundDir: %s\n", groundDir)
+	if err := os.MkdirAll(destDir, os.ModePerm); err != nil {
+		t.Fatalf("Failed to create directory: %v", err)
+	}
+
+	// Copy srcDir to destDir
+	copyDir(t, srcDir, groundDir)
+
+	// Save the current working directory
+	origWd, err := os.Getwd()
+	if err != nil {
+		t.Fatalf("Failed to get current directory: %v", err)
+	}
+
+	// Change to the new directory
+	if err := os.Chdir(groundDir); err != nil {
+		t.Fatalf("Failed to change directory: %v", err)
+	}
+
+	// Return a function to restore the original directory and clean up
+	return func() {
+		// Change back to the original directory
+		if err := os.Chdir(origWd); err != nil {
+			t.Fatalf("Failed to change back to original directory: %v", err)
+		}
+
+		// Remove the copied directory
+		if err := os.RemoveAll(groundDir); err != nil {
+			t.Fatalf("Failed to remove directory %s: %v", groundDir, err)
+		}
+	}
+}
+
+// Helper function to copy a directory
+func copyDir(t testing.TB, src string, dest string) {
+	t.Logf("copyDir: %s -> %s\n", src, dest)
+
+	entries, err := os.ReadDir(src)
+	if err != nil {
+		t.Fatalf("Failed to read directory: %v", err)
+	}
+
+	err = os.MkdirAll(dest, os.ModePerm)
+	if err != nil {
+		t.Fatalf("Failed to create directory: %v", err)
+	}
+
+	for _, entry := range entries {
+		copyEntry(t, src, dest, entry)
+	}
+}
+
+func copyEntry(t testing.TB, src string, dest string, entry fs.DirEntry) {
+	if entry.Name() == ".git" {
+		t.Logf("skip .git directory\n")
+		return
+	}
+
+	srcPath := filepath.Join(src, entry.Name())
+	destPath := filepath.Join(dest, entry.Name())
+
+	if entry.IsDir() {
+		copyDir(t, srcPath, destPath)
+		return
+	}
+
+	t.Logf("copyEntry: %s -> %s\n", srcPath, destPath)
+
+	reader, err := os.Open(srcPath)
+	if err != nil {
+		t.Fatalf("Failed to open source file: %v", err)
+	}
+	defer reader.Close()
+
+	writer, err := os.Create(destPath)
+	if err != nil {
+		t.Fatalf("Failed to create destination file: %v", err)
+	}
+	defer writer.Close()
+
+	if _, err := io.Copy(writer, reader); err != nil {
+		t.Fatalf("Failed to copy file: %v", err)
+	}
+}

testexec/cmd.go

@@ -0,0 +1,29 @@
+package testexec
+
+import (
+	"os"
+	"os/exec"
+	"testing"
+)
+
+func Run(t testing.TB, command string, args ...string) {
+	t.Helper()
+
+	cmd := exec.Command(command, args...)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	if err := cmd.Run(); err != nil {
+		t.Fatalf("failed to run %s %v: %s", command, args, err)
+	}
+}
+
+func Stdout(t testing.TB, command string, args ...string) string {
+	t.Helper()
+
+	cmd := exec.Command(command, args...)
+	out, err := cmd.Output()
+	if err != nil {
+		t.Fatalf("failed to run %s %v: %s", command, args, err)
+	}
+	return string(out)
+}

tests/grounds/.gitignore

@@ -0,0 +1,4 @@
+*
+.*
+*.*
+!.gitignore

tests/scenes/01_basic/Makefile

@@ -0,0 +1,17 @@
+README.md:
+	@echo "Generating README.md"
+	@echo "This is a test" > README.md
+
+WORK_FILE=work.txt
+
+.PHONY: add-one
+add-one:
+	@echo "One" >> $(WORK_FILE)
+
+.PHONY: add-two
+add-two:
+	@echo "Two" >> $(WORK_FILE)
+
+.PHONY: add-three
+add-three:
+	@echo "Three" >> $(WORK_FILE)

tests/scenes/01_basic/aliases.go

@@ -0,0 +1,10 @@
+package basic
+
+import (
+	"github.com/akm/git-exec/testexec"
+)
+
+var (
+	run    = testexec.Run
+	stdout = testexec.Stdout
+)

tests/scenes/01_basic/commit_message_test.go

@@ -0,0 +1,28 @@
+package basic
+
+import (
+	"testing"
+
+	"github.com/akm/git-exec/core"
+	"github.com/akm/git-exec/tests/testground"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCommitMessage(t *testing.T) {
+	defer testground.Setup(t)()
+
+	opts := *core.DefaultOptions
+	opts.Emoji = "🏭️"
+	opts.Prompt = "%"
+	opts.Template = `{{.Emoji}} {{.Prompt}} {{.Command}} [at {{.Location}}]`
+	err := core.Run(&opts, []string{"make", "README.md"})
+	require.NoError(t, err)
+
+	commitMessage := stdout(t, "git", "log", "-1", "--pretty=%B")
+	assert.Equal(t, `🏭️ % make README.md [at 01_basic]
+
+Generating README.md
+
+`, commitMessage)
+}

tests/scenes/01_basic/guard_test.go

@@ -0,0 +1,45 @@
+package basic
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/akm/git-exec/core"
+	"github.com/akm/git-exec/tests/testground"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestGuardUntrackedFiles(t *testing.T) {
+	defer testground.Setup(t)()
+	defer testground.AssertStringNotChanged(t, testground.GitLastCommitHash)()
+
+	run(t, "make", "add-one") // Let it not be committed
+
+	err := core.Run(core.DefaultOptions, []string{"make", "README.md"})
+	require.Error(t, err)
+	assert.Equal(t, `Quit processing because There are untracked files
+
+Untracked files:
+work.txt`, err.Error())
+}
+
+func TestGuardUncommittedChanes(t *testing.T) {
+	defer testground.Setup(t)()
+
+	// commit add-one
+	run(t, "make", "add-one")
+	run(t, "git", "add", ".")
+	run(t, "git", "commit", "-m", "add one")
+
+	defer testground.AssertStringNotChanged(t, testground.GitLastCommitHash)()
+	run(t, "make", "add-two") // Let it not be committed
+
+	err := core.Run(core.DefaultOptions, []string{"make", "README.md"})
+	require.Error(t, err)
+	assert.Equal(t, `Quit processing because There are uncommitted changes
+
+Uncommitted changes:
+`+strings.TrimSpace(stdout(t, "git", "diff")),
+		err.Error())
+}

tests/scenes/01_basic/happy_path_test.go

@@ -0,0 +1,25 @@
+package basic
+
+import (
+	"testing"
+
+	"github.com/akm/git-exec/core"
+	"github.com/akm/git-exec/tests/testground"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestHappyPath(t *testing.T) {
+	defer testground.Setup(t)()
+
+	// run(t, "make", "README.md")
+	err := core.Run(core.DefaultOptions, []string{"make", "README.md"})
+	require.NoError(t, err)
+
+	commitMessage := stdout(t, "git", "log", "-1", "--pretty=%B")
+	assert.Equal(t, `🤖 [01_basic] $ make README.md
+
+Generating README.md
+
+`, commitMessage)
+}