diff --git a/pkg/git/inspect.go b/pkg/git/inspect.go index a965e97e35..2d10ea19e8 100644 --- a/pkg/git/inspect.go +++ b/pkg/git/inspect.go @@ -38,25 +38,34 @@ func InspectRemote(ctx context.Context, info *GitInfo, env []string) (*Inspectio if err != nil { return nil, err } + inspection, err := setupInspection(ctx, root, info, env) + if err != nil { + _ = os.RemoveAll(root) + return nil, err + } + return inspection, nil +} +func setupInspection( + ctx context.Context, + root string, + info *GitInfo, + env []string, +) (*Inspection, error) { repo, err := cloneInspectionRepo(ctx, root, info, env) if err != nil { - _ = os.RemoveAll(root) return nil, err } rev, err := selectInspectionRevision(ctx, repo, info) if err != nil { - _ = os.RemoveAll(root) return nil, err } commitSHA, err := resolveCommitSHA(ctx, repo, rev) if err != nil { - _ = os.RemoveAll(root) return nil, err } subPath, err := cleanInspectionSubPath(info.SubPath) if err != nil { - _ = os.RemoveAll(root) return nil, err } return &Inspection{repo: repo, rev: commitSHA, root: root, subPath: subPath}, nil diff --git a/pkg/git/inspect_test.go b/pkg/git/inspect_test.go index 9f6bb20af8..de63e525d4 100644 --- a/pkg/git/inspect_test.go +++ b/pkg/git/inspect_test.go @@ -2,6 +2,7 @@ package git import ( "context" + "os" "testing" "gotest.tools/assert" @@ -129,3 +130,84 @@ func TestInspectionReadDevContainerConfig_DevContainerID(t *testing.T) { assert.Equal(t, pathFound, ".devcontainer/my-profile/devcontainer.json") assert.Assert(t, len(data) > 0) } + +const inspectTestRepository = "https://github.com/devsy-org/devsy.git" + +func useDefaultRunner(t *testing.T, runner Runner) { + t.Helper() + previous := defaultRunner + defaultRunner = runner + t.Cleanup(func() { defaultRunner = previous }) +} + +func isolateInspectTempDir(t *testing.T) string { + t.Helper() + dir := t.TempDir() + t.Setenv("TMPDIR", dir) + t.Setenv("TMP", dir) + t.Setenv("TEMP", dir) + return dir +} + +func tempEntryCount(t *testing.T, dir string) int { + t.Helper() + entries, err := os.ReadDir(dir) + assert.NilError(t, err) + return len(entries) +} + +func TestInspectRemoteRemovesTempCloneOnSetupFailure(t *testing.T) { + tests := []struct { + name string + info GitInfo + stdout []byte + errUntil int + }{ + { + name: "clone fails", + info: GitInfo{Repository: inspectTestRepository}, + errUntil: 1, + }, + { + name: "pull request reference invalid", + info: GitInfo{Repository: inspectTestRepository, PR: "not-a-pr"}, + }, + { + name: "commit sha empty", + info: GitInfo{Repository: inspectTestRepository}, + }, + { + name: "subpath escapes repository", + info: GitInfo{Repository: inspectTestRepository, SubPath: "../escape"}, + stdout: []byte("abc123\n"), + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + tempDir := isolateInspectTempDir(t) + useDefaultRunner(t, &fakeRunner{stdout: tt.stdout, errUntil: tt.errUntil}) + + inspection, err := InspectRemote(context.Background(), &tt.info, nil) + assert.Assert(t, err != nil) + assert.Assert(t, inspection == nil) + assert.Equal(t, tempEntryCount(t, tempDir), 0) + }) + } +} + +func TestInspectRemoteKeepsTempCloneUntilClose(t *testing.T) { + tempDir := isolateInspectTempDir(t) + useDefaultRunner(t, &fakeRunner{stdout: []byte("abc123\n")}) + + inspection, err := InspectRemote( + context.Background(), + &GitInfo{Repository: inspectTestRepository, SubPath: testSubPath}, + nil, + ) + assert.NilError(t, err) + assert.Equal(t, inspection.Revision(), "abc123") + assert.Equal(t, tempEntryCount(t, tempDir), 1) + + assert.NilError(t, inspection.Close()) + assert.Equal(t, tempEntryCount(t, tempDir), 0) +}