Move handling of deprecated config into resolve method

Author: m90

cmd/backup/config.go

@@ -226,10 +226,11 @@ func (c *Config) applyEnv() (func() error, error) {
 	return unset, nil
 }
 
-func (c *Config) resolve() (func() error, error) {
+func (c *Config) resolve() (func() error, []string, error) {
+	warnings := []string{}
 	resetEnv, err := c.applyEnv()
 	if err != nil {
-		return resetEnv, errwrap.Wrap(err, "error applying env")
+		return resetEnv, warnings, errwrap.Wrap(err, "error applying env")
 	}
 
 	if c.BackupFilenameExpand {
@@ -238,5 +239,40 @@ func (c *Config) resolve() (func() error, error) {
 		c.BackupPruningPrefix = os.ExpandEnv(c.BackupPruningPrefix)
 	}
 
-	return resetEnv, nil
+	if c.EmailNotificationRecipient != "" {
+		emailURL := fmt.Sprintf(
+			"smtp://%s:%s@%s:%d/?from=%s&to=%s",
+			c.EmailSMTPUsername,
+			c.EmailSMTPPassword,
+			c.EmailSMTPHost,
+			c.EmailSMTPPort,
+			c.EmailNotificationSender,
+			c.EmailNotificationRecipient,
+		)
+		c.NotificationURLs = append(c.NotificationURLs, emailURL)
+		warnings = append(warnings,
+			"Using EMAIL_* keys for providing notification configuration has been deprecated and will be removed in the next major version.",
+			"Please use NOTIFICATION_URLS instead. Refer to the README for an upgrade guide.",
+		)
+	}
+
+	if c.BackupFromSnapshot {
+		warnings = append(warnings,
+			"Using BACKUP_FROM_SNAPSHOT has been deprecated and will be removed in the next major version.",
+			"Please use `archive-pre` and `archive-post` commands to prepare your backup sources. Refer to the documentation for an upgrade guide.",
+		)
+	}
+
+	if c.BackupStopDuringBackupLabel != "" && c.BackupStopContainerLabel != "" {
+		return resetEnv, warnings, errwrap.Wrap(nil, "both BACKUP_STOP_DURING_BACKUP_LABEL and BACKUP_STOP_CONTAINER_LABEL have been set, cannot continue")
+	}
+	if c.BackupStopContainerLabel != "" {
+		warnings = append(warnings,
+			"Using BACKUP_STOP_CONTAINER_LABEL has been deprecated and will be removed in the next major version.",
+			"Please use BACKUP_STOP_DURING_BACKUP_LABEL instead. Refer to the docs for an upgrade guide.",
+		)
+		c.BackupStopDuringBackupLabel = c.BackupStopContainerLabel
+	}
+
+	return resetEnv, warnings, nil
 }

cmd/backup/create_archive.go

@@ -18,12 +18,6 @@ func (s *script) createArchive() error {
 	backupSources := s.c.BackupSources
 
 	if s.c.BackupFromSnapshot {
-		s.logger.Warn(
-			"Using BACKUP_FROM_SNAPSHOT has been deprecated and will be removed in the next major version.",
-		)
-		s.logger.Warn(
-			"Please use `archive-pre` and `archive-post` commands to prepare your backup sources. Refer to the documentation for an upgrade guide.",
-		)
 		backupSources = filepath.Join("/tmp", s.c.BackupSources)
 		// copy before compressing guard against a situation where backup folder's content are still growing.
 		s.registerHook(hookLevelPlumbing, func(error) error {

cmd/backup/run_script.go

@@ -43,7 +43,7 @@ func runScript(c *Config) (err error) {
 		}
 	}()
 
-	unset, err := s.c.resolve()
+	unset, warnings, err := s.c.resolve()
 	if err != nil {
 		return errwrap.Wrap(err, "error applying env")
 	}
@@ -52,6 +52,9 @@ func runScript(c *Config) (err error) {
 			err = errors.Join(err, errwrap.Wrap(derr, "error unsetting environment variables"))
 		}
 	}()
+	for _, w := range warnings {
+		s.logger.Warn(w)
+	}
 
 	if s.c != nil && s.c.BackupJitter > 0 {
 		max := s.c.BackupJitter

cmd/backup/script.go

@@ -79,24 +79,6 @@ func (s *script) init() error {
 		return nil
 	})
 	// Register notifications first so they can fire in case of other init errors.
-	if s.c.EmailNotificationRecipient != "" {
-		emailURL := fmt.Sprintf(
-			"smtp://%s:%s@%s:%d/?from=%s&to=%s",
-			s.c.EmailSMTPUsername,
-			s.c.EmailSMTPPassword,
-			s.c.EmailSMTPHost,
-			s.c.EmailSMTPPort,
-			s.c.EmailNotificationSender,
-			s.c.EmailNotificationRecipient,
-		)
-		s.c.NotificationURLs = append(s.c.NotificationURLs, emailURL)
-		s.logger.Warn(
-			"Using EMAIL_* keys for providing notification configuration has been deprecated and will be removed in the next major version.",
-		)
-		s.logger.Warn(
-			"Please use NOTIFICATION_URLS instead. Refer to the README for an upgrade guide.",
-		)
-	}
 
 	hookLevel, ok := hookLevels[s.c.NotificationLevel]
 	if !ok {

cmd/backup/stop_restart.go

@@ -8,7 +8,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"os"
 	"sync"
 	"time"
 
@@ -113,23 +112,9 @@ func (s *script) stopContainersAndServices() (func() error, error) {
 		return noop, errwrap.Wrap(err, "error determining swarm state")
 	}
 
-	labelValue := s.c.BackupStopDuringBackupLabel
-	if s.c.BackupStopContainerLabel != "" {
-		s.logger.Warn(
-			"Using BACKUP_STOP_CONTAINER_LABEL has been deprecated and will be removed in the next major version.",
-		)
-		s.logger.Warn(
-			"Please use BACKUP_STOP_DURING_BACKUP_LABEL instead. Refer to the docs for an upgrade guide.",
-		)
-		if _, ok := os.LookupEnv("BACKUP_STOP_DURING_BACKUP_LABEL"); ok {
-			return noop, errwrap.Wrap(nil, "both BACKUP_STOP_DURING_BACKUP_LABEL and BACKUP_STOP_CONTAINER_LABEL have been set, cannot continue")
-		}
-		labelValue = s.c.BackupStopContainerLabel
-	}
-
 	stopDuringBackupLabel := fmt.Sprintf(
 		"docker-volume-backup.stop-during-backup=%s",
-		labelValue,
+		s.c.BackupStopDuringBackupLabel,
 	)
 
 	stopDuringBackupNoRestartLabel := fmt.Sprintf(
@@ -144,7 +129,7 @@ func (s *script) stopContainersAndServices() (func() error, error) {
 
 	var containersToStop []handledContainer
 	for _, c := range allContainers.Items {
-		hasStopDuringBackupLabel, hasStopDuringBackupNoRestartLabel, err := checkStopLabels(c.Labels, labelValue, s.c.BackupStopDuringBackupNoRestartLabel)
+		hasStopDuringBackupLabel, hasStopDuringBackupNoRestartLabel, err := checkStopLabels(c.Labels, s.c.BackupStopDuringBackupLabel, s.c.BackupStopDuringBackupNoRestartLabel)
 		if err != nil {
 			return noop, errwrap.Wrap(err, "error querying for containers to stop")
 		}
@@ -169,7 +154,7 @@ func (s *script) stopContainersAndServices() (func() error, error) {
 		}
 
 		for _, service := range allServices {
-			hasStopDuringBackupLabel, hasStopDuringBackupNoRestartLabel, err := checkStopLabels(service.Spec.Labels, labelValue, s.c.BackupStopDuringBackupNoRestartLabel)
+			hasStopDuringBackupLabel, hasStopDuringBackupNoRestartLabel, err := checkStopLabels(service.Spec.Labels, s.c.BackupStopDuringBackupLabel, s.c.BackupStopDuringBackupNoRestartLabel)
 			if err != nil {
 				return noop, errwrap.Wrap(err, "error querying for services to scale down")
 			}