renamed "log-commands" to "command-output"

Author: jkellerer

commands.go

@@ -626,8 +626,8 @@ func prepareScheduledProfile(ctx *Context) {
 	if len(s.Log) > 0 {
 		ctx.logTarget = s.Log
 	}
-	if len(s.LogCommands) > 0 {
-		ctx.logCommands = s.LogCommands
+	if len(s.CommandOutput) > 0 {
+		ctx.commandOutput = s.CommandOutput
 	}
 	// battery
 	if s.IgnoreOnBatteryLessThan > 0 && !s.IgnoreOnBattery.IsStrictlyFalse() {

commands_test.go

@@ -288,15 +288,15 @@ func TestShowSchedules(t *testing.T) {
 schedule backup@default:
     at:                   daily
     permission:           auto
-    log-commands:         auto
+    command-output:       auto
     priority:             background
     lock-mode:            default
     capture-environment:  RESTIC_*
 
 schedule check@default:
     at:                   weekly
     permission:           auto
-    log-commands:         auto
+    command-output:       auto
     priority:             background
     lock-mode:            default
     capture-environment:  RESTIC_*

complete.go

@@ -115,8 +115,8 @@ func (c *Completer) completeFlagSetValue(flag *pflag.Flag, word string) (complet
 		fallthrough
 	case "log":
 		completions = []string{RequestFileCompletion}
-	case "log-commands":
-		completions = []string{"auto", "log", "console", "both"}
+	case "command-output":
+		completions = []string{"auto", "log", "console", "all"}
 	}
 
 	completions = c.appendMatches(completions, word, list...)

config/global.go

@@ -27,7 +27,7 @@ type Global struct {
 	Scheduler            string              `mapstructure:"scheduler" description:"Leave blank for the default scheduler or use \"crond\" to select cron on supported operating systems"`
 	ScheduleDefaults     *ScheduleBaseConfig `mapstructure:"schedule-defaults" default:"" description:"Sets defaults for all schedules"`
 	Log                  string              `mapstructure:"log" default:"" examples:"/resticprofile.log;syslog-tcp://syslog-server:514;syslog:server;syslog:" description:"Sets the default log destination to be used if not specified in \"--log\" or \"schedule-log\" - see https://creativeprojects.github.io/resticprofile/configuration/logs/"`
-	LogCommands          string              `mapstructure:"log-commands" default:"auto" enum:"auto;log;console;both" description:"Sets the destination for command output (stderr/stdout). \"log\" sends output to the log file (if specified), \"console\" sends it to the console instead. \"auto\" sends it to \"both\" if console is a terminal otherwise to \"log\" only - see https://creativeprojects.github.io/resticprofile/configuration/logs/"`
+	CommandOutput        string              `mapstructure:"command-output" default:"auto" enum:"auto;log;console;all" description:"Sets the destination for command output (stderr/stdout). \"log\" sends output to the log file (if specified), \"console\" sends it to the console instead. \"auto\" sends it to \"both\" if console is a terminal otherwise to \"log\" only - see https://creativeprojects.github.io/resticprofile/configuration/logs/"`
 	LegacyArguments      bool                `mapstructure:"legacy-arguments" default:"false" deprecated:"0.20.0" description:"Legacy, broken arguments mode of resticprofile before version 0.15"`
 	SystemdUnitTemplate  string              `mapstructure:"systemd-unit-template" default:"" description:"File containing the go template to generate a systemd unit - see https://creativeprojects.github.io/resticprofile/schedules/systemd/"`
 	SystemdTimerTemplate string              `mapstructure:"systemd-timer-template" default:"" description:"File containing the go template to generate a systemd timer - see https://creativeprojects.github.io/resticprofile/schedules/systemd/"`
@@ -48,7 +48,7 @@ func NewGlobal() *Global {
 		ResticLockRetryAfter: constants.DefaultResticLockRetryAfter,
 		ResticStaleLockAge:   constants.DefaultResticStaleLockAge,
 		MinMemory:            constants.DefaultMinMemory,
-		LogCommands:          constants.DefaultLogCommands,
+		CommandOutput:        constants.DefaultCommandOutput,
 		SenderTimeout:        constants.DefaultSenderTimeout,
 	}
 }

config/schedule.go

@@ -36,7 +36,7 @@ const (
 type ScheduleBaseConfig struct {
 	Permission              string         `mapstructure:"permission" default:"auto" enum:"auto;system;user;user_logged_on" description:"Specify whether the schedule runs with system or user privileges - see https://creativeprojects.github.io/resticprofile/schedules/configuration/"`
 	Log                     string         `mapstructure:"log" examples:"/resticprofile.log;syslog-tcp://syslog-server:514;syslog:server;syslog:" description:"Redirect the output into a log file or to syslog when running on schedule - see https://creativeprojects.github.io/resticprofile/configuration/logs/"`
-	LogCommands             string         `mapstructure:"log-commands" default:"auto" enum:"auto;log;console;both" description:"Sets the destination for command output (stderr/stdout). \"log\" sends output to the log file (if specified), \"console\" sends it to the console instead. \"auto\" sends it to \"both\" if console is a terminal otherwise to \"log\" only - see https://creativeprojects.github.io/resticprofile/configuration/logs/"`
+	CommandOutput           string         `mapstructure:"command-output" default:"auto" enum:"auto;log;console;all" description:"Sets the destination for command output (stderr/stdout). \"log\" sends output to the log file (if specified), \"console\" sends it to the console instead. \"auto\" sends it to \"both\" if console is a terminal otherwise to \"log\" only - see https://creativeprojects.github.io/resticprofile/configuration/logs/"`
 	Priority                string         `mapstructure:"priority" default:"background" enum:"background;standard" description:"Set the priority at which the schedule is run"`
 	LockMode                string         `mapstructure:"lock-mode" default:"default" enum:"default;fail;ignore" description:"Specify how locks are used when running on schedule - see https://creativeprojects.github.io/resticprofile/schedules/configuration/"`
 	LockWait                maybe.Duration `mapstructure:"lock-wait" examples:"150s;15m;30m;45m;1h;2h30m" description:"Set the maximum time to wait for acquiring locks when running on schedule"`
@@ -49,11 +49,11 @@ type ScheduleBaseConfig struct {
 
 // scheduleBaseConfigDefaults declares built-in scheduling defaults
 var scheduleBaseConfigDefaults = ScheduleBaseConfig{
-	Permission:  "auto",
-	LogCommands: constants.DefaultLogCommands,
-	Priority:    "background",
-	LockMode:    "default",
-	EnvCapture:  []string{"RESTIC_*"},
+	Permission:    "auto",
+	CommandOutput: constants.DefaultCommandOutput,
+	Priority:      "background",
+	LockMode:      "default",
+	EnvCapture:    []string{"RESTIC_*"},
 }
 
 func (s *ScheduleBaseConfig) init(defaults *ScheduleBaseConfig) {
@@ -67,8 +67,8 @@ func (s *ScheduleBaseConfig) init(defaults *ScheduleBaseConfig) {
 	if s.Log == "" {
 		s.Log = defaults.Log
 	}
-	if s.LogCommands == "" {
-		s.LogCommands = defaults.LogCommands
+	if s.CommandOutput == "" {
+		s.CommandOutput = defaults.CommandOutput
 	}
 	if s.Priority == "" {
 		s.Priority = defaults.Priority

constants/default.go

@@ -18,7 +18,7 @@ const (
 	DefaultVerboseFlag          = false
 	DefaultQuietFlag            = false
 	DefaultMinMemory            = 100
-	DefaultLogCommands          = "auto"
+	DefaultCommandOutput        = "auto"
 	DefaultSenderTimeout        = 30 * time.Second
 	DefaultPrometheusPushFormat = "text"
 	BatteryFull                 = 100

context.go

@@ -29,7 +29,7 @@ type Context struct {
 	schedule      *config.Schedule // when profile is running with run-schedule command
 	sigChan       chan os.Signal   // termination request
 	logTarget     string           // where to send the log output
-	logCommands   string           // where to send the command output when a lotTarget is set
+	commandOutput string           // where to send the command output when a lotTarget is set
 	stopOnBattery int              // stop if running on battery
 	noLock        bool             // skip profile lock file
 	lockWait      time.Duration    // wait up to duration to acquire a lock
@@ -52,16 +52,16 @@ func CreateContext(flags commandLineFlags, global *config.Global, cfg *config.Co
 			group:     "",
 			schedule:  "",
 		},
-		flags:       flags,
-		global:      global,
-		config:      cfg,
-		binary:      "",
-		command:     "",
-		profile:     nil,
-		schedule:    nil,
-		sigChan:     nil,
-		logTarget:   global.Log, // default to global (which can be empty)
-		logCommands: global.LogCommands,
+		flags:         flags,
+		global:        global,
+		config:        cfg,
+		binary:        "",
+		command:       "",
+		profile:       nil,
+		schedule:      nil,
+		sigChan:       nil,
+		logTarget:     global.Log, // default to global (which can be empty)
+		commandOutput: global.CommandOutput,
 	}
 	// own commands can check the context before running
 	if ownCommands.Exists(command, true) {
@@ -74,8 +74,8 @@ func CreateContext(flags commandLineFlags, global *config.Global, cfg *config.Co
 	if flags.log != "" {
 		ctx.logTarget = flags.log
 	}
-	if flags.logCommands != "" {
-		ctx.logCommands = flags.logCommands
+	if flags.commandOutput != "" {
+		ctx.commandOutput = flags.commandOutput
 	}
 	// same for battery configuration
 	if flags.ignoreOnBattery > 0 {

flags.go

@@ -24,7 +24,7 @@ type commandLineFlags struct {
 	format          string
 	name            string
 	log             string // file path or log url
-	logCommands     string
+	commandOutput   string
 	dryRun          bool
 	noLock          bool
 	lockWait        time.Duration
@@ -81,7 +81,7 @@ func loadFlags(args []string) (*pflag.FlagSet, commandLineFlags, error) {
 		format:          envValueOverride("", "RESTICPROFILE_FORMAT"),
 		name:            envValueOverride(constants.DefaultProfileName, "RESTICPROFILE_NAME"),
 		log:             envValueOverride("", "RESTICPROFILE_LOG"),
-		logCommands:     envValueOverride(constants.DefaultLogCommands, "RESTICPROFILE_LOG_COMMANDS"),
+		commandOutput:   envValueOverride(constants.DefaultCommandOutput, "RESTICPROFILE_COMMAND_OUTPUT"),
 		dryRun:          envValueOverride(false, "RESTICPROFILE_DRY_RUN"),
 		noLock:          envValueOverride(false, "RESTICPROFILE_NO_LOCK"),
 		lockWait:        envValueOverride(time.Duration(0), "RESTICPROFILE_LOCK_WAIT"),
@@ -100,7 +100,7 @@ func loadFlags(args []string) (*pflag.FlagSet, commandLineFlags, error) {
 	flagset.StringVarP(&flags.format, "format", "f", flags.format, "file format of the configuration (default is to use the file extension)")
 	flagset.StringVarP(&flags.name, "name", "n", flags.name, "profile name")
 	flagset.StringVarP(&flags.log, "log", "l", flags.log, "logs to a target instead of the console")
-	flagset.StringVar(&flags.logCommands, "log-commands", flags.logCommands, "sets how to log command output when a log target is specified (auto, log, console, both)")
+	flagset.StringVar(&flags.commandOutput, "command-output", flags.commandOutput, "sets how to redirect command output when a log target is specified (auto, log, console, all)")
 	flagset.BoolVar(&flags.dryRun, "dry-run", flags.dryRun, "display the restic commands instead of running them")
 	flagset.BoolVar(&flags.noLock, "no-lock", flags.noLock, "skip profile lock file")
 	flagset.DurationVar(&flags.lockWait, "lock-wait", flags.lockWait, "wait up to duration to acquire a lock (syntax \"1h5m30s\")")

flags_test.go

@@ -65,7 +65,7 @@ func TestEnvOverrides(t *testing.T) {
 		format:          setEnv("custom-format", "RESTICPROFILE_FORMAT").(string),
 		name:            setEnv("custom-profile", "RESTICPROFILE_NAME").(string),
 		log:             setEnv("custom.log", "RESTICPROFILE_LOG").(string),
-		logCommands:     setEnv("log", "RESTICPROFILE_LOG_COMMANDS").(string),
+		commandOutput:   setEnv("log", "RESTICPROFILE_COMMAND_OUTPUT").(string),
 		dryRun:          setEnv(true, "RESTICPROFILE_DRY_RUN").(bool),
 		noLock:          setEnv(true, "RESTICPROFILE_NO_LOCK").(bool),
 		lockWait:        setEnv(time.Minute*5, "RESTICPROFILE_LOCK_WAIT").(time.Duration),

logger.go

@@ -5,6 +5,7 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"slices"
 	"strings"
 	"time"
 
@@ -15,6 +16,7 @@ import (
 	"github.com/creativeprojects/resticprofile/remote"
 	"github.com/creativeprojects/resticprofile/term"
 	"github.com/creativeprojects/resticprofile/util"
+	"github.com/creativeprojects/resticprofile/util/collect"
 )
 
 type LogCloser interface {
@@ -40,7 +42,7 @@ func setupRemoteLogger(flags commandLineFlags, client *remote.Client) {
 	clog.SetDefaultLogger(logger)
 }
 
-func setupTargetLogger(flags commandLineFlags, logTarget, logCommands string) (io.Closer, error) {
+func setupTargetLogger(flags commandLineFlags, logTarget, commandOutput string) (io.Closer, error) {
 	var (
 		handler LogCloser
 		file    io.Writer
@@ -62,17 +64,19 @@ func setupTargetLogger(flags commandLineFlags, logTarget, logCommands string) (i
 
 	// also redirect all terminal output
 	if file != nil {
-		if logCommands == "auto" {
+		if commandOutput == "auto" {
 			if term.OsStdoutIsTerminal() {
-				logCommands = "both"
+				commandOutput = "log,console"
 			} else {
-				logCommands = "log"
+				commandOutput = "log"
 			}
 		}
-		if logCommands == "both" {
+		co := collect.From(strings.Split(commandOutput, ","), strings.TrimSpace)
+		all := slices.Contains(co, "all") || (slices.Contains(co, "log") && slices.Contains(co, "console"))
+		if all {
 			term.SetOutput(io.MultiWriter(file, term.GetOutput()))
 			term.SetErrorOutput(io.MultiWriter(file, term.GetErrorOutput()))
-		} else if logCommands == "log" {
+		} else if slices.Contains(co, "log") {
 			term.SetAllOutput(file)
 		}
 	}