common

Documentation

Index

• Variables
• func BootTimeWithContext(ctx context.Context) (uint64, error)
• func ByteToString(orig []byte) string
• func CallLsofWithContext(ctx context.Context, invoke Invoker, pid int32, args ...string) ([]string, error)
• func CallPgrepWithContext(ctx context.Context, invoke Invoker, pid int32) ([]int32, error)
• func DoSysctrl(mib string) ([]string, error)
• func GetEnv(key string, dfault string, combineWith ...string) string
• func GetOSRelease() (platform string, version string, err error)
• func HexToUint32(hex string) uint32
• func HostDev(combineWith ...string) string
• func HostEtc(combineWith ...string) string
• func HostProc(combineWith ...string) string
• func HostRun(combineWith ...string) string
• func HostSys(combineWith ...string) string
• func HostVar(combineWith ...string) string
• func IntContains(target []int, src int) bool
• func IntToString(orig []int8) string
• func MockEnv(key string, value string) func()
• func NumProcs() (uint64, error)
• func PathExists(filename string) bool
• func Read(r io.Reader, order ByteOrder, data interface{}) error
• func ReadFile(filename string) (string, error)
• func ReadInts(filename string) ([]int64, error)
• func ReadLines(filename string) ([]string, error)
• func ReadLinesOffsetN(filename string, offset uint, n int) ([]string, error)
• func Size(v interface{}) int
• func Sleep(ctx context.Context, interval time.Duration) error
• func StringsContains(target []string, src string) bool
• func StringsHas(target []string, src string) bool
• func UintToString(orig []uint8) string
• func Virtualization() (string, string, error)
• func VirtualizationWithContext(ctx context.Context) (string, string, error)
• func Write(w io.Writer, order ByteOrder, data interface{}) error
• type ByteOrder
• type FakeInvoke
  • func (i FakeInvoke) Command(name string, arg ...string) ([]byte, error)
  • func (i FakeInvoke) CommandWithContext(ctx context.Context, name string, arg ...string) ([]byte, error)
• type Invoke
  • func (i Invoke) Command(name string, arg ...string) ([]byte, error)
  • func (i Invoke) CommandWithContext(ctx context.Context, name string, arg ...string) ([]byte, error)
• type Invoker

Variables

var (
	Timeout    = 3 * time.Second
	ErrTimeout = errors.New("command timed out")
)

var BigEndian bigEndian

BigEndian is the big-endian implementation of ByteOrder.

var ErrNotImplementedError = errors.New("not implemented yet")

var LittleEndian littleEndian

LittleEndian is the little-endian implementation of ByteOrder.

Functions

func BootTimeWithContext

func BootTimeWithContext(ctx context.Context) (uint64, error)

func ByteToString

func ByteToString(orig []byte) string

func CallLsofWithContext

func CallLsofWithContext(ctx context.Context, invoke Invoker, pid int32, args ...string) ([]string, error)

func CallPgrepWithContext

func CallPgrepWithContext(ctx context.Context, invoke Invoker, pid int32) ([]int32, error)

func DoSysctrl

func DoSysctrl(mib string) ([]string, error)

func GetEnv

func GetEnv(key string, dfault string, combineWith ...string) string

GetEnv retrieves the environment variable key. If it does not exist it returns the default.

func GetOSRelease

func GetOSRelease() (platform string, version string, err error)

func HexToUint32

func HexToUint32(hex string) uint32

HexToUint32 parses Hex to uint32 without error.

func HostDev

func HostDev(combineWith ...string) string

func HostEtc

func HostEtc(combineWith ...string) string

func HostProc

func HostProc(combineWith ...string) string

func HostRun

func HostRun(combineWith ...string) string

func HostSys

func HostSys(combineWith ...string) string

func HostVar

func HostVar(combineWith ...string) string

func IntContains

func IntContains(target []int, src int) bool

IntContains checks the src in any int of the target int slice.

