git

Documentation

Index

• Constants
• Variables
• func AddGitProtocolEnv(ctx context.Context, req RequestWithGitProtocol, env []string) []string
• func BareCommand(ctx context.Context, stdin io.Reader, stdout, stderr io.Writer, env []string, ...) (*command.Command, error)
• func BuildGitOptions(gitOpts []string, otherOpts ...string) []string
• func Command(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)
• func CommandWithoutRepo(ctx context.Context, args ...string) (*command.Command, error)
• func HookEnv(req ReceivePackRequest) []string
• func InfoAlternatesPath(repo repository.GitRepo) (string, error)
• func IsInvalidArgErr(err error) bool
• func IsLFSPointer(b []byte) bool
• func IsValidRef(ctx context.Context, repo *gitalypb.Repository, ref string) bool
• func NoMissingWantErrMessage() bool
• func ReceivePackConfig() []string
• func SafeBareCmd(ctx context.Context, stdin io.Reader, stdout, stderr io.Writer, env []string, ...) (*command.Command, error)
• func SafeCmd(ctx context.Context, repo repository.GitRepo, globals []Option, sc SubCmd) (*command.Command, error)
• func SafeCmdWithoutRepo(ctx context.Context, globals []Option, sc SubCmd) (*command.Command, error)
• func SafeStdinCmd(ctx context.Context, repo repository.GitRepo, globals []Option, sc SubCmd) (*command.Command, error)
• func StdinCommand(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)
• func SupportsDeltaIslands(versionStr string) (bool, error)
• func ValidateCommitID(id string) error
• func ValidateRevision(revision []byte) error
• func ValidateRevisionAllowEmpty(revision []byte) error
• func Version() (string, error)
• func VersionLessThan(v1Str, v2Str string) (bool, error)
• type Flag
  • func (Flag) IsOption()
  • func (f Flag) ValidateArgs() ([]string, error)
• type Option
• type ReceivePackRequest
• type RequestWithGitProtocol
• type SubCmd
  • func (sc SubCmd) ValidateArgs() ([]string, error)
• type ValueFlag
  • func (ValueFlag) IsOption()
  • func (vf ValueFlag) ValidateArgs() ([]string, error)

Constants

const (
	// EmptyTreeID is the Git tree object hash that corresponds to an empty tree (directory)
	EmptyTreeID = "4b825dc642cb6eb9a060e54bf8d69288fbee4904"

	// NullSHA is the special value that Git uses to signal a ref or object does not exist
	NullSHA = "0000000000000000000000000000000000000000"
)

const (
	// ProtocolV2 is the special value used by Git clients to request protocol v2
	ProtocolV2 = "version=2"
)

Variables

var FallbackTimeValue = time.Unix(1<<63-62135596801, 999999999)

FallbackTimeValue is the value returned by `SafeTimeParse` in case it encounters a parse error. It's the maximum time value possible in golang. See https://gitlab.com/gitlab-org/gitaly/issues/556#note_40289573

Functions

func AddGitProtocolEnv

func AddGitProtocolEnv(ctx context.Context, req RequestWithGitProtocol, env []string) []string

AddGitProtocolEnv checks whether the request has Git protocol v2 and sets this in the environment.

func BareCommand

func BareCommand(ctx context.Context, stdin io.Reader, stdout, stderr io.Writer, env []string, args ...string) (*command.Command, error)

BareCommand creates a git.Command with the given args, stdin/stdout/stderr, and env

Deprecated: use git.SafeBareCmd

func BuildGitOptions

func BuildGitOptions(gitOpts []string, otherOpts ...string) []string

BuildGitOptions helps to generate options to the git command. If gitOpts is not empty then its values are passed as part of the "-c" option of the git command, the other values are passed along with the subcommand.

func Command

func Command(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)

Command creates a git.Command with the given args and Repository

Deprecated: use git.SafeCmd instead

func CommandWithoutRepo

func CommandWithoutRepo(ctx context.Context, args ...string) (*command.Command, error)

CommandWithoutRepo works like Command but without a git repository

func HookEnv

func HookEnv(req ReceivePackRequest) []string

HookEnv is information we pass down to the Git hooks during git-receive-pack.

func InfoAlternatesPath

func InfoAlternatesPath(repo repository.GitRepo) (string, error)

InfoAlternatesPath finds the fully qualified path for the alternates file.

func IsInvalidArgErr

func IsInvalidArgErr(err error) bool

IsInvalidArgErr relays if the error is due to an argument validation failure

func IsLFSPointer

func IsLFSPointer(b []byte) bool

IsLFSPointer checks to see if a blob is an LFS pointer. It returns the raw data of the pointer if it is

func IsValidRef

