Add support for parsing git trailers (#614)

Adds a wrapper for git_message_trailers which returns a slice of trailer
structs.

(cherry picked from commit 5241c72e6e)
This commit is contained in:
Jesse Hathaway 2020-06-02 12:30:42 -05:00 committed by lhchavez
parent 7b83382e04
commit 354218d9bb
2 changed files with 84 additions and 0 deletions

42
message.go Normal file
View File

@ -0,0 +1,42 @@
package git
/*
#include <git2.h>
*/
import "C"
import (
"runtime"
"unsafe"
)
// Trailer represents a single git message trailer.
type Trailer struct {
Key string
Value string
}
// MessageTrailers parses trailers out of a message, returning a slice of
// Trailer structs. Trailers are key/value pairs in the last paragraph of a
// message, not including any patches or conflicts that may be present.
func MessageTrailers(message string) ([]Trailer, error) {
var trailersC C.git_message_trailer_array
messageC := C.CString(message)
defer C.free(unsafe.Pointer(messageC))
runtime.LockOSThread()
defer runtime.UnlockOSThread()
ecode := C.git_message_trailers(&trailersC, messageC)
if ecode < 0 {
return nil, MakeGitError(ecode)
}
defer C.git_message_trailer_array_free(&trailersC)
trailers := make([]Trailer, trailersC.count)
var trailer *C.git_message_trailer
for i, p := 0, uintptr(unsafe.Pointer(trailersC.trailers)); i < int(trailersC.count); i, p = i+1, p+unsafe.Sizeof(C.git_message_trailer{}) {
trailer = (*C.git_message_trailer)(unsafe.Pointer(p))
trailers[i] = Trailer{Key: C.GoString(trailer.key), Value: C.GoString(trailer.value)}
}
return trailers, nil
}

42
message_test.go Normal file
View File

@ -0,0 +1,42 @@
package git
import (
"fmt"
"reflect"
"testing"
)
func TestTrailers(t *testing.T) {
t.Parallel()
tests := []struct {
input string
expected []Trailer
}{
{
"commit with zero trailers\n",
[]Trailer{},
},
{
"commit with one trailer\n\nCo-authored-by: Alice <alice@example.com>\n",
[]Trailer{
Trailer{Key: "Co-authored-by", Value: "Alice <alice@example.com>"},
},
},
{
"commit with two trailers\n\nCo-authored-by: Alice <alice@example.com>\nSigned-off-by: Bob <bob@example.com>\n",
[]Trailer{
Trailer{Key: "Co-authored-by", Value: "Alice <alice@example.com>"},
Trailer{Key: "Signed-off-by", Value: "Bob <bob@example.com>"}},
},
}
for _, test := range tests {
fmt.Printf("%s", test.input)
actual, err := MessageTrailers(test.input)
if err != nil {
t.Errorf("Trailers returned an unexpected error: %v", err)
}
if !reflect.DeepEqual(test.expected, actual) {
t.Errorf("expecting %#v\ngot %#v", test.expected, actual)
}
}
}