utils

Documentation

Index

• func AbsTarPath(tarPath string) (string, error)
• func CheckPackageSum(checkedSum, localPath string) bool
• func CreateFileIfNotExist(filePath string, storeFunc func() error) error
• func CreateSubdirInUserHome(subdir string) (string, error)
• func CreateSymlink(oldName, newName string) error
• func DirExists(path string) bool
• func Exists(path string) (bool, error)
• func FindKFiles(path string) ([]string, error)
• func GetUsernamePassword(usernameOpt string, passwordOpt string, passwordFromStdinOpt bool) (string, string, error)
• func HashDir(dir string) (string, error)
• func IsGitRepoUrl(str string) bool
• func IsKfile(str string) bool
• func IsRef(str string) bool
• func IsTar(str string) bool
• func IsURL(str string) bool
• func JoinPath(base, elem string) string
• func ParseRepoNameFromGitUrl(gitUrl string) string
• func RmNewline(s string) string
• func StoreToFile(filePath string, dataStr string) error
• func TarDir(srcDir string, tarPath string) error
• func UnTarDir(tarPath string, destDir string) error

Functions

func AbsTarPath

func AbsTarPath(tarPath string) (string, error)

AbsTarPath checks whether path 'tarPath' exists and whether path 'tarPath' ends with '.tar' And after checking, absTarPath return the abs path for 'tarPath'.

func CheckPackageSum

func CheckPackageSum(checkedSum, localPath string) bool

CheckPackageSum will check whether the 'checkedSum' is equal to the hash of the package under 'localPath'.

func CreateFileIfNotExist

func CreateFileIfNotExist(filePath string, storeFunc func() error) error

CreateFileIfNotExist will check whether the file under a certain path 'filePath/fileName' exists, and return an error if it exists, and call the method 'storeFunc' to save the file if it does not exist.

func CreateSubdirInUserHome

func CreateSubdirInUserHome(subdir string) (string, error)

DefaultKpmHome create the '.kpm' in the user home and return the path of ".kpm".

func CreateSymlink

func CreateSymlink(oldName, newName string) error

CreateSymlink will create symbolic link named 'newName' for 'oldName', and if the symbolic link already exists, it will be deleted and recreated.

func DirExists

func DirExists(path string) bool

DirExists will check whether the directory 'path' exists.

func Exists

func Exists(path string) (bool, error)

Whether the file exists

func FindKFiles

func FindKFiles(path string) ([]string, error)

FindKFiles will find all the '.k' files in the 'path' directory.

func GetUsernamePassword

func GetUsernamePassword(usernameOpt string, passwordOpt string, passwordFromStdinOpt bool) (string, string, error)

Copied/Adapted from https://github.com/helm/helm

func HashDir

func HashDir(dir string) (string, error)

HashDir computes the checksum of a directory by concatenating all files and hashing them by sha256.

func IsGitRepoUrl

func IsGitRepoUrl(str string) bool

IsGitRepoUrl will check whether the string 'str' is a git repo url

func IsKfile

func IsKfile(str string) bool

IsKfile will check whether the string 'str' is a k file path.

func IsRef

func IsRef(str string) bool

IsRef will check whether the string 'str' is a reference.

func IsTar

func IsTar(str string) bool

IsTar will check whether the string 'str' is a tar path.

func IsURL

func IsURL(str string) bool

IsUrl will check whether the string 'str' is a url.

func JoinPath

func JoinPath(base, elem string) string

JoinPath will join the 'elem' to the 'base' with '/'.

func ParseRepoNameFromGitUrl

func ParseRepoNameFromGitUrl(gitUrl string) string

ParseRepoNameFromGitUrl get the repo name from git url, the repo name in 'https://github.com/xxx/kcl1.git' is 'kcl1'.

func RmNewline

func RmNewline(s string) string

RmNewline will remove all the '\r\n' and '\n' in the string 's'.

func StoreToFile

func StoreToFile(filePath string, dataStr string) error

StoreToFile will store 'data' into toml file under 'filePath'.

func TarDir

func TarDir(srcDir string, tarPath string) error

func UnTarDir

func UnTarDir(tarPath string, destDir string) error

UnTarDir will extract tar from 'tarPath' to 'destDir'.