runner

package

v0.7.0 Latest Latest Go to latest Published: Oct 20, 2020 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ubclaunchpad/inertia

Links

Open Source Insights

Documentation ¶

Overview ¶

Package runner provides the Inertia client's low-level SSH command runner

Index ¶

type SSHOptions
type SSHRunner
- func NewSSHRunner(ip string, cfg *cfg.SSH, opts SSHOptions) *SSHRunner
type SSHSession

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type SSHOptions ¶

type SSHOptions struct {
	KeyPassphrase string
}

SSHOptions denotes options for the SSH runner

type SSHRunner ¶

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

SSHRunner runs commands over SSH and captures results.

func NewSSHRunner ¶

func NewSSHRunner(ip string, cfg *cfg.SSH, opts SSHOptions) *SSHRunner

NewSSHRunner returns a new SSHRunner

func (*SSHRunner) CopyFile ¶

func (r *SSHRunner) CopyFile(file io.Reader, remotePath string, permissions string) error

CopyFile copies given reader to remote

func (*SSHRunner) Run ¶

func (r *SSHRunner) Run(cmd string) (cmdout *bytes.Buffer, cmderr *bytes.Buffer, err error)

Run runs a command remotely.

func (*SSHRunner) RunSession ¶

func (r *SSHRunner) RunSession(commands ...string) error

RunSession sets up a SSH shell to the remote

func (*SSHRunner) RunStream ¶

func (r *SSHRunner) RunStream(cmd string, interactive bool) error

RunStream remotely executes given command, streaming its output and opening up an optionally interactive session

type SSHSession ¶

type SSHSession interface {
	Run(cmd string) (*bytes.Buffer, *bytes.Buffer, error)
	RunStream(cmd string, interactive bool) error
	RunSession(commands ...string) error
	CopyFile(f io.Reader, remotePath string, permissions string) error
}

SSHSession can run remote commands over SSH

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mocks Package mocks provides mocked implmentations of interfaces in client/runner Code generated by counterfeiter.	Package mocks provides mocked implmentations of interfaces in client/runner Code generated by counterfeiter.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL