util

Documentation

Index

• Constants
• func Exec(argv0 string, argv []string, envv []string, systemCallExec SystemCallExec) error
• func ExecCommand(context ExecContext, name string, arg ...string) *exec.Cmd
• func FakeExecCommandSuccess(command string, args ...string) *exec.Cmd
• func FakeLookPath(path string) (string, error)
• func FakeSystemCallExecSuccess(argv0 string, argv []string, envv []string) (err error)
• func GeneratePassword(length int) string
• func GetEnvOrDefault(key, defaultVal string) string
• func GetExternalIP() (string, error)
• func InitLogger(level string) (logger *zap.Logger, err error)
• func Lenf(han string) (l int)
• func LookPath(file string, context LookPathContext) (string, error)
• func MaxAndMin(data []float64) (max, min float64)
• func Open(url string, browser string, cmdContext ExecContext) error
• func Pad(s, pad string, width int, align int) string
• func PadCenter(s, pad string, width int) string
• func PadLeft(s, pad string, width int) string
• func PadRight(s, pad string, width int) string
• func PrintCollectTrend(data []float64) (buf string)
• func ReflectFieldValueAsString(v reflect.Value, field string) string
• func SetProxy(proxy, proxyAuth string, tr *http.Transport) (err error)
• func URLJoin(host, api string) (targetURL *url.URL, err error)
• func URLJoinAsString(host, api string) (targetURLStr string, err error)
• type ExecContext
• type HTTPDownloader
  • func (h *HTTPDownloader) DownloadFile() error
• type LookPathContext
• type ProgressIndicator
  • func (i *ProgressIndicator) Init()
  • func (i *ProgressIndicator) Read(p []byte) (n int, err error)
  • func (i *ProgressIndicator) Write(p []byte) (n int, err error)
• type SystemCallExec
• type Table
  • func CreateTable(out io.Writer) Table
  • func CreateTableWithHeader(out io.Writer, withoutHeader bool) (table Table)
  • func (t *Table) AddHeader(col ...string)
  • func (t *Table) AddRow(col ...string)
  • func (t *Table) Clear()
  • func (t *Table) GetColumnAlign(i int) int
  • func (t *Table) Render()
  • func (t *Table) SetColumnAlign(i int, align int)
  • func (t *Table) SetColumnsAligns(colAligns []int)

Constants

const (
	// ContentType is for the http header of content type
	ContentType = "Content-Type"
	// ApplicationForm is for the form submit
	ApplicationForm = "application/x-www-form-urlencoded"
)

const (
	// AlignLeft align left
	AlignLeft = 0
	// AlignCenter align center
	AlignCenter = 1
	// AlignRight align right
	AlignRight = 2
)

Functions

func Exec

func Exec(argv0 string, argv []string, envv []string, systemCallExec SystemCallExec) error

Exec is the wrapper of syscall.Exec

func ExecCommand

func ExecCommand(context ExecContext, name string, arg ...string) *exec.Cmd

ExecCommand is a warp of exec.Command

func FakeExecCommandSuccess

func FakeExecCommandSuccess(command string, args ...string) *exec.Cmd

FakeExecCommandSuccess is a function that initialises a new exec.Cmd, one which will simply call TestShellProcessSuccess rather than the command it is provided. It will also pass through the command and its arguments as an argument to TestShellProcessSuccess

func FakeLookPath

func FakeLookPath(path string) (string, error)

FakeLookPath is a fake function of exec.LookPath

func FakeSystemCallExecSuccess

func FakeSystemCallExecSuccess(argv0 string, argv []string, envv []string) (err error)

FakeSystemCallExecSuccess is a fake function of syscall.Exec

func GeneratePassword

func GeneratePassword(length int) string

GeneratePassword generates a password with the specific length

func GetEnvOrDefault

func GetEnvOrDefault(key, defaultVal string) string

GetEnvOrDefault returns a env or default value

func GetExternalIP

func GetExternalIP() (string, error)

GetExternalIP returns an external ip of current machine

func InitLogger

func InitLogger(level string) (logger *zap.Logger, err error)

InitLogger returns a logger

func Lenf

func Lenf(han string) (l int)

