serverchecker

Documentation

Overview

Package serverchecker contains the functions to check if a cloud server is ready.

Index

• type MockSSHClient
  • func (m *MockSSHClient) Close() error
  • func (m *MockSSHClient) Connect() error
  • func (m *MockSSHClient) ExecCommand(cmd string) (string, error)
• type RealSSHClient
  • func (r *RealSSHClient) Close() error
  • func (r *RealSSHClient) Connect() error
  • func (r *RealSSHClient) ExecCommand(cmd string) (string, error)
• type SSHClient
• type ServerChecker
  • func NewServerChecker(host string, user string, keyPath string, timeout time.Duration, attempts int) (*ServerChecker, error)
  • func (sc *ServerChecker) Check() (bool, error)
  • func (sc *ServerChecker) CheckWithContext(ctx context.Context) (bool, error)
• type ServerResult
  • func CheckServers(servers []*types.Server, logger *slog.Logger, timeout time.Duration, ...) ([]ServerResult, error)

Types

type MockSSHClient

type MockSSHClient struct {
	ConnectFunc     func() error
	CloseFunc       func() error
	ExecCommandFunc func(string) (string, error)
}

func (*MockSSHClient) Close

func (m *MockSSHClient) Close() error

func (*MockSSHClient) Connect

func (m *MockSSHClient) Connect() error

func (*MockSSHClient) ExecCommand

func (m *MockSSHClient) ExecCommand(cmd string) (string, error)

type RealSSHClient

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

func (*RealSSHClient) Close

func (r *RealSSHClient) Close() error

func (*RealSSHClient) Connect

func (r *RealSSHClient) Connect() error

func (*RealSSHClient) ExecCommand

func (r *RealSSHClient) ExecCommand(cmd string) (string, error)

type SSHClient

type SSHClient interface {
	Connect() error
	Close() error
	ExecCommand(cmd string) (string, error)
}

SSHClient interface abstracts SSH operations

type ServerChecker

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

func NewServerChecker

func NewServerChecker(host string, user string, keyPath string, timeout time.Duration, attempts int) (*ServerChecker, error)

func (*ServerChecker) Check

func (sc *ServerChecker) Check() (bool, error)

Check verifies if the server is ready This is now a wrapper around CheckWithContext using the server's timeout

func (*ServerChecker) CheckWithContext

func (sc *ServerChecker) CheckWithContext(ctx context.Context) (bool, error)

CheckWithContext verifies if the server is ready using the provided context Returns true if the server is ready, false otherwise If an error occurs during checking, it returns false and the error

type ServerResult

type ServerResult struct {
	Server *types.Server
	Ready  bool
	Error  error
}

func CheckServers

func CheckServers(servers []*types.Server, logger *slog.Logger, timeout time.Duration, attempts int) ([]ServerResult, error)