Files
buildx/util/gitutil/gitutil.go
T

138 lines
3.9 KiB
Go

package gitutil
import (
"context"
"path/filepath"
"strings"
"github.com/docker/buildx/util/osutil"
bkgitutil "github.com/moby/buildkit/util/gitutil"
bkurlutil "github.com/moby/buildkit/util/urlutil"
"github.com/pkg/errors"
)
// GitCLI represents an active git object.
type GitCLI struct {
bkgitutil.GitCLI
}
// New initializes a new git client.
func New(opts ...bkgitutil.Option) (*GitCLI, error) {
cli := bkgitutil.NewGitCLI(append(opts, bkgitutil.WithHostGitConfig())...)
gitpath, err := gitPath(cli.Dir())
if err != nil {
return nil, err
}
cli = cli.New(
bkgitutil.WithGitBinary(gitpath),
bkgitutil.WithArgs("-c", "log.showSignature=false"),
)
return &GitCLI{*cli}, nil
}
func (cli *GitCLI) IsInsideWorkTree(ctx context.Context) bool {
out, err := cli.clean(cli.Run(ctx, "rev-parse", "--is-inside-work-tree"))
return out == "true" && err == nil
}
func (cli *GitCLI) IsDirty(ctx context.Context) bool {
out, err := cli.Run(ctx, "status", "--porcelain", "--ignored")
return strings.TrimSpace(string(out)) != "" || err != nil
}
func (cli *GitCLI) WorkTree(ctx context.Context) (string, error) {
root, err := cli.GitCLI.WorkTree(ctx)
if err != nil {
return "", err
}
return osutil.SanitizePath(root), nil
}
func (cli *GitCLI) GitDir(ctx context.Context) (string, error) {
dir, err := cli.WorkTree(ctx)
if err != nil {
return "", err
}
return filepath.Join(dir, ".git"), nil
}
func (cli *GitCLI) RemoteURL(ctx context.Context) (string, error) {
// Try default remote based on remote tracking branch.
if remote, err := cli.currentRemote(ctx); err == nil && remote != "" {
if ru, err := cli.clean(cli.Run(ctx, "remote", "get-url", remote)); err == nil && ru != "" {
return bkurlutil.RedactCredentials(ru), nil
}
}
// Next try to get the remote URL from the origin remote first.
if ru, err := cli.clean(cli.Run(ctx, "remote", "get-url", "origin")); err == nil && ru != "" {
return bkurlutil.RedactCredentials(ru), nil
}
// If that fails, try to get the remote URL from the upstream remote.
if ru, err := cli.clean(cli.Run(ctx, "remote", "get-url", "upstream")); err == nil && ru != "" {
return bkurlutil.RedactCredentials(ru), nil
}
return "", errors.New("no remote URL found for either origin or upstream")
}
func (cli *GitCLI) FullCommit(ctx context.Context) (string, error) {
return cli.clean(cli.Run(ctx, "show", "--format=%H", "HEAD", "--quiet", "--"))
}
func (cli *GitCLI) ShortCommit(ctx context.Context) (string, error) {
return cli.clean(cli.Run(ctx, "show", "--format=%h", "HEAD", "--quiet", "--"))
}
func (cli *GitCLI) Tag(ctx context.Context) (string, error) {
var tag string
var err error
for _, fn := range []func() (string, error){
func() (string, error) {
return cli.clean(cli.Run(ctx, "tag", "--points-at", "HEAD", "--sort", "-version:creatordate"))
},
func() (string, error) {
return cli.clean(cli.Run(ctx, "describe", "--tags", "--abbrev=0"))
},
} {
tag, err = fn()
if tag != "" || err != nil {
return tag, err
}
}
return tag, err
}
func (cli *GitCLI) clean(dt []byte, err error) (string, error) {
out := string(dt)
out = strings.ReplaceAll(strings.Split(out, "\n")[0], "'", "")
if err != nil {
err = errors.New(strings.TrimSuffix(err.Error(), "\n"))
}
return out, err
}
func (cli *GitCLI) currentRemote(ctx context.Context) (string, error) {
symref, err := cli.clean(cli.Run(ctx, "symbolic-ref", "-q", "HEAD"))
if err != nil {
return "", err
}
if symref == "" {
return "", nil
}
remote, err := cli.clean(cli.Run(ctx, "for-each-ref", "--format=%(upstream:remotename)", symref))
if err != nil {
return "", err
}
return remote, nil
}
func IsUnknownRevision(err error) bool {
if err == nil {
return false
}
// https://github.com/git/git/blob/a6a323b31e2bcbac2518bddec71ea7ad558870eb/setup.c#L204
errMsg := strings.ToLower(err.Error())
return strings.Contains(errMsg, "unknown revision or path not in the working tree") || strings.Contains(errMsg, "bad revision")
}