runtime

Documentation

Index

• func CopyLocal(src, dst string) error
• func CopyRemote(sftpClient *SftpClient, src, dst string) error
• func ReadLocalFileBytes(filename string) ([]byte, error)
• func ReadRemoteFileBytes(sftpClient *SftpClient, remotePath string) ([]byte, error)
• func RunLocalCommandWithShell(command, username string, useShell bool, cfg *config.Config) (int, string, string, error)
• func RunRemoteCommandWithShell(pool *desopssshpool.Pool, host, command, username string, cfg *config.Config, ...) (int, string, string, error)
• func SetLocalFileMode(path, modeStr string) error
• func SetRemoteFileMode(sftpClient *SftpClient, path, modeStr string) error
• func StatLocal(path string, follow bool) (os.FileInfo, error)
• func StatRemote(sftpClient *SftpClient, path string) (os.FileInfo, error)
• func WriteLocalFile(filename string, data string) error
• func WriteRemoteFile(sftpClient *SftpClient, remotePath, data string) error
• type CommandOptions
  • func NewCommandOptions(cfg *config.Config) *CommandOptions
  • func (co *CommandOptions) WithInteractive() *CommandOptions
  • func (co *CommandOptions) WithInteractiveSudo() *CommandOptions
  • func (co *CommandOptions) WithShell() *CommandOptions
  • func (co *CommandOptions) WithUsername(username string) *CommandOptions
• type CommandResult
• type SftpClient
  • func (s *SftpClient) Close() error

Functions

func CopyLocal

func CopyLocal(src, dst string) error

func CopyRemote

func CopyRemote(sftpClient *SftpClient, src, dst string) error

CopyRemote copies a file or directory recursively on the remote host using a pooled SFTP client

func ReadLocalFileBytes

func ReadLocalFileBytes(filename string) ([]byte, error)

func ReadRemoteFileBytes

func ReadRemoteFileBytes(sftpClient *SftpClient, remotePath string) ([]byte, error)

ReadRemoteFileBytes reads the content of a remote file as raw bytes using a pooled SFTP client

func RunLocalCommandWithShell

func RunLocalCommandWithShell(command, username string, useShell bool, cfg *config.Config) (int, string, string, error)

func RunRemoteCommandWithShell

func RunRemoteCommandWithShell(pool *desopssshpool.Pool, host, command, username string, cfg *config.Config, useShell bool) (int, string, string, error)

func SetLocalFileMode

func SetLocalFileMode(path, modeStr string) error

func SetRemoteFileMode

func SetRemoteFileMode(sftpClient *SftpClient, path, modeStr string) error

SetRemoteFileMode sets the mode of a remote file using a pooled SFTP client

func StatLocal

func StatLocal(path string, follow bool) (os.FileInfo, error)

StatLocal retrieves local file information. If follow is true, it follows symlinks (os.Stat). If follow is false, it stats the link itself (os.Lstat).

func StatRemote

func StatRemote(sftpClient *SftpClient, path string) (os.FileInfo, error)

StatRemote retrieves remote file information using a pooled SFTP client

func WriteLocalFile

func WriteLocalFile(filename string, data string) error

func WriteRemoteFile

func WriteRemoteFile(sftpClient *SftpClient, remotePath, data string) error

WriteRemoteFile writes data to a remote file using a pooled SFTP client

Types

type CommandOptions

type CommandOptions struct {
	Username        string
	UseShell        bool
	Interactive     bool
	UseSudo         bool
	SudoUser        string
	InteractiveSudo bool
	BecomeFlags     string
}

CommandOptions holds configuration for command execution

func NewCommandOptions

func NewCommandOptions(cfg *config.Config) *CommandOptions

NewCommandOptions creates a new CommandOptions with sensible defaults

func (*CommandOptions) WithInteractive

func (co *CommandOptions) WithInteractive() *CommandOptions

WithInteractive enables interactive execution

func (*CommandOptions) WithInteractiveSudo

func (co *CommandOptions) WithInteractiveSudo() *CommandOptions

WithInteractiveSudo enables interactive sudo

func (*CommandOptions) WithShell

func (co *CommandOptions) WithShell() *CommandOptions

WithShell enables shell execution

func (*CommandOptions) WithUsername

func (co *CommandOptions) WithUsername(username string) *CommandOptions

WithUsername sets the username for the command

type CommandResult

type CommandResult struct {
	Command  string
	ExitCode int
	Stdout   string
	Stderr   string
	Error    error
}

CommandResult represents the result of a command execution

type SftpClient

type SftpClient struct {
	*sftp.Client
	// contains filtered or unexported fields
}

SftpClient wraps an SFTP client with SSH client information

func (*SftpClient) Close

func (s *SftpClient) Close() error

Close closes the SFTP client