Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions pkg/git/inspect.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
82 changes: 82 additions & 0 deletions pkg/git/inspect_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package git

import (
"context"
"os"
"testing"

"gotest.tools/assert"
Expand Down Expand Up @@ -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)
}
Loading