toolchain

Documentation

Overview

Package toolchain checks installed tools against a tested release set.

Index

• type Component
• type ExecRunner
  • func (ExecRunner) LookPath(name string) (string, error)
  • func (ExecRunner) Output(ctx context.Context, name string, args ...string) ([]byte, error)
• type ReleaseSet
  • func Load(path string) (ReleaseSet, error)
• type Report
  • func Inspect(ctx context.Context, set ReleaseSet, selfVersion string, runner Runner) Report
  • func (r Report) Compatible() bool
• type Runner
• type Tool

Types

type Component

type Component struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type ExecRunner

type ExecRunner struct{}

func (ExecRunner) LookPath

func (ExecRunner) LookPath(name string) (string, error)

func (ExecRunner) Output

func (ExecRunner) Output(ctx context.Context, name string, args ...string) ([]byte, error)

type ReleaseSet

type ReleaseSet struct {
	SchemaVersion int         `json:"schemaVersion"`
	ID            string      `json:"id"`
	Components    []Component `json:"components"`
}

func Load

func Load(path string) (ReleaseSet, error)

type Report

type Report struct {
	SchemaVersion int    `json:"schemaVersion"`
	ReleaseSet    string `json:"releaseSet"`
	Tools         []Tool `json:"tools"`
}

func Inspect

func Inspect(ctx context.Context, set ReleaseSet, selfVersion string, runner Runner) Report

func (Report) Compatible

func (r Report) Compatible() bool

type Runner

type Runner interface {
	LookPath(string) (string, error)
	Output(context.Context, string, ...string) ([]byte, error)
}

type Tool

type Tool struct {
	Name     string `json:"name"`
	Expected string `json:"expected"`
	Actual   string `json:"actual,omitempty"`
	Path     string `json:"path,omitempty"`
	Status   string `json:"status"`
}