feat(grep): search a repository

Use `git grep` to search a repository.

Author: aymanbagabas

repo_grep.go

@@ -0,0 +1,117 @@
+package git
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+)
+
+type GrepOptions struct {
+	// TreeID to search in
+	TreeID string
+	// Limits the search to files in the specified pathspec
+	Pathspec string
+	// Case insensitive search.
+	IgnoreCase bool
+	// Match the pattern only at word boundaries.
+	WordMatch bool
+	// Whether or not to use extended regular expressions.
+	ExtendedRegex bool
+	// The timeout duration before giving up for each shell command execution. The
+	// default timeout duration will be used when not supplied.
+	Timeout time.Duration
+	// The additional options to be passed to the underlying git.
+	CommandOptions
+}
+
+// GrepResult represents a single result from a grep search.
+type GrepResult struct {
+	// The TreeID of the file that matched. Could be `HEAD` or a tree ID.
+	TreeID string
+	// The path of the file that matched.
+	Path string
+	// The line number of the match.
+	Line int
+	// The 1-indexed column number of the match.
+	Column int
+	// The text of the line that matched.
+	Text string
+}
+
+func parseGrepLine(line string) (*GrepResult, error) {
+	r := &GrepResult{}
+	sp := strings.SplitN(line, ":", 5)
+
+	var n int
+	switch len(sp) {
+	case 4:
+		// HEAD tree ID
+		r.TreeID = "HEAD"
+	case 5:
+		// Tree ID included
+		r.TreeID = sp[0]
+		n++
+	default:
+		return nil, fmt.Errorf("invalid grep line: %s", line)
+	}
+	r.Path = sp[n]
+	n++
+	r.Line, _ = strconv.Atoi(sp[n])
+	n++
+	r.Column, _ = strconv.Atoi(sp[n])
+	n++
+	r.Text = sp[n]
+
+	return r, nil
+}
+
+// Grep returns the results of a grep search in the repository.
+func (r *Repository) Grep(pattern string, opts ...GrepOptions) ([]*GrepResult, error) {
+	var opt GrepOptions
+	if len(opts) > 0 {
+		opt = opts[0]
+	}
+
+	cmd := NewCommand("grep").
+		AddOptions(opt.CommandOptions).
+		// Result full-name, line number & column number
+		AddArgs("--full-name", "--line-number", "--column")
+	if opt.IgnoreCase {
+		cmd.AddArgs("-i")
+	}
+	if opt.WordMatch {
+		cmd.AddArgs("-w")
+	}
+	if opt.ExtendedRegex {
+		cmd.AddArgs("-E")
+	}
+	// Escape the pattern
+	cmd.AddArgs(pattern)
+	if opt.TreeID != "" {
+		cmd.AddArgs(opt.TreeID)
+	} else {
+		cmd.AddArgs("HEAD")
+	}
+	if opt.Pathspec != "" {
+		cmd.AddArgs("--", opt.Pathspec)
+	}
+
+	results := make([]*GrepResult, 0)
+	stdout, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
+	if err == nil && len(stdout) > 0 {
+		// normalize line endings
+		lines := strings.Split(strings.ReplaceAll(string(stdout), "\r", ""), "\n")
+		for _, line := range lines {
+			if len(line) == 0 {
+				continue
+			}
+			r, err := parseGrepLine(line)
+			if err == nil {
+				results = append(results, r)
+			}
+		}
+	}
+
+	return results, nil
+}

repo_grep_test.go

@@ -0,0 +1,99 @@
+package git
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRepoGrepSimple(t *testing.T) {
+	pattern := "programmingPoints"
+	expect := []GrepResult{
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 7, Column: 5, Text: "int programmingPoints = 10",
+		},
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 10, Column: 33, Text: `println "${name} has at least ${programmingPoints} programming points."`,
+		},
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 11, Column: 12, Text: `println "${programmingPoints} squared is ${square(programmingPoints)}"`,
+		},
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 12, Column: 12, Text: `println "${programmingPoints} divided by 2 bonus points is ${divide(programmingPoints, 2)}"`,
+		},
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 13, Column: 12, Text: `println "${programmingPoints} minus 7 bonus points is ${subtract(programmingPoints, 7)}"`,
+		},
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 14, Column: 12, Text: `println "${programmingPoints} plus 3 bonus points is ${sum(programmingPoints, 3)}"`,
+		},
+	}
+	results, err := testrepo.Grep(pattern)
+	assert.NoError(t, err)
+	for i, result := range results {
+		assert.Equal(t, expect[i], *result)
+	}
+}
+
+func TestRepoGrepIgnoreCase(t *testing.T) {
+	pattern := "Hello"
+	expect := []GrepResult{
+		{
+			TreeID: "HEAD", Path: "README.txt", Line: 9, Column: 36, Text: "* [email protected]:matthewmccullough/hellogitworld.git",
+		},
+		{
+			TreeID: "HEAD", Path: "README.txt", Line: 10, Column: 38, Text: "* git://github.com/matthewmccullough/hellogitworld.git",
+		},
+		{
+			TreeID: "HEAD", Path: "README.txt", Line: 11, Column: 58, Text: "* https://[email protected]/matthewmccullough/hellogitworld.git",
+		},
+		{
+			TreeID: "HEAD", Path: "src/Main.groovy", Line: 9, Column: 10, Text: `println "Hello ${name}"`,
+		},
+		{
+			TreeID: "HEAD", Path: "src/main/java/com/github/App.java", Line: 4, Column: 4, Text: " * Hello again",
+		},
+		{
+			TreeID: "HEAD", Path: "src/main/java/com/github/App.java", Line: 5, Column: 4, Text: " * Hello world!",
+		},
+		{
+			TreeID: "HEAD", Path: "src/main/java/com/github/App.java", Line: 6, Column: 4, Text: " * Hello",
+		},
+		{
+			TreeID: "HEAD", Path: "src/main/java/com/github/App.java", Line: 13, Column: 30, Text: `        System.out.println( "Hello World!" );`,
+		},
+	}
+	results, err := testrepo.Grep(pattern, GrepOptions{IgnoreCase: true})
+	assert.NoError(t, err)
+	for i, result := range results {
+		assert.Equal(t, expect[i], *result)
+	}
+}
+
+func TestRepoGrepRegex(t *testing.T) {
+	pattern := "Hello\\sW\\w+"
+	expect := []GrepResult{
+		{
+			TreeID: "HEAD", Path: "src/main/java/com/github/App.java", Line: 13, Column: 30, Text: `        System.out.println( "Hello World!" );`,
+		},
+	}
+	results, err := testrepo.Grep(pattern, GrepOptions{ExtendedRegex: true})
+	assert.NoError(t, err)
+	for i, result := range results {
+		assert.Equal(t, expect[i], *result)
+	}
+}
+
+func TestRepoGrepWord(t *testing.T) {
+	pattern := "Hello\\sW\\w+"
+	expect := []GrepResult{
+		{
+			TreeID: "HEAD", Path: "src/main/java/com/github/App.java", Line: 13, Column: 36, Text: `        System.out.println( "Hello World!" );`,
+		},
+	}
+	results, err := testrepo.Grep(pattern, GrepOptions{WordMatch: true})
+	assert.NoError(t, err)
+	for i, result := range results {
+		assert.Equal(t, expect[i], *result)
+	}
+}