util

Documentation

Index

• Constants
• func CheckUser(cfg config.Cfg) bool
• func CleanTmpDir(cfg config.Cfg) bool
• func DirectoryExists(dir string) (bool, os.FileInfo)
• func EnsureConfigDirIsGitRepo(cfg config.Cfg) (bool, error)
• func ExecCommand(fullCommand string, arg ...string) ([]byte, int, error)
• func FileExists(fn string) (bool, os.FileInfo)
• func GetGitConfigSafeDir(cfg config.Cfg) error
• func IsGitLockFileOld(lockFile string, now time.Time, maxAge time.Duration) (bool, error)
• func MakeGitCommitAll(cfg config.Cfg, self bool, success bool) error
• func MkDir(name string, reportOnly bool) bool
• func MkDirWithOwner(name string, reportOnly bool, uid *int, gid *int) bool
• func PackageAction(cmdstr string, name string) (bool, error)
• func PackageInfo(cmdstr string, name string) ([]string, error)
• func RandomDuration(max time.Duration) time.Duration
• func ReadFile(fn string) ([]byte, error)
• func RemoveGitLock(lockFile string) error
• func ServiceStart(service string, cmd string) (bool, error)
• func Touch(fn string) error
• func UpdateMaxmind(maxmindlocation string, tsconfigdir string, reportonly bool) bool
• func WriteFileWithOwner(fn string, data []byte, uid *int, gid *int, perm os.FileMode) (int, error)
• type FileLock
  • func (f *FileLock) GetLock(lockFile string) bool
  • func (f *FileLock) Unlock()
• type ServiceStatus
  • func GetServiceStatus(name string) (ServiceStatus, int, error)
  • func (s ServiceStatus) String() string

Constants

const GitChangeIsSelf = true

const GitChangeNotSelf = false

const GitSafeDir = "safe.directory"

const OneWeek = 604800

Functions

func CheckUser

func CheckUser(cfg config.Cfg) bool

func CleanTmpDir

func CleanTmpDir(cfg config.Cfg) bool

func DirectoryExists

func DirectoryExists(dir string) (bool, os.FileInfo)

func EnsureConfigDirIsGitRepo

func EnsureConfigDirIsGitRepo(cfg config.Cfg) (bool, error)

EnsureConfigDirIsGitRepo ensures the ATS config directory is a git repo. Returns whether it tried to create a git repo, and any error. Note the return will be (false, nil) if a git repo already exists. Note true and a non-nil error may be returned, if creating a git repo is necessary and attempted and fails.

func ExecCommand

func ExecCommand(fullCommand string, arg ...string) ([]byte, int, error)

func FileExists

func FileExists(fn string) (bool, os.FileInfo)

func GetGitConfigSafeDir

func GetGitConfigSafeDir(cfg config.Cfg) error

GetGitConfigSafeDir checks that TsConfigDir has been configured as a safe directory. if not it will be added to the git config this will prevent the fatal: detected dubious ownership error

func IsGitLockFileOld

func IsGitLockFileOld(lockFile string, now time.Time, maxAge time.Duration) (bool, error)

func MakeGitCommitAll

func MakeGitCommitAll(cfg config.Cfg, self bool, success bool) error

makeGitCommitAll makes a git commit of all changes in cfg.TsConfigDir, including untracked files.

func MkDir

func MkDir(name string, reportOnly bool) bool

func MkDirWithOwner

func MkDirWithOwner(name string, reportOnly bool, uid *int, gid *int) bool

func PackageAction

func PackageAction(cmdstr string, name string) (bool, error)

func PackageInfo

func PackageInfo(cmdstr string, name string) ([]string, error)

runs the rpm command. if the return code from rpm == 0, then a valid package list is returned.

if the return code is 1, the the 'name' queried for is not part of a

package or is not installed.

otherwise, if the return code is not 0 or 1 and error is set, a general rpm command execution error is assumed and the error is returned.

func RandomDuration

func RandomDuration(max time.Duration) time.Duration

func ReadFile

func ReadFile(fn string) ([]byte, error)

func RemoveGitLock

func RemoveGitLock(lockFile string) error

func ServiceStart

func ServiceStart(service string, cmd string) (bool, error)

start or restart the service 'service'. cmd is 'start | restart'

func Touch

func Touch(fn string) error

func UpdateMaxmind

func UpdateMaxmind(maxmindlocation string, tsconfigdir string, reportonly bool) bool

func WriteFileWithOwner

func WriteFileWithOwner(fn string, data []byte, uid *int, gid *int, perm os.FileMode) (int, error)

Types

type FileLock

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

func (*FileLock) GetLock

func (f *FileLock) GetLock(lockFile string) bool

Try to get a file lock, non-blocking.

func (*FileLock) Unlock

func (f *FileLock) Unlock()

Releases the file lock, if locked.

type ServiceStatus

type ServiceStatus int

const (
	SvcNotRunning ServiceStatus = 0
	SvcRunning    ServiceStatus = 1
	SvcUnknown    ServiceStatus = 2
)

func GetServiceStatus

func GetServiceStatus(name string) (ServiceStatus, int, error)

func (ServiceStatus) String

func (s ServiceStatus) String() string