version

Documentation

Index

• func NewVersionNotification(timesSent notifications.TimesNotified, suggestedVersion version.SemVer, ...) (_ notifications.NewNotification)
• type Chore
  • func NewChore(log *zap.Logger, service *checker.Service, ...) *Chore
  • func (chore *Chore) Run(ctx context.Context) (err error)
  • func (chore *Chore) TestCheckVersion() (relevance Relevance)
  • func (chore *Chore) TestSetNow(now func() time.Time)
• type Relevance

Functions

func NewVersionNotification

func NewVersionNotification(timesSent notifications.TimesNotified, suggestedVersion version.SemVer, senderID storj.NodeID) (_ notifications.NewNotification)

NewVersionNotification - returns version update required notification.

Types

type Chore

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore contains the information and variables to ensure the Software is up to date for storagenode.

func NewChore

func NewChore(log *zap.Logger, service *checker.Service, notifications *notifications.Service, nodeID storj.NodeID, checkInterval time.Duration) *Chore

NewChore creates a Version Check Client with default configuration for storagenode.

func (*Chore) Run

func (chore *Chore) Run(ctx context.Context) (err error)

Run logs the current version information and detects if software outdated, if so - sends notifications.

func (*Chore) TestCheckVersion

func (chore *Chore) TestCheckVersion() (relevance Relevance)

TestCheckVersion returns chore.relevance, used for chore tests only.

func (*Chore) TestSetNow

func (chore *Chore) TestSetNow(now func() time.Time)

TestSetNow allows tests to have the Service act as if the current time is whatever they want. This avoids races and sleeping, making tests more reliable and efficient.

type Relevance

type Relevance struct {
	ExpectedVersion  version.SemVer
	IsOutdated       bool
	FirstTimeSpotted time.Time
	TimesNotified    notifications.TimesNotified
}

Relevance contains information about software being outdated.