agent

Documentation

Overview

Package agent provides facilities for extracting, installing, and connecting to agent binaries.

Index

• Constants
• func CopyBundleForTesting() error
• func Dial(transport Transport, prompter, root, session string, version session.Version, ...) (session.Endpoint, error)
• func Housekeep()
• func Install() error
• type Transport

Constants

const (
	// ModeInstall is the agent command to invoke for installation.
	ModeInstall = "install"
	// ModeEndpoint is the agent command to invoke for running as an endpoint.
	ModeEndpoint = "endpoint"
	// ModeVersion is the agent command to invoke to print version information.
	ModeVersion = "version"
	// ModeLegal is the agent command to invoke to print legal information.
	ModeLegal = "legal"
)

const (
	// BundleName is the base name of the agent bundle.
	BundleName = "mutagen-agents.tar.gz"
)

Functions

func CopyBundleForTesting

func CopyBundleForTesting() error

CopyBundleForTesting copies the agent bundle from it's build path alongside the current executable. It is useful for copying the agent bundle next to the current test executable.

func Dial

func Dial(
	transport Transport,
	prompter,
	root,
	session string,
	version session.Version,
	configuration *session.Configuration,
	alpha bool,
) (session.Endpoint, error)

Dial connects to an agent-based endpoint using the specified transport, prompter, and endpoint metadata.

func Housekeep

func Housekeep()

Housekeep performs housekeeping of agent binaries.

func Install

func Install() error

Install installs the current binary to the appropriate location for an agent binary with the current Mutagen version.

Types

type Transport

type Transport interface {
	// Copy copies the specified local file (which is guaranteed to exist and be
	// a file) to the remote. The provided local path will be absolute. The
	// remote path will be a filename (i.e. without path separators) that should
	// be treated as being relative to the user's home directory.
	Copy(localPath, remoteName string) error
	// Command creates (but does not start) a process that will invoke the
	// specified command on the specified remote. It should not re-direct any of
	// the output streams of the process. The command on the remote must be
	// invoked with the user's home directory as the working directory. Any
	// command provided to this interface is guaranteed to be lexable by simply
	// splitting on spaces.
	Command(command string) (*exec.Cmd, error)
	// ClassifyError is used to determine how the agent dialing infrastructure
	// should attempt to handle failure when launching agents. It is provided
	// with the process exit error returned from os/exec.Cmd.Wait as well as a
	// string containing the standard error output from the command. It should
	// return a bool representing whether or not the error condition represents
	// a failure due to an agent either not being installed or being installed
	// improperly and a bool representing whether or not the remote system
	// should be treated as a cmd.exe-like environment on Windows. If neither of
	// these can be determined reliably, this method should return an error to
	// abort dialing. If the second bool changes the dialer's platform
	// hypothesis, it will attempt to reconnect using the correct command syntax
	// for that platform. Otherwise, if the first bool indicates that the agent
	// binary simply needs to be (re-)installed, it will attempt to do so and
	// then reconnect.
	ClassifyError(processError error, errorOutput string) (bool, bool, error)
}

Transport is the interface that protocols wishing to use the agent infrastructure must implement. It should be natural for "SSH"-like protocols, i.e. those where SCP-like and SSH-like operations can be performed. Transport instances do not need to be safe for concurrent invocation unless being used for concurrent Dial operations.