Merge pull request #52 from newrelic/feat/bindings

Add bindings support

Author: jcoscollanr

cmd/agent-metadata-action/main.go

@@ -227,12 +227,25 @@ func runAgentFlow(ctx context.Context, client metadataClient, workspace, agentTy
 		logging.Noticef(ctx, "Loaded %d agent control definitions", len(agentControl))
 	}
 
+	// Load agent definition (optional)
+	agentDef, err := loader.ReadAgentDefinition(ctx, workspace)
+	if err != nil {
+		logging.Warnf(ctx, "Unable to load agent definition: %v - continuing without it", err)
+		agentDef = nil
+	} else if agentDef != nil {
+		logging.Notice(ctx, "Loaded agent definition")
+	}
+
 	// Build metadata
 	metadata := models.AgentMetadata{
 		ConfigurationDefinitions: configs,
 		Metadata:                 loader.LoadMetadataForAgents(agentVersion),
 		AgentControlDefinitions:  agentControl,
 	}
+	if agentDef != nil {
+		metadata.Bindings = agentDef.Bindings
+		metadata.BreakingChange = agentDef.BreakingChange
+	}
 
 	printJSON(ctx, "Agent Metadata", metadata)
 

internal/config/dirs.go

@@ -33,6 +33,11 @@ func GetAgentControlDefinitionsFilename() string {
 	return "agentControlDefinitions.yml"
 }
 
+// GetAgentDefinitionFilepath returns the path to the optional agentDefinition.yml file
+func GetAgentDefinitionFilepath() string {
+	return filepath.Join(GetRootFolderForAgentRepo(), "agentDefinition.yml")
+}
+
 func GetReleaseNotesDirectory() string {
 	return "src/content/docs/release-notes"
 }

internal/loader/definitions.go

@@ -103,6 +103,27 @@ func ReadAgentControlDefinitions(ctx context.Context, workspacePath string) ([]m
 	return result, nil
 }
 
+// ReadAgentDefinition reads the optional agentDefinition.yml file.
+// Returns nil, nil if the file does not exist (the file is optional).
+func ReadAgentDefinition(ctx context.Context, workspacePath string) (*models.AgentDefinition, error) {
+	fullPath := filepath.Join(workspacePath, config.GetAgentDefinitionFilepath())
+
+	data, err := os.ReadFile(fullPath)
+	if err != nil {
+		if os.IsNotExist(err) {
+			logging.Debug(ctx, "agentDefinition.yml not found - skipping")
+			return nil, nil
+		}
+		return nil, fmt.Errorf("failed to read agentDefinition.yml: %w", err)
+	}
+
+	var def models.AgentDefinition
+	if err := yaml.Unmarshal(data, &def); err != nil {
+		return nil, fmt.Errorf("failed to parse agentDefinition.yml: %w", err)
+	}
+	return &def, nil
+}
+
 // readDefinitionsFile reads a YAML file and extracts the first array it finds at the top level.
 // This is a generic function that works for both configurationDefinitions and agentControlDefinitions files.
 // It returns the array of definitions as []map[string]interface{}.

internal/loader/definitions_test.go

@@ -1002,3 +1002,90 @@ func TestReadAgentControlDefinitions_DropsBrokenContentField(t *testing.T) {
 		})
 	}
 }
