storage

Documentation

Index

• Constants
• func ExtractS3BucketAndPrefix(uri string) (string, string, error)
• type ArtifactObject
  • func (o ArtifactObject) GetPath() string
  • func (o ArtifactObject) GetSize() int64
  • func (o ArtifactObject) IsDirectory() bool
• type ArtifactStorageFactory
  • func NewArtifactStorageFactory(config *config.ServiceConfig) (*ArtifactStorageFactory, error)
  • func (s *ArtifactStorageFactory) GetStorage(ctx context.Context, runArtifactPath string) (ArtifactStorageProvider, error)
• type ArtifactStorageFactoryProvider
• type ArtifactStorageProvider
• type Local
  • func NewLocal(config *config.ServiceConfig) (*Local, error)
  • func (s Local) Get(ctx context.Context, artifactURI, path string) (io.ReadCloser, error)
  • func (s Local) List(ctx context.Context, artifactURI, path string) ([]ArtifactObject, error)
• type MockArtifactStorageFactoryProvider
  • func NewMockArtifactStorageFactoryProvider(t interface{ ... }) *MockArtifactStorageFactoryProvider
  • func (_m *MockArtifactStorageFactoryProvider) GetStorage(ctx context.Context, runArtifactPath string) (ArtifactStorageProvider, error)
• type MockArtifactStorageProvider
  • func NewMockArtifactStorageProvider(t interface{ ... }) *MockArtifactStorageProvider
  • func (_m *MockArtifactStorageProvider) Get(ctx context.Context, artifactURI string, path string) (io.ReadCloser, error)
  • func (_m *MockArtifactStorageProvider) List(ctx context.Context, artifactURI string, path string) ([]ArtifactObject, error)
• type S3
  • func NewS3(ctx context.Context, config *config.ServiceConfig) (*S3, error)
  • func (s S3) Get(ctx context.Context, artifactURI, path string) (io.ReadCloser, error)
  • func (s S3) List(ctx context.Context, artifactURI, path string) ([]ArtifactObject, error)

Constants

const (
	LocalStorageName = "file"
)

LocalStorageName is a file storage name.

const (
	S3StorageName = "s3"
)

S3StorageName is a s3 storage name.

Functions

func ExtractS3BucketAndPrefix

func ExtractS3BucketAndPrefix(uri string) (string, string, error)

ExtractS3BucketAndPrefix extracts bucket name and prefix path from provided uri. after processing of this uri s3://fasttrackml/2/30357ed2eaac4f2cacdbcd0e06e9e48a/artifacts result will be: - bucket = fasttrackml - prefix = 2/30357ed2eaac4f2cacdbcd0e06e9e48a/artifacts

Types

type ArtifactObject

type ArtifactObject struct {
	Path  string
	Size  int64 // artifact object size in bytes.
	IsDir bool
}

ArtifactObject represents Artifact object agnostic to selected storage.

func (ArtifactObject) GetPath

func (o ArtifactObject) GetPath() string

GetPath returns Artifact Path.

func (ArtifactObject) GetSize

func (o ArtifactObject) GetSize() int64

GetSize returns Artifact Size in bytes.

func (ArtifactObject) IsDirectory

func (o ArtifactObject) IsDirectory() bool

IsDirectory show that object is directly or not.

type ArtifactStorageFactory

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

ArtifactStorageFactory represents Artifact Storage .

func NewArtifactStorageFactory

func NewArtifactStorageFactory(config *config.ServiceConfig) (*ArtifactStorageFactory, error)

NewArtifactStorageFactory creates new Artifact Storage Factory instance.

func (*ArtifactStorageFactory) GetStorage

func (s *ArtifactStorageFactory) GetStorage(
	ctx context.Context,
	runArtifactPath string,
) (ArtifactStorageProvider, error)

GetStorage returns Artifact storage based on provided runArtifactPath.

type ArtifactStorageFactoryProvider

type ArtifactStorageFactoryProvider interface {
	// GetStorage returns Artifact storage based on provided runArtifactPath.
	GetStorage(ctx context.Context, runArtifactPath string) (ArtifactStorageProvider, error)
}

ArtifactStorageFactoryProvider provides an interface provider to work with Artifact Storage.

type ArtifactStorageProvider

type ArtifactStorageProvider interface {
	// Get returns an io.ReadCloser for specific artifact.
	Get(ctx context.Context, artifactURI, path string) (io.ReadCloser, error)
	// List lists all artifact object under provided path.
	List(ctx context.Context, artifactURI, path string) ([]ArtifactObject, error)
}

ArtifactStorageProvider provides an interface to work with artifact storage.

type Local

type Local struct{}

Local represents local file storage adapter to work with artifacts.

func NewLocal

func NewLocal(config *config.ServiceConfig) (*Local, error)

NewLocal creates new Local storage instance.

func (Local) Get

func (s Local) Get(ctx context.Context, artifactURI, path string) (io.ReadCloser, error)

Get returns actual file content at the storage location.

func (Local) List

func (s Local) List(ctx context.Context, artifactURI, path string) ([]ArtifactObject, error)

List implements ArtifactStorageProvider interface.

type MockArtifactStorageFactoryProvider

type MockArtifactStorageFactoryProvider struct {
	mock.Mock
}

MockArtifactStorageFactoryProvider is an autogenerated mock type for the ArtifactStorageFactoryProvider type

func NewMockArtifactStorageFactoryProvider

func NewMockArtifactStorageFactoryProvider(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockArtifactStorageFactoryProvider

NewMockArtifactStorageFactoryProvider creates a new instance of MockArtifactStorageFactoryProvider. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockArtifactStorageFactoryProvider) GetStorage

func (_m *MockArtifactStorageFactoryProvider) GetStorage(ctx context.Context, runArtifactPath string) (ArtifactStorageProvider, error)

GetStorage provides a mock function with given fields: ctx, runArtifactPath

type MockArtifactStorageProvider

type MockArtifactStorageProvider struct {
	mock.Mock
}

MockArtifactStorageProvider is an autogenerated mock type for the ArtifactStorageProvider type

func NewMockArtifactStorageProvider

func NewMockArtifactStorageProvider(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockArtifactStorageProvider

NewMockArtifactStorageProvider creates a new instance of MockArtifactStorageProvider. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockArtifactStorageProvider) Get

func (_m *MockArtifactStorageProvider) Get(ctx context.Context, artifactURI string, path string) (io.ReadCloser, error)

Get provides a mock function with given fields: ctx, artifactURI, path

func (*MockArtifactStorageProvider) List

func (_m *MockArtifactStorageProvider) List(ctx context.Context, artifactURI string, path string) ([]ArtifactObject, error)

List provides a mock function with given fields: ctx, artifactURI, path

type S3

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

S3 represents S3 adapter to work with artifacts.

func NewS3

func NewS3(ctx context.Context, config *config.ServiceConfig) (*S3, error)

NewS3 creates new S3 instance.

func (S3) Get

func (s S3) Get(ctx context.Context, artifactURI, path string) (io.ReadCloser, error)

Get returns file content at the storage location.

func (S3) List

func (s S3) List(ctx context.Context, artifactURI, path string) ([]ArtifactObject, error)

List implements ArtifactStorageProvider interface.