mirror of
https://github.com/taigrr/systemctl.git
synced 2026-04-02 02:28:50 -07:00
Compare commits
9 Commits
v1.0.10
...
cd/filtere
| Author | SHA1 | Date | |
|---|---|---|---|
| 5518d863a8 | |||
| 7253c912ca | |||
| adf3c36632 | |||
| 22132919e5 | |||
| d38136c0dc | |||
|
|
14c9f0f70d | ||
| 5f1537f8bc | |||
|
|
d38d347cc6 | ||
| 14a2ca2acd |
65
.github/workflows/ci.yml
vendored
Normal file
65
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
pull_request:
|
||||
branches: [master]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Test (Go ${{ matrix.go-version }})
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
go-version: ["1.26"]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Go ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
cache: true
|
||||
|
||||
- name: Install and start nginx
|
||||
run: |
|
||||
sudo apt-get update -qq
|
||||
sudo apt-get install -y -qq nginx
|
||||
sudo systemctl start nginx
|
||||
sudo systemctl enable nginx
|
||||
|
||||
- name: Run tests (user)
|
||||
run: go test -race -coverprofile=coverage-user.out -covermode=atomic ./...
|
||||
|
||||
- name: Run tests (root)
|
||||
run: sudo go test -race -coverprofile=coverage-root.out -covermode=atomic ./...
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
if: matrix.go-version == '1.26'
|
||||
uses: codecov/codecov-action@v5
|
||||
with:
|
||||
files: coverage-user.out,coverage-root.out
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
fail_ci_if_error: false
|
||||
|
||||
lint:
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: "1.26"
|
||||
cache: true
|
||||
|
||||
- name: Run staticcheck
|
||||
uses: dominikh/staticcheck-action@v1
|
||||
with:
|
||||
version: latest
|
||||
install-go: false
|
||||
@@ -32,7 +32,7 @@ If your system isn't running (or targeting another system running) `systemctl`,
|
||||
## Helper functionality
|
||||
|
||||
- [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 restart count of a unit (`NRestarts`) as an int
|
||||
|
||||
|
||||
@@ -13,10 +13,10 @@ import (
|
||||
|
||||
func TestErrorFuncs(t *testing.T) {
|
||||
errFuncs := []func(ctx context.Context, unit string, opts Options) error{
|
||||
Enable,
|
||||
Disable,
|
||||
Restart,
|
||||
Start,
|
||||
func(ctx context.Context, unit string, opts Options) error { return Enable(ctx, unit, opts) },
|
||||
func(ctx context.Context, unit string, opts Options) error { return Disable(ctx, unit, opts) },
|
||||
func(ctx context.Context, unit string, opts Options) error { return Restart(ctx, unit, opts) },
|
||||
func(ctx context.Context, unit string, opts Options) error { return Start(ctx, unit, opts) },
|
||||
}
|
||||
errCases := []struct {
|
||||
unit string
|
||||
|
||||
134
filtererr_test.go
Normal file
134
filtererr_test.go
Normal file
@@ -0,0 +1,134 @@
|
||||
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: "does not exist with auth required prioritizes permission error",
|
||||
stderr: "Unit nginx.service does not exist, proceeding anyway.\nFailed to mask unit: Interactive authentication required.",
|
||||
want: ErrInsufficientPermissions,
|
||||
},
|
||||
{
|
||||
name: "does not exist with access denied prioritizes permission error",
|
||||
stderr: "Unit foo.service does not exist, proceeding anyway.\nAccess denied",
|
||||
want: ErrInsufficientPermissions,
|
||||
},
|
||||
{
|
||||
name: "does not exist with bus failure prioritizes bus error",
|
||||
stderr: "Unit foo.service does not exist, proceeding anyway.\n$DBUS_SESSION_BUS_ADDRESS not set",
|
||||
want: ErrBusFailure,
|
||||
},
|
||||
{
|
||||
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)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
33
helpers.go
33
helpers.go
@@ -1,5 +1,3 @@
|
||||
//go:build linux
|
||||
|
||||
package systemctl
|
||||
|
||||
import (
|
||||
@@ -34,10 +32,26 @@ func GetNumRestarts(ctx context.Context, unit string, opts Options) (int, error)
|
||||
if err != nil {
|
||||
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) {
|
||||
value, err := Show(ctx, unit, properties.MemoryCurrent, opts)
|
||||
if err != nil {
|
||||
@@ -58,6 +72,7 @@ func GetPID(ctx context.Context, unit string, opts Options) (int, error) {
|
||||
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) {
|
||||
args := []string{"list-sockets", "--all", "--no-legend", "--no-pager"}
|
||||
if opts.UserMode {
|
||||
@@ -83,6 +98,7 @@ func GetSocketsForServiceUnit(ctx context.Context, unit string, opts Options) ([
|
||||
return sockets, nil
|
||||
}
|
||||
|
||||
// GetUnits returns a list of all loaded units and their states.
|
||||
func GetUnits(ctx context.Context, opts Options) ([]Unit, error) {
|
||||
args := []string{"list-units", "--all", "--no-legend", "--full", "--no-pager"}
|
||||
if opts.UserMode {
|
||||
@@ -111,6 +127,7 @@ func GetUnits(ctx context.Context, opts Options) ([]Unit, error) {
|
||||
return units, nil
|
||||
}
|
||||
|
||||
// GetMaskedUnits returns a list of all masked unit names.
|
||||
func GetMaskedUnits(ctx context.Context, opts Options) ([]string, error) {
|
||||
args := []string{"list-unit-files", "--state=masked"}
|
||||
if opts.UserMode {
|
||||
@@ -140,7 +157,7 @@ func GetMaskedUnits(ctx context.Context, opts Options) ([]string, error) {
|
||||
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) {
|
||||
b, err := os.ReadFile("/proc/1/comm")
|
||||
if err != nil {
|
||||
@@ -149,7 +166,7 @@ func IsSystemd() (bool, error) {
|
||||
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) {
|
||||
units, err := GetMaskedUnits(ctx, opts)
|
||||
if err != nil {
|
||||
@@ -163,8 +180,8 @@ func IsMasked(ctx context.Context, unit string, opts Options) (bool, error) {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
// check if a service is running
|
||||
// https://unix.stackexchange.com/a/396633
|
||||
// IsRunning checks if a unit's sub-state is "running".
|
||||
// See https://unix.stackexchange.com/a/396633 for details.
|
||||
func IsRunning(ctx context.Context, unit string, opts Options) (bool, error) {
|
||||
status, err := Show(ctx, unit, properties.SubState, opts)
|
||||
return status == "running", err
|
||||
|
||||
@@ -105,8 +105,8 @@ func TestGetNumRestarts(t *testing.T) {
|
||||
|
||||
// try nonexistant unit in user mode as user
|
||||
{"nonexistant", ErrValueNotSet, Options{UserMode: false}, true},
|
||||
// try existing unit in user mode as user
|
||||
{"syncthing", ErrValueNotSet, Options{UserMode: true}, true},
|
||||
// try existing unit in user mode as user (loaded, so NRestarts=0 is valid)
|
||||
{"syncthing", nil, Options{UserMode: true}, true},
|
||||
// try existing unit in system mode as user
|
||||
{"nginx", nil, Options{UserMode: false}, true},
|
||||
|
||||
|
||||
31
structs.go
31
structs.go
@@ -1,7 +1,7 @@
|
||||
//go:build linux
|
||||
|
||||
package systemctl
|
||||
|
||||
import "strings"
|
||||
|
||||
type Options struct {
|
||||
UserMode bool
|
||||
}
|
||||
@@ -13,3 +13,30 @@ type Unit struct {
|
||||
Sub string
|
||||
Description string
|
||||
}
|
||||
|
||||
// UnitTypes contains all valid systemd unit type suffixes.
|
||||
var UnitTypes = []string{
|
||||
"automount",
|
||||
"device",
|
||||
"mount",
|
||||
"path",
|
||||
"scope",
|
||||
"service",
|
||||
"slice",
|
||||
"snapshot",
|
||||
"socket",
|
||||
"swap",
|
||||
"target",
|
||||
"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
|
||||
}
|
||||
|
||||
211
systemctl.go
211
systemctl.go
@@ -1,11 +1,7 @@
|
||||
//go:build linux
|
||||
|
||||
package systemctl
|
||||
|
||||
import (
|
||||
"context"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/taigrr/systemctl/properties"
|
||||
)
|
||||
@@ -16,13 +12,10 @@ import (
|
||||
// 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
|
||||
//
|
||||
// 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.
|
||||
@@ -30,13 +23,10 @@ func DaemonReload(ctx context.Context, opts Options) error {
|
||||
// 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,
|
||||
// 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
|
||||
//
|
||||
// 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.
|
||||
@@ -44,13 +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
|
||||
// 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
|
||||
//
|
||||
// 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.
|
||||
@@ -59,38 +46,20 @@ func Disable(ctx context.Context, unit string, opts Options) error {
|
||||
// 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
|
||||
//
|
||||
// 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).
|
||||
//
|
||||
// Returns true if the unit is active, false if inactive or failed.
|
||||
// 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")
|
||||
switch stdout {
|
||||
case "inactive":
|
||||
return false, nil
|
||||
case "active":
|
||||
return true, nil
|
||||
case "failed":
|
||||
return false, nil
|
||||
case "activating":
|
||||
return false, nil
|
||||
default:
|
||||
return false, err
|
||||
}
|
||||
//
|
||||
// Any additional arguments are passed directly to the systemctl command.
|
||||
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).
|
||||
@@ -102,60 +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
|
||||
// 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")
|
||||
switch stdout {
|
||||
case "enabled":
|
||||
return true, nil
|
||||
case "enabled-runtime":
|
||||
return true, nil
|
||||
case "linked":
|
||||
return false, ErrLinked
|
||||
case "linked-runtime":
|
||||
return false, ErrLinked
|
||||
case "alias":
|
||||
return true, nil
|
||||
case "masked":
|
||||
return false, ErrMasked
|
||||
case "masked-runtime":
|
||||
return false, ErrMasked
|
||||
case "static":
|
||||
return true, nil
|
||||
case "indirect":
|
||||
return true, nil
|
||||
case "disabled":
|
||||
return false, nil
|
||||
case "generated":
|
||||
return true, nil
|
||||
case "transient":
|
||||
return true, nil
|
||||
}
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return false, ErrUnspecified
|
||||
//
|
||||
// Any additional arguments are passed directly to the systemctl command.
|
||||
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.
|
||||
func IsFailed(ctx context.Context, unit string, opts Options) (bool, error) {
|
||||
args := []string{"is-failed", "--system", unit}
|
||||
if opts.UserMode {
|
||||
args[1] = "--user"
|
||||
}
|
||||
stdout, _, _, err := execute(ctx, args)
|
||||
if matched, _ := regexp.MatchString(`inactive`, stdout); matched {
|
||||
return false, nil
|
||||
} else if matched, _ := regexp.MatchString(`active`, stdout); matched {
|
||||
return false, nil
|
||||
} else if matched, _ := regexp.MatchString(`failed`, stdout); matched {
|
||||
return true, nil
|
||||
}
|
||||
return false, err
|
||||
//
|
||||
// Any additional arguments are passed directly to the systemctl command.
|
||||
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
|
||||
@@ -164,71 +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
|
||||
// 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
|
||||
//
|
||||
// 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.
|
||||
// If the units are not running yet, they will be started.
|
||||
func Restart(ctx context.Context, unit string, opts Options) error {
|
||||
args := []string{"restart", "--system", unit}
|
||||
if opts.UserMode {
|
||||
args[1] = "--user"
|
||||
}
|
||||
_, _, _, err := execute(ctx, args)
|
||||
return err
|
||||
//
|
||||
// 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
|
||||
// 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) {
|
||||
args := []string{"show", "--system", unit, "--property", string(property)}
|
||||
if opts.UserMode {
|
||||
args[1] = "--user"
|
||||
}
|
||||
stdout, _, _, err := execute(ctx, args)
|
||||
stdout = strings.TrimPrefix(stdout, string(property)+"=")
|
||||
stdout = strings.TrimSuffix(stdout, "\n")
|
||||
return stdout, err
|
||||
//
|
||||
// Any additional arguments are passed directly to the systemctl command.
|
||||
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
|
||||
func Start(ctx context.Context, unit string, opts Options) error {
|
||||
args := []string{"start", "--system", unit}
|
||||
if opts.UserMode {
|
||||
args[1] = "--user"
|
||||
}
|
||||
_, _, _, err := execute(ctx, args)
|
||||
return err
|
||||
//
|
||||
// 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
|
||||
// `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
|
||||
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
|
||||
//
|
||||
// Any additional arguments are passed directly to the systemctl command.
|
||||
func Status(ctx context.Context, unit string, opts Options, args ...string) (string, error) {
|
||||
return status(ctx, unit, opts, args...)
|
||||
}
|
||||
|
||||
// Stop (deactivate) a given unit
|
||||
func Stop(ctx context.Context, unit string, opts Options) error {
|
||||
args := []string{"stop", "--system", unit}
|
||||
if opts.UserMode {
|
||||
args[1] = "--user"
|
||||
}
|
||||
_, _, _, err := execute(ctx, args)
|
||||
return err
|
||||
//
|
||||
// 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.
|
||||
@@ -238,11 +144,8 @@ func Stop(ctx context.Context, unit string, opts Options) error {
|
||||
// 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
|
||||
//
|
||||
// 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...)
|
||||
}
|
||||
|
||||
65
systemctl_darwin.go
Normal file
65
systemctl_darwin.go
Normal file
@@ -0,0 +1,65 @@
|
||||
//go:build !linux
|
||||
|
||||
package systemctl
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/taigrr/systemctl/properties"
|
||||
)
|
||||
|
||||
func daemonReload(_ context.Context, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func reenable(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func disable(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func enable(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func isActive(_ context.Context, _ string, _ Options, _ ...string) (bool, error) {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
func isEnabled(_ context.Context, _ string, _ Options, _ ...string) (bool, error) {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
func isFailed(_ context.Context, _ string, _ Options, _ ...string) (bool, error) {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
func mask(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func restart(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func show(_ context.Context, _ string, _ properties.Property, _ Options, _ ...string) (string, error) {
|
||||
return "", nil
|
||||
}
|
||||
|
||||
func start(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func status(_ context.Context, _ string, _ Options, _ ...string) (string, error) {
|
||||
return "", nil
|
||||
}
|
||||
|
||||
func stop(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func unmask(_ context.Context, _ string, _ Options, _ ...string) error {
|
||||
return nil
|
||||
}
|
||||
149
systemctl_linux.go
Normal file
149
systemctl_linux.go
Normal file
@@ -0,0 +1,149 @@
|
||||
//go:build linux
|
||||
|
||||
package systemctl
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
|
||||
"github.com/taigrr/systemctl/properties"
|
||||
)
|
||||
|
||||
func daemonReload(ctx context.Context, opts Options, args ...string) error {
|
||||
a := prepareArgs("daemon-reload", opts, args...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func reenable(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("reenable", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func disable(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("disable", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func enable(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("enable", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func isActive(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
|
||||
a := prepareArgs("is-active", opts, append([]string{unit}, args...)...)
|
||||
stdout, _, _, err := execute(ctx, a)
|
||||
stdout = strings.TrimSuffix(stdout, "\n")
|
||||
switch stdout {
|
||||
case "inactive":
|
||||
return false, nil
|
||||
case "active":
|
||||
return true, nil
|
||||
case "failed":
|
||||
return false, nil
|
||||
case "activating":
|
||||
return false, nil
|
||||
default:
|
||||
return false, err
|
||||
}
|
||||
}
|
||||
|
||||
func isEnabled(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
|
||||
a := prepareArgs("is-enabled", opts, append([]string{unit}, args...)...)
|
||||
stdout, _, _, err := execute(ctx, a)
|
||||
stdout = strings.TrimSuffix(stdout, "\n")
|
||||
switch stdout {
|
||||
case "enabled":
|
||||
return true, nil
|
||||
case "enabled-runtime":
|
||||
return true, nil
|
||||
case "linked":
|
||||
return false, ErrLinked
|
||||
case "linked-runtime":
|
||||
return false, ErrLinked
|
||||
case "alias":
|
||||
return true, nil
|
||||
case "masked":
|
||||
return false, ErrMasked
|
||||
case "masked-runtime":
|
||||
return false, ErrMasked
|
||||
case "static":
|
||||
return true, nil
|
||||
case "indirect":
|
||||
return true, nil
|
||||
case "disabled":
|
||||
return false, nil
|
||||
case "generated":
|
||||
return true, nil
|
||||
case "transient":
|
||||
return true, nil
|
||||
}
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return false, ErrUnspecified
|
||||
}
|
||||
|
||||
func isFailed(ctx context.Context, unit string, opts Options, args ...string) (bool, error) {
|
||||
a := prepareArgs("is-failed", opts, append([]string{unit}, args...)...)
|
||||
stdout, _, _, err := execute(ctx, a)
|
||||
stdout = strings.TrimSuffix(stdout, "\n")
|
||||
switch stdout {
|
||||
case "inactive":
|
||||
return false, nil
|
||||
case "active":
|
||||
return false, nil
|
||||
case "failed":
|
||||
return true, nil
|
||||
default:
|
||||
return false, err
|
||||
}
|
||||
}
|
||||
|
||||
func mask(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("mask", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func restart(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("restart", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func show(ctx context.Context, unit string, property properties.Property, opts Options, args ...string) (string, error) {
|
||||
extra := append([]string{unit, "--property", string(property)}, args...)
|
||||
a := prepareArgs("show", opts, extra...)
|
||||
stdout, _, _, err := execute(ctx, a)
|
||||
stdout = strings.TrimPrefix(stdout, string(property)+"=")
|
||||
stdout = strings.TrimSuffix(stdout, "\n")
|
||||
return stdout, err
|
||||
}
|
||||
|
||||
func start(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("start", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func status(ctx context.Context, unit string, opts Options, args ...string) (string, error) {
|
||||
a := prepareArgs("status", opts, append([]string{unit}, args...)...)
|
||||
stdout, _, _, err := execute(ctx, a)
|
||||
return stdout, err
|
||||
}
|
||||
|
||||
func stop(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("stop", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
|
||||
func unmask(ctx context.Context, unit string, opts Options, args ...string) error {
|
||||
a := prepareArgs("unmask", opts, append([]string{unit}, args...)...)
|
||||
_, _, _, err := execute(ctx, a)
|
||||
return err
|
||||
}
|
||||
@@ -290,7 +290,7 @@ func TestMask(t *testing.T) {
|
||||
// try existing unit in user mode as user
|
||||
{"syncthing", nil, Options{UserMode: true}, true},
|
||||
// try nonexisting unit in system mode as user
|
||||
{"nonexistant", ErrDoesNotExist, Options{UserMode: false}, true},
|
||||
{"nonexistant", ErrInsufficientPermissions, Options{UserMode: false}, true},
|
||||
// try existing unit in system mode as user
|
||||
{"nginx", ErrInsufficientPermissions, Options{UserMode: false}, true},
|
||||
|
||||
@@ -521,7 +521,7 @@ func TestUnmask(t *testing.T) {
|
||||
// try existing unit in user mode as user
|
||||
{"syncthing", nil, Options{UserMode: true}, true},
|
||||
// try nonexisting unit in system mode as user
|
||||
{"nonexistant", ErrDoesNotExist, Options{UserMode: false}, true},
|
||||
{"nonexistant", ErrInsufficientPermissions, Options{UserMode: false}, true},
|
||||
// try existing unit in system mode as user
|
||||
{"nginx", ErrInsufficientPermissions, Options{UserMode: false}, true},
|
||||
|
||||
|
||||
43
util.go
43
util.go
@@ -1,5 +1,3 @@
|
||||
//go:build linux
|
||||
|
||||
package systemctl
|
||||
|
||||
import (
|
||||
@@ -13,6 +11,7 @@ import (
|
||||
|
||||
var systemctl string
|
||||
|
||||
// killed is the exit code returned when a process is terminated by SIGINT.
|
||||
const killed = 130
|
||||
|
||||
func init() {
|
||||
@@ -41,6 +40,10 @@ func execute(ctx context.Context, args []string) (string, string, int, error) {
|
||||
warnings = stderr.String()
|
||||
code = cmd.ProcessState.ExitCode()
|
||||
|
||||
if code == killed {
|
||||
return output, warnings, code, ErrExecTimeout
|
||||
}
|
||||
|
||||
customErr := filterErr(warnings)
|
||||
if customErr != nil {
|
||||
err = customErr
|
||||
@@ -52,16 +55,28 @@ func execute(ctx context.Context, args []string) (string, string, int, error) {
|
||||
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 {
|
||||
// Order matters: check higher-priority errors first.
|
||||
// For example, `systemctl mask nginx` as a non-root user on a system
|
||||
// without nginx prints both "does not exist, proceeding anyway" (a
|
||||
// warning) and "Interactive authentication required" (the real error).
|
||||
// Permission and bus errors must be checked before "does not exist" so
|
||||
// the actual failure reason is returned.
|
||||
switch {
|
||||
case strings.Contains(stderr, `does not exist`):
|
||||
return errors.Join(ErrDoesNotExist, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `not found.`):
|
||||
return errors.Join(ErrDoesNotExist, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `not loaded.`):
|
||||
return errors.Join(ErrUnitNotLoaded, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `No such file or directory`):
|
||||
return errors.Join(ErrDoesNotExist, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `Interactive authentication required`):
|
||||
return errors.Join(ErrInsufficientPermissions, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `Access denied`):
|
||||
@@ -70,6 +85,14 @@ func filterErr(stderr string) error {
|
||||
return errors.Join(ErrBusFailure, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `is masked`):
|
||||
return errors.Join(ErrMasked, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `does not exist`):
|
||||
return errors.Join(ErrDoesNotExist, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `not found.`):
|
||||
return errors.Join(ErrDoesNotExist, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `not loaded.`):
|
||||
return errors.Join(ErrUnitNotLoaded, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `No such file or directory`):
|
||||
return errors.Join(ErrDoesNotExist, fmt.Errorf("stderr: %s", stderr))
|
||||
case strings.Contains(stderr, `Failed`):
|
||||
return errors.Join(ErrUnspecified, fmt.Errorf("stderr: %s", stderr))
|
||||
default:
|
||||
|
||||
62
util_test.go
Normal file
62
util_test.go
Normal 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)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user