util

Documentation

Overview

Package util is a generated GoMock package.

Index

• Constants
• func BytesToGiB(volumeSizeBytes int64) int64
• func ConvertTagsToMap(tags string) (map[string]string, error)
• func GetKubeClient(kubeconfig string, kubeAPIQPS float64, kubeAPIBurst int, userAgent string) (kubernetes.Interface, error)
• func GetMountOptions(options []string) string
• func GiBToBytes(volumeSizeGiB int64) int64
• func MakeDir(pathname string, perm os.FileMode) error
• func RoundUpBytes(volumeSizeBytes int64) int64
• func RoundUpGiB(volumeSizeBytes int64) int64
• func SetVolumeOwnership(path, gid, policy string) error
• func TrimDuplicatedSpace(s string) string
• func WaitUntilTimeout(timeout time.Duration, execFunc ExecFunc, timeoutFunc TimeoutFunc) error
• type Azcopy
  • func (ac *Azcopy) GetAzcopyJob(dstBlobContainer string, authAzcopyEnv []string) (AzcopyJobState, string, error)
  • func (ac *Azcopy) TestListJobs(accountName, storageEndpointSuffix string, authAzcopyEnv []string) (string, error)
• type AzcopyJobState
• type EXEC
• type ExecCommand
  • func (ec *ExecCommand) RunCommand(cmdStr string, authEnv []string) (string, error)
• type ExecFunc
• type LockMap
  • func NewLockMap() *LockMap
  • func (lm *LockMap) LockEntry(entry string)
  • func (lm *LockMap) UnlockEntry(entry string)
• type MockEXEC
  • func NewMockEXEC(ctrl *gomock.Controller) *MockEXEC
  • func (m *MockEXEC) EXPECT() *MockEXECMockRecorder
  • func (m *MockEXEC) RunCommand(arg0 string, arg1 []string) (string, error)
• type MockEXECMockRecorder
  • func (mr *MockEXECMockRecorder) RunCommand(arg0, arg1 interface{}) *gomock.Call
• type OsInfo
  • func GetOSInfo(f interface{}) (*OsInfo, error)
• type TimeoutFunc
• type VolumeMounter
  • func (l *VolumeMounter) CanMount() error
  • func (l *VolumeMounter) GetAttributes() volume.Attributes
  • func (l *VolumeMounter) GetMetrics() (*volume.Metrics, error)
  • func (l *VolumeMounter) GetPath() string
  • func (l *VolumeMounter) SetUp(_ volume.MounterArgs) error
  • func (l *VolumeMounter) SetUpAt(_ string, _ volume.MounterArgs) error

Constants

const (
	GiB = 1024 * 1024 * 1024
	TiB = 1024 * GiB
)

Functions

func BytesToGiB

func BytesToGiB(volumeSizeBytes int64) int64

BytesToGiB conversts Bytes to GiB

func ConvertTagsToMap

func ConvertTagsToMap(tags string) (map[string]string, error)

func GetKubeClient

func GetKubeClient(kubeconfig string, kubeAPIQPS float64, kubeAPIBurst int, userAgent string) (kubernetes.Interface, error)

func GetMountOptions

func GetMountOptions(options []string) string

GetMountOptions return options with string list separated by space

func GiBToBytes

func GiBToBytes(volumeSizeGiB int64) int64

GiBToBytes converts GiB to Bytes

func MakeDir

func MakeDir(pathname string, perm os.FileMode) error

func RoundUpBytes

func RoundUpBytes(volumeSizeBytes int64) int64

RoundUpBytes rounds up the volume size in bytes up to multiplications of GiB in the unit of Bytes

func RoundUpGiB

func RoundUpGiB(volumeSizeBytes int64) int64

RoundUpGiB rounds up the volume size in bytes up to multiplications of GiB in the unit of GiB

func SetVolumeOwnership

func SetVolumeOwnership(path, gid, policy string) error

