Merge pull request #614 from cbosdo/backup-fix

Fix backup handling of images and systemd files.

Author: deneb-alpha

mgradm/cmd/backup/create/create.go

@@ -161,8 +161,16 @@ func gatherContainerImagesToBackup(skipImages bool) []string {
 
 	if !skipImages {
 		for _, service := range utils.UyuniServices {
-			if present, err := podman.IsImagePresent(service.Image.Name); err == nil && len(present) > 0 {
-				images = append(images, service.Image.Name)
+			serviceName, skip := findService(service.Name)
+			if skip {
+				continue
+			}
+			image := podman.GetServiceImage(serviceName)
+			if image != "" {
+				present, err := podman.IsImagePresent(image)
+				if err == nil && len(present) > 0 {
+					images = append(images, image)
+				}
 			}
 		}
 	}

mgradm/cmd/backup/create/systemd_utils.go

@@ -10,6 +10,7 @@ import (
 	"io"
 	"os"
 	"path"
+	"strings"
 
 	"github.com/rs/zerolog/log"
 	backup "github.com/uyuni-project/uyuni-tools/mgradm/cmd/backup/shared"
@@ -76,20 +77,20 @@ func gatherSystemdItems() []string {
 			continue
 		}
 
-		result = append(result, podman.GetServicePath(serviceName))
-		// For single mandatory replica following returns 0 so loop is skipped
-		for i := 0; i < systemd.CurrentReplicaCount(service.Name); i++ {
-			result = append(result, podman.GetServicePath(fmt.Sprintf("%s%d", serviceName, i)))
-		}
-		serviceConfDir := podman.GetServiceConfFolder(serviceName)
-		serviceFiles, err := os.ReadDir(serviceConfDir)
+		servicePath, err := systemd.GetServiceProperty(serviceName, podman.FragmentPath)
 		if err != nil {
-			log.Debug().Msgf("Service configuration directory %s not found, skipping", serviceConfDir)
+			log.Debug().Err(err).Msgf("failed to get the path to the %s service file", serviceName)
+			// Skipping the dropins since we would likely get a similar error.
 			continue
 		}
-		result = append(result, serviceConfDir)
-		for _, entry := range serviceFiles {
-			result = append(result, path.Join(serviceConfDir, entry.Name()))
+		result = append(result, servicePath)
+
+		// Get the drop in files
+		dropIns, err := systemd.GetServiceProperty(serviceName, podman.DropInPaths)
+		if err != nil {
+			log.Debug().Err(err).Msgf("failed to get the path to the %s service configuration files", serviceName)
+		} else {
+			result = append(result, strings.Split(dropIns, " ")...)
 		}
 	}
 	return result

mgradm/shared/templates/salineServiceTemplate.go

@@ -42,7 +42,7 @@ ExecStart=/bin/sh -c '/usr/bin/podman run \
 	{{- end }}
 	-e TZ=${TZ} \
 	-e NOSSL=YES \
-	${PODMAN_EXTRA_ARGS} ${UYUNI_SALINE_IMAGE}'
+	${UYUNI_SALINE_IMAGE}'
 ExecStop=/usr/bin/podman stop --ignore -t 10 --cidfile=%t/%n.ctr-id
 ExecStopPost=/usr/bin/podman rm -f --ignore -t 10 --cidfile=%t/%n.ctr-id
 PIDFile=%t/uyuni-saline.pid

shared/podman/images.go

@@ -12,6 +12,7 @@ import (
 	"net/url"
 	"os"
 	"path"
+	"path/filepath"
 	"regexp"
 	"strings"
 
@@ -226,7 +227,7 @@ func loadRpmImage(rpmImageBasePath string) (string, error) {
 	return "", fmt.Errorf(L("error parsing: %s"), string(out))
 }
 
-// IsImagePresent return true if the image is present.
+// IsImagePresent returns the image name if the image is present.
 func IsImagePresent(image string) (string, error) {
 	log.Debug().Msgf("Checking for %s", image)
 	out, err := utils.RunCmdOutput(zerolog.DebugLevel, "podman", "images", "--format={{ .Repository }}", image)
@@ -354,18 +355,21 @@ func DeleteImage(name string, dryRun bool) error {
 	return nil
 }
 
+var newRunner = utils.NewRunner
+
 // ExportImage saves a podman image based on its name to a specified directory.
 // outputDir option expects already existing directory.
 // If dryRun is set to true, nothing will be done, only messages logged to explain what would happen.
 func ExportImage(name string, outputDir string, dryRun bool) error {
 	exists := imageExists(name)
 	if exists {
-		saveCommand := []string{"podman", "image", "save", "--quiet", "-o", path.Join(outputDir, name+".tar"), name}
+		baseName, _, _ := strings.Cut(filepath.Base(name), ":")
+		saveCommand := []string{"podman", "image", "save", "--quiet", "-o", path.Join(outputDir, baseName+".tar"), name}
 		if dryRun {
 			log.Info().Msgf(L("Would run %s"), strings.Join(saveCommand, " "))
 		} else {
 			log.Info().Msgf(L("Run %s"), strings.Join(saveCommand, " "))
-			err := utils.RunCmd(saveCommand[0], saveCommand[1:]...)
+			_, err := newRunner(saveCommand[0], saveCommand[1:]...).Exec()
 			if err != nil {
 				return utils.Errorf(err, L("Failed to export image %s"), name)
 			}
@@ -380,12 +384,12 @@ func imageExists(image string) bool {
 }
 
 func RestoreImage(imageFile string, dryRun bool) error {
-	restoreCommand := []string{"podman", "image", "import", "--quiet", imageFile}
+	restoreCommand := []string{"podman", "image", "load", "--quiet", "-i", imageFile}
 	if dryRun {
 		log.Info().Msgf(L("Would run %s"), strings.Join(restoreCommand, " "))
 	} else {
 		log.Info().Msgf(L("Run %s"), strings.Join(restoreCommand, " "))
-		err := utils.RunCmd(restoreCommand[0], restoreCommand[1:]...)
+		_, err := newRunner(restoreCommand[0], restoreCommand[1:]...).Exec()
 		if err != nil {
 			return utils.Errorf(err, L("Failed to restore image %s"), imageFile)
 		}

shared/podman/interfaces.go

@@ -1,9 +1,17 @@
-// SPDX-FileCopyrightText: 2024 SUSE LLC
+// SPDX-FileCopyrightText: 2025 SUSE LLC
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package podman
 
+const (
+	// FragmentPath is a systemd property containing the path of the service file.
+	FragmentPath = "FragmentPath"
+
+	// DropInPaths is a systemd property containing the paths of the service configuration file separated by a space.
+	DropInPaths = "DropInPaths"
+)
+
 // Systemd is an interface providing systemd operations.
 type Systemd interface {
 
@@ -65,4 +73,7 @@ type Systemd interface {
 
 	// GetServicesFromSystemdFiles return the uyuni enabled services as string list.
 	GetServicesFromSystemdFiles(systemdFileList string) []string
+
+	// GetServiceProperty returns the value of a systemd service property.
+	GetServiceProperty(service string, property string) (string, error)
 }

shared/podman/systemd.go

@@ -73,6 +73,18 @@ func GetServicePath(name string) string {
 	return path.Join(servicesPath, name+".service")
 }
 
+func (s SystemdImpl) GetServiceProperty(service string, property string) (string, error) {
+	serviceName := service
+	if strings.HasSuffix(service, "@") {
+		serviceName = service + "0"
+	}
+	out, err := newRunner("systemctl", "show", "-p", property, serviceName).Exec()
+	if err != nil {
+		return "", utils.Errorf(err, L("Failed to get the %[1]s property from %[2]s service"), property, service)
+	}
+	return strings.TrimPrefix(strings.TrimSpace(string(out)), property+"="), nil
+}
+
 // GetServiceConfFolder return the conf folder for systemd services.
 func GetServiceConfFolder(name string) string {
 	return path.Join(servicesPath, name+".service.d")

shared/podman/systemd_test.go

@@ -1,12 +1,14 @@
-// SPDX-FileCopyrightText: 2024 SUSE LLC
+// SPDX-FileCopyrightText: 2025 SUSE LLC
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package podman
 
 import (
+	"errors"
 	"os"
 	"path"
+	"strings"
 	"testing"
 
 	"github.com/uyuni-project/uyuni-tools/shared/testutils"
@@ -91,3 +93,21 @@ Environment="PODMAN_EXTRA_ARGS="
 	actual = testutils.ReadFile(t, path.Join(serviceConfDir, "custom.conf"))
 	testutils.AssertEquals(t, "invalid custom.conf file", customFile, actual)
 }
+
+func TestGetServiceProperty(t *testing.T) {
+	newRunner = testutils.FakeRunnerGenerator("TestProperty=foo bar\n", nil)
+	tested := SystemdImpl{}
+	actual, err := tested.GetServiceProperty("myservice", "TestProperty")
+	testutils.AssertTrue(t, "No error expected", err == nil)
+	testutils.AssertEquals(t, "Wrong expected property", "foo bar", actual)
+}
+
+func TestGetServicePropertyError(t *testing.T) {
+	newRunner = testutils.FakeRunnerGenerator("", errors.New("Test error"))
+	tested := SystemdImpl{}
+	actual, err := tested.GetServiceProperty("myservice", "TestProperty")
+	testutils.AssertTrue(t, "Error message missing the root error message", strings.Contains(err.Error(), "Test error"))
+	testutils.AssertTrue(t, "Unexpected error description",
+		strings.Contains(err.Error(), "Failed to get the TestProperty property from myservice service"))
+	testutils.AssertEquals(t, "Wrong expected property", "", actual)
+}

shared/podman/utils.go

@@ -146,10 +146,10 @@ func GetServiceImage(service string) string {
 		return ""
 	}
 
-	imageFinder := regexp.MustCompile(`UYUNI_IMAGE=(.*)`)
+	imageFinder := regexp.MustCompile(`UYUNI.*_IMAGE=(.*)`)
 	matches := imageFinder.FindStringSubmatch(string(out))
 	if len(matches) < 2 {
-		log.Warn().Msgf(L("no UYUNI_IMAGE defined in %s systemd service"), service)
+		log.Warn().Msgf(L("no UYUNI.*_IMAGE defined in %s systemd service"), service)
 		return ""
 	}
 	return matches[1]

shared/testutils/runner.go

@@ -0,0 +1,47 @@
+// SPDX-FileCopyrightText: 2025 SUSE LLC
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package testutils
+
+import (
+	"github.com/rs/zerolog"
+	"github.com/uyuni-project/uyuni-tools/shared/types"
+)
+
+type fakeRunner struct {
+	out []byte
+	err error
+}
+
+func (r fakeRunner) Log(_ zerolog.Level) types.Runner {
+	return r
+}
+
+func (r fakeRunner) Spinner(_ string) types.Runner {
+	return r
+}
+
+func (r fakeRunner) StdMapping() types.Runner {
+	return r
+}
+
+func (r fakeRunner) Env(_ []string) types.Runner {
+	return r
+}
+
+func (r fakeRunner) Exec() ([]byte, error) {
+	return r.out, r.err
+}
+
+// FakeRunnerGenerator creates NewRunner function generating a FakeRunner.
+// out and err are the returns of the mocked Exec().
+func FakeRunnerGenerator(out string, err error) func(string, ...string) types.Runner {
+	return func(_ string, _ ...string) types.Runner {
+		runner := fakeRunner{
+			out: []byte(out),
+			err: err,
+		}
+		return runner
+	}
+}

shared/types/runner.go

@@ -0,0 +1,28 @@
+// SPDX-FileCopyrightText: 2025 SUSE LLC
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package types
+
+import "github.com/rs/zerolog"
+
+// Runner is an interface to execute system calls.
+type Runner interface {
+	// Log sets the log level of the output.
+	Log(logLevel zerolog.Level) Runner
+
+	// Spinner sets a spinner with its message.
+	// If no message is passed, the command will be used.
+	Spinner(message string) Runner
+
+	// StdMapping maps the process output and error streams to the standard ones.
+	// This is useful to show the process output in the console and the logs and can be combined with Log().
+	StdMapping() Runner
+
+	// Env sets environment variables to use for the command.
+	Env(env []string) Runner
+
+	// Exec really executes the command and returns its output and error.
+	// The error output to used as error message if the StdMapping() function wasn't called.
+	Exec() ([]byte, error)
+}