internal

Documentation

Index

• Constants
• Variables
• func GetUrlToDir(u string, targetDir string, bearer string, ctx context.Context) (string, error)
• func GetUrltoTempFile(u string, bearer string, ctx context.Context) (string, error)
• type Hash
  • func NewHash(algo string) (*Hash, error)
• type Hasher
• type Lock
  • func NewLock(path string, newOk bool) (*Lock, error)
  • func (l *Lock) AddResource(paths []string, algo string, tags []string, filename string, cacheURL string) error
  • func (l *Lock) Contains(url string) bool
  • func (l *Lock) DeleteResource(path string) error
  • func (l *Lock) Download(dir string, tags []string, notags []string, perm string, status bool) error
  • func (l *Lock) Save() error
• type Resource
  • func NewResourceFromUrl(urls []string, algo string, tags []string, filename string, ...) (*Resource, error)
  • func (l *Resource) AddToCache(filePath string) error
  • func (l *Resource) Contains(url string) bool
  • func (l *Resource) Delete() error
  • func (l *Resource) Download(dir string, mode os.FileMode, ctx context.Context) error
• type StatusLine
  • func NewStatusLine(ctx context.Context, resources *[]Resource) *StatusLine
  • func (st *StatusLine) GetStatusString() string
  • func (st *StatusLine) Increment(i int)
  • func (st *StatusLine) InitResourcesSizes() error
  • func (st *StatusLine) Start(doTick bool)
  • func (st *StatusLine) Stop()

Constants

const GRABIT_ARTIFACTORY_TOKEN_ENV_VAR = "GRABIT_ARTIFACTORY_TOKEN"

const NoFileMode = os.FileMode(0)

Variables

var (
	Version = "dev"
	Commit  = "none"
	Date    = "unknown"
)

var COMMENT_PREFIX = "//"

var RecommendedAlgo = "sha256"

Functions

func GetUrlToDir

func GetUrlToDir(u string, targetDir string, bearer string, ctx context.Context) (string, error)

GetUrlToDir downloads the given resource to the given directory and returns the path to it.

func GetUrltoTempFile

func GetUrltoTempFile(u string, bearer string, ctx context.Context) (string, error)

GetUrlWithDir downloads the given resource to a temporary file and returns the path to it.

Types

type Hash

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

func NewHash

func NewHash(algo string) (*Hash, error)

type Hasher

type Hasher func() hash.Hash

type Lock

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

Lock represents a grabit lockfile.

func NewLock

func NewLock(path string, newOk bool) (*Lock, error)

func (*Lock) AddResource

func (l *Lock) AddResource(paths []string, algo string, tags []string, filename string, cacheURL string) error

func (*Lock) Contains

func (l *Lock) Contains(url string) bool

Contains returns true if this lock file contains the given resource url.

func (*Lock) DeleteResource

func (l *Lock) DeleteResource(path string) error

func (*Lock) Download

func (l *Lock) Download(dir string, tags []string, notags []string, perm string, status bool) error

Download gets all the resources in this lock file and moves them to the destination directory.

func (*Lock) Save

func (l *Lock) Save() error

Save this lock file to disk.

type Resource

type Resource struct {
	Urls                []string
	Integrity           string
	Tags                []string `toml:",omitempty"`
	Filename            string   `toml:",omitempty"`
	ArtifactoryCacheURL string   `toml:",omitempty"`
}

Resource represents an external resource to be downloaded.

func NewResourceFromUrl

func NewResourceFromUrl(urls []string, algo string, tags []string, filename string, ArtifactoryCacheURL string) (*Resource, error)

func (*Resource) AddToCache

func (l *Resource) AddToCache(filePath string) error

func (*Resource) Contains

func (l *Resource) Contains(url string) bool

func (*Resource) Delete

func (l *Resource) Delete() error

func (*Resource) Download

func (l *Resource) Download(dir string, mode os.FileMode, ctx context.Context) error

type StatusLine

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

func NewStatusLine

func NewStatusLine(ctx context.Context, resources *[]Resource) *StatusLine

NewStatusLine creates and initializes a new StatusLine.

func (*StatusLine) GetStatusString

func (st *StatusLine) GetStatusString() string

GetStatusString composes and returns the status line string for printing.

func (*StatusLine) Increment

func (st *StatusLine) Increment(i int)

Increment informs the StatusLine that a resource (at index i in resource list) has finished downloading. The SL is printed and Stopped if all resources are downloaded.

func (*StatusLine) InitResourcesSizes

func (st *StatusLine) InitResourcesSizes() error

initResourceSizes fetches the size, in bytes, of each resource.

func (*StatusLine) Start

func (st *StatusLine) Start(doTick bool)

Start begins the goroutine and loop that will update/print the status line. Pass true to force SL to update (spinner and second counter) every 50ms.

func (*StatusLine) Stop

func (st *StatusLine) Stop()