[go: up one dir, main page]
Skip to content

Latest commit

 

History

History
445 lines (321 loc) · 8.29 KB

system.md

File metadata and controls

445 lines (321 loc) · 8.29 KB
Raw

System

Package system contains some functions about os, runtime, shell command.

Source:

Usage:

import (
    "github.com/duke-git/lancet/v2/system"
)

Index

Documentation

IsWindows

Check if current os is windows.

Signature:

func IsWindows() bool

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    isOsWindows := system.IsWindows()
    fmt.Println(isOsWindows)
}

IsLinux

Check if current os is linux.

Signature:

func IsLinux() bool

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    isOsLinux := system.IsLinux()
    fmt.Println(isOsLinux)
}

IsMac

Check if current os is macos.

Signature:

func IsMac() bool

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    isOsMac := system.IsMac()
    fmt.Println(isOsMac)
}

GetOsEnv

Gets the value of the environment variable named by the key.

Signature:

func GetOsEnv(key string) string

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    err := system.SetOsEnv("foo", "abc")
    result := system.GetOsEnv("foo")

    fmt.Println(err)
    fmt.Println(result)
    // Output:
    // <nil>
    // abc
}

SetOsEnv

Sets the value of the environment variable named by the key.

Signature:

func SetOsEnv(key, value string) error

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    err := system.SetOsEnv("foo", "abc")
    result := system.GetOsEnv("foo")

    fmt.Println(err)
    fmt.Println(result)
    // Output:
    // <nil>
    // abc
}

RemoveOsEnv

Remove a single environment variable.

Signature:

func RemoveOsEnv(key string) error

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    err1 := system.SetOsEnv("foo", "abc")
    result1 := GetOsEnv("foo")

    err2 := system.RemoveOsEnv("foo")
    result2 := GetOsEnv("foo")

    fmt.Println(err1)
    fmt.Println(err2)
    fmt.Println(result1)
    fmt.Println(result2)

    // Output:
    // <nil>
    // <nil>
    // abc
    //
}

CompareOsEnv

Get env named by the key and compare it with comparedEnv.

Signature:

func CompareOsEnv(key, comparedEnv string) bool

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    err := system.SetOsEnv("foo", "abc")
    if err != nil {
        return
    }

    result := system.CompareOsEnv("foo", "abc")

    fmt.Println(result)

    // Output:
    // true
}

ExecCommand

Execute shell command, return the stdout and stderr string of command, and error if error occur. param `command` is a complete command string, like, ls -a (linux), dir(windows), ping 127.0.0.1. In linux, use /bin/bash -c to execute command, In windows, use powershell.exe to execute command. The second parameter of the function is the cmd option control parameter. The type is func(*exec.Cmd). You can set the cmd attribute through this parameter.

Signature:

type (
    Option func(*exec.Cmd)
)
func ExecCommand(command string, opts ...Option) (stdout, stderr string, err error)

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    // linux or mac
    stdout, stderr, err := system.ExecCommand("ls", func(cmd *exec.Cmd) {
        cmd.Dir = "/tmp"
    })
    fmt.Println("std out: ", stdout)
    fmt.Println("std err: ", stderr)
    assert.Equal("", stderr)

    // windows
    stdout, stderr, err = system.ExecCommand("dir")
    fmt.Println("std out: ", stdout)
    fmt.Println("std err: ", stderr)

    // error command
    stdout, stderr, err = system.ExecCommand("abc")
    fmt.Println("std out: ", stdout)
    fmt.Println("std err: ", stderr)
    if err != nil {
        fmt.Println(err.Error())
    }
}

GetOsBits

Get current os bits, 32bit or 64bit. return 32 or 64.

Signature:

func GetOsBits() int

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    osBit := system.GetOsBits()
    fmt.Println(osBit) // 32 or 64
}

StartProcess

Start a new process with the specified name and arguments.

Signature:

func StartProcess(command string, args ...string) (int, error)

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    pid, err := system.StartProcess("sleep", "2")
    if err != nil {
        return
    }

    fmt.Println(pid)
}

StopProcess

Stop a process by pid.

Signature:

func StopProcess(pid int) error

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    pid, err := system.StartProcess("sleep", "10")
    if err != nil {
        return
    }
    time.Sleep(1 * time.Second)

    err = system.StopProcess(pid)

    fmt.Println(err)

    // Output:
    // <nil>
}

KillProcess

Kill a process by pid.

Signature:

func KillProcess(pid int) error

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    pid, err := system.StartProcess("sleep", "10")
    if err != nil {
        return
    }
    time.Sleep(1 * time.Second)

    err = system.KillProcess(pid)

    fmt.Println(err)

    // Output:
    // <nil>
}

GetProcessInfo

Retrieves detailed process information by pid.

Signature:

func GetProcessInfo(pid int) (*ProcessInfo, error)

Example:Run

import (
    "fmt"
    "github.com/duke-git/lancet/v2/system"
)

func main() {
    pid, err := system.StartProcess("ls", "-a")
    if err != nil {
        return
    }

    processInfo, err := system.GetProcessInfo(pid)
    if err != nil {
        return
    }

    fmt.Println(processInfo)
}