utils

Documentation

Index

• Constants
• Variables
• func CheckSHA256(reader io.Reader, sha string) error
• func Checksum(file string) (string, error)
• func Copy(src, dst string) error
• func FmtVer(ver string) (string, error)
• func IsEmptyDir(path string) (bool, error)
• func IsExecBinary(path string) bool
• func IsExist(path string) bool
• func IsNotExist(path string) bool
• func IsSubDir(parent, sub string) bool
• func IsSymExist(path string) bool
• func IsTimeoutOrMaxRetry(err error) bool
• func JoinHostPort(host string, port int) string
• func MkdirAll(path string, minPerm os.FileMode) error
• func Move(src, dst string) error
• func ParseHostPort(hostport string) (host, port string)
• func Retry(doFunc func() error, opts ...RetryOption) error
• func RetryUntil(f func() error, when func(error) bool) error
• func SHA256(reader io.Reader) (string, error)
• func SHA512(reader io.Reader) (string, error)
• func SaveFileWithBackup(path string, data []byte, backupDir string) error
• func TailN(fname string, n int) (lines []string, err error)
• func Tar(writer io.Writer, from string) error
• func Ternary(condition bool, a, b any) any
• func Untar(reader io.Reader, to string) error
• func UserHome() string
• func WriteFile(name string, data []byte, perm os.FileMode) error
• type HTTPClient
  • func NewHTTPClient(timeout time.Duration, tlsConfig *tls.Config) *HTTPClient
  • func (c *HTTPClient) Client() *http.Client
  • func (c *HTTPClient) Delete(ctx context.Context, url string, body io.Reader) ([]byte, int, error)
  • func (c *HTTPClient) Download(ctx context.Context, url, filePath string) error
  • func (c *HTTPClient) Get(ctx context.Context, url string) ([]byte, error)
  • func (c *HTTPClient) GetWithStatusCode(ctx context.Context, url string) ([]byte, int, error)
  • func (c *HTTPClient) Post(ctx context.Context, url string, body io.Reader) ([]byte, error)
  • func (c *HTTPClient) PostWithStatusCode(ctx context.Context, url string, body io.Reader) ([]byte, int, error)
  • func (c *HTTPClient) Put(ctx context.Context, url string, body io.Reader) ([]byte, int, error)
  • func (c *HTTPClient) SetRequestHeader(key, value string)
  • func (c *HTTPClient) WithClient(client *http.Client) *HTTPClient
• type HashValidationErr
  • func (e *HashValidationErr) Error() string
  • func (e *HashValidationErr) Is(target error) bool
  • func (e *HashValidationErr) Unwrap() error
• type RetryOption
• type Version
  • func (v Version) IsEmpty() bool
  • func (v Version) IsNightly() bool
  • func (v Version) IsValid() bool
  • func (v Version) String() string

Constants

const LatestVersionAlias = "latest"

LatestVersionAlias represents the latest build (excluding nightly versions).

const NightlyVersionAlias = "nightly"

NightlyVersionAlias represents latest build of master branch.

Variables

var (
	// ErrPropSuggestion is a property of an Error that will be printed as the suggestion.
	ErrPropSuggestion = errorx.RegisterProperty("suggestion")

	// ErrTraitPreCheck means that the Error is a pre-check error so that no error logs will be outputted directly.
	ErrTraitPreCheck = errorx.RegisterTrait("pre_check")
)

var (
	// ErrValidateChecksum is an empty HashValidationErr object, useful for type checking
	ErrValidateChecksum = &HashValidationErr{}
)

Functions

func CheckSHA256

func CheckSHA256(reader io.Reader, sha string) error

CheckSHA256 returns an error if the hash of reader mismatches `sha`

func Checksum

func Checksum(file string) (string, error)

Checksum returns the sha1 sum of target file

func Copy

func Copy(src, dst string) error

Copy copies a file or directory from src to dst

func FmtVer

func FmtVer(ver string) (string, error)

FmtVer converts a version string to SemVer format, if the string is not a valid SemVer and fails to parse and convert it, an error is raised.

func IsEmptyDir

func IsEmptyDir(path string) (bool, error)

IsEmptyDir check whether a path is an empty directory

func IsExecBinary

func IsExecBinary(path string) bool

IsExecBinary check whether a path is a valid executable

func IsExist

func IsExist(path string) bool

IsExist check whether a path is exist

func IsNotExist

func IsNotExist(path string) bool

IsNotExist check whether a path is not exist

func IsSubDir

func IsSubDir(parent, sub string) bool

IsSubDir returns if sub is a sub directory of parent

func IsSymExist

func IsSymExist(path string) bool

IsSymExist check whether a symbol link is exist

func IsTimeoutOrMaxRetry

func IsTimeoutOrMaxRetry(err error) bool

IsTimeoutOrMaxRetry return true if it's timeout or reach max retry.

func JoinHostPort

func JoinHostPort(host string, port int) string

JoinHostPort return host and port

func MkdirAll

func MkdirAll(path string, minPerm os.FileMode) error

