[8.17] (backport #8279) feat: introduce new mage tidy target (#8294)

* feat: introduce new mage tidy target (#8279)

* fix: introduce new mage tidy target

* fix: G204: Subprocess launched with a potential tainted input or cmd arguments

* doc: add documentation for mage tidy

(cherry picked from commit 5b7ee26)

# Conflicts:
#	README.md
#	dev-tools/mage/target/common/notice.go
#	dev-tools/mage/target/update/update.go
#	wrapper/windows/archive-proxy/go.mod
#	wrapper/windows/archive-proxy/go.sum

* fix: resolve conflicts

---------

Co-authored-by: Panos Koutsovasilis <[email protected]>

Author: mergify[bot]

.ci/scripts/otel-update.sh

@@ -35,8 +35,6 @@ sed -i.bak "s/\(go\.opentelemetry\.io\/collector.*\) $current_stable_core/\1 $ne
 sed -i.bak "s/\(github\.com\/open-telemetry\/opentelemetry\-collector\-contrib\/.*\) $current_contrib/\1 $next_contrib/" go.mod
 rm go.mod.bak
 
-echo "=> Running go mod tidy"
-go mod tidy
 echo "=> Running mage notice"
 mage notice
 echo "=> Running mage otel:readme"

README.md

@@ -258,6 +258,12 @@ rules implemented on our `Makefile` as well as CI will use the
 locally before submitting any PRs to have a quicker feedback instead
 of waiting for a CI failure.
 
+### Keeping Go module files tidy
+The Elastic Agent repository includes additional Go modules (e.g. `wrapper/windows/archive-proxy`) that import the main `elastic-agent` module. This requires keeping all `go.mod` files in sync whenever dependencies change. There is a dedicated `mage tidy` target that recursively runs `go mod tidy` across the entire repo. This is now handled automatically in the following targets:
+- `mage check`
+- `mage notice`
+- `mage update`
+
 ### Generating the `NOTICE.txt` when updating/adding dependencies
 To do so, just run `make notice`, this is also part of the `make
 check-ci` and is the same check our CI will do.

dev-tools/mage/target/common/check.go

@@ -23,6 +23,7 @@ func Check() {
 	deps := make([]interface{}, 0, len(checkDeps)+2)
 	deps = append(deps, devtools.Format)
 	deps = append(deps, checkDeps...)
+	deps = append(deps, Tidy)
 	deps = append(deps, devtools.Check)
 	mg.SerialDeps(deps...)
 }

dev-tools/mage/target/common/notice.go

@@ -29,7 +29,7 @@ func runCommand(cmd string, args ...string) error {
 // Notice Generates NOTICE.txt.
 func Notice() (err error) {
 	fmt.Println("Generating NOTICE")
-	if err := runCommand("go", "mod", "tidy"); err != nil {
+	if err := Tidy(); err != nil {
 		return err
 	}
 	if err := runCommand("go", "mod", "download"); err != nil {

dev-tools/mage/target/common/tidy.go

@@ -0,0 +1,42 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License 2.0;
+// you may not use this file except in compliance with the Elastic License 2.0.
+
+package common
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+
+	"github.com/magefile/mage/mg"
+
+	devtools "github.com/elastic/elastic-agent/dev-tools/mage"
+)
+
+// Tidy runs go mod tidy on all go.mod recursively inside the elastic-agent repository.
+func Tidy() error {
+	goModFiles, err := devtools.FindFilesRecursive(func(path string, _ os.FileInfo) bool {
+		return filepath.Base(path) == "go.mod"
+	})
+	if err != nil {
+		return err
+	}
+	for _, file := range goModFiles {
+		dir, err := filepath.Abs(filepath.Dir(file))
+		if err != nil {
+			return fmt.Errorf("tidy: error getting absolute dir: %w", err)
+		}
+		fmt.Printf(">> tidy: Running go mod tidy inside %s\n", dir)
+		cmd := exec.Command(mg.GoCmd(), "mod", "tidy", "-v") // #nosec G204 -- Need to pass in name of package
+		cmd.Dir = dir
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+		err = cmd.Run()
+		if err != nil {
+			return fmt.Errorf("tidy: error running go mod tidy: %w", err)
+		}
+	}
+	return nil
+}

dev-tools/mage/target/update/update.go

@@ -4,7 +4,9 @@
 
 package update
 
-import "github.com/magefile/mage/sh"
+import (
+	"github.com/magefile/mage/sh"
+)
 
 // Update updates the generated files (aka make update).
 func Update() error {