refact: exec.Command() -> exec.CommandContext() (#3826)

* refact: exec.Command() -> exec.CommandContext()

* lint

Author: mmetc

.golangci.yml

@@ -468,10 +468,6 @@ linters:
           - noctx
         text: "net.Listen must not be called"
 
-      - linters:
-          - noctx
-        text: "exec.Command must not be called"
-
       - linters:
           - noctx
         text: "net.LookupAddr must not be called"

cmd/crowdsec-cli/cliexplain/explain.go

@@ -2,6 +2,7 @@ package cliexplain
 
 import (
 	"bufio"
+	"context"
 	"errors"
 	"fmt"
 	"io"
@@ -18,8 +19,8 @@ import (
 	"github.com/crowdsecurity/crowdsec/pkg/hubtest"
 )
 
-func getLineCountForFile(filepath string) (int, error) {
-	f, err := os.Open(filepath)
+func getLineCountForFile(pth string) (int, error) {
+	f, err := os.Open(pth)
 	if err != nil {
 		return 0, err
 	}
@@ -83,8 +84,8 @@ tail -n 5 myfile.log | cscli explain --type nginx -f -
 		`,
 		Args:              args.NoArgs,
 		DisableAutoGenTag: true,
-		RunE: func(_ *cobra.Command, _ []string) error {
-			return cli.run()
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			return cli.run(cmd.Context())
 		},
 		PersistentPreRunE: func(_ *cobra.Command, _ []string) error {
 			fileInfo, _ := os.Stdin.Stat()
@@ -115,7 +116,7 @@ tail -n 5 myfile.log | cscli explain --type nginx -f -
 	return cmd
 }
 
-func (cli *cliExplain) run() error {
+func (cli *cliExplain) run(ctx context.Context) error {
 	logFile := cli.flags.logFile
 	logLine := cli.flags.logLine
 	logType := cli.flags.logType
@@ -227,11 +228,11 @@ func (cli *cliExplain) run() error {
 		cmdArgs = append(cmdArgs, "-label", labels)
 	}
 
-	crowdsecCmd := exec.Command(crowdsec, cmdArgs...)
+	crowdsecCmd := exec.CommandContext(ctx, crowdsec, cmdArgs...)
 
 	output, err := crowdsecCmd.CombinedOutput()
 	if err != nil {
-		fmt.Println(string(output))
+		fmt.Fprintln(os.Stdout, string(output))
 
 		return fmt.Errorf("fail to run crowdsec for test: %w", err)
 	}

pkg/acquisition/modules/journalctl/journalctl_test.go

@@ -264,9 +264,9 @@ journalctl_filter:
 		err = tomb.Wait()
 		require.NoError(t, err)
 
-		output, _ := exec.Command("pgrep", "-x", "journalctl").CombinedOutput()
+		output, _ := exec.CommandContext(ctx, "pgrep", "-x", "journalctl").CombinedOutput()
 		if len(output) != 0 {
-			t.Fatalf("Found a journalctl process after killing the tomb !")
+			t.Fatal("Found a journalctl process after killing the tomb !")
 		}
 
 		if ts.expectedOutput != "" {

pkg/csplugin/broker.go

@@ -37,7 +37,7 @@ const (
 	CrowdsecPluginKey     string = "CROWDSEC_PLUGIN_KEY"
 )
 
-// The broker is responsible for running the plugins and dispatching events
+// PluginBroker is responsible for running the plugins and dispatching events
 // It receives all the events from the main process and stacks them up
 // It is as well notified by the watcher when it needs to deliver events to plugins (based on time or count threshold)
 type PluginBroker struct {
@@ -95,7 +95,6 @@ func (pc *PluginConfig) UnmarshalYAML(unmarshal func(any) error) error {
 
 type PluginConfigList []PluginConfig
 
-
 func (pb *PluginBroker) Init(ctx context.Context, pluginCfg *csconfig.PluginCfg, profileConfigs []*csconfig.ProfileCfg, configPaths *csconfig.ConfigurationPaths) error {
 	pb.PluginChannel = make(chan models.ProfileAlert)
 	pb.notificationConfigsByPluginType = make(map[string][][]byte)
@@ -300,7 +299,7 @@ func (pb *PluginBroker) loadPlugins(ctx context.Context, path string) error {
 			continue
 		}
 
-		pluginClient, err := pb.loadNotificationPlugin(pSubtype, binaryPath)
+		pluginClient, err := pb.loadNotificationPlugin(ctx, pSubtype, binaryPath)
 		if err != nil {
 			return err
 		}
@@ -331,15 +330,15 @@ func (pb *PluginBroker) loadPlugins(ctx context.Context, path string) error {
 	return pb.verifyPluginBinaryWithProfile()
 }
 
-func (pb *PluginBroker) loadNotificationPlugin(name string, binaryPath string) (protobufs.NotifierServer, error) {
+func (pb *PluginBroker) loadNotificationPlugin(ctx context.Context, name string, binaryPath string) (protobufs.NotifierServer, error) {
 	handshake, err := getHandshake()
 	if err != nil {
 		return nil, err
 	}
 
 	log.Debugf("Executing plugin %s", binaryPath)
 
-	cmd, err := pb.CreateCmd(binaryPath)
+	cmd, err := pb.CreateCmd(ctx, binaryPath)
 	if err != nil {
 		return nil, err
 	}

pkg/csplugin/broker_suite_test.go

@@ -51,7 +51,9 @@ func (s *PluginSuite) SetupSuite() {
 		s.builtBinary += ".exe"
 	}
 
-	cmd := exec.Command("go", "build", "-o", s.builtBinary, "../../cmd/notification-dummy/")
+	ctx := t.Context()
+
+	cmd := exec.CommandContext(ctx, "go", "build", "-o", s.builtBinary, "../../cmd/notification-dummy/")
 	err = cmd.Run()
 	require.NoError(t, err, "while building dummy plugin")
 }
@@ -120,6 +122,7 @@ func (s *PluginSuite) SetupSubTest() {
 
 	err = copyFile(s.builtBinary, s.pluginBinary)
 	require.NoError(t, err, "while copying built binary")
+
 	err = os.Chmod(s.pluginBinary, 0o744)
 	require.NoError(t, err, "chmod 0744 %s", s.pluginBinary)
 

pkg/csplugin/utils.go

@@ -3,6 +3,7 @@
 package csplugin
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"io/fs"
@@ -25,9 +26,9 @@ func CheckCredential(uid int, gid int) *syscall.SysProcAttr {
 	}
 }
 
-func (pb *PluginBroker) CreateCmd(binaryPath string) (*exec.Cmd, error) {
+func (pb *PluginBroker) CreateCmd(ctx context.Context, binaryPath string) (*exec.Cmd, error) {
 	var err error
-	cmd := exec.Command(binaryPath)
+	cmd := exec.CommandContext(ctx, binaryPath)
 	if pb.pluginProcConfig.User != "" || pb.pluginProcConfig.Group != "" {
 		if pb.pluginProcConfig.User == "" || pb.pluginProcConfig.Group == "" {
 			return nil, errors.New("while getting process attributes: both plugin user and group must be set")

pkg/csplugin/utils_js.go

@@ -1,10 +1,13 @@
 package csplugin
 
-import "os/exec"
+import (
+	"context"
+	"os/exec"
+)
 
 //All functions are empty, just to make the code compile when targeting js/wasm
 
-func (pb *PluginBroker) CreateCmd(binaryPath string) (*exec.Cmd, error) {
+func (pb *PluginBroker) CreateCmd(ctx context.Context, binaryPath string) (*exec.Cmd, error) {
 	return nil, nil
 }
 

pkg/csplugin/utils_windows.go

@@ -3,6 +3,7 @@
 package csplugin
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"os"
@@ -200,9 +201,9 @@ func getProcessAtr() (*syscall.SysProcAttr, error) {
 	}, nil
 }
 
-func (pb *PluginBroker) CreateCmd(binaryPath string) (*exec.Cmd, error) {
+func (pb *PluginBroker) CreateCmd(ctx context.Context, binaryPath string) (*exec.Cmd, error) {
 	var err error
-	cmd := exec.Command(binaryPath)
+	cmd := exec.CommandContext(ctx, binaryPath)
 	cmd.SysProcAttr, err = getProcessAtr()
 	if err != nil {
 		return nil, fmt.Errorf("while getting process attributes: %w", err)

pkg/hubtest/hubtest_item.go

@@ -123,10 +123,10 @@ func NewTest(name string, hubTest *HubTest, dataDir string) (*HubTestItem, error
 	}
 
 	parserAssertFilePath := filepath.Join(testPath, ParserAssertFileName)
-	ParserAssert := NewParserAssert(parserAssertFilePath)
+	parserAssert := NewParserAssert(parserAssertFilePath)
 
 	scenarioAssertFilePath := filepath.Join(testPath, ScenarioAssertFileName)
-	ScenarioAssert := NewScenarioAssert(scenarioAssertFilePath)
+	scenarioAssert := NewScenarioAssert(scenarioAssertFilePath)
 
 	// force own_data_dir for backard compatibility
 	if name == "magento-ccs-by-as" || name == "magento-ccs-by-country" || name == "geoip-enrich" {
@@ -170,8 +170,8 @@ func NewTest(name string, hubTest *HubTest, dataDir string) (*HubTestItem, error
 		TemplateAcquisPath:        hubTest.TemplateAcquisPath,
 		TemplateAppsecProfilePath: hubTest.TemplateAppsecProfilePath,
 		HubIndex:                  hubTest.HubIndex,
-		ScenarioAssert:            ScenarioAssert,
-		ParserAssert:              ParserAssert,
+		ScenarioAssert:            scenarioAssert,
+		ParserAssert:              parserAssert,
 		CustomItemsLocation:       []string{hubTest.HubPath, testPath},
 		NucleiTargetHost:          hubTest.NucleiTargetHost,
 		AppSecHost:                hubTest.AppSecHost,
@@ -318,7 +318,7 @@ func (t *HubTestItem) ImprovedLogDisplay(crowdsecLogFile string) error {
 	return nil
 }
 
-func (t *HubTestItem) RunWithNucleiTemplate() error {
+func (t *HubTestItem) RunWithNucleiTemplate(ctx context.Context) error {
 	testPath := filepath.Join(t.HubTestPath, t.Name)
 	if _, err := os.Stat(testPath); os.IsNotExist(err) {
 		return fmt.Errorf("test '%s' doesn't exist in '%s', exiting", t.Name, t.HubTestPath)
@@ -328,7 +328,7 @@ func (t *HubTestItem) RunWithNucleiTemplate() error {
 
 	// machine add
 	cmdArgs := []string{"-c", t.RuntimeConfigFilePath, "machines", "add", "testMachine", "--force", "--auto"}
-	cscliRegisterCmd := exec.Command(t.CscliPath, cmdArgs...)
+	cscliRegisterCmd := exec.CommandContext(ctx, t.CscliPath, cmdArgs...)
 	cscliRegisterCmd.Dir = testPath
 	cscliRegisterCmd.Env = []string{"TESTDIR=" + testPath, "DATADIR=" + t.RuntimeHubConfig.InstallDataDir, "TZ=UTC"}
 
@@ -342,7 +342,7 @@ func (t *HubTestItem) RunWithNucleiTemplate() error {
 
 	// hardcode bouncer key
 	cmdArgs = []string{"-c", t.RuntimeConfigFilePath, "bouncers", "add", "appsectests", "-k", TestBouncerApiKey}
-	cscliBouncerCmd := exec.Command(t.CscliPath, cmdArgs...)
+	cscliBouncerCmd := exec.CommandContext(ctx, t.CscliPath, cmdArgs...)
 	cscliBouncerCmd.Dir = testPath
 	cscliBouncerCmd.Env = []string{"TESTDIR=" + testPath, "DATADIR=" + t.RuntimeHubConfig.InstallDataDir, "TZ=UTC"}
 
@@ -356,7 +356,7 @@ func (t *HubTestItem) RunWithNucleiTemplate() error {
 
 	// start crowdsec service
 	cmdArgs = []string{"-c", t.RuntimeConfigFilePath}
-	crowdsecDaemon := exec.Command(t.CrowdSecPath, cmdArgs...)
+	crowdsecDaemon := exec.CommandContext(ctx, t.CrowdSecPath, cmdArgs...)
 	crowdsecDaemon.Dir = testPath
 	crowdsecDaemon.Env = []string{"TESTDIR=" + testPath, "DATADIR=" + t.RuntimeHubConfig.InstallDataDir, "TZ=UTC"}
 
@@ -400,7 +400,7 @@ func (t *HubTestItem) RunWithNucleiTemplate() error {
 	// the value in config is relative
 	nucleiTemplate := filepath.Join(t.Path, t.Config.NucleiTemplate)
 
-	err = nucleiConfig.RunNucleiTemplate(t.Name, nucleiTemplate, t.NucleiTargetHost)
+	err = nucleiConfig.RunNucleiTemplate(ctx, t.Name, nucleiTemplate, t.NucleiTargetHost)
 	if t.Config.ExpectedNucleiFailure {
 		if err != nil && errors.Is(err, ErrNucleiTemplateFail) {
 			log.Infof("Appsec test %s failed as expected", t.Name)
@@ -441,7 +441,7 @@ func createDirs(dirs []string) error {
 	return nil
 }
 
-func (t *HubTestItem) RunWithLogFile() error {
+func (t *HubTestItem) RunWithLogFile(ctx context.Context) error {
 	testPath := filepath.Join(t.HubTestPath, t.Name)
 	if _, err := os.Stat(testPath); os.IsNotExist(err) {
 		return fmt.Errorf("test '%s' doesn't exist in '%s', exiting", t.Name, t.HubTestPath)
@@ -461,7 +461,7 @@ func (t *HubTestItem) RunWithLogFile() error {
 	}
 
 	cmdArgs := []string{"-c", t.RuntimeConfigFilePath, "machines", "add", "testMachine", "--force", "--auto"}
-	cscliRegisterCmd := exec.Command(t.CscliPath, cmdArgs...)
+	cscliRegisterCmd := exec.CommandContext(ctx, t.CscliPath, cmdArgs...)
 	cscliRegisterCmd.Dir = testPath
 	cscliRegisterCmd.Env = []string{"TESTDIR=" + testPath, "DATADIR=" + t.RuntimeHubConfig.InstallDataDir, "TZ=UTC"}
 
@@ -482,7 +482,7 @@ func (t *HubTestItem) RunWithLogFile() error {
 		cmdArgs = append(cmdArgs, "-label", arg)
 	}
 
-	crowdsecCmd := exec.Command(t.CrowdSecPath, cmdArgs...)
+	crowdsecCmd := exec.CommandContext(ctx, t.CrowdSecPath, cmdArgs...)
 	crowdsecCmd.Dir = testPath
 	crowdsecCmd.Env = []string{"TESTDIR=" + testPath, "DATADIR=" + t.RuntimeHubConfig.InstallDataDir, "TZ=UTC"}
 
@@ -649,11 +649,11 @@ func (t *HubTestItem) Run(ctx context.Context, patternDir string) error {
 	}
 
 	if t.Config.LogFile != "" {
-		return t.RunWithLogFile()
+		return t.RunWithLogFile(ctx)
 	}
 
 	if t.Config.NucleiTemplate != "" {
-		return t.RunWithNucleiTemplate()
+		return t.RunWithNucleiTemplate(ctx)
 	}
 
 	return fmt.Errorf("log file or nuclei template must be set in '%s'", t.Name)

pkg/hubtest/nucleirunner.go

@@ -2,6 +2,7 @@ package hubtest
 
 import (
 	"bytes"
+	"context"
 	"errors"
 	"fmt"
 	"os"
@@ -19,7 +20,7 @@ type NucleiConfig struct {
 
 var ErrNucleiTemplateFail = errors.New("nuclei template failed")
 
-func (nc *NucleiConfig) RunNucleiTemplate(testName string, templatePath string, target string) error {
+func (nc *NucleiConfig) RunNucleiTemplate(ctx context.Context, testName string, templatePath string, target string) error {
 	tstamp := time.Now().Unix()
 
 	outputPrefix := fmt.Sprintf("%s/%s-%d", nc.OutputDir, testName, tstamp)
@@ -30,7 +31,7 @@ func (nc *NucleiConfig) RunNucleiTemplate(testName string, templatePath string,
 		"-o", outputPrefix + ".json",
 	}
 	args = append(args, nc.CmdLineOptions...)
-	cmd := exec.Command(nc.Path, args...)
+	cmd := exec.CommandContext(ctx, nc.Path, args...)
 
 	log.Debugf("Running Nuclei command: '%s'", cmd.String())
 
@@ -41,7 +42,6 @@ func (nc *NucleiConfig) RunNucleiTemplate(testName string, templatePath string,
 	cmd.Stderr = &outErr
 
 	err := cmd.Run()
-
 	if err := os.WriteFile(outputPrefix+"_stdout.txt", out.Bytes(), 0o644); err != nil {
 		log.Warningf("Error writing stdout: %s", err)
 	}
@@ -55,13 +55,16 @@ func (nc *NucleiConfig) RunNucleiTemplate(testName string, templatePath string,
 		log.Warningf("Stdout saved to %s", outputPrefix+"_stdout.txt")
 		log.Warningf("Stderr saved to %s", outputPrefix+"_stderr.txt")
 		log.Warningf("Nuclei generated output saved to %s", outputPrefix+".json")
+
 		return err
 	} else if out.String() == "" {
 		log.Warningf("Stdout saved to %s", outputPrefix+"_stdout.txt")
 		log.Warningf("Stderr saved to %s", outputPrefix+"_stderr.txt")
 		log.Warningf("Nuclei generated output saved to %s", outputPrefix+".json")
-		//No stdout means no finding, it means our test failed
+
+		// No stdout means no finding, it means our test failed
 		return ErrNucleiTemplateFail
 	}
+
 	return nil
 }