SetVolumeOwnership would set gid for path recursively

func TrimDuplicatedSpace

func TrimDuplicatedSpace(s string) string

func WaitUntilTimeout

func WaitUntilTimeout(timeout time.Duration, execFunc ExecFunc, timeoutFunc TimeoutFunc) error

WaitUntilTimeout waits for the exec function to complete or return timeout error

Types

type Azcopy

type Azcopy struct {
	ExecCmd EXEC
}

func (*Azcopy) GetAzcopyJob

func (ac *Azcopy) GetAzcopyJob(dstBlobContainer string, authAzcopyEnv []string) (AzcopyJobState, string, error)

GetAzcopyJob get the azcopy job status if job existed

func (*Azcopy) TestListJobs

func (ac *Azcopy) TestListJobs(accountName, storageEndpointSuffix string, authAzcopyEnv []string) (string, error)

TestListJobs test azcopy jobs list command with authAzcopyEnv

type AzcopyJobState

type AzcopyJobState string

const (
	AzcopyJobError     AzcopyJobState = "Error"
	AzcopyJobNotFound  AzcopyJobState = "NotFound"
	AzcopyJobRunning   AzcopyJobState = "Running"
	AzcopyJobCompleted AzcopyJobState = "Completed"
)

type EXEC

type EXEC interface {
	RunCommand(string, []string) (string, error)
}

type ExecCommand

type ExecCommand struct {
}

func (*ExecCommand) RunCommand

func (ec *ExecCommand) RunCommand(cmdStr string, authEnv []string) (string, error)

type ExecFunc

type ExecFunc func() (err error)

ExecFunc returns a exec function's output and error

type LockMap

type LockMap struct {
	sync.Mutex
	// contains filtered or unexported fields
}

LockMap used to lock on entries

func NewLockMap

func NewLockMap() *LockMap

NewLockMap returns a new lock map

func (*LockMap) LockEntry

func (lm *LockMap) LockEntry(entry string)

LockEntry acquires a lock associated with the specific entry

func (*LockMap) UnlockEntry

func (lm *LockMap) UnlockEntry(entry string)

UnlockEntry release the lock associated with the specific entry

type MockEXEC

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

MockEXEC is a mock of EXEC interface.

func NewMockEXEC

func NewMockEXEC(ctrl *gomock.Controller) *MockEXEC

NewMockEXEC creates a new mock instance.

func (*MockEXEC) EXPECT

func (m *MockEXEC) EXPECT() *MockEXECMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockEXEC) RunCommand

func (m *MockEXEC) RunCommand(arg0 string, arg1 []string) (string, error)

RunCommand mocks base method.

type MockEXECMockRecorder

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

MockEXECMockRecorder is the mock recorder for MockEXEC.

func (*MockEXECMockRecorder) RunCommand

func (mr *MockEXECMockRecorder) RunCommand(arg0, arg1 interface{}) *gomock.Call

RunCommand indicates an expected call of RunCommand.

type OsInfo

type OsInfo struct {
	Distro  string
	Version string
}

func GetOSInfo

func GetOSInfo(f interface{}) (*OsInfo, error)

type TimeoutFunc

type TimeoutFunc func() (err error)

TimeoutFunc returns output and error if an ExecFunc timeout

type VolumeMounter

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

func (*VolumeMounter) CanMount

func (l *VolumeMounter) CanMount() error

func (*VolumeMounter) GetAttributes

func (l *VolumeMounter) GetAttributes() volume.Attributes

func (*VolumeMounter) GetMetrics

func (l *VolumeMounter) GetMetrics() (*volume.Metrics, error)

func (*VolumeMounter) GetPath

func (l *VolumeMounter) GetPath() string

func (*VolumeMounter) SetUp

func (l *VolumeMounter) SetUp(_ volume.MounterArgs) error

func (*VolumeMounter) SetUpAt

func (l *VolumeMounter) SetUpAt(_ string, _ volume.MounterArgs) error