osutils

Documentation

Index

• Constants
• func Exists(path string) (bool, error)
• func SafeCreate(name ...string) (file *os.File, err error)
• func SafeCreateSSH(client SFTPClient, name ...string) (file *sftp.File, err error)
• func SafeRemoveSSH(client SFTPClient, filePath string) (err error)
• type RemoteOperations
  • func NewRemoteOperations(sshCfg command.SshConfig) *RemoteOperations
  • func NewRemoteOperationsWithPath(sshCfg command.SshConfig, remoteImportPath string) *RemoteOperations
  • func (s *RemoteOperations) GetRemoteFile() (rfile io.WriteCloser, err error)
  • func (s *RemoteOperations) Path() string
  • func (s *RemoteOperations) RemoveRemoteFile() (err error)
  • func (s *RemoteOperations) SetPath(p string)
  • func (s *RemoteOperations) UploadFile(lfile io.Reader) (err error)
• type SFTPClient

Constants

const (
	//RemoteImportPath - path to place the temporary remote import files when uploaded
	RemoteImportPath string = "/tmp/archive.backup"
)

Functions

func Exists

func Exists(path string) (bool, error)

Exists - check if the given path exists

func SafeCreate

func SafeCreate(name ...string) (file *os.File, err error)

SafeCreate creates a file, creating parent directories if needed

func SafeCreateSSH

func SafeCreateSSH(client SFTPClient, name ...string) (file *sftp.File, err error)

SafeCreateSSH creates a file, creating parent directories if needed on a remote machine via an ssh client

func SafeRemoveSSH

func SafeRemoveSSH(client SFTPClient, filePath string) (err error)

SafeRemoveSSH removes a file on a remote machine via an ssh client

Types

type RemoteOperations

type RemoteOperations struct {
	GetSSHConnection func(command.SshConfig, *ssh.ClientConfig) (SFTPClient, error)
	// contains filtered or unexported fields
}

RemoteOperations - an object which allows us to execute operations on a remote system

func NewRemoteOperations

func NewRemoteOperations(sshCfg command.SshConfig) *RemoteOperations

NewRemoteOperations - a constructor for a remoteoperations object

func NewRemoteOperationsWithPath

func NewRemoteOperationsWithPath(sshCfg command.SshConfig, remoteImportPath string) *RemoteOperations

NewRemoteOperationsWithPath -

func (*RemoteOperations) GetRemoteFile

func (s *RemoteOperations) GetRemoteFile() (rfile io.WriteCloser, err error)

GetRemoteFile - get a file from a remote system and return a writecloser to it

func (*RemoteOperations) Path

func (s *RemoteOperations) Path() string

Path - allows us to get the path of the remote upload

func (*RemoteOperations) RemoveRemoteFile

func (s *RemoteOperations) RemoveRemoteFile() (err error)

RemoveRemoteFile - get a file from a remote system and return a writecloser to it

func (*RemoteOperations) SetPath

func (s *RemoteOperations) SetPath(p string)

SetPath - allows us to set the remote path of the upload

func (*RemoteOperations) UploadFile

func (s *RemoteOperations) UploadFile(lfile io.Reader) (err error)

UploadFile - allows us to upload the contents of the given reader

type SFTPClient

type SFTPClient interface {
	Create(path string) (*sftp.File, error)
	Mkdir(path string) error
	ReadDir(p string) ([]os.FileInfo, error)
	Remove(path string) error
}

SFTPClient -