db

Documentation

Index

• Variables
• func MetadataPath(cacheDir string) string
• type Client
  • func NewClient(dbc dbOperation, githubClient github.Operation, pb indicator.ProgressBar, ...) Client
  • func (c Client) Download(ctx context.Context, cacheDir string, light bool) error
  • func (c Client) NeedsUpdate(cliVersion string, light, skip bool) (bool, error)
  • func (c Client) UpdateMetadata(cacheDir string) error
• type Metadata
  • func NewMetadata(fs afero.Fs, cacheDir string) Metadata
  • func (m Metadata) Delete() error
  • func (m Metadata) Get() (db.Metadata, error)
• type MockOperation
  • func (_m *MockOperation) ApplyDownloadExpectation(e OperationDownloadExpectation)
  • func (_m *MockOperation) ApplyDownloadExpectations(expectations []OperationDownloadExpectation)
  • func (_m *MockOperation) ApplyNeedsUpdateExpectation(e OperationNeedsUpdateExpectation)
  • func (_m *MockOperation) ApplyNeedsUpdateExpectations(expectations []OperationNeedsUpdateExpectation)
  • func (_m *MockOperation) ApplyUpdateMetadataExpectation(e OperationUpdateMetadataExpectation)
  • func (_m *MockOperation) ApplyUpdateMetadataExpectations(expectations []OperationUpdateMetadataExpectation)
  • func (_m *MockOperation) Download(ctx context.Context, cacheDir string, light bool) error
  • func (_m *MockOperation) NeedsUpdate(cliVersion string, skip bool, light bool) (bool, error)
  • func (_m *MockOperation) UpdateMetadata(cacheDir string) error
• type Operation
• type OperationDownloadArgs
• type OperationDownloadExpectation
• type OperationDownloadReturns
• type OperationNeedsUpdateArgs
• type OperationNeedsUpdateExpectation
• type OperationNeedsUpdateReturns
• type OperationUpdateMetadataArgs
• type OperationUpdateMetadataExpectation
• type OperationUpdateMetadataReturns

Variables

var SuperSet = wire.NewSet(

	indicator.NewProgressBar,

	wire.Struct(new(clock.RealClock)),
	wire.Bind(new(clock.Clock), new(clock.RealClock)),

	wire.Struct(new(db.Config)),
	wire.Bind(new(dbOperation), new(db.Config)),

	github.NewClient,
	wire.Bind(new(github.Operation), new(github.Client)),

	afero.NewOsFs,
	NewMetadata,

	NewClient,
	wire.Bind(new(Operation), new(Client)),
)

SuperSet binds the dependencies

Functions

func MetadataPath

func MetadataPath(cacheDir string) string

MetadataPath returns the metaData file path

Types

type Client

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

Client implements DB operations

func NewClient

func NewClient(dbc dbOperation, githubClient github.Operation, pb indicator.ProgressBar, clock clock.Clock, metadata Metadata) Client

NewClient is the factory method for DB client

func (Client) Download

func (c Client) Download(ctx context.Context, cacheDir string, light bool) error

Download downloads the DB file

func (Client) NeedsUpdate

func (c Client) NeedsUpdate(cliVersion string, light, skip bool) (bool, error)

NeedsUpdate check is DB needs update

func (Client) UpdateMetadata

func (c Client) UpdateMetadata(cacheDir string) error

UpdateMetadata updates the DB metadata

type Metadata

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

Metadata defines the file meta

func NewMetadata

func NewMetadata(fs afero.Fs, cacheDir string) Metadata

NewMetadata is the factory method for file Metadata

func (Metadata) Delete

func (m Metadata) Delete() error

Delete deletes the file of database metadata

func (Metadata) Get

func (m Metadata) Get() (db.Metadata, error)

Get returns the file metadata

type MockOperation

type MockOperation struct {
	mock.Mock
}

MockOperation is an autogenerated mock type for the Operation type

func (*MockOperation) ApplyDownloadExpectation

func (_m *MockOperation) ApplyDownloadExpectation(e OperationDownloadExpectation)

func (*MockOperation) ApplyDownloadExpectations

func (_m *MockOperation) ApplyDownloadExpectations(expectations []OperationDownloadExpectation)

func (*MockOperation) ApplyNeedsUpdateExpectation

func (_m *MockOperation) ApplyNeedsUpdateExpectation(e OperationNeedsUpdateExpectation)

func (*MockOperation) ApplyNeedsUpdateExpectations

func (_m *MockOperation) ApplyNeedsUpdateExpectations(expectations []OperationNeedsUpdateExpectation)

func (*MockOperation) ApplyUpdateMetadataExpectation

func (_m *MockOperation) ApplyUpdateMetadataExpectation(e OperationUpdateMetadataExpectation)

func (*MockOperation) ApplyUpdateMetadataExpectations

func (_m *MockOperation) ApplyUpdateMetadataExpectations(expectations []OperationUpdateMetadataExpectation)

func (*MockOperation) Download

func (_m *MockOperation) Download(ctx context.Context, cacheDir string, light bool) error

Download provides a mock function with given fields: ctx, cacheDir, light

func (*MockOperation) NeedsUpdate

func (_m *MockOperation) NeedsUpdate(cliVersion string, skip bool, light bool) (bool, error)

NeedsUpdate provides a mock function with given fields: cliVersion, skip, light

func (*MockOperation) UpdateMetadata

func (_m *MockOperation) UpdateMetadata(cacheDir string) error

UpdateMetadata provides a mock function with given fields: cacheDir

type Operation

type Operation interface {
	NeedsUpdate(cliVersion string, skip, light bool) (need bool, err error)
	Download(ctx context.Context, cacheDir string, light bool) (err error)
	UpdateMetadata(cacheDir string) (err error)
}

Operation defines the DB operations

type OperationDownloadArgs

type OperationDownloadArgs struct {
	Ctx              context.Context
	CtxAnything      bool
	CacheDir         string
	CacheDirAnything bool
	Light            bool
	LightAnything    bool
}

type OperationDownloadExpectation

type OperationDownloadExpectation struct {
	Args    OperationDownloadArgs
	Returns OperationDownloadReturns
}

type OperationDownloadReturns

type OperationDownloadReturns struct {
	Err error
}

type OperationNeedsUpdateArgs

type OperationNeedsUpdateArgs struct {
	CliVersion         string
	CliVersionAnything bool
	Skip               bool
	SkipAnything       bool
	Light              bool
	LightAnything      bool
}

type OperationNeedsUpdateExpectation

type OperationNeedsUpdateExpectation struct {
	Args    OperationNeedsUpdateArgs
	Returns OperationNeedsUpdateReturns
}

type OperationNeedsUpdateReturns

type OperationNeedsUpdateReturns struct {
	Need bool
	Err  error
}

type OperationUpdateMetadataArgs

type OperationUpdateMetadataArgs struct {
	CacheDir         string
	CacheDirAnything bool
}

type OperationUpdateMetadataExpectation

type OperationUpdateMetadataExpectation struct {
	Args    OperationUpdateMetadataArgs
	Returns OperationUpdateMetadataReturns
}

type OperationUpdateMetadataReturns

type OperationUpdateMetadataReturns struct {
	Err error
}