func IntToString

func IntToString(orig []int8) string

func MockEnv

func MockEnv(key string, value string) func()

MockEnv set environment variable and return revert function. MockEnv should be used testing only.

func NumProcs

func NumProcs() (uint64, error)

func PathExists

func PathExists(filename string) bool

func Read

func Read(r io.Reader, order ByteOrder, data interface{}) error

Read reads structured binary data from r into data. Data must be a pointer to a fixed-size value or a slice of fixed-size values. Bytes read from r are decoded using the specified byte order and written to successive fields of the data. When reading into structs, the field data for fields with blank (_) field names is skipped; i.e., blank field names may be used for padding. When reading into a struct, all non-blank fields must be exported.

func ReadFile

func ReadFile(filename string) (string, error)

ReadFile reads contents from a file.

func ReadInts

func ReadInts(filename string) ([]int64, error)

ReadInts reads contents from single line file and returns them as []int32.

func ReadLines

func ReadLines(filename string) ([]string, error)

ReadLines reads contents from a file and splits them by new lines. A convenience wrapper to ReadLinesOffsetN(filename, 0, -1).

func ReadLinesOffsetN

func ReadLinesOffsetN(filename string, offset uint, n int) ([]string, error)

ReadLinesOffsetN reads contents from file and splits them by new line. The offset tells at which line number to start. The count determines the number of lines to read (starting from offset):

n >= 0: at most n lines
n < 0: whole file

func Size

func Size(v interface{}) int

Size returns how many bytes Write would generate to encode the value v, which must be a fixed-size value or a slice of fixed-size values, or a pointer to such data. If v is neither of these, Size returns -1.

func Sleep

func Sleep(ctx context.Context, interval time.Duration) error

Sleep awaits for provided interval. Can be interrupted by context cancelation.

func StringsContains

func StringsContains(target []string, src string) bool

StringsContains checks the src in any string of the target string slice.

func StringsHas

func StringsHas(target []string, src string) bool

StringsHas checks the target string slice contains src or not.

func UintToString

func UintToString(orig []uint8) string

func Virtualization

func Virtualization() (string, string, error)

func VirtualizationWithContext

func VirtualizationWithContext(ctx context.Context) (string, string, error)

func Write

func Write(w io.Writer, order ByteOrder, data interface{}) error

Write writes the binary representation of data into w. Data must be a fixed-size value or a slice of fixed-size values, or a pointer to such data. Bytes written to w are encoded using the specified byte order and read from successive fields of the data. When writing structs, zero values are written for fields with blank (_) field names.

Types

type ByteOrder

type ByteOrder interface {
	Uint16([]byte) uint16
	Uint32([]byte) uint32
	Uint64([]byte) uint64
	PutUint16([]byte, uint16)
	PutUint32([]byte, uint32)
	PutUint64([]byte, uint64)
	String() string
}

A ByteOrder specifies how to convert byte sequences into 16-, 32-, or 64-bit unsigned integers.

type FakeInvoke

type FakeInvoke struct {
	Suffix string // Suffix species expected file name suffix such as "fail"
	Error  error  // If Error specfied, return the error.
}

func (FakeInvoke) Command

func (i FakeInvoke) Command(name string, arg ...string) ([]byte, error)

Command in FakeInvoke returns from expected file if exists.

func (FakeInvoke) CommandWithContext

func (i FakeInvoke) CommandWithContext(ctx context.Context, name string, arg ...string) ([]byte, error)

type Invoke

type Invoke struct{}

func (Invoke) Command

func (i Invoke) Command(name string, arg ...string) ([]byte, error)

func (Invoke) CommandWithContext

func (i Invoke) CommandWithContext(ctx context.Context, name string, arg ...string) ([]byte, error)

type Invoker

type Invoker interface {
	Command(string, ...string) ([]byte, error)
	CommandWithContext(context.Context, string, ...string) ([]byte, error)
}