helper

Documentation

Index

• Variables
• func ByteSliceHasAnyPrefix(s []byte, prefixes ...string) bool
• func DecorateError(code codes.Code, err error) error
• func ExitStatus(err error) (int, bool)
• func GetPath(repo *pb.Repository) (string, error)
• func GetRepoPath(repo *pb.Repository) (string, error)
• func GitPath() string
• func IsGitDirectory(dir string) bool
• func IsNumber(s []byte) bool
• func IsValidRef(ctx context.Context, path, ref string) bool
• func UnquoteBytes(s []byte) []byte
• type Command
  • func GitCommandReader(ctx context.Context, args ...string) (*Command, error)
  • func GitlabShellCommandReader(ctx context.Context, envs []string, executable string, args ...string) (*Command, error)
  • func NewCommand(ctx context.Context, cmd *exec.Cmd, stdin io.Reader, stdout, stderr io.Writer, ...) (*Command, error)
  • func (c *Command) Close() error

Variables

var Unimplemented = grpc.Errorf(codes.Unimplemented, "this rpc is not implemented")

Unimplemented is a Go error with gRPC error code 'Unimplemented'

Functions

func ByteSliceHasAnyPrefix

func ByteSliceHasAnyPrefix(s []byte, prefixes ...string) bool

ByteSliceHasAnyPrefix tests whether the byte slice s begins with any of the prefixes.

func DecorateError

func DecorateError(code codes.Code, err error) error

DecorateError unless it's already a grpc error.

If given nil it will return nil.

func ExitStatus

func ExitStatus(err error) (int, bool)

ExitStatus will return the exit-code from an error

func GetPath

func GetPath(repo *pb.Repository) (string, error)

GetPath returns the path of the repo passed as first argument. An error is returned when either the storage can't be found or the path includes constructs trying to perform directory traversal.

func GetRepoPath

func GetRepoPath(repo *pb.Repository) (string, error)

GetRepoPath returns the full path of the repository referenced by an RPC Repository message. The errors returned are gRPC errors with relevant error codes and should be passed back to gRPC without further decoration.

func GitPath

func GitPath() string

GitPath returns the path to the `git` binary. See `SetGitPath` for details on how this is set

func IsGitDirectory

func IsGitDirectory(dir string) bool

IsGitDirectory checks if the directory passed as first argument looks like a valid git directory.

func IsNumber

func IsNumber(s []byte) bool

IsNumber tests whether the byte slice s contains only digits or not

func IsValidRef

func IsValidRef(ctx context.Context, path, ref string) bool

IsValidRef checks if a ref in a repo is valid

func UnquoteBytes

func UnquoteBytes(s []byte) []byte

UnquoteBytes removes surrounding double-quotes from a byte slice returning a new slice if they exist, otherwise it returns the same byte slice passed.

Types

type Command

type Command struct {
	io.Reader
	*exec.Cmd
	// contains filtered or unexported fields
}

Command encapsulates operations with commands creates with NewCommand

func GitCommandReader

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

GitCommandReader creates a git Command with the given args

func GitlabShellCommandReader

func GitlabShellCommandReader(ctx context.Context, envs []string, executable string, args ...string) (*Command, error)

GitlabShellCommandReader creates a gitlab-shell Command with the given args

func NewCommand

func NewCommand(ctx context.Context, cmd *exec.Cmd, stdin io.Reader, stdout, stderr io.Writer, env ...string) (*Command, error)

NewCommand creates a Command from an exec.Cmd

func (*Command) Close

func (c *Command) Close() error

Close will send a SIGTERM signal to the process group belonging to the `cmd` process