utils

Documentation

Index

• Constants
• func ExportFS(fsys fs.ReadDirFS, path string) error
• func GetEnvOrDefault(k, d string) string
• func GetLoggerFromContext(ctx context.Context) (*log.Entry, bool)
• func GetLoggerFromContextOrDefault(ctx context.Context) *log.Entry
• func GetLoggerFromContextOrDiscard(ctx context.Context) *log.Entry
• func GetServiceLogs(input *SSHJournalctlInput, startTime time.Time, stdout, stderr io.Writer) error
• func SetLoggerForContext(ctx context.Context, l *log.Entry) context.Context
• type LoggerContextKeyType
• type SSHForwardCallback
• type SSHForwardInput
  • func (i *SSHForwardInput) HostAddressPort() string
  • func (i *SSHForwardInput) LocalAddressPort() string
  • func (i *SSHForwardInput) RemoteAddressPort() string
• type SSHJournalctlInput
• type SSHKeyPair
  • func GenerateSSHKeyPair() (*SSHKeyPair, error)
  • func LoadOrGenerateAndSaveSSHKeyPair(privKeyFile, pubKeyFile, workDir string) (*SSHKeyPair, error)
  • func (p *SSHKeyPair) Load(privKeyFile, pubKeyFile string) error
  • func (p *SSHKeyPair) Save(privKeyFile, pubKeyFile string) error
• type SSHPortForward
  • func NewSSHPortForward(input *SSHForwardInput) (*SSHPortForward, error)
  • func (f *SSHPortForward) DialWithTimeout(ctx context.Context) (*ssh.Client, error)
  • func (f *SSHPortForward) Start(ctx context.Context) error
  • func (f *SSHPortForward) Stop()

Constants

const (
	DefaultSSHPort = 22
	SSHTimeout     = 2 * time.Minute
)

Functions

func ExportFS

func ExportFS(fsys fs.ReadDirFS, path string) error

func GetEnvOrDefault

func GetEnvOrDefault(k, d string) string

func GetLoggerFromContext

func GetLoggerFromContext(ctx context.Context) (*log.Entry, bool)

func GetLoggerFromContextOrDefault

func GetLoggerFromContextOrDefault(ctx context.Context) *log.Entry

func GetLoggerFromContextOrDiscard

func GetLoggerFromContextOrDiscard(ctx context.Context) *log.Entry

func GetServiceLogs

func GetServiceLogs(input *SSHJournalctlInput, startTime time.Time, stdout, stderr io.Writer) error

GetServiceLogs retrieves log entries stored in journal by systemd via ssh.

func SetLoggerForContext

func SetLoggerForContext(ctx context.Context, l *log.Entry) context.Context

Types

type LoggerContextKeyType

type LoggerContextKeyType string

const LoggerContextKey LoggerContextKeyType = "TestEnvContextLogger"

type SSHForwardCallback

type SSHForwardCallback func(ctx context.Context, err error) error

type SSHForwardInput

type SSHForwardInput struct {
	PrivateKey    []byte
	User          string
	Host          string
	Port          int
	LocalPort     int
	RemoteAddress string
	RemotePort    int

	Callback SSHForwardCallback
}

func (*SSHForwardInput) HostAddressPort

func (i *SSHForwardInput) HostAddressPort() string

func (*SSHForwardInput) LocalAddressPort

func (i *SSHForwardInput) LocalAddressPort() string

func (*SSHForwardInput) RemoteAddressPort

func (i *SSHForwardInput) RemoteAddressPort() string

type SSHJournalctlInput

type SSHJournalctlInput struct {
	PrivateKey []byte
	PublicKey  []byte
	User       string
	Host       string
	WorkDir    string
	Service    string
}

type SSHKeyPair

type SSHKeyPair struct {
	PublicKey  []byte
	PrivateKey []byte
}

func GenerateSSHKeyPair

func GenerateSSHKeyPair() (*SSHKeyPair, error)

GenerateSSHKeyPair generates a new SSH key pair.

func LoadOrGenerateAndSaveSSHKeyPair

func LoadOrGenerateAndSaveSSHKeyPair(privKeyFile, pubKeyFile, workDir string) (*SSHKeyPair, error)

Load SSH key-pair if provided, generate and save otherwise.

func (*SSHKeyPair) Load

func (p *SSHKeyPair) Load(privKeyFile, pubKeyFile string) error

Load is responsible for loading the ssh keypair from filesystem into SSHKeyPair.

func (*SSHKeyPair) Save

func (p *SSHKeyPair) Save(privKeyFile, pubKeyFile string) error

Save is responsible for writing the SSHKeyPair to the filesystem.

type SSHPortForward

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

func NewSSHPortForward

func NewSSHPortForward(input *SSHForwardInput) (*SSHPortForward, error)

func (*SSHPortForward) DialWithTimeout

func (f *SSHPortForward) DialWithTimeout(ctx context.Context) (*ssh.Client, error)

func (*SSHPortForward) Start

func (f *SSHPortForward) Start(ctx context.Context) error

func (*SSHPortForward) Stop

func (f *SSHPortForward) Stop()