From 2ecbcb1347897423f1980479d456caed007af3a5 Mon Sep 17 00:00:00 2001
From: Joel Cooklin <joel.cooklin@gmail.com>
Date: Thu, 14 Jan 2016 18:43:27 -0800
Subject: [PATCH] Adds test for managing a failed plugin

---
 control/control_test.go                       | 63 +++++++++++++++++++
 .../snap-collector-mock2/mock/mock.go         |  5 ++
 2 files changed, 68 insertions(+)

diff --git a/control/control_test.go b/control/control_test.go
index 86f4ed608..51cfaa59d 100644
--- a/control/control_test.go
+++ b/control/control_test.go
@@ -229,6 +229,7 @@ type mockPluginEvent struct {
 	UnloadedPluginName    string
 	UnloadedPluginVersion int
 	PluginType            int
+	EventNamespace        string
 }
 
 type listenToPluginEvent struct {
@@ -245,6 +246,9 @@ func newListenToPluginEvent() *listenToPluginEvent {
 
 func (l *listenToPluginEvent) HandleGomitEvent(e gomit.Event) {
 	switch v := e.Body.(type) {
+	case *control_event.DeadAvailablePluginEvent:
+		l.plugin.EventNamespace = v.Namespace()
+		l.done <- struct{}{}
 	case *control_event.LoadPluginEvent:
 		l.plugin.LoadedPluginName = v.Name
 		l.plugin.LoadedPluginVersion = v.Version
@@ -1080,6 +1084,65 @@ func TestCollectDynamicMetrics(t *testing.T) {
 	})
 }
 
+func TestFailedPlugin(t *testing.T) {
+	Convey("given a loaded plugin", t, func() {
+		// Create controller
+		c := New()
+		c.Start()
+		lpe := newListenToPluginEvent()
+		c.eventManager.RegisterHandler("TEST", lpe)
+		c.Config.Plugins.All.AddItem("password", ctypes.ConfigValueStr{Value: "testval"})
+
+		// Load plugin
+		load(c, PluginPath)
+		<-lpe.done
+		_, err := c.MetricCatalog()
+		So(err, ShouldBeNil)
+
+		// metrics to collect
+		cfg := cdata.NewNode()
+		cfg.AddItem("panic", ctypes.ConfigValueBool{Value: true})
+		m := []core.Metric{
+			MockMetricType{
+				namespace: []string{"intel", "mock", "foo"},
+				cfg:       cfg,
+			},
+		}
+
+		// retrieve loaded plugin
+		lp, err := c.pluginManager.get("collector:mock:2")
+		So(err, ShouldBeNil)
+		So(lp, ShouldNotBeNil)
+
+		Convey("create a pool, add subscriptions and start plugins", func() {
+			pool, errp := c.pluginRunner.AvailablePlugins().getOrCreatePool("collector:mock:2")
+			So(errp, ShouldBeNil)
+			pool.subscribe("1", unboundSubscriptionType)
+			err = c.pluginRunner.runPlugin(lp.Details)
+			So(err, ShouldBeNil)
+
+			Convey("collect metrics against a plugin that will panic", func() {
+				So(len(pool.plugins), ShouldEqual, 1)
+				cr, err := c.CollectMetrics(m, time.Now().Add(time.Second*1))
+				So(err, ShouldNotBeNil)
+				So(cr, ShouldBeNil)
+				<-lpe.done
+				So(lpe.plugin.EventNamespace, ShouldResemble, control_event.AvailablePluginDead)
+				// sleep is necessary unless/until we add an event that is fired when the AP is removed
+				// from the array of plugins on the pool
+				time.Sleep(100 * time.Millisecond)
+				So(len(pool.plugins), ShouldEqual, 1)
+				// TODO: On the AvailablePluginDeadEvent we should attempt to restart the plugin
+				//       ensuring that we can't enter an endless failure loop.
+				//
+				//       - Add a configurable max-failure-count for running plugins
+				//       - Add the logic that detects a failure loop to the eligibilty method on the pool
+			})
+		})
+		c.Stop()
+	})
+}
+
 func TestCollectMetrics(t *testing.T) {
 	Convey("given a loaded plugin", t, func() {
 		// adjust HB timeouts for test
diff --git a/plugin/collector/snap-collector-mock2/mock/mock.go b/plugin/collector/snap-collector-mock2/mock/mock.go
index 31b1a5353..010a8d128 100644
--- a/plugin/collector/snap-collector-mock2/mock/mock.go
+++ b/plugin/collector/snap-collector-mock2/mock/mock.go
@@ -29,6 +29,7 @@ import (
 	"github.com/intelsdi-x/snap/control/plugin"
 	"github.com/intelsdi-x/snap/control/plugin/cpolicy"
 	"github.com/intelsdi-x/snap/core"
+	"github.com/intelsdi-x/snap/core/ctypes"
 )
 
 const (
@@ -49,9 +50,13 @@ func (f *Mock) CollectMetrics(mts []plugin.PluginMetricType) ([]plugin.PluginMet
 	for _, p := range mts {
 		log.Printf("collecting %+v\n", p)
 	}
+
 	rand.Seed(time.Now().UTC().UnixNano())
 	metrics := []plugin.PluginMetricType{}
 	for i := range mts {
+		if c, ok := mts[i].Config().Table()["panic"]; ok && c.(ctypes.ConfigValueBool).Value {
+			panic("Opps!")
+		}
 		if mts[i].Namespace()[2] == "*" {
 			hostname, _ := os.Hostname()
 			for j := 0; j < 10; j++ {