feat: add nrdot component to config (#485)

emiliaFer · web-flow · commit c122c91f866a · 2026-02-02T15:24:00.000-05:00
* add nrdot component to config

* fix nrModule url

* add tests

* if there are populated version flags, use those instead of usual update method

* address comments, rename variables, and testing

* add null check, rename more variables for consistency
diff --git a/cmd/nrdot-collector-builder/cmd/manifest/update.go b/cmd/nrdot-collector-builder/cmd/manifest/update.go
@@ -31,6 +31,37 @@ var UpdateCmd = &cobra.Command{
 		jsonOutput, _ := cmd.Root().PersistentFlags().GetBool("json")
 		verbose, _ := cmd.Root().PersistentFlags().GetBool("verbose")
 
+		// Get nrdot version information from persistent flags
+		var nrdotVersion, nrdotUsage string
+		if nrdotVersionFlag := cmd.Root().PersistentFlags().Lookup("nrdot-version"); nrdotVersionFlag != nil {
+			nrdotVersion = nrdotVersionFlag.Value.String()
+			nrdotUsage = nrdotVersionFlag.Usage
+		}
+
+		var coreStable, coreStableUsage string
+		if coreStableFlag := cmd.Root().PersistentFlags().Lookup("core-stable"); coreStableFlag != nil {
+			coreStable = coreStableFlag.Value.String()
+			coreStableUsage = coreStableFlag.Usage
+		}
+
+		var contribBeta, contribBetaUsage string
+		if contribBetaFlag := cmd.Root().PersistentFlags().Lookup("contrib-beta"); contribBetaFlag != nil {
+			contribBeta = contribBetaFlag.Value.String()
+			contribBetaUsage = contribBetaFlag.Usage
+		}
+
+		// Create a map with module path (usage) as key and version array as value for updates
+		nrdotUpdates := make(map[string][]string)
+		if nrdotVersion != "" {
+			nrdotUpdates[nrdotUsage] = []string{nrdotVersion}
+		}
+		if coreStable != "" {
+			nrdotUpdates[coreStableUsage] = []string{coreStable}
+		}
+		if contribBeta != "" {
+			nrdotUpdates[contribBetaUsage] = []string{contribBeta}
+		}
+
 		matches, _ := filepath.Glob(configPath)
 
 		if len(matches) == 0 {
@@ -68,9 +99,17 @@ var UpdateCmd = &cobra.Command{
 				currentVersions = cfg.Versions
 			}
 
-			updatedCfg, err := manifest.UpdateConfigModules(cfg)
-			if err != nil {
-				return fmt.Errorf("failed to update configuration: %w", err)
+			var updatedCfg *manifest.Config
+			if len(nrdotUpdates) > 0 {
+				updatedCfg, err = manifest.CopyAndUpdateConfigModules(cfg, nrdotUpdates)
+				if err != nil {
+					return fmt.Errorf("failed to update configuration with nrdot versions: %w", err)
+				}
+			} else {
+				updatedCfg, err = manifest.UpdateConfigModules(cfg)
+				if err != nil {
+					return fmt.Errorf("failed to update configuration: %w", err)
+				}
 			}
 
 			if err = manifest.WriteConfigFile(updatedCfg); err != nil {
@@ -91,6 +130,7 @@ var UpdateCmd = &cobra.Command{
 				NextVersions:    nextVersions,
 				CurrentVersions: currentVersions,
 			}
+
 			b, err := json.Marshal(output)
 			if err != nil {
 				return fmt.Errorf("failed to marshal JSON output: %w", err)
diff --git a/cmd/nrdot-collector-builder/cmd/root.go b/cmd/nrdot-collector-builder/cmd/root.go
@@ -11,6 +11,9 @@ import (
 
 var jsonOutput bool
 var verbose bool
+var nrdotVersion string
+var coreStableVersion string
+var contribBetaVersion string
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
@@ -26,6 +29,24 @@ It simplifies the process of building and deploying the collector with NRDOT-spe
 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",
+		"",
+		"github.com/newrelic/nrdot-collector-components/exporter/nrdot",
+	)
+	rootCmd.PersistentFlags().StringVar(
+		&coreStableVersion,
+		"core-stable",
+		"",
+		"go.opentelemetry.io/collector",
+	)
+	rootCmd.PersistentFlags().StringVar(
+		&contribBetaVersion,
+		"contrib-beta",
+		"",
+		"github.com/open-telemetry/opentelemetry-collector-contrib",
+	)
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
diff --git a/cmd/nrdot-collector-builder/internal/manifest/config.go b/cmd/nrdot-collector-builder/internal/manifest/config.go
@@ -23,11 +23,13 @@ var errMissingGoMod = errors.New("missing gomod specification for module")
 
 const coreModule = "go.opentelemetry.io/collector"
 const contribModule = "github.com/open-telemetry/opentelemetry-collector-contrib"
+const nrModule = "github.com/newrelic/nrdot-collector-components"
 
 type Versions struct {
 	BetaCoreVersion    string `json:"betaCoreVersion"`
 	BetaContribVersion string `json:"betaContribVersion"`
 	StableCoreVersion  string `json:"stableCoreVersion"`
+	NrdotVersion 		   string `json:"nrdotVersion"`
 }
 
 // Config holds the builder's configuration
@@ -95,6 +97,14 @@ func isOtelContribComponent(mod string) bool {
 	return false
 }
 
+func isNrdotComponent(component Module) bool {
+	// Check if the component is part of the NRDOT Collector
+	if strings.HasPrefix(component.GoMod, nrModule) {
+		return true
+	}
+	return false
+}
+
 func isOtelComponent(component Module) bool {
 	// Check if the component is part of the OpenTelemetry Collector
 	if isOtelCoreComponent(component.GoMod) || isOtelContribComponent(component.GoMod) {
@@ -111,22 +121,40 @@ func isStableVersion(version string) bool {
 	return false
 }
 
+func isCompatibleWithNrdotComponent(nrdotVersion string, betaVersion string) bool {
+	if semver.Compare(nrdotVersion, betaVersion) >= 0 {
+		return true
+	}
+	return false
+}
+
 func (c *Config) SetVersions() error {
 
 	versions := Versions{}
 
+	for _, component := range c.allNrdotComponents() {
+		if isNrdotComponent(component) {
+			componentVersion := strings.Split(component.GoMod, " ")[1]
+			versions.NrdotVersion = componentVersion
+		}
+
+		if versions.NrdotVersion != "" {
+			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 {
+				} else if isCompatibleWithNrdotComponent(versions.NrdotVersion, componentVersion) {
 					versions.BetaCoreVersion = componentVersion
 				}
 			}
 
-			if isOtelContribComponent(component.GoMod) && !isStableVersion(componentVersion) {
+			if isOtelContribComponent(component.GoMod) && !isStableVersion(componentVersion) && isCompatibleWithNrdotComponent(versions.NrdotVersion, componentVersion) {
 				versions.BetaContribVersion = componentVersion
 			}
 
@@ -228,6 +256,16 @@ func (cfg *Config) allOtelComponents() []Module {
 	return allOtelComponents
 }
 
+func (cfg *Config) allNrdotComponents() []Module {
+	allNrdotComponents := []Module{}
+	for _, component := range cfg.allComponents() {
+		if isNrdotComponent(component) {
+			allNrdotComponents = append(allNrdotComponents, component)
+		}
+	}
+	return allNrdotComponents
+}
+
 func validateModules(name string, mods []Module) error {
 	for i, mod := range mods {
 		if mod.GoMod == "" {
diff --git a/cmd/nrdot-collector-builder/internal/manifest/config_test.go b/cmd/nrdot-collector-builder/internal/manifest/config_test.go
@@ -87,10 +87,17 @@ func TestConfig_IsOtelContribComponent(t *testing.T) {
 	assert.False(t, isOtelContribComponent("github.com/some/other/module"))
 }
 
+func TestConfig_IsNrdotComponent(t *testing.T) {
+	assert.True(t, isNrdotComponent(Module{GoMod: "github.com/newrelic/nrdot-collector-components/component v1.0.0"}))
+	assert.True(t, isNrdotComponent(Module{GoMod: "github.com/newrelic/nrdot-collector-components/component"}))
+	assert.False(t, isNrdotComponent(Module{GoMod: "github.com/some/other/module"}))
+}
+
 func TestConfig_SetVersions(t *testing.T) {
 	cfg := &Config{
 		Extensions: []Module{
 			{GoMod: "github.com/open-telemetry/opentelemetry-collector-contrib/component v0.1.0"},
+			{GoMod: "github.com/newrelic/nrdot-collector-components/component v0.1.0"},
 		},
 		Receivers: []Module{
 			{GoMod: "go.opentelemetry.io/collector v1.0.0"},
@@ -104,6 +111,7 @@ func TestConfig_SetVersions(t *testing.T) {
 	assert.Equal(t, "v1.0.0", cfg.Versions.StableCoreVersion)
 	assert.Equal(t, "v0.1.0", cfg.Versions.BetaCoreVersion)
 	assert.Equal(t, "v0.1.0", cfg.Versions.BetaContribVersion)
+	assert.Equal(t, "v0.1.0", cfg.Versions.NrdotVersion)
 }
 
 func TestConfig_SetVersions_MissingCore(t *testing.T) {
@@ -121,3 +129,58 @@ func TestConfig_SetVersions_MissingCore(t *testing.T) {
 	assert.Contains(t, err.Error(), "missing beta core version")
 
 }
+
+func TestIsCompatibleWithNrdotComponent(t *testing.T) {
+	tests := []struct {
+		name          string
+		nrdotVersion  string
+		betaVersion   string
+		expectedMatch bool
+	}{
+		{
+			name:          "nrdot version equal to beta version",
+			nrdotVersion:  "v0.142.0",
+			betaVersion:   "v0.142.0",
+			expectedMatch: true,
+		},
+		{
+			name:          "different minor versions - nrdot higher",
+			nrdotVersion:  "v0.143.0",
+			betaVersion:   "v0.142.5",
+			expectedMatch: true,
+		},
+		{
+			name:          "different minor versions - beta higher",
+			nrdotVersion:  "v0.142.0",
+			betaVersion:   "v0.142.1",
+			expectedMatch: false,
+		},
+		{
+			name:          "different patch versions - nrdot higher",
+			nrdotVersion:  "v0.142.5",
+			betaVersion:   "v0.142.3",
+			expectedMatch: true,
+		},
+		{
+			name:          "different patch versions - beta higher",
+			nrdotVersion:  "v0.142.3",
+			betaVersion:   "v0.142.5",
+			expectedMatch: false,
+		},
+		{
+			name:          "edge case - large version numbers",
+			nrdotVersion:  "v0.999.999",
+			betaVersion:   "v0.999.998",
+			expectedMatch: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := isCompatibleWithNrdotComponent(tt.nrdotVersion, tt.betaVersion)
+			assert.Equal(t, tt.expectedMatch, result,
+				"isCompatibleWithNrdotComponent(%s, %s) = %v, want %v",
+				tt.nrdotVersion, tt.betaVersion, result, tt.expectedMatch)
+		})
+	}
+}
diff --git a/cmd/nrdot-collector-builder/internal/manifest/main.go b/cmd/nrdot-collector-builder/internal/manifest/main.go
@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
+	"slices"
 	"sort"
 	"strings"
 
@@ -77,8 +78,9 @@ func fetchAllModuleVersions(cfg *Config, modules []string) (map[string][]string,
 func fetchLatestModuleVersions(cfg *Config) (map[string][]string, error) {
 	updates := make(map[string][]string)
 
+	var components = slices.Concat(cfg.allOtelComponents(), cfg.allNrdotComponents())
 	var modules []string
-	for _, component := range cfg.allOtelComponents() {
+	for _, component := range components {
 		module, _, _ := strings.Cut(component.GoMod, " ")
 		modules = append(modules, module)
 	}
@@ -90,7 +92,7 @@ func fetchLatestModuleVersions(cfg *Config) (map[string][]string, error) {
 	}
 
 	// Iterate over all components in cfg.allComponents()
-	for _, component := range cfg.allOtelComponents() {
+	for _, component := range components {
 		// Extract the module name from the component's GoMod field
 		module, currentVersion, _ := strings.Cut(component.GoMod, " ")
 		// Log the current version
diff --git a/scripts/bump-component-versions.sh b/scripts/bump-component-versions.sh
