dutssh

type ClientInterface ¶

type ClientInterface interface {
	Close() error
	NewSession() (SessionInterface, error)
	Wait() error
	IsAlive() bool
}

This file only exists because go cannot mock structs and the ssh client library does not provide interfaces for testing.

type CmdExecutor ¶

type CmdExecutor interface {
	RunCmd(cmd string) (*CmdResult, error)
}

Simple interface abstracting away many details around SSH/streaming for clients that execute many simple/quick commands. This insulate clients from the full complexity of DutServer and also makes it easier to test logic that's focused on command execution results. E.g. Identity scanning

type CmdResult ¶

type CmdResult struct {
	ReturnCode int32
	StdOut     string
	StdErr     string
}

type SSHClient ¶

type SSHClient struct {
	*ssh.Client
}

func (c *SSHClient) Close() error

func (c *SSHClient) IsAlive() bool

func (c *SSHClient) NewSession() (SessionInterface, error)

func (c *SSHClient) Wait() error

type SSHSession ¶

type SSHSession struct {
	*ssh.Session
}

func (s *SSHSession) Close() error

func (s *SSHSession) Output(cmd string) ([]byte, error)

func (s *SSHSession) Run(cmd string) error

func (s *SSHSession) SetStderr(writer io.Writer)

func (s *SSHSession) SetStdin(reader io.Reader)

func (s *SSHSession) SetStdout(writer io.Writer)

func (s *SSHSession) Start(cmd string) error

func (s *SSHSession) StderrPipe() (io.Reader, error)

func (s *SSHSession) StdoutPipe() (io.Reader, error)

type SessionInterface ¶

type SessionInterface interface {
	Close() error
	SetStdout(writer io.Writer)
	SetStderr(writer io.Writer)
	SetStdin(reader io.Reader)
	Run(cmd string) error
	Start(cmd string) error
	Output(cmd string) ([]byte, error)
	StdoutPipe() (io.Reader, error)
	StderrPipe() (io.Reader, error)
}