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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
package localrepo
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"strings"
"gitlab.com/gitlab-org/gitaly/v16/internal/git"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
)
// FetchOptsTags controls what tags needs to be imported on fetch.
type FetchOptsTags string
func (t FetchOptsTags) String() string {
return string(t)
}
var (
// FetchOptsTagsDefault enables importing of tags only on fetched branches.
FetchOptsTagsDefault = FetchOptsTags("")
// FetchOptsTagsAll enables importing of every tag from the remote repository.
FetchOptsTagsAll = FetchOptsTags("--tags")
// FetchOptsTagsNone disables importing of tags from the remote repository.
FetchOptsTagsNone = FetchOptsTags("--no-tags")
)
// FetchOpts is used to configure invocation of the 'FetchRemote' command.
type FetchOpts struct {
// Env is a list of env vars to pass to the cmd.
Env []string
// CommandOptions is a list of options to use with 'git' command.
CommandOptions []git.CmdOpt
// Prune if set fetch removes any remote-tracking references that no longer exist on the remote.
// https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---prune
Prune bool
// Force if set fetch overrides local references with values from remote that's
// doesn't have the previous commit as an ancestor.
// https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---force
Force bool
// Verbose controls how much information is written to stderr. The list of
// refs updated by the fetch will only be listed if verbose is true.
// https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---quiet
// https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---verbose
Verbose bool
// Tags controls whether tags will be fetched as part of the remote or not.
// https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---tags
// https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---no-tags
Tags FetchOptsTags
// Stderr if set it would be used to redirect stderr stream into it.
Stderr io.Writer
// DisableTransactions will disable the reference-transaction hook and atomic transactions.
DisableTransactions bool
}
// FetchFailedError indicates that the fetch has failed.
type FetchFailedError struct {
err error
}
// Error returns the error message.
func (e FetchFailedError) Error() string {
return e.err.Error()
}
// FetchRemote fetches changes from the specified remote. Returns an FetchFailedError error in case
// the fetch itself failed.
func (repo *Repo) FetchRemote(ctx context.Context, remoteName string, opts FetchOpts) error {
if err := validateNotBlank(remoteName, "remoteName"); err != nil {
return err
}
var stderr bytes.Buffer
if opts.Stderr == nil {
opts.Stderr = &stderr
}
commandOptions := []git.CmdOpt{
git.WithEnv(opts.Env...),
git.WithStderr(opts.Stderr),
git.WithConfig(git.ConfigPair{
// Git is so kind to point out that we asked it to not show forced updates
// by default, so we need to ask it not to do that.
Key: "advice.fetchShowForcedUpdates", Value: "false",
}),
}
if opts.DisableTransactions {
commandOptions = append(commandOptions, git.WithDisabledHooks())
} else {
commandOptions = append(commandOptions, git.WithRefTxHook(repo))
}
commandOptions = append(commandOptions, opts.CommandOptions...)
cmd, err := repo.gitCmdFactory.New(ctx, repo,
git.Command{
Name: "fetch",
Flags: opts.buildFlags(),
Args: []string{remoteName},
},
commandOptions...,
)
if err != nil {
return err
}
if err := cmd.Wait(); err != nil {
return FetchFailedError{errorWithStderr(err, stderr.Bytes())}
}
return nil
}
// FetchInternal performs a fetch from an internal Gitaly-hosted repository. Returns an
// FetchFailedError error in case git-fetch(1) failed.
func (repo *Repo) FetchInternal(
ctx context.Context,
remoteRepo *gitalypb.Repository,
refspecs []string,
opts FetchOpts,
) error {
if len(refspecs) == 0 {
return fmt.Errorf("fetch internal called without refspecs")
}
var stderr bytes.Buffer
if opts.Stderr == nil {
opts.Stderr = &stderr
}
commandOptions := []git.CmdOpt{
git.WithEnv(opts.Env...),
git.WithStderr(opts.Stderr),
git.WithInternalFetchWithSidechannel(
&gitalypb.SSHUploadPackWithSidechannelRequest{
Repository: remoteRepo,
GitConfigOptions: []string{"uploadpack.allowAnySHA1InWant=true"},
GitProtocol: git.ProtocolV2,
},
),
git.WithConfig(git.ConfigPair{
// Git is so kind to point out that we asked it to not show forced updates
// by default, so we need to ask it not to do that.
Key: "advice.fetchShowForcedUpdates", Value: "false",
}),
}
if opts.DisableTransactions {
commandOptions = append(commandOptions, git.WithDisabledHooks())
} else {
commandOptions = append(commandOptions, git.WithRefTxHook(repo))
}
commandOptions = append(commandOptions, opts.CommandOptions...)
if err := repo.ExecAndWait(ctx,
git.Command{
Name: "fetch",
Flags: opts.buildFlags(),
Args: append(
[]string{git.InternalGitalyURL},
refspecs...,
),
},
commandOptions...,
); err != nil {
return FetchFailedError{errorWithStderr(err, stderr.Bytes())}
}
return nil
}
func (opts FetchOpts) buildFlags() []git.Option {
flags := []git.Option{
// We don't need FETCH_HEAD, and it can potentially be hundreds of megabytes when
// doing a mirror-sync of repos with huge numbers of references.
git.Flag{Name: "--no-write-fetch-head"},
}
if !opts.Verbose {
flags = append(flags, git.Flag{Name: "--quiet"})
}
if opts.Prune {
flags = append(flags, git.Flag{Name: "--prune"})
}
if opts.Force {
flags = append(flags, git.Flag{Name: "--force"})
}
if opts.Tags != FetchOptsTagsDefault {
flags = append(flags, git.Flag{Name: opts.Tags.String()})
}
if !opts.DisableTransactions {
flags = append(flags, git.Flag{Name: "--atomic"})
}
// Even if we ask Git to not print any output and to force-update branches it will still
// compute whether branches have been force-updated only to discard that information again.
// Let's ask it not to given that this check can be quite expensive.
if !opts.Verbose && opts.Force {
flags = append(flags, git.Flag{Name: "--no-show-forced-updates"})
}
return flags
}
func validateNotBlank(val, name string) error {
if strings.TrimSpace(val) == "" {
return fmt.Errorf("%w: %q is blank or empty", git.ErrInvalidArg, name)
}
return nil
}
func envGitSSHCommand(cmd string) string {
return "GIT_SSH_COMMAND=" + cmd
}
// PushOptions are options that can be configured for a push.
type PushOptions struct {
// SSHCommand is the command line to use for git's SSH invocation. The command line is used
// as is and must be verified by the caller to be safe.
SSHCommand string
// Force decides whether to force push all of the refspecs.
Force bool
// Config is the Git configuration which gets passed to the git-push(1) invocation.
// Configuration is set up via `WithConfigEnv()`, so potential credentials won't be leaked
// via the command line.
Config []git.ConfigPair
}
// Push force pushes the refspecs to the remote.
func (repo *Repo) Push(ctx context.Context, remote string, refspecs []string, options PushOptions) error {
if len(refspecs) == 0 {
return errors.New("refspecs to push must be explicitly specified")
}
var env []string
if options.SSHCommand != "" {
env = append(env, envGitSSHCommand(options.SSHCommand))
}
var flags []git.Option
if options.Force {
flags = append(flags, git.Flag{Name: "--force"})
}
stderr := &bytes.Buffer{}
if err := repo.ExecAndWait(ctx,
git.Command{
Name: "push",
Flags: flags,
Args: append([]string{remote}, refspecs...),
},
git.WithStderr(stderr),
git.WithEnv(env...),
git.WithConfigEnv(options.Config...),
); err != nil {
return fmt.Errorf("git push: %w, stderr: %q", err, stderr)
}
return nil
}
|