✨ Exporters: add requires key in manifest to specify required binaries

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Requires key in exporter manifests to specify programs required to run the exporter
+
 ## [1.1.0] - 2024-04-14
 
 ### Added

exporter_custom.go

@@ -19,6 +19,20 @@ type CustomExporter struct {
 	cwd      string
 }
 
+func (e *CustomExporter) VerifyRequiredPrograms() error {
+	missingPrograms := make([]string, 0, len(e.manifest.Requires))
+	for _, program := range e.manifest.Requires {
+		_, err := exec.LookPath(program)
+		if err != nil {
+			missingPrograms = append(missingPrograms, program)
+		}
+	}
+	if len(missingPrograms) > 0 {
+		return fmt.Errorf("intall %s to use the %s exporter", strings.Join(missingPrograms, ", "), e.name)
+	}
+	return nil
+}
+
 func (e *CustomExporter) Name() string {
 	return e.name
 }
@@ -28,6 +42,11 @@ func (e *CustomExporter) OptionsType() any {
 }
 
 func (e *CustomExporter) Before(ctx *RunContext, opts ExporterOptions) error {
+	ctx.LogDebug("Running before commands for %s", e.name)
+	err := e.VerifyRequiredPrograms()
+	if err != nil {
+		return err
+	}
 	return e.runCommands(ctx, e.manifest.Verbose, e.manifest.Before, map[string]any{})
 
 }

exporters.go

@@ -46,6 +46,9 @@ type ExporterManifest struct {
 
 	// If true, will show every command that is run
 	Verbose bool `yaml:"verbose,omitempty"`
+
+	// List of programs that are required to be available in the PATH for the exporter to run.
+	Requires []string `yaml:"requires,omitempty"`
 }
 
 // ExporterOptions validates then returns the configuration options for the given exporter.
@@ -69,6 +72,7 @@ func ValidateExporterOptions(exporter Exporter, opts ExporterOptions) error {
 	return nil
 }
 
+
 var BuiltinExporters = []Exporter{
 	&SqlExporter{},
 	&CustomExporter{},

exporters/ssh.yaml

@@ -1,4 +1,8 @@
 name: SSH Upload
+
+requires:
+    - scp
+
 data:
     # set to true to only print the commands, not execute them
     dry run: false