taigrr/systemctl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add documentation and enable example

Browse Source
This commit is contained in:
Tai Groot 2021-05-16 18:04:21 -07:00
parent 6b8241ed7c
commit 1ce6ec028a
Signed by: taigrr
GPG Key ID: D00C269A87614812
3 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -1,3 +1,4 @@
[![PkgGoDev](https://pkg.go.dev/badge/github.com/taigrr/systemctl)](https://pkg.go.dev/github.com/taigrr/systemctl)
# systemctl
This library aims at providing idiomatic `systemctl` bindings for go developers, in order to make it easier to write system tooling using golang.

15
systemctl.go
View File

@ -137,6 +137,8 @@ func IsFailed(ctx context.Context, unit string, opts Options) (bool, error) {
return false, err
}
// Mask one or more units, as specified on the command line. This will link
// these unit files to /dev/null, making it impossible to start them.
func Mask(ctx context.Context, unit string, opts Options) error {
var args = []string{"mask", "--system", unit}
if opts.UserMode {
@ -146,6 +148,8 @@ func Mask(ctx context.Context, unit string, opts Options) error {
return err
}
// Stop and then start one or more units specified on the command line.
// If the units are not running yet, they will be started.
func Restart(ctx context.Context, unit string, opts Options) error {
var args = []string{"restart", "--system", unit}
if opts.UserMode {
@ -155,6 +159,8 @@ func Restart(ctx context.Context, unit string, opts Options) error {
return err
}
// Show a selected property of a unit. Accepted properties are predefined in the
// properties subpackage to guarantee properties are valid and assist code-completion.
func Show(ctx context.Context, unit string, property properties.Property, opts Options) (string, error) {
var args = []string{"show", "--system", unit, "--property", string(property)}
if opts.UserMode {
@ -166,6 +172,7 @@ func Show(ctx context.Context, unit string, property properties.Property, opts O
return stdout, err
}
// Start (activate) a given unit
func Start(ctx context.Context, unit string, opts Options) error {
var args = []string{"start", "--system", unit}
if opts.UserMode {
@ -175,6 +182,11 @@ func Start(ctx context.Context, unit string, opts Options) error {
return err
}
// Get back the status string which would be returned by running
// `systemctl status [unit]`.
//
// Generally, it makes more sense to programatically retrieve the properties
// using Show, but this command is provided for the sake of completeness
func Status(ctx context.Context, unit string, opts Options) (string, error) {
var args = []string{"status", "--system", unit}
if opts.UserMode {
@ -184,6 +196,7 @@ func Status(ctx context.Context, unit string, opts Options) (string, error) {
return stdout, err
}
// Stop (deactivate) a given unit
func Stop(ctx context.Context, unit string, opts Options) error {
var args = []string{"stop", "--system", unit}
if opts.UserMode {
@ -193,6 +206,8 @@ func Stop(ctx context.Context, unit string, opts Options) error {
return err
}
// Unmask one or more unit files, as specified on the command line.
// This will undo the effect of Mask.
func Unmask(ctx context.Context, unit string, opts Options) error {
var args = []string{"unmask", "--system", unit}
if opts.UserMode {

23
systemctl_test.go
View File

@ -82,8 +82,8 @@ func TestEnable(t *testing.T) {
}
unit := "nginx"
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
err := Mask(ctx, unit, Options{UserMode: false})
defer cancel()
err := Mask(ctx, unit, Options{UserMode: false})
if err != nil {
Unmask(ctx, unit, Options{UserMode: false})
t.Errorf("Unable to mask %s", unit)
@ -100,6 +100,27 @@ func TestEnable(t *testing.T) {
})
}
func ExampleEnable() {
unit := "syncthing"
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
err := Enable(ctx, unit, Options{UserMode: true})
switch err {
case ErrMasked:
fmt.Printf("%s is masked, unmask it before enabling\n", unit)
case ErrDoesNotExist:
fmt.Printf("%s does not exist\n", unit)
case ErrInsufficientPermissions:
fmt.Printf("permission to enable %s denied\n", unit)
case ErrBusFailure:
fmt.Printf("Cannot communicate with the bus\n")
case nil:
fmt.Printf("%s enabled successfully\n", unit)
default:
fmt.Printf("Error: %v", err)
}
}
func TestDisable(t *testing.T) {
testCases := []struct {