devcheck

Documentation

Index

• Variables
• type CheckList
  • func NewCheckList(args ...Checkable) *CheckList
  • func (c *CheckList) Add(chk Checkable) *CheckList
  • func (c *CheckList) Check(l *Logger) error
• type Checkable
• type CommandCheck
  • func NewCommandCheck(command string) *CommandCheck
  • func (c *CommandCheck) Check(l *Logger) error
  • func (c *CommandCheck) WithInstallUrl(url string) *CommandCheck
• type DockerCheck
  • func NewDockerCheck(dockerCommand *CommandCheck) *DockerCheck
  • func (c *DockerCheck) Check(l *Logger) error
• type FreshnessCheck
  • func NewFreshnessCheck(c *VersionCheck) *FreshnessCheck
  • func (c *FreshnessCheck) Check(l *Logger) error
• type GCloudCheck
  • func NewGCloudCheck(gcloudCommand *CommandCheck) *GCloudCheck
  • func (c *GCloudCheck) Check(l *Logger) error
  • func (c *GCloudCheck) WithRequiredIdentitySuffix(suffix string) *GCloudCheck
• type Logger
  • func NewLogger() *Logger
  • func (l *Logger) Bullet(format string, a ...interface{})
  • func (l *Logger) Failure(format string, a ...interface{})
  • func (l *Logger) Indented() *Logger
  • func (l *Logger) Info(format string, a ...interface{})
  • func (l *Logger) Success(format string, a ...interface{})
  • func (l *Logger) Warning(format string, a ...interface{})
• type NilCheck
  • func NewNilCheck() *NilCheck
  • func (c *NilCheck) Check(l *Logger) error
• type PlatformCheck
  • func NewPlatformCheck(supported []string) *PlatformCheck
  • func (c *PlatformCheck) Check(l *Logger) error
• type SSHCheck
  • func NewSSHCheck(arg ...string) *SSHCheck
  • func (s *SSHCheck) Add(connection string) *SSHCheck
  • func (s *SSHCheck) Check(l *Logger) error
• type SSHConnection
• type SectionCheck
  • func NewSectionCheck(title string, contents Checkable) *SectionCheck
  • func (s *SectionCheck) Check(l *Logger) error
• type VersionCheck
  • func NewVersionCheck() *VersionCheck
  • func (c *VersionCheck) Check(l *Logger) error

Variables

var MinDockerComposeVersion = semver.MustParse("2.13.0")

var MinDockerVersion = semver.MustParse("23.0.0")

Types

type CheckList

type CheckList struct {
	List []Checkable
}

func NewCheckList

func NewCheckList(args ...Checkable) *CheckList

func (*CheckList) Add

func (c *CheckList) Add(chk Checkable) *CheckList

func (*CheckList) Check

func (c *CheckList) Check(l *Logger) error

type Checkable

type Checkable interface {
	Check(*Logger) error
}

type CommandCheck

type CommandCheck struct {
	Command    string
	InstallUrl string
	Path       string
}

func NewCommandCheck

func NewCommandCheck(command string) *CommandCheck

func (*CommandCheck) Check

func (c *CommandCheck) Check(l *Logger) error

func (*CommandCheck) WithInstallUrl

func (c *CommandCheck) WithInstallUrl(url string) *CommandCheck

type DockerCheck

type DockerCheck struct {
	CommandCheck *CommandCheck
}

func NewDockerCheck

func NewDockerCheck(dockerCommand *CommandCheck) *DockerCheck

func (*DockerCheck) Check

func (c *DockerCheck) Check(l *Logger) error

type FreshnessCheck

type FreshnessCheck struct {
	VersionCheck *VersionCheck
}

func NewFreshnessCheck

func NewFreshnessCheck(c *VersionCheck) *FreshnessCheck

func (*FreshnessCheck) Check

func (c *FreshnessCheck) Check(l *Logger) error

type GCloudCheck

type GCloudCheck struct {
	CommandCheck           *CommandCheck
	RequiredIdentitySuffix string
}

func NewGCloudCheck

func NewGCloudCheck(gcloudCommand *CommandCheck) *GCloudCheck

func (*GCloudCheck) Check

func (c *GCloudCheck) Check(l *Logger) error

func (*GCloudCheck) WithRequiredIdentitySuffix

func (c *GCloudCheck) WithRequiredIdentitySuffix(suffix string) *GCloudCheck

type Logger

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

func NewLogger

func NewLogger() *Logger

func (*Logger) Bullet

func (l *Logger) Bullet(format string, a ...interface{})

func (*Logger) Failure

func (l *Logger) Failure(format string, a ...interface{})

func (*Logger) Indented

func (l *Logger) Indented() *Logger

func (*Logger) Info

func (l *Logger) Info(format string, a ...interface{})

func (*Logger) Success

func (l *Logger) Success(format string, a ...interface{})

func (*Logger) Warning

func (l *Logger) Warning(format string, a ...interface{})

type NilCheck

type NilCheck struct{}

func NewNilCheck

func NewNilCheck() *NilCheck

func (*NilCheck) Check

func (c *NilCheck) Check(l *Logger) error

type PlatformCheck

type PlatformCheck struct {
	Supported []string
}

func NewPlatformCheck

func NewPlatformCheck(supported []string) *PlatformCheck

func (*PlatformCheck) Check

func (c *PlatformCheck) Check(l *Logger) error

type SSHCheck

type SSHCheck struct {
	Connections []string
}

func NewSSHCheck

func NewSSHCheck(arg ...string) *SSHCheck

func (*SSHCheck) Add

func (s *SSHCheck) Add(connection string) *SSHCheck

func (*SSHCheck) Check

func (s *SSHCheck) Check(l *Logger) error

type SSHConnection

type SSHConnection struct {
	User string
	Addr string
}

type SectionCheck

type SectionCheck struct {
	Title    string
	Contents Checkable
}

func NewSectionCheck

func NewSectionCheck(title string, contents Checkable) *SectionCheck

func (*SectionCheck) Check

func (s *SectionCheck) Check(l *Logger) error

type VersionCheck

type VersionCheck struct {
	Version        string
	ReleaseRefName string
}

func NewVersionCheck

func NewVersionCheck() *VersionCheck

func (*VersionCheck) Check

func (c *VersionCheck) Check(l *Logger) error