ocversion

type Info ¶

type Info struct {
	// Version is the release as OpenCloud reports it ("8.1.0"). Kept as a
	// string: a development build need not be MAJOR.MINOR.PATCH, and it
	// should still be logged as it is.
	Version string
	// Edition is "stable" on the Production channel and "rolling" on Rolling.
	Edition string
}

Info is what an OpenCloud instance says about itself.

type Leg ¶

type Leg struct {
	// Name is the leg's role ("newest"), stable across version bumps
	// so CI job names can be required by a ruleset.
	Name    string `yaml:"name"`
	Channel string `yaml:"channel"`
	Image   string `yaml:"image"`
	Tag     string `yaml:"tag"`
	// Digest pins the image; empty only for the canary, which follows its tag.
	Digest string `yaml:"digest"`
}

Leg is one OpenCloud version the plugin is tested against.

func (l Leg) Ref() string

type Monitor ¶

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

Monitor keeps track of the OpenCloud version and warns when it is outside the window compiled into the build. It never refuses anything: a household that upgraded OpenCloud a day before the plugin caught up must still get its nightly backup (compatibility-policy.md §3, "warns and runs").

func NewMonitor(source Source, window Window, logger *slog.Logger) *Monitor

func (m *Monitor) Check(ctx context.Context) error

func (m *Monitor) Run(ctx context.Context, interval, retry time.Duration)

func (m *Monitor) Status() Status

type Pins ¶

type Pins struct {
	// Default is the leg the fixture starts when none is chosen.
	Default string `yaml:"default"`
	// Legs are the supported versions; CI runs every one of them, blocking.
	Legs []Leg `yaml:"legs"`
	// Canary follows the newest release by tag and is not supported.
	Canary Leg `yaml:"canary"`
}

Pins is the parsed versions.yaml.

func Embedded() (Pins, error)

func Parse(data []byte) (Pins, error)

func (p Pins) SupportedSentence() string

func (p Pins) Window() Window

type Source ¶

type Source interface {
	Fetch(ctx context.Context) (Info, error)
}

Source tells which OpenCloud the service runs against.

type Status ¶

type Status struct {
	// Known is false until OpenCloud has answered once.
	Known   bool
	Version string
	Edition string
	// InWindow is false for a version outside Window and for one that is not
	// MAJOR.MINOR.PATCH (a development or pre-release build was not tested).
	InWindow bool
	// Window is what this build was tested against.
	Window Window
}

Status is the monitor's latest answer.

type StatusSource ¶

type StatusSource struct {
	BaseURL string
	Client  *http.Client
}

StatusSource reads GET <BaseURL>/status.php. Measured in the Phase 9 spike (phase-0-findings.md) on 7.2.4, 7.3.0, 7.5.0 and 8.1.0: it needs no credential, and `productversion` / `edition` carry the release on all of them. `version` and `versionstring` are a frozen ownCloud-compat "0.1.0" and are ignored.

func (s StatusSource) Fetch(ctx context.Context) (Info, error)

type Version ¶

type Version struct{ Major, Minor, Patch int }

Version is an OpenCloud release number, MAJOR.MINOR.PATCH.

func ParseVersion(s string) (Version, error)

func (v Version) Compare(w Version) int

func (v Version) String() string

type Window ¶

type Window struct {
	Oldest Version
	Newest Version
	// ProductionLines are MAJOR.MINOR pairs; Patch is ignored.
	ProductionLines []Version
}

Window is the set of OpenCloud versions a build supports (compatibility-policy.md §3): every release from the oldest to the newest Rolling leg, plus every patch release of the Production lines a leg pins.

Inside the range the channel does not matter: a Production release is a Rolling release OpenCloud kept patching on a side branch. The Production line is added on its own because those patches can be newer than the newest Rolling leg, and because the line stays supported while it is current even once it is older than the two majors the range spans.

A release newer than the newest leg is outside, even a patch release of it: supported means tested, and it was not.

func (w Window) Contains(v Version) bool

func (w Window) String() string