don't ask user to reload systemd service when running in docker (#3434)

mmetc · web-flow · commit bfed861ba7c9 · 2025-01-31T10:15:28.000Z
* don't ask user to reload systemd service when running in docker

* refactor + give appropriate message if terminal is attached

* remove explicit filetype
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,3 @@
-# vim: set ft=dockerfile:
 FROM docker.io/golang:1.23-alpine3.20 AS build
 
 ARG BUILD_VERSION
diff --git a/Dockerfile.debian b/Dockerfile.debian
@@ -1,4 +1,3 @@
-# vim: set ft=dockerfile:
 FROM docker.io/golang:1.23-bookworm AS build
 
 ARG BUILD_VERSION
diff --git a/cmd/crowdsec-cli/clicapi/capi.go b/cmd/crowdsec-cli/clicapi/capi.go
@@ -123,7 +123,9 @@ func (cli *cliCapi) register(ctx context.Context, capiUserPrefix string, outputF
 		fmt.Println(string(apiConfigDump))
 	}
 
-	log.Warning(reload.Message)
+	if msg := reload.UserMessage(); msg != "" {
+		log.Warning(msg)
+	}
 
 	return nil
 }
diff --git a/cmd/crowdsec-cli/cliconsole/console.go b/cmd/crowdsec-cli/cliconsole/console.go
@@ -214,7 +214,9 @@ Enable given information push to the central API. Allows to empower the console`
 				log.Infof("%v have been enabled", args)
 			}
 
-			log.Info(reload.Message)
+			if reload.UserMessage() != "" {
+				log.Info(reload.UserMessage())
+			}
 
 			return nil
 		},
@@ -248,7 +250,9 @@ Disable given information push to the central API.`,
 				log.Infof("%v have been disabled", args)
 			}
 
-			log.Info(reload.Message)
+			if msg := reload.UserMessage(); msg != "" {
+				log.Info(msg)
+			}
 
 			return nil
 		},
diff --git a/cmd/crowdsec-cli/clihub/hub.go b/cmd/crowdsec-cli/clihub/hub.go
@@ -193,8 +193,8 @@ func (cli *cliHub) upgrade(ctx context.Context, yes bool, dryRun bool, force boo
 		return err
 	}
 
