3 Commits

Author SHA1 Message Date
4575e2016c fix(helpers): return ErrValueNotSet for nonexistent units in GetNumRestarts
systemd returns NRestarts=0 for units with LoadState=not-found, making
it indistinguishable from a genuinely loaded unit with zero restarts.
GetNumRestarts now checks LoadState when NRestarts is 0 and returns
ErrValueNotSet for units that don't exist, matching GetMemoryUsage
behavior.

Also adds unit tests for filterErr (all stderr error mapping cases)
and HasValidUnitSuffix (all valid unit types + negative cases).

Updates syncthing test expectation from ErrValueNotSet to nil since
loaded-but-inactive units legitimately have NRestarts=0.
2026-03-05 10:35:01 +00:00
22132919e5 feat: add optional variadic args to all commands (#8)
Allow callers to pass additional systemctl flags (e.g. --no-block,
--force) via variadic string args on every exported function.

This is backward-compatible: existing callers without extra args
continue to work unchanged.

Introduces a prepareArgs helper to centralize argument construction,
replacing the duplicated args/UserMode pattern across all functions.

Closes #2
2026-02-26 11:03:53 -05:00
d38136c0dc refactor: clean up unused code, fix typos, improve docs (#7)
* refactor: clean up unused code, fix typos, improve docs

- Remove unused 'killed' const and 'unitTypes' var (staticcheck U1000)
- Replace regexp with strings.TrimSuffix+switch in isFailed for consistency
- Fix typo: 'programatically' -> 'programmatically'
- Fix typo: 'an an int' -> 'as an int' in README and helpers.go
- Add missing godoc comments on exported helper functions
- Bump minimum Go version from 1.18 to 1.21

* refactor: use unused constants instead of removing them

- Export unitTypes as UnitTypes and add HasValidUnitSuffix helper
- Use killed const (exit code 130) in execute() to detect SIGINT
- Update go.mod to go 1.26
2026-02-23 00:01:59 -05:00
12 changed files with 369 additions and 212 deletions

View File

@@ -32,7 +32,7 @@ If your system isn't running (or targeting another system running) `systemctl`,
## Helper functionality ## Helper functionality
- [x] Get start time of a service (`ExecMainStartTimestamp`) as a `Time` type - [x] Get start time of a service (`ExecMainStartTimestamp`) as a `Time` type
- [x] Get current memory in bytes (`MemoryCurrent`) an an int - [x] Get current memory in bytes (`MemoryCurrent`) as an int
- [x] Get the PID of the main process (`MainPID`) as an int - [x] Get the PID of the main process (`MainPID`) as an int
- [x] Get the restart count of a unit (`NRestarts`) as an int - [x] Get the restart count of a unit (`NRestarts`) as an int

View File

@@ -13,10 +13,10 @@ import (
func TestErrorFuncs(t *testing.T) { func TestErrorFuncs(t *testing.T) {
errFuncs := []func(ctx context.Context, unit string, opts Options) error{ errFuncs := []func(ctx context.Context, unit string, opts Options) error{
Enable, func(ctx context.Context, unit string, opts Options) error { return Enable(ctx, unit, opts) },
Disable, func(ctx context.Context, unit string, opts Options) error { return Disable(ctx, unit, opts) },
Restart, func(ctx context.Context, unit string, opts Options) error { return Restart(ctx, unit, opts) },
Start, func(ctx context.Context, unit string, opts Options) error { return Start(ctx, unit, opts) },
} }
errCases := []struct { errCases := []struct {
unit string unit string

119
filtererr_test.go Normal file
View File

@@ -0,0 +1,119 @@
package systemctl
import (
"errors"
"testing"
)
func TestFilterErr(t *testing.T) {
tests := []struct {
name string
stderr string
want error
}{
{
name: "empty stderr",
stderr: "",
want: nil,
},
{
name: "unit does not exist",
stderr: "Unit foo.service does not exist, proceeding anyway.",
want: ErrDoesNotExist,
},
{
name: "unit not found",
stderr: "Unit foo.service not found.",
want: ErrDoesNotExist,
},
{
name: "unit not loaded",
stderr: "Unit foo.service not loaded.",
want: ErrUnitNotLoaded,
},
{
name: "no such file or directory",
stderr: "No such file or directory",
want: ErrDoesNotExist,
},
{
name: "interactive authentication required",
stderr: "Interactive authentication required.",
want: ErrInsufficientPermissions,
},
{
name: "access denied",
stderr: "Access denied",
want: ErrInsufficientPermissions,
},
{
name: "dbus session bus address",
stderr: "Failed to connect to bus: $DBUS_SESSION_BUS_ADDRESS not set",
want: ErrBusFailure,
},
{
name: "unit is masked",
stderr: "Unit foo.service is masked.",
want: ErrMasked,
},
{
name: "generic failed",
stderr: "Failed to do something unknown",
want: ErrUnspecified,
},
{
name: "unrecognized warning",
stderr: "Warning: something benign happened",
want: nil,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := filterErr(tt.stderr)
if tt.want == nil {
if got != nil {
t.Errorf("filterErr(%q) = %v, want nil", tt.stderr, got)
}
return
}
if !errors.Is(got, tt.want) {
t.Errorf("filterErr(%q) = %v, want error wrapping %v", tt.stderr, got, tt.want)
}
})
}
}
func TestHasValidUnitSuffix(t *testing.T) {
tests := []struct {
unit string
want bool
}{
{"nginx.service", true},
{"sshd.socket", true},
{"backup.timer", true},
{"dev-sda1.device", true},
{"home.mount", true},
{"dev-sda1.swap", true},
{"user.slice", true},
{"multi-user.target", true},
{"session-1.scope", true},
{"foo.automount", true},
{"backup.path", true},
{"foo.snapshot", true},
{"nginx", false},
{"", false},
{"foo.bar", false},
{"foo.services", false},
{".service", true},
}
for _, tt := range tests {
t.Run(tt.unit, func(t *testing.T) {
got := HasValidUnitSuffix(tt.unit)
if got != tt.want {
t.Errorf("HasValidUnitSuffix(%q) = %v, want %v", tt.unit, got, tt.want)
}
})
}
}

2
go.mod
View File

@@ -1,3 +1,3 @@
module github.com/taigrr/systemctl module github.com/taigrr/systemctl
go 1.18 go 1.26

View File

@@ -32,10 +32,26 @@ func GetNumRestarts(ctx context.Context, unit string, opts Options) (int, error)
if err != nil { if err != nil {
return -1, err return -1, err
} }
return strconv.Atoi(value) if value == "[not set]" {
return -1, ErrValueNotSet
}
restarts, err := strconv.Atoi(value)
if err != nil {
return -1, err
}
// systemd returns NRestarts=0 for both genuinely zero-restart units and
// nonexistent/unloaded units. Disambiguate by checking LoadState: if the
// unit isn't loaded, the value is meaningless.
if restarts == 0 {
loadState, loadErr := Show(ctx, unit, properties.LoadState, opts)
if loadErr == nil && loadState == "not-found" {
return -1, ErrValueNotSet
}
}
return restarts, nil
} }
// Get current memory in bytes (`systemctl show [unit] --property MemoryCurrent`) an an int // Get current memory in bytes (`systemctl show [unit] --property MemoryCurrent`) as an int
func GetMemoryUsage(ctx context.Context, unit string, opts Options) (int, error) { func GetMemoryUsage(ctx context.Context, unit string, opts Options) (int, error) {
value, err := Show(ctx, unit, properties.MemoryCurrent, opts) value, err := Show(ctx, unit, properties.MemoryCurrent, opts)
if err != nil { if err != nil {
@@ -56,6 +72,7 @@ func GetPID(ctx context.Context, unit string, opts Options) (int, error) {
return strconv.Atoi(value) return strconv.Atoi(value)
} }
// GetSocketsForServiceUnit returns the socket units associated with a given service unit.
func GetSocketsForServiceUnit(ctx context.Context, unit string, opts Options) ([]string, error) { func GetSocketsForServiceUnit(ctx context.Context, unit string, opts Options) ([]string, error) {
args := []string{"list-sockets", "--all", "--no-legend", "--no-pager"} args := []string{"list-sockets", "--all", "--no-legend", "--no-pager"}
if opts.UserMode { if opts.UserMode {
@@ -81,6 +98,7 @@ func GetSocketsForServiceUnit(ctx context.Context, unit string, opts Options) ([
return sockets, nil return sockets, nil
} }
// GetUnits returns a list of all loaded units and their states.
func GetUnits(ctx context.Context, opts Options) ([]Unit, error) { func GetUnits(ctx context.Context, opts Options) ([]Unit, error) {
args := []string{"list-units", "--all", "--no-legend", "--full", "--no-pager"} args := []string{"list-units", "--all", "--no-legend", "--full", "--no-pager"}
if opts.UserMode { if opts.UserMode {
@@ -109,6 +127,7 @@ func GetUnits(ctx context.Context, opts Options) ([]Unit, error) {
return units, nil return units, nil
} }
// GetMaskedUnits returns a list of all masked unit names.
func GetMaskedUnits(ctx context.Context, opts Options) ([]string, error) { func GetMaskedUnits(ctx context.Context, opts Options) ([]string, error) {
args := []string{"list-unit-files", "--state=masked"} args := []string{"list-unit-files", "--state=masked"}
if opts.UserMode { if opts.UserMode {
@@ -138,7 +157,7 @@ func GetMaskedUnits(ctx context.Context, opts Options) ([]string, error) {
return units, nil return units, nil
} }
// check if systemd is the current init system // IsSystemd checks if systemd is the current init system by reading /proc/1/comm.
func IsSystemd() (bool, error) { func IsSystemd() (bool, error) {
b, err := os.ReadFile("/proc/1/comm") b, err := os.ReadFile("/proc/1/comm")
if err != nil { if err != nil {
@@ -147,7 +166,7 @@ func IsSystemd() (bool, error) {
return strings.TrimSpace(string(b)) == "systemd", nil return strings.TrimSpace(string(b)) == "systemd", nil
} }
// check if a service is masked // IsMasked checks if a unit is masked.
func IsMasked(ctx context.Context, unit string, opts Options) (bool, error) { func IsMasked(ctx context.Context, unit string, opts Options) (bool, error) {
units, err := GetMaskedUnits(ctx, opts) units, err := GetMaskedUnits(ctx, opts)
if err != nil { if err != nil {
@@ -161,8 +180,8 @@ func IsMasked(ctx context.Context, unit string, opts Options) (bool, error) {
return false, nil return false, nil
} }
// check if a service is running // IsRunning checks if a unit's sub-state is "running".
// https://unix.stackexchange.com/a/396633 // See https://unix.stackexchange.com/a/396633 for details.
func IsRunning(ctx context.Context, unit string, opts Options) (bool, error) { func IsRunning(ctx context.Context, unit string, opts Options) (bool, error) {
status, err := Show(ctx, unit, properties.SubState, opts) status, err := Show(ctx, unit, properties.SubState, opts)
return status == "running", err return status == "running", err

View File

@@ -105,8 +105,8 @@ func TestGetNumRestarts(t *testing.T) {
// try nonexistant unit in user mode as user // try nonexistant unit in user mode as user
{"nonexistant", ErrValueNotSet, Options{UserMode: false}, true}, {"nonexistant", ErrValueNotSet, Options{UserMode: false}, true},
// try existing unit in user mode as user // try existing unit in user mode as user (loaded, so NRestarts=0 is valid)
{"syncthing", ErrValueNotSet, Options{UserMode: true}, true}, {"syncthing", nil, Options{UserMode: true}, true},
// try existing unit in system mode as user // try existing unit in system mode as user
{"nginx", nil, Options{UserMode: false}, true}, {"nginx", nil, Options{UserMode: false}, true},

View File

@@ -1,5 +1,7 @@
package systemctl package systemctl
import "strings"
type Options struct { type Options struct {
UserMode bool UserMode bool
} }
@@ -12,7 +14,8 @@ type Unit struct {
Description string Description string
} }
var unitTypes = []string{ // UnitTypes contains all valid systemd unit type suffixes.
var UnitTypes = []string{
"automount", "automount",
"device", "device",
"mount", "mount",
@@ -26,3 +29,14 @@ var unitTypes = []string{
"target", "target",
"timer", "timer",
} }
// HasValidUnitSuffix checks whether the given unit name ends with a valid
// systemd unit type suffix (e.g. ".service", ".timer").
func HasValidUnitSuffix(unit string) bool {
for _, t := range UnitTypes {
if strings.HasSuffix(unit, "."+t) {
return true
}
}
return false
}

View File

@@ -12,8 +12,10 @@ import (
// files, and recreate the entire dependency tree. While the daemon is being // files, and recreate the entire dependency tree. While the daemon is being
// reloaded, all sockets systemd listens on behalf of user configuration will // reloaded, all sockets systemd listens on behalf of user configuration will
// stay accessible. // stay accessible.
func DaemonReload(ctx context.Context, opts Options) error { //
return daemonReload(ctx, opts) // Any additional arguments are passed directly to the systemctl command.
func DaemonReload(ctx context.Context, opts Options, args ...string) error {
return daemonReload(ctx, opts, args...)
} }
// Reenables one or more units. // Reenables one or more units.
@@ -21,8 +23,10 @@ func DaemonReload(ctx context.Context, opts Options) error {
// This removes all symlinks to the unit files backing the specified units from // This removes all symlinks to the unit files backing the specified units from
// the unit configuration directory, then recreates the symlink to the unit again, // the unit configuration directory, then recreates the symlink to the unit again,
// atomically. Can be used to change the symlink target. // atomically. Can be used to change the symlink target.
func Reenable(ctx context.Context, unit string, opts Options) error { //
return reenable(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Reenable(ctx context.Context, unit string, opts Options, args ...string) error {
return reenable(ctx, unit, opts, args...)
} }
// Disables one or more units. // Disables one or more units.
@@ -30,8 +34,10 @@ func Reenable(ctx context.Context, unit string, opts Options) error {
// This removes all symlinks to the unit files backing the specified units from // This removes all symlinks to the unit files backing the specified units from
// the unit configuration directory, and hence undoes any changes made by // the unit configuration directory, and hence undoes any changes made by
// enable or link. // enable or link.
func Disable(ctx context.Context, unit string, opts Options) error { //
return disable(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Disable(ctx context.Context, unit string, opts Options, args ...string) error {
return disable(ctx, unit, opts, args...)
} }
// Enable one or more units or unit instances. // Enable one or more units or unit instances.
@@ -40,17 +46,20 @@ func Disable(ctx context.Context, unit string, opts Options) error {
// the indicated unit files. After the symlinks have been created, the system // the indicated unit files. After the symlinks have been created, the system
// manager configuration is reloaded (in a way equivalent to daemon-reload), // manager configuration is reloaded (in a way equivalent to daemon-reload),
// in order to ensure the changes are taken into account immediately. // in order to ensure the changes are taken into account immediately.
func Enable(ctx context.Context, unit string, opts Options) error { //
return enable(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Enable(ctx context.Context, unit string, opts Options, args ...string) error {
return enable(ctx, unit, opts, args...)
} }
// Check whether any of the specified units are active (i.e. running). // Check whether any of the specified units are active (i.e. running).
// //
// Returns true if the unit is active, false if inactive or failed. // Returns true if the unit is active, false if inactive or failed.
// Also returns false in an error case. // Also returns false in an error case.
func IsActive(ctx context.Context, unit string, opts Options) (bool, error) { //
result, err := isActive(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
return result, err func IsActive(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
return isActive(ctx, unit, opts, args...)
} }
// Checks whether any of the specified unit files are enabled (as with enable). // Checks whether any of the specified unit files are enabled (as with enable).
@@ -62,15 +71,17 @@ func IsActive(ctx context.Context, unit string, opts Options) (bool, error) {
// //
// See https://www.freedesktop.org/software/systemd/man/systemctl.html#is-enabled%20UNIT%E2%80%A6 // See https://www.freedesktop.org/software/systemd/man/systemctl.html#is-enabled%20UNIT%E2%80%A6
// for more information // for more information
func IsEnabled(ctx context.Context, unit string, opts Options) (bool, error) { //
result, err := isEnabled(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
return result, err func IsEnabled(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
return isEnabled(ctx, unit, opts, args...)
} }
// Check whether any of the specified units are in a "failed" state. // Check whether any of the specified units are in a "failed" state.
func IsFailed(ctx context.Context, unit string, opts Options) (bool, error) { //
result, err := isFailed(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
return result, err func IsFailed(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
return isFailed(ctx, unit, opts, args...)
} }
// Mask one or more units, as specified on the command line. This will link // Mask one or more units, as specified on the command line. This will link
@@ -79,41 +90,51 @@ func IsFailed(ctx context.Context, unit string, opts Options) (bool, error) {
// Notably, Mask may return ErrDoesNotExist if a unit doesn't exist, but it will // Notably, Mask may return ErrDoesNotExist if a unit doesn't exist, but it will
// continue masking anyway. Calling Mask on a non-existing masked unit does not // continue masking anyway. Calling Mask on a non-existing masked unit does not
// return an error. Similarly, see Unmask. // return an error. Similarly, see Unmask.
func Mask(ctx context.Context, unit string, opts Options) error { //
return mask(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Mask(ctx context.Context, unit string, opts Options, args ...string) error {
return mask(ctx, unit, opts, args...)
} }
// Stop and then start one or more units specified on the command line. // Stop and then start one or more units specified on the command line.
// If the units are not running yet, they will be started. // If the units are not running yet, they will be started.
func Restart(ctx context.Context, unit string, opts Options) error { //
return restart(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Restart(ctx context.Context, unit string, opts Options, args ...string) error {
return restart(ctx, unit, opts, args...)
} }
// Show a selected property of a unit. Accepted properties are predefined in the // Show a selected property of a unit. Accepted properties are predefined in the
// properties subpackage to guarantee properties are valid and assist code-completion. // 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) { //
str, err := show(ctx, unit, property, opts) // Any additional arguments are passed directly to the systemctl command.
return str, err func Show(ctx context.Context, unit string, property properties.Property, opts Options, args ...string) (string, error) {
return show(ctx, unit, property, opts, args...)
} }
// Start (activate) a given unit // Start (activate) a given unit
func Start(ctx context.Context, unit string, opts Options) error { //
return start(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Start(ctx context.Context, unit string, opts Options, args ...string) error {
return start(ctx, unit, opts, args...)
} }
// Get back the status string which would be returned by running // Get back the status string which would be returned by running
// `systemctl status [unit]`. // `systemctl status [unit]`.
// //
// Generally, it makes more sense to programatically retrieve the properties // Generally, it makes more sense to programmatically retrieve the properties
// using Show, but this command is provided for the sake of completeness // using Show, but this command is provided for the sake of completeness
func Status(ctx context.Context, unit string, opts Options) (string, error) { //
stat, err := status(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
return stat, err func Status(ctx context.Context, unit string, opts Options, args ...string) (string, error) {
return status(ctx, unit, opts, args...)
} }
// Stop (deactivate) a given unit // Stop (deactivate) a given unit
func Stop(ctx context.Context, unit string, opts Options) error { //
return stop(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Stop(ctx context.Context, unit string, opts Options, args ...string) error {
return stop(ctx, unit, opts, args...)
} }
// Unmask one or more unit files, as specified on the command line. // Unmask one or more unit files, as specified on the command line.
@@ -123,6 +144,8 @@ func Stop(ctx context.Context, unit string, opts Options) error {
// doesn't exist, but only if it's not already masked. // doesn't exist, but only if it's not already masked.
// If the unit doesn't exist but it's masked anyway, no error will be // If the unit doesn't exist but it's masked anyway, no error will be
// returned. Gross, I know. Take it up with Poettering. // returned. Gross, I know. Take it up with Poettering.
func Unmask(ctx context.Context, unit string, opts Options) error { //
return unmask(ctx, unit, opts) // Any additional arguments are passed directly to the systemctl command.
func Unmask(ctx context.Context, unit string, opts Options, args ...string) error {
return unmask(ctx, unit, opts, args...)
} }

View File

@@ -8,58 +8,58 @@ import (
"github.com/taigrr/systemctl/properties" "github.com/taigrr/systemctl/properties"
) )
func daemonReload(ctx context.Context, opts Options) error { func daemonReload(_ context.Context, _ Options, _ ...string) error {
return nil return nil
} }
func reenable(ctx context.Context, unit string, opts Options) error { func reenable(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func disable(ctx context.Context, unit string, opts Options) error { func disable(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func enable(ctx context.Context, unit string, opts Options) error { func enable(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func isActive(ctx context.Context, unit string, opts Options) (bool, error) { func isActive(_ context.Context, _ string, _ Options, _ ...string) (bool, error) {
return false, nil return false, nil
} }
func isEnabled(ctx context.Context, unit string, opts Options) (bool, error) { func isEnabled(_ context.Context, _ string, _ Options, _ ...string) (bool, error) {
return false, nil return false, nil
} }
func isFailed(ctx context.Context, unit string, opts Options) (bool, error) { func isFailed(_ context.Context, _ string, _ Options, _ ...string) (bool, error) {
return false, nil return false, nil
} }
func mask(ctx context.Context, unit string, opts Options) error { func mask(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func restart(ctx context.Context, unit string, opts Options) error { func restart(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func show(ctx context.Context, unit string, property properties.Property, opts Options) (string, error) { func show(_ context.Context, _ string, _ properties.Property, _ Options, _ ...string) (string, error) {
return "", nil return "", nil
} }
func start(ctx context.Context, unit string, opts Options) error { func start(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func status(ctx context.Context, unit string, opts Options) (string, error) { func status(_ context.Context, _ string, _ Options, _ ...string) (string, error) {
return "", nil return "", nil
} }
func stop(ctx context.Context, unit string, opts Options) error { func stop(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }
func unmask(ctx context.Context, unit string, opts Options) error { func unmask(_ context.Context, _ string, _ Options, _ ...string) error {
return nil return nil
} }

View File

@@ -4,80 +4,38 @@ package systemctl
import ( import (
"context" "context"
"regexp"
"strings" "strings"
"github.com/taigrr/systemctl/properties" "github.com/taigrr/systemctl/properties"
) )
// Reload systemd manager configuration. func daemonReload(ctx context.Context, opts Options, args ...string) error {
// a := prepareArgs("daemon-reload", opts, args...)
// This will rerun all generators (see systemd. generator(7)), reload all unit _, _, _, err := execute(ctx, a)
// files, and recreate the entire dependency tree. While the daemon is being
// reloaded, all sockets systemd listens on behalf of user configuration will
// stay accessible.
func daemonReload(ctx context.Context, opts Options) error {
args := []string{"daemon-reload", "--system"}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Reenables one or more units. func reenable(ctx context.Context, unit string, opts Options, args ...string) error {
// a := prepareArgs("reenable", opts, append([]string{unit}, args...)...)
// This removes all symlinks to the unit files backing the specified units from _, _, _, err := execute(ctx, a)
// the unit configuration directory, then recreates the symlink to the unit again,
// atomically. Can be used to change the symlink target.
func reenable(ctx context.Context, unit string, opts Options) error {
args := []string{"reenable", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Disables one or more units. func disable(ctx context.Context, unit string, opts Options, args ...string) error {
// a := prepareArgs("disable", opts, append([]string{unit}, args...)...)
// This removes all symlinks to the unit files backing the specified units from _, _, _, err := execute(ctx, a)
// the unit configuration directory, and hence undoes any changes made by
// enable or link.
func disable(ctx context.Context, unit string, opts Options) error {
args := []string{"disable", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Enable one or more units or unit instances. func enable(ctx context.Context, unit string, opts Options, args ...string) error {
// a := prepareArgs("enable", opts, append([]string{unit}, args...)...)
// This will create a set of symlinks, as encoded in the [Install] sections of _, _, _, err := execute(ctx, a)
// the indicated unit files. After the symlinks have been created, the system
// manager configuration is reloaded (in a way equivalent to daemon-reload),
// in order to ensure the changes are taken into account immediately.
func enable(ctx context.Context, unit string, opts Options) error {
args := []string{"enable", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Check whether any of the specified units are active (i.e. running). func isActive(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
// a := prepareArgs("is-active", opts, append([]string{unit}, args...)...)
// Returns true if the unit is active, false if inactive or failed. stdout, _, _, err := execute(ctx, a)
// Also returns false in an error case.
func isActive(ctx context.Context, unit string, opts Options) (bool, error) {
args := []string{"is-active", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
stdout, _, _, err := execute(ctx, args)
stdout = strings.TrimSuffix(stdout, "\n") stdout = strings.TrimSuffix(stdout, "\n")
switch stdout { switch stdout {
case "inactive": case "inactive":
@@ -93,21 +51,9 @@ func isActive(ctx context.Context, unit string, opts Options) (bool, error) {
} }
} }
// Checks whether any of the specified unit files are enabled (as with enable). func isEnabled(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
// a := prepareArgs("is-enabled", opts, append([]string{unit}, args...)...)
// Returns true if the unit is enabled, aliased, static, indirect, generated stdout, _, _, err := execute(ctx, a)
// or transient.
//
// Returns false if disabled. Also returns an error if linked, masked, or bad.
//
// See https://www.freedesktop.org/software/systemd/man/systemctl.html#is-enabled%20UNIT%E2%80%A6
// for more information
func isEnabled(ctx context.Context, unit string, opts Options) (bool, error) {
args := []string{"is-enabled", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
stdout, _, _, err := execute(ctx, args)
stdout = strings.TrimSuffix(stdout, "\n") stdout = strings.TrimSuffix(stdout, "\n")
switch stdout { switch stdout {
case "enabled": case "enabled":
@@ -141,108 +87,63 @@ func isEnabled(ctx context.Context, unit string, opts Options) (bool, error) {
return false, ErrUnspecified return false, ErrUnspecified
} }
// Check whether any of the specified units are in a "failed" state. func isFailed(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
func isFailed(ctx context.Context, unit string, opts Options) (bool, error) { a := prepareArgs("is-failed", opts, append([]string{unit}, args...)...)
args := []string{"is-failed", "--system", unit} stdout, _, _, err := execute(ctx, a)
if opts.UserMode { stdout = strings.TrimSuffix(stdout, "\n")
args[1] = "--user" switch stdout {
} case "inactive":
stdout, _, _, err := execute(ctx, args)
if matched, _ := regexp.MatchString(`inactive`, stdout); matched {
return false, nil return false, nil
} else if matched, _ := regexp.MatchString(`active`, stdout); matched { case "active":
return false, nil return false, nil
} else if matched, _ := regexp.MatchString(`failed`, stdout); matched { case "failed":
return true, nil return true, nil
default:
return false, err
} }
return false, err
} }
// Mask one or more units, as specified on the command line. This will link func mask(ctx context.Context, unit string, opts Options, args ...string) error {
// these unit files to /dev/null, making it impossible to start them. a := prepareArgs("mask", opts, append([]string{unit}, args...)...)
// _, _, _, err := execute(ctx, a)
// Notably, Mask may return ErrDoesNotExist if a unit doesn't exist, but it will
// continue masking anyway. Calling Mask on a non-existing masked unit does not
// return an error. Similarly, see Unmask.
func mask(ctx context.Context, unit string, opts Options) error {
args := []string{"mask", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Stop and then start one or more units specified on the command line. func restart(ctx context.Context, unit string, opts Options, args ...string) error {
// If the units are not running yet, they will be started. a := prepareArgs("restart", opts, append([]string{unit}, args...)...)
func restart(ctx context.Context, unit string, opts Options) error { _, _, _, err := execute(ctx, a)
args := []string{"restart", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Show a selected property of a unit. Accepted properties are predefined in the func show(ctx context.Context, unit string, property properties.Property, opts Options, args ...string) (string, error) {
// properties subpackage to guarantee properties are valid and assist code-completion. extra := append([]string{unit, "--property", string(property)}, args...)
func show(ctx context.Context, unit string, property properties.Property, opts Options) (string, error) { a := prepareArgs("show", opts, extra...)
args := []string{"show", "--system", unit, "--property", string(property)} stdout, _, _, err := execute(ctx, a)
if opts.UserMode {
args[1] = "--user"
}
stdout, _, _, err := execute(ctx, args)
stdout = strings.TrimPrefix(stdout, string(property)+"=") stdout = strings.TrimPrefix(stdout, string(property)+"=")
stdout = strings.TrimSuffix(stdout, "\n") stdout = strings.TrimSuffix(stdout, "\n")
return stdout, err return stdout, err
} }
// Start (activate) a given unit func start(ctx context.Context, unit string, opts Options, args ...string) error {
func start(ctx context.Context, unit string, opts Options) error { a := prepareArgs("start", opts, append([]string{unit}, args...)...)
args := []string{"start", "--system", unit} _, _, _, err := execute(ctx, a)
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Get back the status string which would be returned by running func status(ctx context.Context, unit string, opts Options, args ...string) (string, error) {
// `systemctl status [unit]`. a := prepareArgs("status", opts, append([]string{unit}, args...)...)
// stdout, _, _, err := execute(ctx, a)
// 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) {
args := []string{"status", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
stdout, _, _, err := execute(ctx, args)
return stdout, err return stdout, err
} }
// Stop (deactivate) a given unit func stop(ctx context.Context, unit string, opts Options, args ...string) error {
func stop(ctx context.Context, unit string, opts Options) error { a := prepareArgs("stop", opts, append([]string{unit}, args...)...)
args := []string{"stop", "--system", unit} _, _, _, err := execute(ctx, a)
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }
// Unmask one or more unit files, as specified on the command line. func unmask(ctx context.Context, unit string, opts Options, args ...string) error {
// This will undo the effect of Mask. a := prepareArgs("unmask", opts, append([]string{unit}, args...)...)
// _, _, _, err := execute(ctx, a)
// In line with systemd, Unmask will return ErrDoesNotExist if the unit
// doesn't exist, but only if it's not already masked.
// If the unit doesn't exist but it's masked anyway, no error will be
// returned. Gross, I know. Take it up with Poettering.
func unmask(ctx context.Context, unit string, opts Options) error {
args := []string{"unmask", "--system", unit}
if opts.UserMode {
args[1] = "--user"
}
_, _, _, err := execute(ctx, args)
return err return err
} }

19
util.go
View File

@@ -11,6 +11,7 @@ import (
var systemctl string var systemctl string
// killed is the exit code returned when a process is terminated by SIGINT.
const killed = 130 const killed = 130
func init() { func init() {
@@ -39,6 +40,10 @@ func execute(ctx context.Context, args []string) (string, string, int, error) {
warnings = stderr.String() warnings = stderr.String()
code = cmd.ProcessState.ExitCode() code = cmd.ProcessState.ExitCode()
if code == killed {
return output, warnings, code, ErrExecTimeout
}
customErr := filterErr(warnings) customErr := filterErr(warnings)
if customErr != nil { if customErr != nil {
err = customErr err = customErr
@@ -50,6 +55,20 @@ func execute(ctx context.Context, args []string) (string, string, int, error) {
return output, warnings, code, err return output, warnings, code, err
} }
// prepareArgs builds the systemctl command arguments from a base command,
// options, and any additional arguments the caller wants to pass through.
func prepareArgs(base string, opts Options, extra ...string) []string {
args := make([]string, 0, 2+len(extra))
args = append(args, base)
if opts.UserMode {
args = append(args, "--user")
} else {
args = append(args, "--system")
}
args = append(args, extra...)
return args
}
func filterErr(stderr string) error { func filterErr(stderr string) error {
switch { switch {
case strings.Contains(stderr, `does not exist`): case strings.Contains(stderr, `does not exist`):

62
util_test.go Normal file
View File

@@ -0,0 +1,62 @@
package systemctl
import (
"reflect"
"testing"
)
func TestPrepareArgs(t *testing.T) {
tests := []struct {
name string
base string
opts Options
extra []string
expected []string
}{
{
name: "system mode no extra",
base: "start",
opts: Options{},
extra: nil,
expected: []string{"start", "--system"},
},
{
name: "user mode no extra",
base: "start",
opts: Options{UserMode: true},
extra: nil,
expected: []string{"start", "--user"},
},
{
name: "system mode with unit",
base: "start",
opts: Options{},
extra: []string{"nginx.service"},
expected: []string{"start", "--system", "nginx.service"},
},
{
name: "user mode with unit and extra args",
base: "restart",
opts: Options{UserMode: true},
extra: []string{"foo.service", "--no-block"},
expected: []string{"restart", "--user", "foo.service", "--no-block"},
},
{
name: "daemon-reload no extra",
base: "daemon-reload",
opts: Options{},
extra: nil,
expected: []string{"daemon-reload", "--system"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := prepareArgs(tt.base, tt.opts, tt.extra...)
if !reflect.DeepEqual(got, tt.expected) {
t.Errorf("prepareArgs(%q, %+v, %v) = %v, want %v",
tt.base, tt.opts, tt.extra, got, tt.expected)
}
})
}
}