Lenf counts the number

func LookPath

func LookPath(file string, context LookPathContext) (string, error)

LookPath is the wrapper of exec.LookPath

func MaxAndMin

func MaxAndMin(data []float64) (max, min float64)

MaxAndMin return the max and min number

func Open

func Open(url string, browser string, cmdContext ExecContext) error

Open a URL in a browser

func Pad

func Pad(s, pad string, width int, align int) string

Pad give a pad

func PadCenter

func PadCenter(s, pad string, width int) string

PadCenter pad as center

func PadLeft

func PadLeft(s, pad string, width int) string

PadLeft pad as left

func PadRight

func PadRight(s, pad string, width int) string

PadRight pas as right

func PrintCollectTrend

func PrintCollectTrend(data []float64) (buf string)

PrintCollectTrend print the trend of data

func ReflectFieldValueAsString

func ReflectFieldValueAsString(v reflect.Value, field string) string

ReflectFieldValueAsString returns the value of a field

func SetProxy

func SetProxy(proxy, proxyAuth string, tr *http.Transport) (err error)

SetProxy set the proxy for a http

func URLJoin

func URLJoin(host, api string) (targetURL *url.URL, err error)

URLJoin is a util function to join host URL and API URL

func URLJoinAsString

func URLJoinAsString(host, api string) (targetURLStr string, err error)

URLJoinAsString is a util function to join host URL and API URL

Types

type ExecContext

type ExecContext = func(name string, arg ...string) *exec.Cmd

ExecContext is the context of system command caller

type HTTPDownloader

type HTTPDownloader struct {
	TargetFilePath     string
	URL                string
	ShowProgress       bool
	InsecureSkipVerify bool

	UserName string
	Password string

	Proxy     string
	ProxyAuth string

	Debug        bool
	RoundTripper http.RoundTripper
}

HTTPDownloader is the downloader for http request

func (*HTTPDownloader) DownloadFile

func (h *HTTPDownloader) DownloadFile() error

DownloadFile download a file with the progress

type LookPathContext

type LookPathContext = func(file string) (string, error)

LookPathContext is the context of look path

type ProgressIndicator

type ProgressIndicator struct {
	Writer io.Writer
	Reader io.Reader
	Title  string

	// bytes.Buffer
	Total float64
	// contains filtered or unexported fields
}

ProgressIndicator hold the progress of io operation

func (*ProgressIndicator) Init

func (i *ProgressIndicator) Init()

Init set the default value for progress indicator

func (*ProgressIndicator) Read

func (i *ProgressIndicator) Read(p []byte) (n int, err error)

Read reads the progress

func (*ProgressIndicator) Write

func (i *ProgressIndicator) Write(p []byte) (n int, err error)

Write writes the progress

type SystemCallExec

type SystemCallExec = func(argv0 string, argv []string, envv []string) (err error)

SystemCallExec is the context of syscall.Exec

type Table

type Table struct {
	Out          io.Writer
	Rows         [][]string
	ColumnWidths []int
	ColumnAlign  []int
	Separator    string

	WithHeader bool
}

Table for console print

func CreateTable

func CreateTable(out io.Writer) Table

CreateTable init a table object

func CreateTableWithHeader

func CreateTableWithHeader(out io.Writer, withoutHeader bool) (table Table)

CreateTableWithHeader init a table object

func (*Table) AddHeader

func (t *Table) AddHeader(col ...string)

AddHeader adds a header to the table

func (*Table) AddRow

func (t *Table) AddRow(col ...string)

AddRow adds a new row to the table

func (*Table) Clear

func (t *Table) Clear()

Clear removes all rows while preserving the layout

func (*Table) GetColumnAlign

func (t *Table) GetColumnAlign(i int) int

GetColumnAlign return the column alignment

func (*Table) Render

func (t *Table) Render()

Render render the table into byte array

func (*Table) SetColumnAlign

func (t *Table) SetColumnAlign(i int, align int)

SetColumnAlign sets the column alignment for the given column index

func (*Table) SetColumnsAligns

func (t *Table) SetColumnsAligns(colAligns []int)

SetColumnsAligns sets the alignment of the columns