ssh

Documentation

Index

• type Client
  • func NewClient(host string, config *value.SSHConfig) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) ExecuteCommand(command value.Command) ([]byte, error)
  • func (c *Client) FileExists(path string) bool
  • func (c *Client) FlushCaches() error
  • func (c *Client) InstallPackageAt(path string) error
  • func (c *Client) InstallPackages(packages ...string) error
  • func (c *Client) RemoveDirectory(path string) error
  • func (c *Client) RemoveFile(path string) error
  • func (c *Client) SecureDownload(source, sink string) error
  • func (c *Client) SecureUpload(source, sink string) error
  • func (c *Client) Sync() error
  • func (c *Client) UninstallPackages(packages ...string) error

Types

type Client

type Client struct {
	Platform value.Platform
	// contains filtered or unexported fields
}

Client is thin wrapper around an ssh client which exposes some useful functionality required when setting up/performing benchmarks.

func NewClient

func NewClient(host string, config *value.SSHConfig) (*Client, error)

NewClient creates a new client which is connected to the provided host.

func (*Client) Close

func (c *Client) Close() error

Close releases an resources in use by this client.

func (*Client) ExecuteCommand

func (c *Client) ExecuteCommand(command value.Command) ([]byte, error)

ExecuteCommand is a wrapper with executes the given command on the remote machine.

func (*Client) FileExists

func (c *Client) FileExists(path string) bool

FileExists returns a boolean indicating whether a file with the given path exists on the remote machine.

func (*Client) FlushCaches

func (c *Client) FlushCaches() error

FlushCaches sync then flushes the caches on the remote machine; this allows for more consistent benchmark results.

func (*Client) InstallPackageAt

func (c *Client) InstallPackageAt(path string) error

InstallPackageAt installs the package at the provided path on the remote machine.

func (*Client) InstallPackages

func (c *Client) InstallPackages(packages ...string) error

InstallPackages uses the platform specific package manager to install the given package.

func (*Client) RemoveDirectory

func (c *Client) RemoveDirectory(path string) error

RemoveDirectory removes the directory at the given path on the remote machine.

func (*Client) RemoveFile

func (c *Client) RemoveFile(path string) error

RemoveFile removes the file at the given path on the remote machine.

func (*Client) SecureDownload

func (c *Client) SecureDownload(source, sink string) error

SecureDownload emulates the 'scp' command by downloaded the file at the provided path to the local machine.

func (*Client) SecureUpload

func (c *Client) SecureUpload(source, sink string) error

SecureUpload emulates the 'scp' command by uploading the file at the provided path to the remote server.

func (*Client) Sync

func (c *Client) Sync() error

Sync runs 'sync' on the remote machine ensuring all dirty package are written to disk.

func (*Client) UninstallPackages

func (c *Client) UninstallPackages(packages ...string) error

UninstallPackages uses the platform specific package manager to uninstall the given package.