Create tool to pin locally replaced modules to latest trunk commit

GNUmakefile

@@ -30,6 +30,10 @@ gomod: ## Ensure chainlink's go dependencies are installed.
 gomodtidy: gomods ## Run go mod tidy on all modules.
 	gomods tidy
 
+.PHONY: gomodrequiredupdater
+gomodrequiredupdater: ## Update go.mod files containing certain required dependencies to use latest psuedo-versions from trunk.
+	cd tools/gomod-required-updater && go run cmd/gomod-required-updater/main.go -update-org-modules -root ../..
+
 .PHONY: docs
 docs: ## Install and run pkgsite to view Go docs
 	go install golang.org/x/pkgsite/cmd/pkgsite@latest

core/scripts/go.mod

@@ -7,6 +7,13 @@ replace github.com/smartcontractkit/chainlink/v2 => ../../
 
 replace github.com/smartcontractkit/chainlink/deployment => ../../deployment
 
+// Using a separate `require` here to avoid surrounding line changes
+// creating potential merge conflicts.
+require (
+	github.com/smartcontractkit/chainlink/deployment v0.0.0-20241119120536-03115e80382d
+	github.com/smartcontractkit/chainlink/v2 v2.0.0-20241119120536-03115e80382d
+)
+
 require (
 	github.com/docker/docker v27.3.1+incompatible
 	github.com/docker/go-connections v0.5.0
@@ -25,8 +32,6 @@ require (
 	github.com/shopspring/decimal v1.4.0
 	github.com/smartcontractkit/chainlink-automation v0.8.1
 	github.com/smartcontractkit/chainlink-common v0.3.1-0.20241114134822-aadff98ef068
-	github.com/smartcontractkit/chainlink/deployment v0.0.0-00010101000000-000000000000
-	github.com/smartcontractkit/chainlink/v2 v2.14.0-mercury-20240807.0.20241106193309-5560cd76211a
 	github.com/smartcontractkit/libocr v0.0.0-20241007185508-adbe57025f12
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/viper v1.19.0

deployment/go.mod

@@ -5,6 +5,10 @@ go 1.22.8
 // Make sure we're working with the latest chainlink libs
 replace github.com/smartcontractkit/chainlink/v2 => ../
 
+// Using a separate inline `require` here to avoid surrounding line changes
+// creating potential merge conflicts.
+require github.com/smartcontractkit/chainlink/v2 v2.0.0-20241119120536-03115e80382d
+
 require (
 	github.com/Khan/genqlient v0.7.0
 	github.com/Masterminds/semver/v3 v3.3.0
@@ -26,7 +30,6 @@ require (
 	github.com/smartcontractkit/chainlink-common v0.3.1-0.20241114134822-aadff98ef068
 	github.com/smartcontractkit/chainlink-protos/job-distributor v0.4.0
 	github.com/smartcontractkit/chainlink-testing-framework/lib v1.50.13
-	github.com/smartcontractkit/chainlink/v2 v2.0.0-00010101000000-000000000000
 	github.com/smartcontractkit/libocr v0.0.0-20241007185508-adbe57025f12
 	github.com/stretchr/testify v1.9.0
 	github.com/test-go/testify v1.1.4

integration-tests/go.mod

@@ -7,6 +7,13 @@ replace github.com/smartcontractkit/chainlink/v2 => ../
 
 replace github.com/smartcontractkit/chainlink/deployment => ../deployment
 
+// Using a separate `require` here to avoid surrounding line changes
+// creating potential merge conflicts.
+require (
+	github.com/smartcontractkit/chainlink/deployment v0.0.0-20241119120536-03115e80382d
+	github.com/smartcontractkit/chainlink/v2 v2.0.0-20241119120536-03115e80382d
+)
+
 require (
 	dario.cat/mergo v1.0.1
 	github.com/AlekSi/pointer v1.1.0
@@ -44,8 +51,6 @@ require (
 	github.com/smartcontractkit/chainlink-testing-framework/lib/grafana v1.50.0
 	github.com/smartcontractkit/chainlink-testing-framework/seth v1.50.5
 	github.com/smartcontractkit/chainlink-testing-framework/wasp v1.50.2
-	github.com/smartcontractkit/chainlink/deployment v0.0.0-00010101000000-000000000000
-	github.com/smartcontractkit/chainlink/v2 v2.14.0-mercury-20240807.0.20241106193309-5560cd76211a
 	github.com/smartcontractkit/libocr v0.0.0-20241007185508-adbe57025f12
 	github.com/spf13/cobra v1.8.1
 	github.com/stretchr/testify v1.9.0

integration-tests/load/go.mod

@@ -9,6 +9,14 @@ replace github.com/smartcontractkit/chainlink/deployment => ../../deployment
 
 replace github.com/smartcontractkit/chainlink/integration-tests => ../
 
+// Using a separate `require` here to avoid surrounding line changes
+// creating potential merge conflicts.
+require (
+	github.com/smartcontractkit/chainlink/deployment v0.0.0-20241119120536-03115e80382d
+	github.com/smartcontractkit/chainlink/integration-tests v0.0.0-20241119120536-03115e80382d
+	github.com/smartcontractkit/chainlink/v2 v2.0.0-20241119120536-03115e80382d
+)
+
 require (
 	github.com/K-Phoen/grabana v0.22.2
 	github.com/ethereum/go-ethereum v1.14.11
@@ -21,9 +29,6 @@ require (
 	github.com/smartcontractkit/chainlink-testing-framework/lib v1.50.13
 	github.com/smartcontractkit/chainlink-testing-framework/seth v1.50.5
 	github.com/smartcontractkit/chainlink-testing-framework/wasp v1.50.2
-	github.com/smartcontractkit/chainlink/deployment v0.0.0-00010101000000-000000000000
-	github.com/smartcontractkit/chainlink/integration-tests v0.0.0-20241030133659-9ec788e78b4f
-	github.com/smartcontractkit/chainlink/v2 v2.14.0-mercury-20240807.0.20241106193309-5560cd76211a
 	github.com/smartcontractkit/tdh2/go/tdh2 v0.0.0-20241009055228-33d0c0bf38de
 	github.com/stretchr/testify v1.9.0
 	github.com/wiremock/go-wiremock v1.9.0

tools/gomod-required-updater/README.md

@@ -0,0 +1,82 @@
+# gomod-required-updater
+
+Updates required module versions in go.mod files to match the latest git SHA from a remote branch.
+
+## Features
+
+- Update modules to latest SHA from specified branch
+- Auto-detect and update modules with local replace directives
+- Update multiple modules at once
+- Preview changes with dry run mode
+- Configure via TOML or command line flags
+
+## Configuration
+
+Optional TOML config.
+
+```toml
+# List of modules to update
+modules = [
+    "github.com/smartcontractkit/chainlink/v2"
+]
+```
+
+Command Line Flags:
+
+```shell
+Required (one of):
+  -module             Module to update (can be specified multiple times)
+  -config            Path to TOML config file
+  -update-org-modules Auto-detect and update modules with local replaces
+
+Optional:
+  -repo-remote      Git remote to use (default: origin)
+  -branch-trunk     Branch to get SHA from (default: develop)
+  -root            Root path for searching go.mod files
+  -dry-run         Preview changes without applying them
+```
+
+## Installation
+
+The installed binary will be placed in your `$GOPATH/bin` directory. Make sure this directory is in your system's PATH to run the command from anywhere.
+
+```shell
+go install github.com/smartcontractkit/chainlink/tools/gomod-required-updater
+```
+
+## Usage Examples
+
+Update Specific Modules:
+
+```shell
+# Update single module
+gomod-required-updater -module github.com/org/repo`
+
+# Update multiple modules
+gomod-required-updater -module github.com/org/repo1 -module github.com/org/repo2
+
+# Update using config file
+gomod-required-updater -config modules.toml
+
+# Using different remote/branch
+gomod-required-updater -module github.com/org/repo -repo-remote upstream -branch-trunk main
+```
+
+Auto-detect and Update Local Modules:
+
+```shell
+# Update all local modules that have replace directives
+gomod-required-updater -update-org-modules
+
+# Preview changes first
+gomod-required-updater -update-org-modules -dry-run
+```
+
+## Notes
+
+- When using multiple module sources, precedence is:
+  1. Command line `-module` flags
+  2. Config file modules
+  3. Auto-detected modules via `-update-org-modules` flag
+- Use the `-dry-run` flag to safely preview changes
+- Local replace directives are preserved during updates

tools/gomod-required-updater/cmd/gomod-required-updater/main.go

@@ -0,0 +1,49 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/smartcontractkit/chainlink/tools/gomod-required-updater/internal/updater"
+)
+
+var version = "dev"
+var usage = `gomod-required-updater version %s
+
+Usage:
+  gomod-required-updater [flags]
+
+Examples:
+  # Update modules specified in config file
+  gomod-required-updater -config modules.toml
+
+  # Update specific modules
+  gomod-required-updater -module github.com/org/repo1 -module github.com/org/repo2
+
+  # Dry run with specific modules
+  gomod-required-updater -dry-run -module github.com/org/repo1
+`
+
+func main() {
+	cfg, err := updater.ParseFlags(os.Args[1:], version)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, usage, version)
+		log.Fatal(err)
+	}
+
+	if cfg.ShowVersion {
+		fmt.Printf("gomod-required-updater version %s\n", version)
+		os.Exit(0)
+	}
+
+	u := updater.New(
+		updater.NewGitOperator(),
+		updater.NewSystemOperator(),
+		cfg,
+	)
+
+	if err := u.Run(); err != nil {
+		log.Fatal(err)
+	}
+}

tools/gomod-required-updater/go.mod

@@ -0,0 +1,9 @@
+module github.com/smartcontractkit/chainlink/tools/gomod-required-updater
+
+go 1.23
+
+require (
+	github.com/BurntSushi/toml v1.4.0
+	golang.org/x/mod v0.22.0
+
+)

tools/gomod-required-updater/go.sum

@@ -0,0 +1,4 @@
+github.com/BurntSushi/toml v1.4.0 h1:kuoIxZQy2WRRk1pttg9asf+WVv6tWQuBNVmK8+nqPr0=
+github.com/BurntSushi/toml v1.4.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho=
+golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
+golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=

tools/gomod-required-updater/internal/updater/config.go

@@ -0,0 +1,113 @@
+package updater
+
+import (
+	"flag"
+	"fmt"
+	"strings"
+
+	"github.com/BurntSushi/toml"
+)
+
+type TOMLConfig struct {
+	Modules []string `toml:"modules"`
+}
+
+type Config struct {
+	ModulesToUpdate  []string
+	RepoRemote       string
+	BranchTrunk      string
+	DryRun           bool
+	ConfigFile       string
+	RootPath         string
+	ShowVersion      bool
+	modulesSource    string
+	UpdateOrgModules bool   // Update modules from same org/repo with local replaces
+	OrgName          string // GitHub organization name
+	RepoName         string // Repository name
+}
+
+func (c *Config) Validate() error {
+	if !c.ShowVersion {
+		// Skip module validation if using UpdateOrgModules
+		if !c.UpdateOrgModules && len(c.ModulesToUpdate) == 0 {
+			return fmt.Errorf("%w: no modules specified to update (use -module flag or config file)", ErrInvalidConfig)
+		}
+		if c.RepoRemote == "" {
+			return fmt.Errorf("%w: repo remote cannot be empty", ErrInvalidConfig)
+		}
+		if c.BranchTrunk == "" {
+			return fmt.Errorf("%w: branch trunk cannot be empty", ErrInvalidConfig)
+		}
+	}
+	return nil
+}
+
+func ParseFlags(args []string, version string) (*Config, error) {
+	flags := flag.NewFlagSet("gomod-required-updater", flag.ContinueOnError)
+
+	cfg := &Config{}
+	var cliModules arrayFlags // Define custom flag type for multiple -module flags
+
+	flags.StringVar(&cfg.RepoRemote, "repo-remote", "origin", "The name of the repo remote")
+	flags.StringVar(&cfg.BranchTrunk, "branch-trunk", "develop", "The name of the trunk branch")
+	flags.BoolVar(&cfg.DryRun, "dry-run", false, "Print what would be done without making changes")
+	flags.StringVar(&cfg.ConfigFile, "config", "", "Path to TOML config file (optional if using -module)")
+	flags.StringVar(&cfg.RootPath, "root", ".", "Root path to start scanning for go.mod files")
+	flags.BoolVar(&cfg.ShowVersion, "version", false, "Show version information")
+	flags.Var(&cliModules, "module", "Module to update (can be specified multiple times)")
+	flags.BoolVar(&cfg.UpdateOrgModules, "update-org-modules", false, "Update modules from same org/repo that have local replace directives")
+
+	if err := flags.Parse(args); err != nil {
+		return nil, err
+	}
+
+	// CLI modules take precedence
+	if len(cliModules) > 0 {
+		cfg.ModulesToUpdate = cliModules
+		cfg.modulesSource = "command line"
+	} else if cfg.ConfigFile != "" {
+		// Only load config file if no CLI modules specified
+		modules, err := loadTOMLConfig(cfg.ConfigFile)
+		if err != nil {
+			return nil, fmt.Errorf("failed to load config: %w", err)
+		}
+		cfg.ModulesToUpdate = modules
+		cfg.modulesSource = "config file"
+	}
+
+	if cfg.UpdateOrgModules {
+		gitOp := NewGitOperator()
+		org, repo, err := gitOp.GetRepoInfo(cfg.RepoRemote)
+		if err != nil {
+			return nil, fmt.Errorf("failed to get repo info: %w", err)
+		}
+		cfg.OrgName = org
+		cfg.RepoName = repo
+	}
+
+	if err := cfg.Validate(); err != nil {
+		return nil, err
+	}
+
+	return cfg, nil
+}
+
+// arrayFlags allows for repeated flag values
+type arrayFlags []string
+
+func (i *arrayFlags) String() string {
+	return strings.Join(*i, ", ")
+}
+
+func (i *arrayFlags) Set(value string) error {
+	*i = append(*i, value)
+	return nil
+}
+
+func loadTOMLConfig(path string) ([]string, error) {
+	var cfg TOMLConfig
+	if _, err := toml.DecodeFile(path, &cfg); err != nil {
+		return nil, fmt.Errorf("failed to decode TOML: %w", err)
+	}
+	return cfg.Modules, nil
+}