oskit

Documentation

Index

• Constants
• Variables
• func CommandContext(timeout int, binPath string, args []string) (string, error)
• func Exec(bin string, args []string)
• func ExecCommand(bin string, args []string) (string, error)
• func FromDeployPolicy(policy DeployPolicy) string
• func GetDeployStage() string
• func Init()
• func Install(tmpPath, binPath string) error
• func IsLinux() bool
• func IsMac() bool
• func IsStageDev() bool
• func IsStageTest() bool
• func IsWin() bool
• func SendReloadSignal() error
• type Bar
  • func (bar *Bar) Finish()
  • func (bar *Bar) NewOption(start, total int64)
  • func (bar *Bar) NewOptionWithGraph(start, total int64, graph string)
  • func (bar *Bar) Play(cur int64)
• type BuildInfo
  • func GetBuildInfo() *BuildInfo
  • func (info *BuildInfo) ToProject() string
  • func (info *BuildInfo) ToString() string
• type DeployPolicy
  • func ToEnv(sPolicy string) DeployPolicy

Examples

• Bar.NewOption

Constants

const (
	CloudPlatformAWS    = "aws"
	CloudPlatformAliyun = "aliyun"

	// The name from github, XD.
	CloudPlatformTencent = "tencentyun"
)

const (
	DeployStageDev     = "dev"
	DeployStageTest    = "test"
	DeployStagePre     = "pre"
	DeployStageRelease = "release"
)

Variables

var (
	Env       string
	Repo      string
	Version   string
	Swagger   string
	Build     string
	BuildTime string
	Uptime    string
	CreatedAt time.Time
)

var DeployPolicyMap = map[DeployPolicy]string{

	DeployPolicyBlue: "blue",

	DeployPolicyGreen: "green",

	DeployPolicyRed: "red",

	DeployPolicyBlack: "black",
}

Functions

func CommandContext

func CommandContext(timeout int, binPath string, args []string) (string, error)

func Exec

func Exec(bin string, args []string)

func ExecCommand

func ExecCommand(bin string, args []string) (string, error)

func FromDeployPolicy

func FromDeployPolicy(policy DeployPolicy) string

func GetDeployStage

func GetDeployStage() string

func Init

func Init()

func Install

func Install(tmpPath, binPath string) error

Install command binary.

func IsLinux

func IsLinux() bool

IsLinux system.

func IsMac

func IsMac() bool

IsMac system.

func IsStageDev

func IsStageDev() bool

func IsStageTest

func IsStageTest() bool

func IsWin

func IsWin() bool

IsWin system. linux windows darwin.

func SendReloadSignal

func SendReloadSignal() error

Types

type Bar

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

func (*Bar) Finish

func (bar *Bar) Finish()

func (*Bar) NewOption

func (bar *Bar) NewOption(start, total int64)

Example

package main

import (
	"time"

	"github.com/airdb/toolbox/oskit"
)

func main() {
	var bar oskit.Bar

	bar.NewOption(0, 100)

	for i := 0; i <= 100; i++ {
		time.Sleep(time.Millisecond)
		bar.Play(int64(i))
	}

	bar.Finish()
}

func (*Bar) NewOptionWithGraph

func (bar *Bar) NewOptionWithGraph(start, total int64, graph string)

func (*Bar) Play

func (bar *Bar) Play(cur int64)

type BuildInfo

type BuildInfo struct {
	GoVersion string
	Env       string
	Repo      string
	Version   string
	Swagger   string `json:"swagger,omitempty"`
	Build     string
	BuildTime string
	Uptime    string
	CreatedAt time.Time
}

Build version info.

func GetBuildInfo

func GetBuildInfo() *BuildInfo

func (*BuildInfo) ToProject

func (info *BuildInfo) ToProject() string

func (*BuildInfo) ToString

func (info *BuildInfo) ToString() string

type DeployPolicy

type DeployPolicy uint

const (
	DeployPolicyBlue DeployPolicy = iota + 1
	DeployPolicyGreen
	DeployPolicyRed
	DeployPolicyBlack
)

func ToEnv

func ToEnv(sPolicy string) DeployPolicy