Git designed for AI agents.
package log
import (
"bytes"
"fmt"
"testing"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/require"
)
func TestUrlSanitizerHook(t *testing.T) {
outBuf := &bytes.Buffer{}
urlSanitizer := NewURLSanitizerHook()
urlSanitizer.AddPossibleGrpcMethod(
"UpdateRemoteMirror",
"CreateRepositoryFromURL",
"FetchRemote",
)
logger := newLogger()
logger.Out = outBuf
logger.Hooks.Add(urlSanitizer)
testCases := []struct {
desc string
logFunc func()
expectedString string
}{
{
desc: "with args",
logFunc: func() {
logger.WithFields(Fields{
"grpc.method": "CreateRepositoryFromURL",
"args": []string{"/usr/bin/git", "clone", "--bare", "--", "https://foo_the_user:[email protected]/foo/bar", "/home/git/repositories/foo/bar"},
}).Info("spawn")
},
expectedString: "[/usr/bin/git clone --bare -- https://[FILTERED]@gitlab.com/foo/bar /home/git/repositories/foo/bar]",
},
{
desc: "with error",
logFunc: func() {
logger.WithFields(Fields{
"grpc.method": "UpdateRemoteMirror",
"error": fmt.Errorf("rpc error: code = Unknown desc = remote: Invalid username or password. fatal: Authentication failed for 'https://foo_the_user:[email protected]/foo/bar'"),
}).Error("ERROR")
},
expectedString: "rpc error: code = Unknown desc = remote: Invalid username or password. fatal: Authentication failed for 'https://[FILTERED]@gitlab.com/foo/bar'",
},
{
desc: "with message",
logFunc: func() {
logger.WithFields(Fields{
"grpc.method": "CreateRepositoryFromURL",
}).Info("asked for: https://foo_the_user:[email protected]/foo/bar")
},
expectedString: "asked for: https://[FILTERED]@gitlab.com/foo/bar",
},
{
desc: "with URL without scheme output",
logFunc: func() {
logger.WithFields(Fields{
"grpc.method": "FetchRemote",
}).Info("fatal: unable to look up foo:[email protected] (port 9418) (nodename nor servname provided, or not known")
},
expectedString: "unable to look up [FILTERED]@non-existent.org (port 9418) (nodename nor servname provided, or not known",
},
{
desc: "with gRPC method not added to the list",
logFunc: func() {
logger.WithFields(Fields{
"grpc.method": "UserDeleteTag",
}).Error("fatal: 'https://foo_the_user:[email protected]/foo/bar' is not a valid tag name.")
},
expectedString: "fatal: 'https://foo_the_user:[email protected]/foo/bar' is not a valid tag name.",
},
{
desc: "logrus with URL that does not require sanitization",
logFunc: func() {
logger.WithFields(Fields{
"grpc.method": "CreateRepositoryFromURL",
}).Info("asked for: https://gitlab.com/gitlab-org/gitaly/v15")
},
expectedString: "asked for: https://gitlab.com/gitlab-org/gitaly/v15",
},
}
for _, testCase := range testCases {
t.Run(testCase.desc, func(t *testing.T) {
testCase.logFunc()
logOutput := outBuf.String()
require.Contains(t, logOutput, testCase.expectedString)
})
}
}
func BenchmarkUrlSanitizerWithoutSanitization(b *testing.B) {
urlSanitizer := NewURLSanitizerHook()
logger := newLogger()
logger.Hooks.Add(urlSanitizer)
benchmarkLogging(b, logger)
}
func BenchmarkUrlSanitizerWithSanitization(b *testing.B) {
urlSanitizer := NewURLSanitizerHook()
urlSanitizer.AddPossibleGrpcMethod(
"UpdateRemoteMirror",
"CreateRepositoryFromURL",
)
logger := newLogger()
logger.Hooks.Add(urlSanitizer)
benchmarkLogging(b, logger)
}
func benchmarkLogging(b *testing.B, logger *logrus.Logger) {
for n := 0; n < b.N; n++ {
logger.WithFields(Fields{
"grpc.method": "CreateRepositoryFromURL",
"args": []string{"/usr/bin/git", "clone", "--bare", "--", "https://foo_the_user:[email protected]/foo/bar", "/home/git/repositories/foo/bar"},
}).Info("spawn")
logger.WithFields(Fields{
"grpc.method": "UpdateRemoteMirror",
"error": fmt.Errorf("rpc error: code = Unknown desc = remote: Invalid username or password. fatal: Authentication failed for 'https://foo_the_user:[email protected]/foo/bar'"),
}).Error("ERROR")
logger.WithFields(Fields{
"grpc.method": "CreateRepositoryFromURL",
}).Info("asked for: https://foo_the_user:[email protected]/foo/bar")
}
}