Documentation
¶
Overview ¶
Package helper contains collection of common functions
Index ¶
- func BuildPath(path string) string
- func ContainsString(slice []string, item string) bool
- func CopyFile(sourceFile string, destinationFile string)
- func CopyFileTo(sourceFile string, destinationFile string) error
- func CreateDirectoryNamedPath(path string) (string, error)
- func CreateTempDir(dir string, pattern string) string
- func DeleteFile(name string) error
- func DirOrFileExists(path string) bool
- func DownloadFile(url string, dirPath string, filename string) error
- func DownloadFileTo(url string, destination string) error
- func EncodePrivateSSHKeyToPEM(privateKey *rsa.PrivateKey) []byte
- func FileExists(path string) bool
- func FileSize(path string) (int64, error)
- func GeneratePrivateSSHKey(bitSize int) (*rsa.PrivateKey, error)
- func GeneratePublicSSHKey(privatekey *rsa.PublicKey) ([]byte, error)
- func GenerateSSHKeys(dir string)
- func GetCmdFlagString(cmd *cobra.Command, flag string) string
- func GetStringBetweenDoubleQuotes(str string) (result string, found bool)
- func GetStringInBetweenTwoString(str string, startS string, endS string) (result string, found bool)
- func GetStringTrimmed(s string, sep string) []string
- func ListFiles(dir string) []os.FileInfo
- func MkDirsIfNotExist(name string) bool
- func ValidateCmdArgAndFlag(cmd *cobra.Command, args []string, cmdName string, arg string, flag string) error
- func ValidateCmdArgs(cmd *cobra.Command, args []string, cmdName string) error
- func ValidateCmdArgsV2(cmd *cobra.Command, args []string) error
- func ValidateCmdFlagString(cmd *cobra.Command, flag string) error
- func WriteFile(filename string, data []byte) bool
- func WriteFileFromBox(source string, dest string) bool
- func WriteInterfaceToFile(in interface{}, path string) error
- func WriteSSHKeyToFile(keyBytes []byte, saveFileTo string) error
- type Manual
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContainsString ¶
ContainsString return true if slice contains item
func CopyFile ¶
CopyFile copies a file from source into a given destination path https://github.com/mactsouk/opensource.com/blob/master/cp2.go
func CopyFileTo ¶
CopyFileTo copy a file from sourceFile location to destinationFile location
func CreateDirectoryNamedPath ¶
CreateDirectoryNamedPath creates a directory named path, along with any necessary parents, and returns nil, or else returns an error. The permission bits perm (before umask) are used for all directories. If path is already a directory does nothing and returns nil.
func CreateTempDir ¶
CreateTempDir creates a new temporary directory in the directory dir. The directory name is generated by taking pattern and applying a random string to the end
func DeleteFile ¶
DeleteFile removes the named file or (empty) directory. If there is an error, it will be of type *PathError.
func DirOrFileExists ¶
DirOrFileExists an error is known to report that a file or directory does not exist. It is satisfied by ErrNotExist as well as some syscall errors.
func DownloadFile ¶
DownloadFile downloads a file and saves into the given directory with the given file name
func DownloadFileTo ¶
DownloadFileTo downloads a file and saves into the given directory with the given file name
func EncodePrivateSSHKeyToPEM ¶
func EncodePrivateSSHKeyToPEM(privateKey *rsa.PrivateKey) []byte
EncodePrivateSSHKeyToPEM encodes Private Key from RSA to PEM format
func FileExists ¶
FileExists checks if a file exists and is not a directory before we try using it to prevent further errors.
func FileSize ¶
FileSize return the size of the give file path. Gives an error if files does not exist
func GeneratePrivateSSHKey ¶
func GeneratePrivateSSHKey(bitSize int) (*rsa.PrivateKey, error)
GeneratePrivateSSHKey creates a RSA Private Key of specified byte size
func GeneratePublicSSHKey ¶
GeneratePublicSSHKey take a rsa.PublicKey and return bytes suitable for writing to .pub file returns in the format "ssh-rsa ..."
func GenerateSSHKeys ¶
func GenerateSSHKeys(dir string)
GenerateSSHKeys create SSH keys (private and public) into a given directory
func GetCmdFlagString ¶
GetCmdFlagString return the value of a flag string
func GetStringBetweenDoubleQuotes ¶
GetStringBetweenDoubleQuotes return the string between double quotes
func GetStringInBetweenTwoString ¶
func GetStringInBetweenTwoString(str string, startS string, endS string) (result string, found bool)
GetStringInBetweenTwoString return the string between two strings
func GetStringTrimmed ¶
GetStringTrimmed splits the string by the given separator and trims it by removing all spaces in between
func ListFiles ¶
ListFiles list of all file names in the given directory. Pass "." if you want to list at the current directory.
func MkDirsIfNotExist ¶
MkDirsIfNotExist creates a directory named path, along with any necessary parents, and returns true, or else returns false. The dirs have permission bits 511 (before umask) are used for all directories that this function creates. If path is already a directory, the function does nothing and returns false.
func ValidateCmdArgAndFlag ¶
func ValidateCmdArgAndFlag(cmd *cobra.Command, args []string, cmdName string, arg string, flag string) error
ValidateCmdArgAndFlag basic validation for the given arg on args, and if flag is empty, return error if fails
func ValidateCmdArgs ¶
ValidateCmdArgs basic validation of a command's arguments, return error if fails
func ValidateCmdArgsV2 ¶
ValidateCmdArgsV2 check if first arg is valid
func ValidateCmdFlagString ¶
ValidateCmdFlagString check if there's any error with a flag of string type
func WriteFileFromBox ¶
WriteFileFromBox get the file from box's resources and write into the given destination, returns false if not able to.
func WriteInterfaceToFile ¶
WriteInterfaceToFile write the given interface into a file
func WriteSSHKeyToFile ¶
WriteSSHKeyToFile writes keys to a file
Source Files