fix(cli): make --config reach doctor too

Review finding from Copilot on PR #776.

Declaring the flag globally fixed the rejection for daemon, validate and
config-show, but doctor was still constructed without the pre-parsed
value, so `ofelia --config=x doctor` was accepted and then disregarded:
it reported on /etc/ofelia/config.ini and told the user the file was
missing. Accepting a flag and ignoring it is worse than rejecting it —
nothing says the path was dropped.

doctor is also the reason the default cannot simply be handed to every
command: given no path it searches well-known locations, and a
pre-filled default would take that away silently. The default is
therefore resolved in run() for the commands that need a concrete file,
while doctor keeps the raw value, so an absent flag still means 'go and
find it'.

Verified against the binary in all four combinations: doctor with the
flag before and after the subcommand uses the given file, doctor without
it still auto-detects (./ofelia.ini), and validate is unchanged.

Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>

Author: CybotTM

e2e/cli_exit_codes_test.go

@@ -186,3 +186,43 @@ func TestE2E_GlobalConfigFlagIsHonoured(t *testing.T) {
 			missing, stdout, stderr)
 	}
 }
+
+// TestE2E_GlobalConfigFlagReachesDoctor covers the subcommand that made the
+// first version of this fix incomplete.
+//
+// doctor searches well-known locations when it is given no path, so it is the
+// one command that must NOT receive a pre-filled default — and it was
+// therefore also the one constructed without the pre-parsed value at all, so
+// `ofelia --config=x doctor` was accepted and then ignored, reporting on
+// /etc/ofelia/config.ini instead. Accepting a flag and disregarding it is
+// worse than rejecting it: nothing tells the user their path was dropped.
+func TestE2E_GlobalConfigFlagReachesDoctor(t *testing.T) {
+	t.Parallel()
+
+	configPath := writeConfig(t, `[global]
+  log-level = info
+
+[job-local "hello"]
+  schedule = @every 1h
+  command = echo hi
+`)
+
+	for _, args := range [][]string{
+		{"--config=" + configPath, "doctor"},
+		{"doctor", "--config=" + configPath},
+	} {
+		t.Run(strings.Join(args, " "), func(t *testing.T) {
+			t.Parallel()
+
+			stdout, stderr, _ := runCommand(t, args...)
+			out := stdout + stderr
+
+			if !strings.Contains(out, configPath) {
+				t.Errorf("doctor did not report on the config it was given (%s):\n%s", configPath, out)
+			}
+			if strings.Contains(out, "Config file not found: /etc/ofelia/config.ini") {
+				t.Errorf("doctor fell back to the default despite an explicit --config:\n%s", out)
+			}
+		})
+	}
+}

ofelia.go

@@ -65,9 +65,17 @@ func main() {
 // position a user would naturally write them.
 type globalOptions struct {
 	LogLevel   string `long:"log-level" description:"Set log level (overrides config)"`
-	ConfigFile string `long:"config" description:"Configuration file path" default:"/etc/ofelia/config.ini"`
+	ConfigFile string `long:"config" description:"Configuration file path (default: /etc/ofelia/config.ini)"`
 }
 
+// defaultConfigFile is where ofelia looks when --config is absent.
+//
+// It is resolved here rather than declared as a struct-tag default so that an
+// unset flag stays distinguishable from an explicit one: `doctor` searches a
+// list of well-known locations when given no path, and a pre-filled default
+// would silently take that away.
+const defaultConfigFile = "/etc/ofelia/config.ini"
+
 // run holds what main used to do and returns the process exit code instead of
 // ending the process, so the exit status is a value tests can assert on.
 func run(args []string) int {
@@ -85,8 +93,15 @@ func run(args []string) int {
 	preParser := flags.NewParser(&pre, flags.IgnoreUnknown)
 	_, _ = preParser.ParseArgs(args)
 
+	// Commands that read a config need a concrete path; doctor is handed the
+	// raw value so an absent flag still means "go and find it".
+	configFile := pre.ConfigFile
+	if configFile == "" {
+		configFile = defaultConfigFile
+	}
+
 	if pre.LogLevel == "" {
-		cfg, err := ini.LoadSources(ini.LoadOptions{AllowShadows: true, InsensitiveKeys: true}, pre.ConfigFile)
+		cfg, err := ini.LoadSources(ini.LoadOptions{AllowShadows: true, InsensitiveKeys: true}, configFile)
 		if err == nil {
 			if sec, err := cfg.GetSection("global"); err == nil {
 				pre.LogLevel = cli.ExpandEnvVars(sec.Key("log-level").String())
@@ -109,19 +124,19 @@ func run(args []string) int {
 		"daemon",
 		"daemon process",
 		"",
-		&cli.DaemonCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: pre.ConfigFile},
+		&cli.DaemonCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: configFile},
 	)
 	_, _ = parser.AddCommand(
 		"validate",
 		"validates the config file",
 		"",
-		&cli.ValidateCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: pre.ConfigFile},
+		&cli.ValidateCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: configFile},
 	)
 	_, _ = parser.AddCommand(
 		"config",
 		"shows the effective runtime configuration",
 		"",
-		&cli.ConfigShowCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: pre.ConfigFile},
+		&cli.ConfigShowCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: configFile},
 	)
 	_, _ = parser.AddCommand(
 		"init",
@@ -133,7 +148,7 @@ func run(args []string) int {
 		"doctor",
 		"diagnose Ofelia configuration and environment health",
 		"",
-		&cli.DoctorCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel},
+		&cli.DoctorCommand{Logger: logger, LevelVar: levelVar, LogLevel: pre.LogLevel, ConfigFile: pre.ConfigFile},
 	)
 	_, _ = parser.AddCommand(
 		"hash-password",