gcs

Documentation

Index

• func GetTargetFolder(folderPath string, stepResultType string, subFolder string) string
• func NewClient(opts ...gcsOption) (*gcsClient, error)
• func PersistReportsToGCS(gcsClient Client, outputParams []ReportOutputParam, ...) error
• func WithClientOptions(opts ...option.ClientOption) gcsOption
• func WithCreateFileFunction(createFile func(name string) (io.WriteCloser, error)) gcsOption
• func WithEnvVars(envVars []EnvVar) gcsOption
• func WithOpenFileFunction(openFile func(name string) (io.ReadCloser, error)) gcsOption
• type Client
• type EnvVar
• type ReportOutputParam
• type Task

Functions

func GetTargetFolder

func GetTargetFolder(folderPath string, stepResultType string, subFolder string) string

GetTargetFolder calculates the target folder in GCS bucket

func NewClient

func NewClient(opts ...gcsOption) (*gcsClient, error)

Init intitializes the google cloud storage client

func PersistReportsToGCS

func PersistReportsToGCS(gcsClient Client, outputParams []ReportOutputParam, inputParams map[string]string, gcsFolderPath string, gcsBucketID string, gcsSubFolder string, searchFilesFunc func(string) ([]string, error), fileInfo func(string) (os.FileInfo, error)) error

func WithClientOptions

func WithClientOptions(opts ...option.ClientOption) gcsOption

WithEnvVars initializes the Google Cloud Storage client options

func WithCreateFileFunction

func WithCreateFileFunction(createFile func(name string) (io.WriteCloser, error)) gcsOption

WithEnvVars initializes the createFile function in gcsClient

func WithEnvVars

func WithEnvVars(envVars []EnvVar) gcsOption

WithEnvVars initializes env variables in gcsClient

func WithOpenFileFunction

func WithOpenFileFunction(openFile func(name string) (io.ReadCloser, error)) gcsOption

WithEnvVars initializes the openFile function in gcsClient

Types

type Client

type Client interface {
	UploadFile(bucketID string, sourcePath string, targetPath string) error
	DownloadFile(bucketID string, sourcePath string, targetPath string) error
	ListFiles(bucketID string) ([]string, error)
	Close() error
}

Client is an interface to mock gcsClient

type EnvVar

type EnvVar struct {
	Name     string
	Value    string
	Modified bool
}

EnvVar defines an environment variable incl. information about a potential modification to the variable

type ReportOutputParam

type ReportOutputParam struct {
	FilePattern    string
	ParamRef       string
	StepResultType string
}

type Task

type Task struct {
	SourcePath string
	TargetPath string
}