Skip to content

Commit 349abb9

Browse files
brianmcgeebrianmcgee
committed
feat: simplify git walking
Replaces the use of `go-git` with a simple `git ls-file` for traversing the git index. Signed-off-by: Brian McGee <[email protected]>
1 parent 93c8343 commit 349abb9

13 files changed

+242
-569
lines changed

‎cmd/root_test.go

+100-85
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import (
1212
"testing"
1313
"time"
1414

15+
"github.com/numtide/treefmt/walk"
16+
1517
"github.com/numtide/treefmt/cmd"
1618

1719
"github.com/numtide/treefmt/config"
@@ -25,11 +27,6 @@ import (
2527

2628
"github.com/numtide/treefmt/test"
2729

28-
"github.com/go-git/go-billy/v5/osfs"
29-
"github.com/go-git/go-git/v5"
30-
"github.com/go-git/go-git/v5/plumbing/cache"
31-
"github.com/go-git/go-git/v5/storage/filesystem"
32-
3330
"github.com/stretchr/testify/require"
3431
)
3532

@@ -733,7 +730,7 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
733730
})
734731
}
735732

736-
func TestGitWorktree(t *testing.T) {
733+
func TestGit(t *testing.T) {
737734
as := require.New(t)
738735

739736
tempDir := test.TempExamples(t)
@@ -751,20 +748,6 @@ func TestGitWorktree(t *testing.T) {
751748

752749
test.WriteConfig(t, configPath, cfg)
753750

754-
// init a git repo
755-
repo, err := git.Init(
756-
filesystem.NewStorage(
757-
osfs.New(path.Join(tempDir, ".git")),
758-
cache.NewObjectLRUDefault(),
759-
),
760-
osfs.New(tempDir),
761-
)
762-
as.NoError(err, "failed to init git repository")
763-
764-
// get worktree
765-
wt, err := repo.Worktree()
766-
as.NoError(err, "failed to get git worktree")
767-
768751
run := func(traversed int32, matched int32, formatted int32, changed int32) {
769752
_, statz, err := treefmt(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
770753
as.NoError(err)
@@ -777,16 +760,26 @@ func TestGitWorktree(t *testing.T) {
777760
})
778761
}
779762

780-
// run before adding anything to the worktree
763+
// init a git repo
764+
gitCmd := exec.Command("git", "init")
765+
gitCmd.Dir = tempDir
766+
as.NoError(gitCmd.Run(), "failed to init git repository")
767+
768+
// run before adding anything to the index
781769
run(0, 0, 0, 0)
782770

783-
// add everything to the worktree
784-
as.NoError(wt.AddGlob("."))
785-
as.NoError(err)
771+
// add everything to the index
772+
gitCmd = exec.Command("git", "add", ".")
773+
gitCmd.Dir = tempDir
774+
as.NoError(gitCmd.Run(), "failed to add everything to the index")
775+
786776
run(32, 32, 32, 0)
787777

788-
// remove python directory from the worktree
789-
as.NoError(wt.RemoveGlob("python/*"))
778+
// remove python directory from the index
779+
gitCmd = exec.Command("git", "rm", "--cached", "python/*")
780+
gitCmd.Dir = tempDir
781+
as.NoError(gitCmd.Run(), "failed to remove python directory from the index")
782+
790783
run(29, 29, 29, 0)
791784

792785
// remove nixpkgs.toml from the filesystem but leave it in the index
@@ -799,8 +792,9 @@ func TestGitWorktree(t *testing.T) {
799792
as.NoError(err)
800793

801794
assertStats(t, as, statz, map[stats.Type]int32{
802-
stats.Traversed: 60,
803-
stats.Matched: 60,
795+
stats.Traversed: 80,
796+
stats.Matched: 80,
797+
stats.Formatted: 80,
804798
stats.Changed: 0,
805799
})
806800

@@ -1109,65 +1103,86 @@ func TestDeterministicOrderingInPipeline(t *testing.T) {
11091103
func TestRunInSubdir(t *testing.T) {
11101104
as := require.New(t)
11111105

1112-
// capture current cwd, so we can replace it after the test is finished
1113-
cwd, err := os.Getwd()
1114-
as.NoError(err)
1115-
1116-
t.Cleanup(func() {
1117-
// return to the previous working directory
1118-
as.NoError(os.Chdir(cwd))
1119-
})
1120-
1121-
tempDir := test.TempExamples(t)
1122-
configPath := filepath.Join(tempDir, "/treefmt.toml")
1123-
1124-
// Also test that formatters are resolved relative to the treefmt root
1125-
echoPath, err := exec.LookPath("echo")
1126-
as.NoError(err)
1127-
echoRel := path.Join(tempDir, "echo")
1128-
err = os.Symlink(echoPath, echoRel)
1129-
as.NoError(err)
1130-
1131-
// change working directory to sub directory
1132-
as.NoError(os.Chdir(filepath.Join(tempDir, "elm")))
1106+
// Run the same test for each walk type
1107+
for _, walkType := range walk.TypeValues() {
1108+
t.Run(walkType.String(), func(t *testing.T) {
1109+
// capture current cwd, so we can replace it after the test is finished
1110+
cwd, err := os.Getwd()
1111+
as.NoError(err)
1112+
1113+
t.Cleanup(func() {
1114+
// return to the previous working directory
1115+
as.NoError(os.Chdir(cwd))
1116+
})
1117+
1118+
tempDir := test.TempExamples(t)
1119+
configPath := filepath.Join(tempDir, "/treefmt.toml")
1120+
1121+
// set the walk type via environment variable
1122+
t.Setenv("TREEFMT_WALK_TYPE", walkType.String())
1123+
1124+
// if we are testing git walking, init a git repo before continuing
1125+
if walkType == walk.Git {
1126+
// init a git repo
1127+
gitCmd := exec.Command("git", "init")
1128+
gitCmd.Dir = tempDir
1129+
as.NoError(gitCmd.Run(), "failed to init git repository")
1130+
1131+
// add everything to the index
1132+
gitCmd = exec.Command("git", "add", ".")
1133+
gitCmd.Dir = tempDir
1134+
as.NoError(gitCmd.Run(), "failed to add everything to the index")
1135+
}
11331136

1134-
// basic config
1135-
cfg := &config.Config{
1136-
FormatterConfigs: map[string]*config.Formatter{
1137-
"echo": {
1138-
Command: "./echo",
1139-
Includes: []string{"*"},
1140-
},
1141-
},
1137+
// test that formatters are resolved relative to the treefmt root
1138+
echoPath, err := exec.LookPath("echo")
1139+
as.NoError(err)
1140+
echoRel := path.Join(tempDir, "echo")
1141+
err = os.Symlink(echoPath, echoRel)
1142+
as.NoError(err)
1143+
1144+
// change working directory to subdirectory
1145+
as.NoError(os.Chdir(filepath.Join(tempDir, "elm")))
1146+
1147+
// basic config
1148+
cfg := &config.Config{
1149+
FormatterConfigs: map[string]*config.Formatter{
1150+
"echo": {
1151+
Command: "./echo",
1152+
Includes: []string{"*"},
1153+
},
1154+
},
1155+
}
1156+
test.WriteConfig(t, configPath, cfg)
1157+
1158+
// without any path args, should reformat the whole tree
1159+
_, statz, err := treefmt(t)
1160+
as.NoError(err)
1161+
1162+
assertStats(t, as, statz, map[stats.Type]int32{
1163+
stats.Traversed: 32,
1164+
stats.Matched: 32,
1165+
stats.Formatted: 32,
1166+
stats.Changed: 0,
1167+
})
1168+
1169+
// specify some explicit paths, relative to the tree root
1170+
// this should not work, as we're in a subdirectory
1171+
_, _, err = treefmt(t, "-c", "elm/elm.json", "haskell/Nested/Foo.hs")
1172+
as.ErrorContains(err, "path elm/elm.json not found")
1173+
1174+
// specify some explicit paths, relative to the current directory
1175+
_, statz, err = treefmt(t, "-c", "elm.json", "../haskell/Nested/Foo.hs")
1176+
as.NoError(err)
1177+
1178+
assertStats(t, as, statz, map[stats.Type]int32{
1179+
stats.Traversed: 2,
1180+
stats.Matched: 2,
1181+
stats.Formatted: 2,
1182+
stats.Changed: 0,
1183+
})
1184+
})
11421185
}
1143-
test.WriteConfig(t, configPath, cfg)
1144-
1145-
// without any path args, should reformat the whole tree
1146-
_, statz, err := treefmt(t)
1147-
as.NoError(err)
1148-
1149-
assertStats(t, as, statz, map[stats.Type]int32{
1150-
stats.Traversed: 32,
1151-
stats.Matched: 32,
1152-
stats.Formatted: 32,
1153-
stats.Changed: 0,
1154-
})
1155-
1156-
// specify some explicit paths, relative to the tree root
1157-
// this should not work, as we're in a subdirectory
1158-
_, _, err = treefmt(t, "-c", "elm/elm.json", "haskell/Nested/Foo.hs")
1159-
as.ErrorContains(err, "path elm/elm.json not found")
1160-
1161-
// specify some explicit paths, relative to the current directory
1162-
_, statz, err = treefmt(t, "-c", "elm.json", "../haskell/Nested/Foo.hs")
1163-
as.NoError(err)
1164-
1165-
assertStats(t, as, statz, map[stats.Type]int32{
1166-
stats.Traversed: 2,
1167-
stats.Matched: 2,
1168-
stats.Formatted: 2,
1169-
stats.Changed: 0,
1170-
})
11711186
}
11721187

11731188
func treefmt(t *testing.T, args ...string) ([]byte, *stats.Stats, error) {

‎config/config.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ func SetFlags(fs *pflag.FlagSet) {
122122
)
123123
fs.String(
124124
"walk", "auto",
125-
"The method used to traverse the files within the tree root. Currently supports 'auto', 'git' or "+
126-
"'filesystem'. (env $TREEFMT_WALK)",
125+
"The method used to traverse the files within the tree root. Currently supports "+
126+
"<auto|git|filesystem>. (env $TREEFMT_WALK)",
127127
)
128128
fs.StringP(
129129
"working-dir", "C", ".",

‎go.mod

+1-19
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ require (
66
github.com/BurntSushi/toml v1.4.0
77
github.com/adrg/xdg v0.5.0
88
github.com/charmbracelet/log v0.4.0
9-
github.com/go-git/go-billy/v5 v5.5.1-0.20241008101053-371e232676ac
10-
github.com/go-git/go-git/v5 v5.12.1-0.20240930111449-d1843220b6ab
119
github.com/gobwas/glob v0.2.3
1210
github.com/otiai10/copy v1.14.0
1311
github.com/spf13/cobra v1.8.1
@@ -21,23 +19,13 @@ require (
2119
)
2220

2321
require (
24-
dario.cat/mergo v1.0.0 // indirect
25-
github.com/Microsoft/go-winio v0.6.2 // indirect
26-
github.com/ProtonMail/go-crypto v1.0.0 // indirect
2722
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
2823
github.com/charmbracelet/lipgloss v0.10.0 // indirect
29-
github.com/cloudflare/circl v1.3.8 // indirect
30-
github.com/cyphar/filepath-securejoin v0.2.5 // indirect
3124
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
32-
github.com/emirpasic/gods v1.18.1 // indirect
3325
github.com/fsnotify/fsnotify v1.7.0 // indirect
34-
github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
3526
github.com/go-logfmt/logfmt v0.6.0 // indirect
36-
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
3727
github.com/hashicorp/hcl v1.0.0 // indirect
3828
github.com/inconshreveable/mousetrap v1.1.0 // indirect
39-
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
40-
github.com/kevinburke/ssh_config v1.2.0 // indirect
4129
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
4230
github.com/magiconair/properties v1.8.7 // indirect
4331
github.com/mattn/go-isatty v0.0.20 // indirect
@@ -47,28 +35,22 @@ require (
4735
github.com/muesli/reflow v0.3.0 // indirect
4836
github.com/muesli/termenv v0.15.2 // indirect
4937
github.com/pelletier/go-toml/v2 v2.2.2 // indirect
50-
github.com/pjbgf/sha1cd v0.3.0 // indirect
5138
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
5239
github.com/rivo/uniseg v0.4.7 // indirect
5340
github.com/sagikazarmark/locafero v0.4.0 // indirect
5441
github.com/sagikazarmark/slog-shim v0.1.0 // indirect
55-
github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
56-
github.com/skeema/knownhosts v1.3.0 // indirect
5742
github.com/sourcegraph/conc v0.3.0 // indirect
5843
github.com/spf13/afero v1.11.0 // indirect
5944
github.com/spf13/cast v1.6.0 // indirect
6045
github.com/subosito/gotenv v1.6.0 // indirect
6146
github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
62-
github.com/xanzy/ssh-agent v0.3.3 // indirect
6347
go.uber.org/atomic v1.9.0 // indirect
6448
go.uber.org/multierr v1.9.0 // indirect
65-
golang.org/x/crypto v0.27.0 // indirect
6649
golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
67-
golang.org/x/net v0.29.0 // indirect
6850
golang.org/x/sys v0.25.0 // indirect
6951
golang.org/x/term v0.24.0 // indirect
7052
golang.org/x/text v0.18.0 // indirect
53+
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
7154
gopkg.in/ini.v1 v1.67.0 // indirect
72-
gopkg.in/warnings.v0 v0.1.2 // indirect
7355
gopkg.in/yaml.v3 v3.0.1 // indirect
7456
)

0 commit comments

Comments
 (0)