+
+func TestReadAgentDefinition_FileNotFound(t *testing.T) {
+	tmpDir := t.TempDir()
+	configDir := filepath.Join(tmpDir, config.GetRootFolderForAgentRepo())
+	require.NoError(t, os.MkdirAll(configDir, 0755))
+
+	result, err := ReadAgentDefinition(context.Background(), tmpDir)
+	require.NoError(t, err)
+	assert.Nil(t, result)
+}
+
+func TestReadAgentDefinition_ValidFile(t *testing.T) {
+	tmpDir := t.TempDir()
+	configDir := filepath.Join(tmpDir, config.GetRootFolderForAgentRepo())
+	require.NoError(t, os.MkdirAll(configDir, 0755))
+
+	yamlContent := `bindings:
+  - type: REQUIRES
+    targetType: AGENT
+    target: NrInfra
+    versions:
+      - ">=1.0.0"
+breakingChange: "2.0.0"`
+	defFile := filepath.Join(configDir, "agentDefinition.yml")
+	require.NoError(t, os.WriteFile(defFile, []byte(yamlContent), 0644))
+
+	result, err := ReadAgentDefinition(context.Background(), tmpDir)
+	require.NoError(t, err)
+	require.NotNil(t, result)
+
+	require.NotNil(t, result.BreakingChange)
+	assert.Equal(t, "2.0.0", *result.BreakingChange)
+
+	require.Len(t, result.Bindings, 1)
+	binding := result.Bindings[0].(map[string]interface{})
+	assert.Equal(t, "REQUIRES", binding["type"])
+	assert.Equal(t, "AGENT", binding["targetType"])
+	assert.Equal(t, "NrInfra", binding["target"])
+}
+
+func TestReadAgentDefinition_BreakingChangeOnly(t *testing.T) {
+	tmpDir := t.TempDir()
+	configDir := filepath.Join(tmpDir, config.GetRootFolderForAgentRepo())
+	require.NoError(t, os.MkdirAll(configDir, 0755))
+
+	yamlContent := `breakingChange: "1.5.0"`
+	defFile := filepath.Join(configDir, "agentDefinition.yml")
+	require.NoError(t, os.WriteFile(defFile, []byte(yamlContent), 0644))
+
+	result, err := ReadAgentDefinition(context.Background(), tmpDir)
+	require.NoError(t, err)
+	require.NotNil(t, result)
+	require.NotNil(t, result.BreakingChange)
+	assert.Equal(t, "1.5.0", *result.BreakingChange)
+	assert.Nil(t, result.Bindings)
+}
+
+func TestReadAgentDefinition_BreakingChangeUnquotedFloat(t *testing.T) {
+	tmpDir := t.TempDir()
+	configDir := filepath.Join(tmpDir, config.GetRootFolderForAgentRepo())
+	require.NoError(t, os.MkdirAll(configDir, 0755))
+
+	// Unquoted float — go-yaml coerces to string representation
+	yamlContent := `breakingChange: 2.0`
+	defFile := filepath.Join(configDir, "agentDefinition.yml")
+	require.NoError(t, os.WriteFile(defFile, []byte(yamlContent), 0644))
+
+	result, err := ReadAgentDefinition(context.Background(), tmpDir)
+	require.NoError(t, err)
+	require.NotNil(t, result)
+	require.NotNil(t, result.BreakingChange)
+	assert.Equal(t, "2.0", *result.BreakingChange)
+}
+
+func TestReadAgentDefinition_InvalidYAML(t *testing.T) {
+	tmpDir := t.TempDir()
+	configDir := filepath.Join(tmpDir, config.GetRootFolderForAgentRepo())
+	require.NoError(t, os.MkdirAll(configDir, 0755))
+
+	defFile := filepath.Join(configDir, "agentDefinition.yml")
+	require.NoError(t, os.WriteFile(defFile, []byte(":\tinvalid: yaml: ["), 0644))
+
+	result, err := ReadAgentDefinition(context.Background(), tmpDir)
+	require.Error(t, err)
+	assert.Nil(t, result)
+	assert.Contains(t, err.Error(), "failed to parse agentDefinition.yml")
+}

internal/models/models.go

@@ -5,6 +5,8 @@ type AgentMetadata struct {
 	ConfigurationDefinitions []ConfigurationDefinition `json:"configurationDefinitions"`
 	Metadata                 Metadata                  `json:"metadata"`
 	AgentControlDefinitions  []AgentControlDefinition  `json:"agentControlDefinitions"`
+	Bindings                 []interface{}             `json:"bindings,omitempty"`
+	BreakingChange           *string                   `json:"breakingChange,omitempty"`
 }
 
 // ConfigurationDefinition represents a configuration that can be read from YAML and sent as JSON.
@@ -22,6 +24,13 @@ type Metadata map[string]interface{}
 // YAML fields are automatically translated to JSON.
 type AgentControlDefinition map[string]interface{}
 
+// AgentDefinition is a typed view of agentDefinition.yml used for parsing.
+// Fields are promoted flat onto AgentMetadata for JSON serialization.
+type AgentDefinition struct {
+	Bindings       []interface{} `yaml:"bindings"`
+	BreakingChange *string       `yaml:"breakingChange"`
+}
+
 // ConfigFile represents the YAML file structure containing multiple configs
 type ConfigFile struct {
 	Configs []ConfigurationDefinition `yaml:"configurationDefinitions"`