MkdirAll basically copied from os.MkdirAll, but use max(parent permission,minPerm)

func Move

func Move(src, dst string) error

Move moves a file from src to dst, this is done by copying the file and then delete the old one. Use os.Rename() to rename file within the same filesystem instead this, it's more lightweight but can not be used across devices.

func ParseHostPort

func ParseHostPort(hostport string) (host, port string)

ParseHostPort Prase host and port

func Retry

func Retry(doFunc func() error, opts ...RetryOption) error

Retry retries the func until it returns no error or reaches attempts limit or timed out, either one is earlier

func RetryUntil

func RetryUntil(f func() error, when func(error) bool) error

RetryUntil when the `when` func returns true

func SHA256

func SHA256(reader io.Reader) (string, error)

SHA256 returns the hash of reader

func SHA512

func SHA512(reader io.Reader) (string, error)

SHA512 returns the hash of reader

func SaveFileWithBackup

func SaveFileWithBackup(path string, data []byte, backupDir string) error

SaveFileWithBackup will backup the file before save it. e.g., backup meta.yaml as meta-2006-01-02T15:04:05Z07:00.yaml backup the files in the same dir of path if backupDir is empty.

func TailN

func TailN(fname string, n int) (lines []string, err error)

TailN try get the latest n line of the file.

func Tar

func Tar(writer io.Writer, from string) error

Tar compresses the folder to tarball with gzip

func Ternary

func Ternary(condition bool, a, b any) any

Ternary operator

func Untar

func Untar(reader io.Reader, to string) error

Untar decompresses the tarball

func UserHome

func UserHome() string

UserHome returns home directory of current user

func WriteFile

func WriteFile(name string, data []byte, perm os.FileMode) error

WriteFile call os.WriteFile, but use max(parent permission,minPerm)

Types

type HTTPClient

type HTTPClient struct {
	// contains filtered or unexported fields
}

HTTPClient is a wrap of http.Client

func NewHTTPClient

func NewHTTPClient(timeout time.Duration, tlsConfig *tls.Config) *HTTPClient

NewHTTPClient returns a new HTTP client with timeout and HTTPS support

func (*HTTPClient) Client

func (c *HTTPClient) Client() *http.Client

Client returns the http.Client

func (*HTTPClient) Delete

func (c *HTTPClient) Delete(ctx context.Context, url string, body io.Reader) ([]byte, int, error)

Delete send a DELETE request to the url and returns the response and status code.

func (*HTTPClient) Download

func (c *HTTPClient) Download(ctx context.Context, url, filePath string) error

Download fetch an URL with GET method and Download the response to filePath

func (*HTTPClient) Get

func (c *HTTPClient) Get(ctx context.Context, url string) ([]byte, error)

Get fetch an URL with GET method and returns the response

func (*HTTPClient) GetWithStatusCode

func (c *HTTPClient) GetWithStatusCode(ctx context.Context, url string) ([]byte, int, error)

GetWithStatusCode fetch a URL with GET method and returns the response, also the status code.

func (*HTTPClient) Post

func (c *HTTPClient) Post(ctx context.Context, url string, body io.Reader) ([]byte, error)

Post send a POST request to the url and returns the response

func (*HTTPClient) PostWithStatusCode

func (c *HTTPClient) PostWithStatusCode(ctx context.Context, url string, body io.Reader) ([]byte, int, error)

PostWithStatusCode send a POST request to the url and returns the response, also the http status code.

func (*HTTPClient) Put

func (c *HTTPClient) Put(ctx context.Context, url string, body io.Reader) ([]byte, int, error)

Put send a PUT request to the url and returns the response, also the status code

func (*HTTPClient) SetRequestHeader

func (c *HTTPClient) SetRequestHeader(key, value string)

SetRequestHeader set http request header

func (*HTTPClient) WithClient

func (c *HTTPClient) WithClient(client *http.Client) *HTTPClient

WithClient uses the specified HTTP client

type HashValidationErr

type HashValidationErr struct {
	// contains filtered or unexported fields
}

HashValidationErr is the error indicates a failed hash validation

func (*HashValidationErr) Error

func (e *HashValidationErr) Error() string

Error implements the error interface

func (*HashValidationErr) Is

func (e *HashValidationErr) Is(target error) bool

Is implements the error interface

func (*HashValidationErr) Unwrap

func (e *HashValidationErr) Unwrap() error

Unwrap implements the error interface

type RetryOption

type RetryOption struct {
	Attempts int64
	Delay    time.Duration
	Timeout  time.Duration
}

RetryOption is options for Retry()

type Version

type Version string

Version represents a version string, like: v3.1.2

func (Version) IsEmpty

func (v Version) IsEmpty() bool

IsEmpty returns true if the `Version` is a empty string

func (Version) IsNightly

func (v Version) IsNightly() bool

IsNightly returns true if the version is nightly

func (Version) IsValid

func (v Version) IsValid() bool

IsValid checks whether is the version string valid

func (Version) String

func (v Version) String() string

String implements the fmt.Stringer interface