1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
|
// Copyright 2024 Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>.
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.
package gitmap
import (
"bytes"
"errors"
"fmt"
"io"
"os/exec"
"path/filepath"
"strings"
"time"
)
var (
// will be modified during tests
gitExec string
ErrGitNotFound = errors.New("git executable not found in $PATH")
)
type GitRepo struct {
// TopLevelAbsPath contains the absolute path of the top-level directory.
// This is similar to the answer from "git rev-parse --show-toplevel"
// except symbolic link is not followed on non-Windows platforms.
// Note that this follows Git's way of handling paths, so expect to get forward slashes,
// even on Windows.
TopLevelAbsPath string
// The files in this Git repository.
Files GitMap
}
// GitMap maps filenames to Git revision information.
type GitMap map[string]*GitInfo
// GitInfo holds information about a Git commit.
type GitInfo struct {
Hash string `json:"hash"` // Commit hash
AbbreviatedHash string `json:"abbreviatedHash"` // Abbreviated commit hash
Subject string `json:"subject"` // The commit message's subject/title line
AuthorName string `json:"authorName"` // The author name, respecting .mailmap
AuthorEmail string `json:"authorEmail"` // The author email address, respecting .mailmap
AuthorDate time.Time `json:"authorDate"` // The author date
CommitDate time.Time `json:"commitDate"` // The commit date
Body string `json:"body"` // The commit message body
Parent *GitInfo `json:"-"` // The file-filtered ancestor commit, if any
}
// Ancestors returns a slice of GitInfo objects representing the ancestors.
func (g *GitInfo) Ancestors() GitInfos {
var ancestors GitInfos
for parent := g.Parent; parent != nil; parent = parent.Parent {
ancestors = append(ancestors, parent)
}
return ancestors
}
type GitInfos []*GitInfo
// Reverse creates a copy of the GitInfos slice in reverse order.
func (g GitInfos) Reverse() GitInfos {
reversed := make(GitInfos, len(g))
for i, v := range g {
reversed[len(g)-1-i] = v
}
return reversed
}
// Runner is an interface for running Git commands,
// as implemented buy *exec.Cmd.
type Runner interface {
Run() 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(stdout, stderr io.Writer, args ...string) (Runner, error)
}
// 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(stdout, stderr io.Writer, args ...string) (Runner, error) {
cmd := exec.Command(gitExec, args...)
cmd.Stdout = stdout
cmd.Stderr = stderr
return cmd, nil
}
}
m := make(GitMap)
a := make(GitMap)
// First get the top level repo path
absRepoPath, err := filepath.Abs(opts.Repository)
if err != nil {
return nil, err
}
out, err := git(opts, "-C", opts.Repository, "rev-parse", "--show-cdup")
if err != nil {
return nil, err
}
cdUp := strings.TrimSpace(string(out))
topLevelPath := filepath.ToSlash(filepath.Join(absRepoPath, cdUp))
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`,
opts.Revision,
))
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
}
entriesStr := strings.Trim(out, "\n\x1e'")
entries := strings.Split(entriesStr, "\x1e")
for _, e := range entries {
lines := strings.Split(e, "\x1d")
gitInfo, err := toGitInfo(lines[0])
if err != nil {
return nil, err
}
filenames := strings.Split(lines[1], "\n")
for _, filename := range filenames {
filename := strings.TrimSpace(filename)
if filename == "" {
continue
}
// Cannot reuse because each GitInfo object has its own ancestor
// gitInfo.Ancestor is always nil at this point, so we're copying
gitInfoCopy := *gitInfo
if rootInfo, ok := m[filename]; !ok {
m[filename] = &gitInfoCopy
} else {
var ancInfo *GitInfo
if ancInfo, ok = a[filename]; !ok {
ancInfo = rootInfo
}
ancInfo.Parent = &gitInfoCopy
a[filename] = ancInfo.Parent
}
}
}
return &GitRepo{Files: m, TopLevelAbsPath: topLevelPath}, nil
}
func git(opts Options, args ...string) (string, error) {
var outBuff bytes.Buffer
var errBuff bytes.Buffer
cmd, err := opts.GetGitCommandFunc(&outBuff, &errBuff, args...)
if err != nil {
return "", err
}
err = cmd.Run()
if err != nil {
if ee, ok := err.(*exec.Error); ok {
if ee.Err == exec.ErrNotFound {
return "", ErrGitNotFound
}
}
return "", errors.New(strings.TrimSpace(errBuff.String()))
}
return outBuff.String(), nil
}
func toGitInfo(entry string) (*GitInfo, error) {
items := strings.Split(entry, "\x1f")
if len(items) == 7 {
items = append(items, "")
}
authorDate, err := time.Parse("2006-01-02 15:04:05 -0700", items[5])
if err != nil {
return nil, err
}
commitDate, err := time.Parse("2006-01-02 15:04:05 -0700", items[6])
if err != nil {
return nil, err
}
return &GitInfo{
Hash: items[0],
AbbreviatedHash: items[1],
Subject: items[2],
AuthorName: items[3],
AuthorEmail: items[4],
AuthorDate: authorDate,
CommitDate: commitDate,
Body: strings.TrimSpace(items[7]),
}, nil
}
func init() {
initDefaults()
}
func initDefaults() {
gitExec = "git"
}
|