gcs

Documentation

Index

• type Adapter
  • func (a Adapter) Read(ctx context.Context) ([]byte, error)
  • func (a Adapter) Write(ctx context.Context, p []byte) error
• type Client
  • func NewClient(ctx context.Context, config Config) (Client, error)
• type Config
  • func (c *Config) NewStorage() (storage.Storage, error)
• type Storage
  • func NewStorage(config *Config, client Client) (*Storage, error)
  • func (s *Storage) Read(ctx context.Context) ([]byte, error)
  • func (s *Storage) Write(ctx context.Context, b []byte) error

Types

type Adapter

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

An implementation of Client that delegates actual operation to gcsStorage.Client.

func (Adapter) Read

func (a Adapter) Read(ctx context.Context) ([]byte, error)

func (Adapter) Write

func (a Adapter) Write(ctx context.Context, p []byte) error

type Client

type Client interface {
	// Read an object from a GCS bucket.
	Read(ctx context.Context) ([]byte, error)

	// Write an object onto a GCS bucket.
	Write(ctx context.Context, p []byte) error
}

A minimal interface to mock behavior of GCS client.

func NewClient

func NewClient(ctx context.Context, config Config) (Client, error)

NewClient returns a new Client with given Context and Config.

type Config

type Config struct {
	// The name of the GCS bucket.
	Bucket string `hcl:"bucket"`
	// Path to the migration history file.
	Name string `hcl:"name"`
}

Config is a config for Google Cloud Storage. This is expected to have almost the same options as Terraform gcs backend. https://www.terraform.io/language/settings/backends/gcs However, it has many minor options and it's a pain to test all options from first, so we added only options we need for now.

func (*Config) NewStorage

func (c *Config) NewStorage() (storage.Storage, error)

NewStorage returns a new instance of storage.Storage.

type Storage

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

An implementation of storage.Storage interface.

func NewStorage

func NewStorage(config *Config, client Client) (*Storage, error)

NewStorage returns a new instance of Storage.

func (*Storage) Read

func (s *Storage) Read(ctx context.Context) ([]byte, error)

func (*Storage) Write

func (s *Storage) Write(ctx context.Context, b []byte) error