sdstore

Documentation

Index

• Constants
• Variables
• func Cache2Disk(command, cacheScope, src string, cacheMaxSizeInMB int64) error
• func Compress(src, dst string, files []*FileInfo) error
• func Decompress(src, dst string) error
• func MD5All(root string) (map[string]string, error)
• func Unzip(src string, dest string) ([]string, error)
• func Zip(source, target string) error
• type FileInfo
• type SDError
  • func (e SDError) Error() string
• type SDStore
  • func NewStore(token string, maxRetries int, httpTimeout int, retryWaitMin int, ...) SDStore

Constants

const CompressFormatTarZst = ".tar.zst"

const CompressFormatZip = ".zip"

const CompressionLevel = -3 // default compression level - 3 / possible values (1-19) or --fast

const DefaultFilePermission = os.ModePerm

const Md5Extension = ".md5"

const ZstdCli = true // use zstd binary or go library

Variables

var ExecCommand = exec.Command

ExecCommand : os exec command

var FlockWaitMaxSecs = 15

var FlockWaitMinSecs = 5

var UTCLoc, _ = time.LoadLocation("UTC")

Functions

func Cache2Disk

func Cache2Disk(command, cacheScope, src string, cacheMaxSizeInMB int64) error

cache directories and files to/from shared storage param - command set, get or remove param - cacheScope pipeline, event, job param - src source directory param - cacheMaxSizeInMB max cache size limit allowed in MB return - nil / error success - return nil; error - return error description

func Compress

func Compress(src, dst string, files []*FileInfo) error

func Decompress

func Decompress(src, dst string) error

func MD5All

func MD5All(root string) (map[string]string, error)

MD5All reads all the files in the file tree rooted at root and returns a map from file path to the MD5 sum of the file's contents. If the directory walk fails or any read operation fails, MD5All returns an error. In that case, MD5All does not wait for inflight read operations to complete.

func Unzip

func Unzip(src string, dest string) ([]string, error)

Unzip is repurposed from https://github.com/mholt/archiver/pull/92/files To include support for symbolic links

func Zip

func Zip(source, target string) error

Zip is repurposed from https://github.com/mholt/archiver/pull/92/files To include support for symbolic links

Types

type FileInfo

type FileInfo struct {
	Path    string `json:"path"`
	Size    int64  `json:"size"`
	ModTime int64  `json:"modtime"`
	Mode    string `json:"mode"`
}

type SDError

type SDError struct {
	StatusCode int    `json:"statusCode"`
	Reason     string `json:"error"`
	Message    string `json:"message"`
}

SDError is an error response from the Screwdriver API

func (SDError) Error

func (e SDError) Error() string

Error implements the error interface for SDError

type SDStore

type SDStore interface {
	Upload(u *url.URL, filePath string, toCompress bool) error
	Download(url *url.URL, toExtract bool) error
	Remove(url *url.URL) error
}

SDStore is able to upload, download, and remove the contents of a Reader to the SD Store

func NewStore

func NewStore(token string, maxRetries int, httpTimeout int, retryWaitMin int, retryWaitMax int) SDStore

NewStore returns an SDStore instance.