chore: update bump-component-versions and nrdot-collector-builder with ability to update nr forks repo (#614)

Author: agarvin-nr

cmd/nrdot-collector-builder/cmd/manifest/testdata/test-config-nrdot.yaml

@@ -0,0 +1,17 @@
+# This config is for testing purposes and should not be used in production.
+#
+
+dist:
+  module: github.com/newrelic/nrdot-collector-releases/nrdot-collector
+  name: nrdot-collector
+  description: NRDOT Collector
+  version: 1.1.0
+  output_path: ./_build
+
+receivers:
+  - gomod: go.opentelemetry.io/collector/receiver/nopreceiver v0.154.0
+  - gomod: github.com/newrelic-forks/opentelemetry-collector-contrib/receiver/nrsqlserverreceiver v0.154.4
+processors:
+  - gomod: github.com/newrelic/nrdot-collector-components/processor/adaptivetelemetryprocessor v0.154.0
+exporters:
+  - gomod: go.opentelemetry.io/collector/exporter/nopexporter v0.154.0

cmd/nrdot-collector-builder/cmd/manifest/testdata/test-config.yaml

@@ -27,4 +27,3 @@ providers:
   - gomod: go.opentelemetry.io/collector/confmap/provider/httpprovider v1.31.0
   - gomod: go.opentelemetry.io/collector/confmap/provider/httpsprovider v1.31.0
   - gomod: go.opentelemetry.io/collector/confmap/provider/yamlprovider v1.31.0
-

cmd/nrdot-collector-builder/cmd/manifest/update.go

@@ -33,6 +33,7 @@ var UpdateCmd = &cobra.Command{
 
 		// Get version overrides from persistent flags.
 		nrdotVersion := persistentFlag(cmd, "nrdot-version")
+		nrForkContribVersion := persistentFlag(cmd, "nr-fork-contrib-version")
 		coreStable := persistentFlag(cmd, "core-stable")
 		coreBeta := persistentFlag(cmd, "core-beta")
 		contribBeta := persistentFlag(cmd, "contrib-beta")
@@ -42,6 +43,9 @@ var UpdateCmd = &cobra.Command{
 		if nrdotVersion != "" {
 			nrdotUpdates[manifest.NrModule] = manifest.VersionUpdate{BetaVersion: nrdotVersion}
 		}
+		if nrForkContribVersion != "" {
+			nrdotUpdates[manifest.NrForkContribModule] = manifest.VersionUpdate{BetaVersion: nrForkContribVersion}
+		}
 		if coreStable != "" || coreBeta != "" {
 			nrdotUpdates[manifest.CoreModule] = manifest.VersionUpdate{StableVersion: coreStable, BetaVersion: coreBeta}
 		}

cmd/nrdot-collector-builder/cmd/manifest/update_test.go

@@ -82,3 +82,50 @@ func TestUpdateCmd_RunE_InvalidConfig(t *testing.T) {
 	err = UpdateCmd.RunE(cmd, []string{})
 	assert.Error(t, err)
 }
+
+func TestUpdateCmd_RunE_NrdotComponents(t *testing.T) {
+	// Load the test-config-nrdot.yaml file
+	testConfigPath := "testdata/test-config-nrdot.yaml"
+	yamlData, err := os.ReadFile(testConfigPath)
+	assert.NoError(t, err)
+
+	// Create a temporary file to simulate writing to a file
+	tempFile, err := os.CreateTemp("", "test-config-*.yaml")
+	assert.NoError(t, err)
+	defer os.Remove(tempFile.Name()) // Clean up the file after the test
+
+	// Write the loaded YAML data to the temporary file
+	_, err = tempFile.Write(yamlData)
+	assert.NoError(t, err)
+	tempFile.Close() // Close the file to ensure the changes are flushed
+
+	targetStable := "v1.61.0"
+	targetBeta := "v0.155.0"
+
+	cmd := &cobra.Command{}
+	cmd.Flags().String("config", tempFile.Name(), "")
+
+	// Version overrides are read from the root command's persistent flags.
+	cmd.PersistentFlags().String("nrdot-version", targetBeta, "")
+	cmd.PersistentFlags().String("nr-fork-contrib-version", targetBeta, "")
+	cmd.PersistentFlags().String("core-stable", targetStable, "")
+	cmd.PersistentFlags().String("core-beta", targetBeta, "")
+	cmd.PersistentFlags().String("contrib-beta", targetBeta, "")
+
+	err = UpdateCmd.RunE(cmd, []string{})
+	assert.NoError(t, err)
+
+	updatedYamlData, err := os.ReadFile(tempFile.Name())
+	assert.NoError(t, err)
+	updated := string(updatedYamlData)
+
+	betaModules := []string{
+		"github.com/newrelic/nrdot-collector-components/processor/adaptivetelemetryprocessor",
+		"github.com/newrelic-forks/opentelemetry-collector-contrib/receiver/nrsqlserverreceiver",
+		"go.opentelemetry.io/collector/receiver/nopreceiver",
+		"go.opentelemetry.io/collector/exporter/nopexporter",
+	}
+	for _, module := range betaModules {
+		assert.Contains(t, updated, module+" "+targetBeta)
+	}
+}

cmd/nrdot-collector-builder/cmd/root.go

@@ -10,12 +10,13 @@ import (
 )
 
 var (
-	jsonOutput         bool
-	verbose            bool
-	nrdotVersion       string
-	coreStableVersion  string
-	coreBetaVersion    string
-	contribBetaVersion string
+	jsonOutput           bool
+	verbose              bool
+	nrdotVersion         string
+	nrForkContribVersion string
+	coreStableVersion    string
+	coreBetaVersion      string
+	contribBetaVersion   string
 )
 
 // rootCmd represents the base command when called without any subcommands
@@ -33,6 +34,7 @@ func init() {
 	rootCmd.PersistentFlags().BoolVar(&jsonOutput, "json", false, "Output results in JSON format")
 	rootCmd.PersistentFlags().BoolVar(&verbose, "verbose", false, "Verbose output")
 	rootCmd.PersistentFlags().StringVar(&nrdotVersion, "nrdot-version", "", "Pin nrdot-collector-components to this version")
+	rootCmd.PersistentFlags().StringVar(&nrForkContribVersion, "nr-fork-contrib-version", "", "Pin newrelic-forks/opentelemetry-collector-contrib to this version")
 	rootCmd.PersistentFlags().StringVar(&coreStableVersion, "core-stable", "", "Pin OTel core stable (v1.x) modules to this version")
 	rootCmd.PersistentFlags().StringVar(&coreBetaVersion, "core-beta", "", "Pin OTel core beta (v0.x) modules to this version")
 	rootCmd.PersistentFlags().StringVar(&contribBetaVersion, "contrib-beta", "", "Pin OTel contrib modules to this version")

cmd/nrdot-collector-builder/internal/manifest/config.go

@@ -22,16 +22,18 @@ import (
 var errMissingGoMod = errors.New("missing gomod specification for module")
 
 const (
-	CoreModule    = "go.opentelemetry.io/collector"
-	ContribModule = "github.com/open-telemetry/opentelemetry-collector-contrib"
-	NrModule      = "github.com/newrelic/nrdot-collector-components"
+	CoreModule          = "go.opentelemetry.io/collector"
+	ContribModule       = "github.com/open-telemetry/opentelemetry-collector-contrib"
+	NrModule            = "github.com/newrelic/nrdot-collector-components"
+	NrForkContribModule = "github.com/newrelic-forks/opentelemetry-collector-contrib"
 )
 
 type Versions struct {
-	BetaCoreVersion    string `json:"betaCoreVersion"`
-	BetaContribVersion string `json:"betaContribVersion"`
-	StableCoreVersion  string `json:"stableCoreVersion"`
-	NrdotVersion       string `json:"nrdotVersion"`
+	BetaCoreVersion      string `json:"betaCoreVersion"`
+	BetaContribVersion   string `json:"betaContribVersion"`
+	StableCoreVersion    string `json:"stableCoreVersion"`
+	NrdotVersion         string `json:"nrdotVersion"`
+	NrForkContribVersion string `json:"nrForkContribVersion"`
 }
 
 // Config holds the builder's configuration
@@ -95,6 +97,10 @@ func isNrdotComponent(component Module) bool {
 	return strings.HasPrefix(component.GoMod, NrModule)
 }
 
+func isNrForkContribComponent(component Module) bool {
+	return strings.HasPrefix(component.GoMod, NrForkContribModule)
+}
+
 func isOtelComponent(component Module) bool {
 	return isOtelCoreComponent(component.GoMod) || isOtelContribComponent(component.GoMod)
 }
@@ -103,8 +109,13 @@ func isStableVersion(version string) bool {
 	return semver.Compare(version, "v1.0.0") >= 0
 }
 
-func isCompatibleWithNrdotComponent(nrdotVersion, betaVersion string) bool {
-	return semver.Compare(nrdotVersion, betaVersion) >= 0
+func isCompatibleWithNrComponent(nrComponentVersion, betaVersion string) bool {
+	return semver.MajorMinor(nrComponentVersion) == semver.MajorMinor(betaVersion)
+}
+
+func isCompatibleWithNrVersions(nrdotVersion, nrForkContribVersion, betaVersion string) bool {
+	return (nrdotVersion == "" || isCompatibleWithNrComponent(nrdotVersion, betaVersion)) &&
+		(nrForkContribVersion == "" || isCompatibleWithNrComponent(nrForkContribVersion, betaVersion))
 }
 
 func (c *Config) SetVersions() error {
@@ -122,18 +133,35 @@ func (c *Config) SetVersions() error {
 		}
 	}
 
+	for _, component := range c.allNrForkContribComponents() {
+		if isNrForkContribComponent(component) {
+			componentVersion := strings.Split(component.GoMod, " ")[1]
+			versions.NrForkContribVersion = componentVersion
+		}
+
+		if versions.NrForkContribVersion != "" {
+			break
+		}
+	}
+
 	for _, component := range c.allOtelComponents() {
 		if isOtelComponent(component) {
 			componentVersion := strings.Split(component.GoMod, " ")[1]
 			if isOtelCoreComponent(component.GoMod) {
 				if isStableVersion(componentVersion) {
 					versions.StableCoreVersion = componentVersion
-				} else if versions.NrdotVersion == "" || isCompatibleWithNrdotComponent(versions.NrdotVersion, componentVersion) {
+				} else {
+					if !isCompatibleWithNrVersions(versions.NrdotVersion, versions.NrForkContribVersion, componentVersion) {
+						return fmt.Errorf("beta core version %s incompatible with nrdot %s or nr-fork %s", componentVersion, versions.NrdotVersion, versions.NrForkContribVersion)
+					}
 					versions.BetaCoreVersion = componentVersion
 				}
 			}
 
-			if isOtelContribComponent(component.GoMod) && !isStableVersion(componentVersion) && (versions.NrdotVersion == "" || isCompatibleWithNrdotComponent(versions.NrdotVersion, componentVersion)) {
+			if isOtelContribComponent(component.GoMod) && !isStableVersion(componentVersion) {
+				if !isCompatibleWithNrVersions(versions.NrdotVersion, versions.NrForkContribVersion, componentVersion) {
+					return fmt.Errorf("contrib version %s incompatible with nrdot %s or nr-fork %s", componentVersion, versions.NrdotVersion, versions.NrForkContribVersion)
+				}
 				versions.BetaContribVersion = componentVersion
 			}
 
@@ -245,6 +273,16 @@ func (cfg *Config) allNrdotComponents() []Module {
 	return allNrdotComponents
 }
 
+func (cfg *Config) allNrForkContribComponents() []Module {
+	allNrForkContribComponents := []Module{}
+	for _, component := range cfg.allComponents() {
+		if isNrForkContribComponent(component) {
+			allNrForkContribComponents = append(allNrForkContribComponents, component)
+		}
+	}
+	return allNrForkContribComponents
+}
+
 func validateModules(name string, mods []Module) error {
 	for i, mod := range mods {
 		if mod.GoMod == "" {