func IsValidRef(ctx context.Context, repo *gitalypb.Repository, ref string) bool

IsValidRef checks if a ref in a repo is valid

func NoMissingWantErrMessage

func NoMissingWantErrMessage() bool

NoMissingWantErrMessage checks if the git version is before Git 2.22, in which versions the missing objects in the wants didn't yield an explicit error message, but no ouput at all.

func ReceivePackConfig

func ReceivePackConfig() []string

ReceivePackConfig contains config options we want to enforce when receiving a push with git-receive-pack.

func SafeBareCmd

func SafeBareCmd(ctx context.Context, stdin io.Reader, stdout, stderr io.Writer, env []string, globals []Option, sc SubCmd) (*command.Command, error)

SafeBareCmd creates a git.Command with the given args, stdin/stdout/stderr, and env. It validates the arguments in the command before executing.

func SafeCmd

func SafeCmd(ctx context.Context, repo repository.GitRepo, globals []Option, sc SubCmd) (*command.Command, error)

SafeCmd creates a git.Command with the given args and Repository. It validates the arguments in the command before executing.

func SafeCmdWithoutRepo

func SafeCmdWithoutRepo(ctx context.Context, globals []Option, sc SubCmd) (*command.Command, error)

SafeCmdWithoutRepo works like Command but without a git repository. It validates the arugments in the command before executing.

func SafeStdinCmd

func SafeStdinCmd(ctx context.Context, repo repository.GitRepo, globals []Option, sc SubCmd) (*command.Command, error)

SafeStdinCmd creates a git.Command with the given args and Repository that is suitable for Write()ing to. It validates the arguments in the command before executing.

func StdinCommand

func StdinCommand(ctx context.Context, repo repository.GitRepo, args ...string) (*command.Command, error)

StdinCommand creates a git.Command with the given args and Repository that is suitable for Write()ing to

Deprecated: Use git.SafeStdinCmd instead

func SupportsDeltaIslands

func SupportsDeltaIslands(versionStr string) (bool, error)

SupportsDeltaIslands checks if a version string (e.g. "2.20.0") corresponds to a Git version that supports delta islands.

func ValidateCommitID

func ValidateCommitID(id string) error

ValidateCommitID checks if id could be a Git commit ID, syntactically.

func ValidateRevision

func ValidateRevision(revision []byte) error

ValidateRevision checks if a revision looks valid

func ValidateRevisionAllowEmpty

func ValidateRevisionAllowEmpty(revision []byte) error

ValidateRevisionAllowEmpty checks if a revision looks valid, but allows empty strings

func Version

func Version() (string, error)

Version returns the used git version.

func VersionLessThan

func VersionLessThan(v1Str, v2Str string) (bool, error)

VersionLessThan returns true if the parsed version value of v1Str is less than the parsed version value of v2Str. An error can be returned if the strings cannot be parsed. Note: this is an extremely simplified semver comparison algorithm

Types

type Flag

type Flag struct {
	Name string
}

Flag is a single token optional command line argument that enables or disables functionality (e.g. "-L")

func (Flag) IsOption

func (Flag) IsOption()

IsOption is a method present on all Flag interface implementations

func (Flag) ValidateArgs

func (f Flag) ValidateArgs() ([]string, error)

ValidateArgs returns an error if the flag is not sanitary

type Option

type Option interface {
	IsOption()
	ValidateArgs() ([]string, error)
}

Option is a git command line flag with validation logic

type ReceivePackRequest

type ReceivePackRequest interface {
	GetGlId() string
	GetGlUsername() string
	GetGlRepository() string
}

ReceivePackRequest abstracts away the different requests that end up spawning git-receive-pack.

type RequestWithGitProtocol

type RequestWithGitProtocol interface {
	GetGitProtocol() string
}

RequestWithGitProtocol holds requests that respond to GitProtocol

type SubCmd

type SubCmd struct {
	Name        string   // e.g. "log", or "cat-file", or "worktree"
	Flags       []Option // optional flags before the positional args
	Args        []string // positional args after all flags
	PostSepArgs []string // post separator (i.e. "--") positional args
}

SubCmd represents a specific git command

func (SubCmd) ValidateArgs

func (sc SubCmd) ValidateArgs() ([]string, error)

ValidateArgs checks all arguments in the sub command and validates them

type ValueFlag

type ValueFlag struct {
	Name  string
	Value string
}

ValueFlag is an optional command line argument that is comprised of pair of tokens (e.g. "-n 50")

func (ValueFlag) IsOption

func (ValueFlag) IsOption()

IsOption is a method present on all Flag interface implementations

func (ValueFlag) ValidateArgs

func (vf ValueFlag) ValidateArgs() ([]string, error)

ValidateArgs returns an error if the flag is not sanitary