Skip to content

Ignore environment variables when executing git command #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bep merged 2 commits into from
Jul 13, 2024
Merged

Ignore environment variables when executing git command #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc0086b
Add Options struct to replace Map parameters
FantasyTeddy Jul 12, 2024
04dc645
Enable setting the Git command externally
FantasyTeddy Jul 12, 2024
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
32 changes: 22 additions & 10 deletions gitmap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,30 @@ type GitInfo struct {
Body string `json:"body"` // The commit message body
}

// Map creates a GitRepo with a file map from the given repository path and revision.
// Use blank or HEAD as revision for the currently active revision.
func Map(repository, revision string) (*GitRepo, error) {
// Options for the Map function
type Options struct {
Repository string // Path to the repository to map
Revision string // Use blank or HEAD for the currently active revision
GetGitCommandFunc func(args ...string) *exec.Cmd
}

// Map creates a GitRepo with a file map from the given options.
func Map(opts Options) (*GitRepo, error) {
if opts.GetGitCommandFunc == nil {
opts.GetGitCommandFunc = func(args ...string) *exec.Cmd {
return exec.Command(gitExec, args...)
}
}

m := make(GitMap)

// First get the top level repo path
absRepoPath, err := filepath.Abs(repository)
absRepoPath, err := filepath.Abs(opts.Repository)
if err != nil {
return nil, err
}

out, err := git("-C", repository, "rev-parse", "--show-cdup")
out, err := git(opts, "-C", opts.Repository, "rev-parse", "--show-cdup")
if err != nil {
return nil, err
}
Expand All @@ -70,11 +82,11 @@ func Map(repository, revision string) (*GitRepo, error) {

gitLogArgs := strings.Fields(fmt.Sprintf(
`--name-only --no-merges --format=format:%%x1e%%H%%x1f%%h%%x1f%%s%%x1f%%aN%%x1f%%aE%%x1f%%ai%%x1f%%ci%%x1f%%b%%x1d %s`,
revision,
opts.Revision,
))

gitLogArgs = append([]string{"-c", "diff.renames=0", "-c", "log.showSignature=0", "-C", repository, "log"}, gitLogArgs...)
out, err = git(gitLogArgs...)
gitLogArgs = append([]string{"-c", "diff.renames=0", "-c", "log.showSignature=0", "-C", opts.Repository, "log"}, gitLogArgs...)
out, err = git(opts, gitLogArgs...)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -104,8 +116,8 @@ func Map(repository, revision string) (*GitRepo, error) {
return &GitRepo{Files: m, TopLevelAbsPath: topLevelPath}, nil
}

func git(args ...string) ([]byte, error) {
out, err := exec.Command(gitExec, args...).CombinedOutput()
func git(opts Options, args ...string) ([]byte, error) {
out, err := opts.GetGitCommandFunc(args...).CombinedOutput()
if err != nil {
if ee, ok := err.(*exec.Error); ok {
if ee.Err == exec.ErrNotFound {
Expand Down
18 changes: 9 additions & 9 deletions gitmap_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func TestMap(t *testing.T) {
err error
)

if gr, err = Map(repository, revision); err != nil {
if gr, err = Map(Options{Repository: repository, Revision: revision}); err != nil {
t.Fatal(err)
}

Expand Down Expand Up @@ -120,7 +120,7 @@ func TestCommitMessage(t *testing.T) {
err error
)

if gr, err = Map(repository, "HEAD"); err != nil {
if gr, err = Map(Options{Repository: repository, Revision: "HEAD"}); err != nil {
t.Fatal(err)
}

Expand Down Expand Up @@ -182,7 +182,7 @@ func TestActiveRevision(t *testing.T) {
err error
)

if gr, err = Map(repository, "HEAD"); err != nil {
if gr, err = Map(Options{Repository: repository, Revision: "HEAD"}); err != nil {
t.Fatal(err)
}

Expand All @@ -200,7 +200,7 @@ func TestActiveRevision(t *testing.T) {
func TestGitExecutableNotFound(t *testing.T) {
defer initDefaults()
gitExec = "thisShouldHopefullyNotExistOnPath"
gi, err := Map(repository, revision)
gi, err := Map(Options{Repository: repository, Revision: revision})

if err != ErrGitNotFound || gi != nil {
t.Fatal("Invalid error handling")
Expand All @@ -217,7 +217,7 @@ func TestEncodeJSON(t *testing.T) {
filename = "README.md"
)

if gr, err = Map(repository, revision); err != nil {
if gr, err = Map(Options{Repository: repository, Revision: revision}); err != nil {
t.Fatal(err)
}

Expand All @@ -240,7 +240,7 @@ func TestEncodeJSON(t *testing.T) {
}

func TestGitRevisionNotFound(t *testing.T) {
gi, err := Map(repository, "adfasdfasdf")
gi, err := Map(Options{Repository: repository, Revision: "adfasdfasdf"})

// TODO(bep) improve error handling.
if err == nil || gi != nil {
Expand All @@ -249,7 +249,7 @@ func TestGitRevisionNotFound(t *testing.T) {
}

func TestGitRepoNotFound(t *testing.T) {
gi, err := Map("adfasdfasdf", revision)
gi, err := Map(Options{Repository: "adfasdfasdf", Revision: revision})

// TODO(bep) improve error handling.
if err == nil || gi != nil {
Expand All @@ -263,7 +263,7 @@ func TestTopLevelAbsPath(t *testing.T) {
err error
)

if gr, err = Map(repository, revision); err != nil {
if gr, err = Map(Options{Repository: repository, Revision: revision}); err != nil {
t.Fatal(err)
}

Expand All @@ -276,7 +276,7 @@ func TestTopLevelAbsPath(t *testing.T) {

func BenchmarkMap(b *testing.B) {
for i := 0; i < b.N; i++ {
_, err := Map(repository, revision)
_, err := Map(Options{Repository: repository, Revision: revision})
if err != nil {
b.Fatalf("Got error: %s", err)
}
Expand Down