feat(install): local validation for OHI installations (#1516)

internal/install/recipe_installer.go

@@ -620,13 +620,22 @@ func (i *RecipeInstall) validateRecipeViaAllMethods(ctx context.Context, r *type
 		log.Debugf("no validationUrl defined, skipping")
 	}
 
-	// Add NRQL validation if configured
-	if r.ValidationNRQL != "" {
+	hasValidationIntegration := r.ValidationIntegration != ""
+	hasValidationNRQL := r.ValidationNRQL != ""
+
+	// Add either Integration Validation or NRQL Validation if configured
+	if hasValidationIntegration {
+		integrationName := r.ValidationIntegration
+
+		validationFuncs = append(validationFuncs, func() (string, error) {
+			return validation.ValidateIntegration(integrationName)
+		})
+	} else if hasValidationNRQL {
 		validationFuncs = append(validationFuncs, func() (string, error) {
 			return i.recipeValidator.ValidateRecipe(timeoutCtx, *m, *r, vars)
 		})
 	} else {
-		log.Debugf("no validationNRQL defined, skipping")
+		log.Debugf("no validationIntegration or validationNRQL defined, skipping")
 	}
 
 	if len(validationFuncs) == 0 {

internal/install/types/recipe.go

@@ -77,6 +77,10 @@ func (r *OpenInstallationRecipe) UnmarshalYAML(unmarshal func(interface{}) error
 		r.ValidationURL = v.(string)
 	}
 
+	if v, ok := recipe["validationIntegration"]; ok {
+		r.ValidationIntegration = v.(string)
+	}
+
 	return err
 }
 

internal/install/validation/integration_validator.go

@@ -0,0 +1,101 @@
+package validation
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
+	"gopkg.in/yaml.v3"
+)
+
+type integrationType struct {
+	Name string            `yaml:"name"`
+	Env  map[string]string `yaml:"env"`
+}
+
+type configType struct {
+	Integrations []integrationType `yaml:"integrations"`
+}
+
+// Validate an integration using its <integrationName>-config.yml
+// by iterating over the defined integrations and running the
+// integration command with its defined environment variables.
+// <integrationName>-config.yml is determined to be valid if every
+// defined integration exits without error (exits with exit code 0).
+// The <integrationName>-config.yml is located in the
+// default configuration directory, which may vary by GOOS.
+func ValidateIntegration(integrationName string) (string, error) {
+	configBasename := fmt.Sprintf("%s-config.yml", integrationName)
+
+	configPath := filepath.Join(ConfigurationsDirname, configBasename)
+
+	config, err := readConfig(configPath)
+
+	if err != nil {
+		return "", err
+	}
+
+	for _, integration := range config.Integrations {
+		integrationBasename := integration.Name
+
+		binPath := filepath.Join(IntegrationsDirname, integrationBasename)
+
+		cmd := exec.Command(binPath)
+
+		for k, v := range integration.Env {
+			env := fmt.Sprintf("%s=%s", k, v)
+
+			cmd.Env = append(cmd.Env, env)
+		}
+
+		var e strings.Builder
+
+		cmd.Stderr = &e
+
+		if err := cmd.Run(); err != nil {
+			stderr := e.String()
+
+			if stderr != "" {
+				s := strings.TrimSpace(stderr)
+
+				return "", fmt.Errorf("%w: %s", err, s)
+			}
+
+			return "", err
+		}
+	}
+
+	return "", nil
+}
+
+// Reads and unmarshals an <integrationName>-config.yml from the
+// given configPath, returning a configType{} containing the
+// defined integrations and their respective environments.
+// Returns an empty configType{} and an error if:
+// 1.) The file does not exist
+// 2.) The file can not be read
+// 3.) The file cannot be unmarshalled to a configType{}
+func readConfig(configPath string) (configType, error) {
+	if _, err := os.Stat(configPath); errors.Is(err, os.ErrNotExist) {
+		return configType{}, err
+	}
+
+	b, err := os.ReadFile(configPath)
+
+	if err != nil {
+		return configType{}, err
+	}
+
+	config := configType{}
+
+	err = yaml.Unmarshal(b, &config)
+
+	if err != nil {
+		return configType{}, err
+	}
+
+	return config, nil
+}

internal/install/validation/integration_validator_darwin.go

@@ -0,0 +1,7 @@
+package validation
+
+// There are no integrations for macOS,
+// therefore there is no directory
+// for integrations or configurations.
+const IntegrationsDirname = "/dev/null"
+const ConfigurationsDirname = "/dev/null"

internal/install/validation/integration_validator_linux.go

@@ -0,0 +1,4 @@
+package validation
+
+const IntegrationsDirname = "/var/db/newrelic-infra/newrelic-integrations/bin/"
+const ConfigurationsDirname = "/etc/newrelic-infra/integrations.d/"

internal/install/validation/integration_validator_windows.go

@@ -0,0 +1,4 @@
+package validation
+
+const IntegrationsDirname = "C:\\Program Files\\New Relic\\newrelic-infra\\newrelic-integrations\\bin\\"
+const ConfigurationsDirname = "C:\\Program Files\\New Relic\\newrelic-infra\\integrations.d\\"