-	if plan.ReloadNeeded {
-		fmt.Println("\n" + reload.Message)
+	if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {
+		fmt.Println("\n" + msg)
 	}
 
 	return nil
diff --git a/cmd/crowdsec-cli/cliitem/cmdinstall.go b/cmd/crowdsec-cli/cliitem/cmdinstall.go
@@ -88,8 +88,8 @@ func (cli cliItem) install(ctx context.Context, args []string, yes bool, dryRun
 		log.Error(err)
 	}
 
-	if plan.ReloadNeeded {
-		fmt.Println("\n" + reload.Message)
+	if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {
+		fmt.Println("\n" + msg)
 	}
 
 	return nil
diff --git a/cmd/crowdsec-cli/cliitem/cmdremove.go b/cmd/crowdsec-cli/cliitem/cmdremove.go
@@ -104,8 +104,8 @@ func (cli cliItem) remove(ctx context.Context, args []string, yes bool, dryRun b
 		return err
 	}
 
-	if plan.ReloadNeeded {
-		fmt.Println("\n" + reload.Message)
+	if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {
+		fmt.Println("\n" + msg)
 	}
 
 	return nil
diff --git a/cmd/crowdsec-cli/cliitem/cmdupgrade.go b/cmd/crowdsec-cli/cliitem/cmdupgrade.go
@@ -66,8 +66,8 @@ func (cli cliItem) upgrade(ctx context.Context, args []string, yes bool, dryRun
 		return err
 	}
 
-	if plan.ReloadNeeded {
-		fmt.Println("\n" + reload.Message)
+	if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {
+		fmt.Println("\n" + msg)
 	}
 
 	return nil
diff --git a/cmd/crowdsec-cli/clilapi/register.go b/cmd/crowdsec-cli/clilapi/register.go
@@ -87,7 +87,9 @@ func (cli *cliLapi) register(ctx context.Context, apiURL string, outputFile stri
 		fmt.Printf("%s\n", string(apiConfigDump))
 	}
 
-	log.Warning(reload.Message)
+	if msg := reload.UserMessage(); msg != "" {
+		log.Warning(msg)
+	}
 
 	return nil
 }
diff --git a/cmd/crowdsec-cli/clisimulation/simulation.go b/cmd/crowdsec-cli/clisimulation/simulation.go
@@ -47,8 +47,8 @@ cscli simulation disable crowdsecurity/ssh-bf`,
 			return nil
 		},
 		PersistentPostRun: func(cmd *cobra.Command, _ []string) {
-			if cmd.Name() != "status" {
-				log.Info(reload.Message)
+			if msg := reload.UserMessage(); msg != "" && cmd.Name() != "status" {
+				log.Info(msg)
 			}
 		},
 	}
diff --git a/cmd/crowdsec-cli/reload/message.go b/cmd/crowdsec-cli/reload/message.go
@@ -0,0 +1,6 @@
+//go:build !windows && !freebsd && !linux
+
+package reload
+
+// generic message since we don't know the platform
+const message = "Please reload the crowdsec process for the new configuration to be effective."
diff --git a/cmd/crowdsec-cli/reload/message_freebsd.go b/cmd/crowdsec-cli/reload/message_freebsd.go
@@ -1,4 +1,4 @@
 package reload
 
 // actually sudo is not that popular on freebsd, but this will do
-const Message = "Run 'sudo service crowdsec reload' for the new configuration to be effective."
+const message = "Run 'sudo service crowdsec reload' for the new configuration to be effective."
diff --git a/cmd/crowdsec-cli/reload/message_linux.go b/cmd/crowdsec-cli/reload/message_linux.go
@@ -1,4 +1,4 @@
 package reload
 
 // assume systemd, although gentoo and others may differ
-const Message = "Run 'sudo systemctl reload crowdsec' for the new configuration to be effective."
+const message = "Run 'sudo systemctl reload crowdsec' for the new configuration to be effective."
diff --git a/cmd/crowdsec-cli/reload/message_windows.go b/cmd/crowdsec-cli/reload/message_windows.go
@@ -0,0 +1,3 @@
+package reload
+
+const message = "Please restart the crowdsec service for the new configuration to be effective."
diff --git a/cmd/crowdsec-cli/reload/reload.go b/cmd/crowdsec-cli/reload/reload.go
@@ -1,6 +1,20 @@
-//go:build !windows && !freebsd && !linux
-
 package reload
 
-// generic message since we don't know the platform
-const Message = "Please reload the crowdsec process for the new configuration to be effective."
+import (
+	"os"
+
+	"github.com/crowdsecurity/go-cs-lib/version"
+	isatty "github.com/mattn/go-isatty"
+)
+
+func UserMessage() string {
+	if version.System == "docker" {
+		if isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) {
+			return "You may need to restart the container to apply the changes."
+		}
+
+		return ""
+	}
+
+	return message
+}
diff --git a/cmd/crowdsec-cli/reload/reload_windows.go b/cmd/crowdsec-cli/reload/reload_windows.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# vim: set ft=dockerfile:`
`2`	`1`	`FROM docker.io/golang:1.23-alpine3.20 AS build`
`3`	`2`
`4`	`3`	`ARG BUILD_VERSION`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# vim: set ft=dockerfile:`
`2`	`1`	`FROM docker.io/golang:1.23-bookworm AS build`
`3`	`2`
`4`	`3`	`ARG BUILD_VERSION`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,9 @@ func (cli *cliCapi) register(ctx context.Context, capiUserPrefix string, outputF`
`123`	`123`	`fmt.Println(string(apiConfigDump))`
`124`	`124`	`}`
`125`	`125`
`126`		`- log.Warning(reload.Message)`
	`126`	`+ if msg := reload.UserMessage(); msg != "" {`
	`127`	`+ log.Warning(msg)`
	`128`	`+ }`
`127`	`129`
`128`	`130`	`return nil`
`129`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -193,8 +193,8 @@ func (cli *cliHub) upgrade(ctx context.Context, yes bool, dryRun bool, force boo`
`193`	`193`	`return err`
`194`	`194`	`}`
`195`	`195`
`196`		`- if plan.ReloadNeeded {`
`197`		`- fmt.Println("\n" + reload.Message)`
	`196`	`+ if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {`
	`197`	`+ fmt.Println("\n" + msg)`
`198`	`198`	`}`
`199`	`199`
`200`	`200`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -88,8 +88,8 @@ func (cli cliItem) install(ctx context.Context, args []string, yes bool, dryRun`
`88`	`88`	`log.Error(err)`
`89`	`89`	`}`
`90`	`90`
`91`		`- if plan.ReloadNeeded {`
`92`		`- fmt.Println("\n" + reload.Message)`
	`91`	`+ if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {`
	`92`	`+ fmt.Println("\n" + msg)`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -104,8 +104,8 @@ func (cli cliItem) remove(ctx context.Context, args []string, yes bool, dryRun b`
`104`	`104`	`return err`
`105`	`105`	`}`
`106`	`106`
`107`		`- if plan.ReloadNeeded {`
`108`		`- fmt.Println("\n" + reload.Message)`
	`107`	`+ if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {`
	`108`	`+ fmt.Println("\n" + msg)`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -66,8 +66,8 @@ func (cli cliItem) upgrade(ctx context.Context, args []string, yes bool, dryRun`
`66`	`66`	`return err`
`67`	`67`	`}`
`68`	`68`
`69`		`- if plan.ReloadNeeded {`
`70`		`- fmt.Println("\n" + reload.Message)`
	`69`	`+ if msg := reload.UserMessage(); msg != "" && plan.ReloadNeeded {`
	`70`	`+ fmt.Println("\n" + msg)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,9 @@ func (cli *cliLapi) register(ctx context.Context, apiURL string, outputFile stri`
`87`	`87`	`fmt.Printf("%s\n", string(apiConfigDump))`
`88`	`88`	`}`
`89`	`89`
`90`		`- log.Warning(reload.Message)`
	`90`	`+ if msg := reload.UserMessage(); msg != "" {`
	`91`	`+ log.Warning(msg)`
	`92`	`+ }`
`91`	`93`
`92`	`94`	`return nil`
`93`	`95`	`}`
Original file line number	Diff line number	Diff line change
@@ -47,8 +47,8 @@ cscli simulation disable crowdsecurity/ssh-bf`,
`47`	`47`	`return nil`
`48`	`48`	`},`
`49`	`49`	`PersistentPostRun: func(cmd *cobra.Command, _ []string) {`
`50`		`- if cmd.Name() != "status" {`
`51`		`- log.Info(reload.Message)`
	`50`	`+ if msg := reload.UserMessage(); msg != "" && cmd.Name() != "status" {`
	`51`	`+ log.Info(msg)`
`52`	`52`	`}`
`53`	`53`	`},`
`54`	`54`	`}`