fix scenario.WithDefaults()

Adds a new `api.DefaultsHandler` interface that plugins must now
implement. This `api.DefaultsHandler` inherits from `yaml.Unmarshaler`
and exposes another `Merge()` method that accepts a map of variable
override defaults received from `scenario.WithDefaults()` and merges
those values with whatever the plugin returns from its `Defaults()`
method.

Issue #68

Signed-off-by: Jay Pipes <[email protected]>

Author: jaypipes

api/plugin.go

@@ -23,13 +23,23 @@ type PluginInfo struct {
 	Retry *Retry
 }
 
+type DefaultsHandler interface {
+	yaml.Unmarshaler
+	// Merge merges the supplies map of key/value combinations with the set of
+	// handled defaults for the plugin. The supplied key/value map will NOT be
+	// unpacked from its top-most plugin named element. So, for example, the
+	// kube plugin should expect to get a map that looks like
+	// "kube:namespace:<namespace>" and not "namespace:<namespace>".
+	Merge(map[string]any)
+}
+
 // Plugin is the driver interface for different types of gdt tests.
 type Plugin interface {
 	// Info returns a struct that describes what the plugin does
 	Info() PluginInfo
 	// Defaults returns a YAML Unmarshaler types that the plugin knows how
 	// to parse its defaults configuration with.
-	Defaults() yaml.Unmarshaler
+	Defaults() DefaultsHandler
 	// Specs returns a list of YAML Unmarshaler types that the plugin knows
 	// how to parse.
 	Specs() []Evaluable

context/context_test.go

@@ -21,6 +21,8 @@ type fooDefaults struct {
 	Foo string `yaml:"foo"`
 }
 
+func (d *fooDefaults) Merge(map[string]any) {}
+
 func (d *fooDefaults) UnmarshalYAML(node *yaml.Node) error {
 	return nil
 }
@@ -62,7 +64,7 @@ func (p *fooPlugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *fooPlugin) Defaults() yaml.Unmarshaler {
+func (p *fooPlugin) Defaults() api.DefaultsHandler {
 	return &fooDefaults{}
 }
 

internal/testutil/plugin/bar/plugin.go

@@ -28,6 +28,8 @@ type Defaults struct {
 	Foo string `yaml:"bar"`
 }
 
+func (d *Defaults) Merge(map[string]any) {}
+
 func (d *Defaults) UnmarshalYAML(node *yaml.Node) error {
 	return nil
 }
@@ -98,7 +100,7 @@ func (p *Plugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *Plugin) Defaults() yaml.Unmarshaler {
+func (p *Plugin) Defaults() api.DefaultsHandler {
 	return &Defaults{}
 }
 

internal/testutil/plugin/failer/plugin.go

@@ -28,6 +28,8 @@ type Defaults struct {
 	InnerDefaults
 }
 
+func (d *Defaults) Merge(map[string]any) {}
+
 func (d *Defaults) UnmarshalYAML(node *yaml.Node) error {
 	if node.Kind != yaml.MappingNode {
 		return parse.ExpectedMapAt(node)
@@ -129,7 +131,7 @@ func (p *Plugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *Plugin) Defaults() yaml.Unmarshaler {
+func (p *Plugin) Defaults() api.DefaultsHandler {
 	return &Defaults{}
 }
 

internal/testutil/plugin/foo/plugin.go

@@ -33,6 +33,8 @@ type Defaults struct {
 	InnerDefaults `yaml:",inline"`
 }
 
+func (d *Defaults) Merge(map[string]any) {}
+
 func (d *Defaults) UnmarshalYAML(node *yaml.Node) error {
 	if node.Kind != yaml.MappingNode {
 		return parse.ExpectedMapAt(node)
@@ -136,7 +138,7 @@ func (p *Plugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *Plugin) Defaults() yaml.Unmarshaler {
+func (p *Plugin) Defaults() api.DefaultsHandler {
 	return &Defaults{}
 }
 

internal/testutil/plugin/priorrun/plugin.go

@@ -24,6 +24,8 @@ const PriorRunDataKey = "priorrun"
 
 type Defaults struct{}
 
+func (d *Defaults) Merge(map[string]any) {}
+
 func (d *Defaults) UnmarshalYAML(node *yaml.Node) error {
 	return nil
 }
@@ -116,7 +118,7 @@ func (p *Plugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *Plugin) Defaults() yaml.Unmarshaler {
+func (p *Plugin) Defaults() api.DefaultsHandler {
 	return &Defaults{}
 }
 

plugin/exec/defaults.go

@@ -16,6 +16,13 @@ type Defaults struct {
 	execDefaults
 }
 
+// Merge merges the supplies map of key/value combinations with the set of
+// handled defaults for the plugin. The supplied key/value map will NOT be
+// unpacked from its top-most plugin named element. So, for example, the
+// kube plugin should expect to get a map that looks like
+// "kube:namespace:<namespace>" and not "namespace:<namespace>".
+func (d *Defaults) Merge(map[string]any) {}
+
 func (d *Defaults) UnmarshalYAML(node *yaml.Node) error {
 	if node.Kind != yaml.MappingNode {
 		return parse.ExpectedMapAt(node)

plugin/exec/plugin.go

@@ -5,8 +5,6 @@
 package exec
 
 import (
-	"gopkg.in/yaml.v3"
-
 	"github.com/gdt-dev/core/api"
 	gdtplugin "github.com/gdt-dev/core/plugin"
 )
@@ -44,7 +42,7 @@ func (p *plugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *plugin) Defaults() yaml.Unmarshaler {
+func (p *plugin) Defaults() api.DefaultsHandler {
 	return &Defaults{}
 }
 

plugin/registry_test.go

@@ -18,6 +18,8 @@ type fooDefaults struct {
 	Foo string `yaml:"foo"`
 }
 
+func (d *fooDefaults) Merge(map[string]any) {}
+
 func (d *fooDefaults) UnmarshalYAML(node *yaml.Node) error {
 	return nil
 }
@@ -59,7 +61,7 @@ func (p *fooPlugin) Info() api.PluginInfo {
 	}
 }
 
-func (p *fooPlugin) Defaults() yaml.Unmarshaler {
+func (p *fooPlugin) Defaults() api.DefaultsHandler {
 	return &fooDefaults{}
 }
 

scenario/parse.go

@@ -81,6 +81,10 @@ func (s *Scenario) UnmarshalYAML(node *yaml.Node) error {
 				if err := valNode.Decode(plugDefaults); err != nil {
 					return err
 				}
+				// The user may have used scenario.WithDefaults() so we need to
+				// merge anything we got from WithDefaults with anything we
+				// parsed from the plugins.
+				plugDefaults.Merge(s.Defaults)
 				defaults[p.Info().Name] = plugDefaults
 			}
 			// The scenario may have its own defaults as well, so we stash