dbus: added new dbus methods

implemented new dbus methods:
* ListUnitsFiltered
* ListUnitsByPatterns
* ListUnitsByNames
* ListUnitFilesByPatterns

refactored legacy ListUnits and ListUnitFiles functions

Author: kayrus

dbus/methods.go

@@ -239,12 +239,11 @@ type UnitStatus struct {
 	JobPath     dbus.ObjectPath // The job object path
 }
 
-// ListUnits returns an array with all currently loaded units. Note that
-// units may be known by multiple names at the same time, and hence there might
-// be more unit names loaded than actual units behind them.
-func (c *Conn) ListUnits() ([]UnitStatus, error) {
+type storeFunc func(retvalues ...interface{}) error
+
+func (c *Conn) listUnitsInternal(f storeFunc) ([]UnitStatus, error) {
 	result := make([][]interface{}, 0)
-	err := c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnits", 0).Store(&result)
+	err := f(&result)
 	if err != nil {
 		return nil, err
 	}
@@ -268,15 +267,43 @@ func (c *Conn) ListUnits() ([]UnitStatus, error) {
 	return status, nil
 }
 
+// ListUnits returns an array with all currently loaded units. Note that
+// units may be known by multiple names at the same time, and hence there might
+// be more unit names loaded than actual units behind them.
+func (c *Conn) ListUnits() ([]UnitStatus, error) {
+	return c.listUnitsInternal(c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnits", 0).Store)
+}
+
+// ListUnitsFiltered returns an array with units filtered by state.
+// It takes a list of units' statuses to filter.
+func (c *Conn) ListUnitsFiltered(states []string) ([]UnitStatus, error) {
+	return c.listUnitsInternal(c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnitsFiltered", 0, states).Store)
+}
+
+// ListUnitsByPatterns returns an array with units.
+// It takes a list of units' statuses and names to filter.
+// Note that units may be known by multiple names at the same time,
+// and hence there might be more unit names loaded than actual units behind them.
+func (c *Conn) ListUnitsByPatterns(states []string, patterns []string) ([]UnitStatus, error) {
+	return c.listUnitsInternal(c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnitsByPatterns", 0, states, patterns).Store)
+}
+
+// ListUnitsByNames returns an array with units. It takes a list of units'
+// names and returns an UnitStatus array. Comparing to ListUnitsByPatterns
+// method, this method returns statuses even for inactive or non-existing
+// units. Input array should contain exact unit names, but not patterns.
+func (c *Conn) ListUnitsByNames(units []string) ([]UnitStatus, error) {
+	return c.listUnitsInternal(c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnitsByNames", 0, units).Store)
+}
+
 type UnitFile struct {
 	Path string
 	Type string
 }
 
-// ListUnitFiles returns an array of all available units on disk.
-func (c *Conn) ListUnitFiles() ([]UnitFile, error) {
+func (c *Conn) listUnitFilesInternal(f storeFunc) ([]UnitFile, error) {
 	result := make([][]interface{}, 0)
-	err := c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnitFiles", 0).Store(&result)
+	err := f(&result)
 	if err != nil {
 		return nil, err
 	}
@@ -300,6 +327,16 @@ func (c *Conn) ListUnitFiles() ([]UnitFile, error) {
 	return files, nil
 }
 
+// ListUnitFiles returns an array of all available units on disk.
+func (c *Conn) ListUnitFiles() ([]UnitFile, error) {
+	return c.listUnitFilesInternal(c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnitFiles", 0).Store)
+}
+
+// ListUnitFilesByPatterns returns an array of all available units on disk matched the patterns.
+func (c *Conn) ListUnitFilesByPatterns(states []string, patterns []string) ([]UnitFile, error) {
+	return c.listUnitFilesInternal(c.sysobj.Call("org.freedesktop.systemd1.Manager.ListUnitFilesByPatterns", 0, states, patterns).Store)
+}
+
 type LinkUnitFileChange EnableUnitFileChange
 
 // LinkUnitFiles() links unit files (that are located outside of the

dbus/methods_test.go

@@ -18,6 +18,7 @@ import (
 	"fmt"
 	"math/rand"
 	"os"
+	"path"
 	"path/filepath"
 	"reflect"
 	"testing"
@@ -96,6 +97,7 @@ func TestStartStopUnit(t *testing.T) {
 	for _, u := range units {
 		if u.Name == target {
 			unit = &u
+			break
 		}
 	}
 
@@ -122,6 +124,7 @@ func TestStartStopUnit(t *testing.T) {
 	for _, u := range units {
 		if u.Name == target {
 			unit = &u
+			break
 		}
 	}
 
@@ -130,6 +133,238 @@ func TestStartStopUnit(t *testing.T) {
 	}
 }
 
+// Ensure that ListUnitsByNames works.
+func TestListUnitsByNames(t *testing.T) {
+	target1 := "systemd-journald.service"
+	target2 := "unexisting.service"
+
+	conn := setupConn(t)
+
+	units, err := conn.ListUnitsByNames([]string{target1, target2})
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var unit *UnitStatus
+	for _, u := range units {
+		if u.Name == target1 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target1)
+	}
+
+	if unit.ActiveState != "active" {
+		t.Fatalf("%s unit should be active but it is %s", target1, unit.ActiveState)
+	}
+
+	unit = nil
+	for _, u := range units {
+		if u.Name == target2 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("Unexisting test unit not found in list")
+	}
+
+	if unit.ActiveState != "inactive" {
+		t.Fatalf("Test unit should be inactive")
+	}
+}
+
+// Ensure that ListUnitsByPatterns works.
+func TestListUnitsByPatterns(t *testing.T) {
+	target1 := "systemd-journald.service"
+	target2 := "unexisting.service"
+
+	conn := setupConn(t)
+
+	units, err := conn.ListUnitsByPatterns([]string{}, []string{"systemd-journald*", target2})
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var unit *UnitStatus
+	for _, u := range units {
+		if u.Name == target1 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target1)
+	}
+
+	if unit.ActiveState != "active" {
+		t.Fatalf("Test unit should be active")
+	}
+
+	unit = nil
+	for _, u := range units {
+		if u.Name == target2 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit != nil {
+		t.Fatalf("Unexisting test unit found in list")
+	}
+}
+
+// Ensure that ListUnitsFiltered works.
+func TestListUnitsFiltered(t *testing.T) {
+	target := "systemd-journald.service"
+
+	conn := setupConn(t)
+
+	units, err := conn.ListUnitsFiltered([]string{"active"})
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var unit *UnitStatus
+	for _, u := range units {
+		if u.Name == target {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target)
+	}
+
+	if unit.ActiveState != "active" {
+		t.Fatalf("Test unit should be active")
+	}
+
+	units, err = conn.ListUnitsFiltered([]string{"inactive"})
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	unit = nil
+	for _, u := range units {
+		if u.Name == target {
+			unit = &u
+			break
+		}
+	}
+
+	if unit != nil {
+		t.Fatalf("Inactive unit should not be found in list")
+	}
+}
+
+// Ensure that ListUnitFilesByPatterns works.
+func TestListUnitFilesByPatterns(t *testing.T) {
+	target1 := "systemd-journald.service"
+	target2 := "exit.target"
+
+	conn := setupConn(t)
+
+	units, err := conn.ListUnitFilesByPatterns([]string{"static"}, []string{"systemd-journald*", target2})
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var unit *UnitFile
+	for _, u := range units {
+		if path.Base(u.Path) == target1 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target1)
+	}
+
+	if unit.Type != "static" {
+		t.Fatalf("Test unit file should be static")
+	}
+
+	units, err = conn.ListUnitFilesByPatterns([]string{"disabled"}, []string{"systemd-journald*", target2})
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	unit = nil
+	for _, u := range units {
+		if path.Base(u.Path) == target2 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target2)
+	}
+
+	if unit.Type != "disabled" {
+		t.Fatalf("%s unit file should be disabled", target2)
+	}
+}
+
+func TestListUnitFiles(t *testing.T) {
+	target1 := "systemd-journald.service"
+	target2 := "exit.target"
+
+	conn := setupConn(t)
+
+	units, err := conn.ListUnitFiles()
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	var unit *UnitFile
+	for _, u := range units {
+		if path.Base(u.Path) == target1 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target1)
+	}
+
+	if unit.Type != "static" {
+		t.Fatalf("Test unit file should be static")
+	}
+
+	unit = nil
+	for _, u := range units {
+		if path.Base(u.Path) == target2 {
+			unit = &u
+			break
+		}
+	}
+
+	if unit == nil {
+		t.Fatalf("%s unit not found in list", target2)
+	}
+
+	if unit.Type != "disabled" {
+		t.Fatalf("%s unit file should be disabled", target2)
+	}
+}
+
 // Enables a unit and then immediately tears it down
 func TestEnableDisableUnit(t *testing.T) {
 	target := "enable-disable.service"
@@ -302,6 +537,7 @@ func TestStartStopTransientUnit(t *testing.T) {
 	for _, u := range units {
 		if u.Name == target {
 			unit = &u
+			break
 		}
 	}
 
@@ -328,6 +564,7 @@ func TestStartStopTransientUnit(t *testing.T) {
 	for _, u := range units {
 		if u.Name == target {
 			unit = &u
+			break
 		}
 	}