gitfile

Documentation

Index

• Variables
• type EnvVarTokenFetcher
  • func (s *EnvVarTokenFetcher) BuildHeader(context.Context, string, string, func(ctx context.Context, url string)) (*HeaderStruct, error)
• type GitFile
  • func Default() *GitFile
  • func New(fetcher TokenFetcher) *GitFile
  • func (g *GitFile) GetFileContents(ctx context.Context, namespace, repoUrl, filepath, ref string, ...) (io.ReadCloser, error)
• type GitHubScmProvider
• type GitLabScmProvider
• type GithubFile
• type HeaderStruct
• type InternalError
  • func (e *InternalError) Error() string
• type InvalidRequestError
  • func (e *InvalidRequestError) Error() string
• type ScmProvider
• type SpiTokenFetcher
  • func NewSpiTokenFetcher() *SpiTokenFetcher
  • func (s *SpiTokenFetcher) BuildHeader(ctx context.Context, namespace, repoUrl string, ...) (*HeaderStruct, error)
• type TokenFetcher
• type UnauthorizedError
  • func (e *UnauthorizedError) Error() string

Variables

var GithubAPITemplate = "https://api.github.com/repos/%s/%s/contents/%s"

var GithubURLRegexp = regexp.MustCompile(`(?Um)^(?:https)(?:\:\/\/)github.com/(?P<repoUser>[^/]+)/(?P<repoName>[^/]+)(.git)?$`)

var GithubURLRegexpNames = GithubURLRegexp.SubexpNames()

var ScmProviders []ScmProvider

ScmProviders is the list of detectors that are tried on an SCM URL. This is also the order they're tried (index 0 is first).

Types

type EnvVarTokenFetcher

type EnvVarTokenFetcher struct{}

EnvVarTokenFetcher token fetcher implementation that looks for token in the specific ENV variable.

func (*EnvVarTokenFetcher) BuildHeader

func (s *EnvVarTokenFetcher) BuildHeader(context.Context, string, string, func(ctx context.Context, url string)) (*HeaderStruct, error)

type GitFile

type GitFile struct {
	// contains filtered or unexported fields
}

func Default

func Default() *GitFile

func New

func New(fetcher TokenFetcher) *GitFile

New creates a new *GitFile instance

func (*GitFile) GetFileContents

func (g *GitFile) GetFileContents(ctx context.Context, namespace, repoUrl, filepath, ref string, callback func(ctx context.Context, url string)) (io.ReadCloser, error)

GetFileContents is a main entry function allowing to retrieve file content from the SCM provider. It expects three file location parameters, from which the repository URL and path to the file are mandatory, and optional Git reference for the branch/tags/commitIds. Function type parameter is a callback used when user authentication is needed in order to retrieve the file, that function will be called with the URL to OAuth service, where user need to be redirected.

type GitHubScmProvider

type GitHubScmProvider struct {
}

GitHubScmProvider implements Detector to detect GitHub URLs.

type GitLabScmProvider

type GitLabScmProvider struct{}

GitLabScmProvider implements Detector to detect Gitlab URLs.

type GithubFile

type GithubFile struct {
	Name        string `json:"name"`
	Path        string `json:"path"`
	Size        int32  `json:"size"`
	Encoding    string `json:"encoding"`
	DownloadUrl string `json:"download_url"`
}

type HeaderStruct

type HeaderStruct struct {
	Authorization string `json:"Authorization"`
}

HeaderStruct is the simple struct to carry authentication string from different suppliers

type InternalError

type InternalError struct {
	// contains filtered or unexported fields
}

func (*InternalError) Error

func (e *InternalError) Error() string

type InvalidRequestError

type InvalidRequestError struct {
	// contains filtered or unexported fields
}

func (*InvalidRequestError) Error

func (e *InvalidRequestError) Error() string

type ScmProvider

type ScmProvider interface {
	// contains filtered or unexported methods
}

ScmProvider defines the interface that in order to determine if URL belongs to SCM provider

type SpiTokenFetcher

type SpiTokenFetcher struct {
	// contains filtered or unexported fields
}

SpiTokenFetcher token fetcher implementation that looks for token in the specific ENV variable.

func NewSpiTokenFetcher

func NewSpiTokenFetcher() *SpiTokenFetcher

func (*SpiTokenFetcher) BuildHeader

func (s *SpiTokenFetcher) BuildHeader(ctx context.Context, namespace, repoUrl string, loginCallback func(ctx context.Context, url string)) (*HeaderStruct, error)

type TokenFetcher

type TokenFetcher interface {
	BuildHeader(ctx context.Context, namespace, repoUrl string, loginCallback func(ctx context.Context, url string)) (*HeaderStruct, error)
}

TokenFetcher is the interface for the authentication token suppliers which are provides tokens as a HeaderStruct instances

type UnauthorizedError

type UnauthorizedError struct {
}

func (*UnauthorizedError) Error

func (e *UnauthorizedError) Error() string