Merge pull request #1489 from kindermoumoute/refactor_API

Refactor api and add v2 API (beta)

cmd/snaptel/metric.go

@@ -29,7 +29,7 @@ import (
 	"time"
 
 	"github.com/intelsdi-x/snap/mgmt/rest/client"
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 	"github.com/urfave/cli"
 
 	"github.com/intelsdi-x/snap/pkg/stringutils"

control/plugin/cpolicy/node.go

@@ -167,16 +167,18 @@ func (p *ConfigPolicyNode) Add(rules ...Rule) {
 	}
 }
 
+type RuleTableSlice []RuleTable
+
 type RuleTable struct {
-	Name     string
-	Type     string
-	Default  interface{}
-	Required bool
-	Minimum  interface{}
-	Maximum  interface{}
+	Name     string      `json:"name"`
+	Type     string      `json:"type"`
+	Default  interface{} `json:"default,omitempty"`
+	Required bool        `json:"required"`
+	Minimum  interface{} `json:"minimum,omitempty"`
+	Maximum  interface{} `json:"maximum,omitempty"`
 }
 
-func (p *ConfigPolicyNode) RulesAsTable() []RuleTable {
+func (p *ConfigPolicyNode) RulesAsTable() RuleTableSlice {
 	p.mutex.Lock()
 	defer p.mutex.Unlock()
 

mgmt/rest/api/api.go

@@ -0,0 +1,18 @@
+package api
+
+import (
+	"github.com/julienschmidt/httprouter"
+)
+
+type API interface {
+	GetRoutes() []Route
+	BindMetricManager(Metrics)
+	BindTaskManager(Tasks)
+	BindTribeManager(Tribe)
+	BindConfigManager(Config)
+}
+
+type Route struct {
+	Method, Path string
+	Handle       httprouter.Handle
+}

mgmt/rest/api/config.go

@@ -0,0 +1,15 @@
+package api
+
+import (
+	"github.com/intelsdi-x/snap/core"
+	"github.com/intelsdi-x/snap/core/cdata"
+)
+
+type Config interface {
+	GetPluginConfigDataNode(core.PluginType, string, int) cdata.ConfigDataNode
+	GetPluginConfigDataNodeAll() cdata.ConfigDataNode
+	MergePluginConfigDataNode(pluginType core.PluginType, name string, ver int, cdn *cdata.ConfigDataNode) cdata.ConfigDataNode
+	MergePluginConfigDataNodeAll(cdn *cdata.ConfigDataNode) cdata.ConfigDataNode
+	DeletePluginConfigDataNodeField(pluginType core.PluginType, name string, ver int, fields ...string) cdata.ConfigDataNode
+	DeletePluginConfigDataNodeFieldAll(fields ...string) cdata.ConfigDataNode
+}

mgmt/rest/api/metric.go

@@ -0,0 +1,18 @@
+package api
+
+import (
+	"github.com/intelsdi-x/snap/core"
+	"github.com/intelsdi-x/snap/core/serror"
+)
+
+type Metrics interface {
+	MetricCatalog() ([]core.CatalogedMetric, error)
+	FetchMetrics(core.Namespace, int) ([]core.CatalogedMetric, error)
+	GetMetricVersions(core.Namespace) ([]core.CatalogedMetric, error)
+	GetMetric(core.Namespace, int) (core.CatalogedMetric, error)
+	Load(*core.RequestedPlugin) (core.CatalogedPlugin, serror.SnapError)
+	Unload(core.Plugin) (core.CatalogedPlugin, serror.SnapError)
+	PluginCatalog() core.PluginCatalog
+	AvailablePlugins() []core.AvailablePlugin
+	GetAutodiscoverPaths() []string
+}

mgmt/rest/api/task.go

@@ -0,0 +1,19 @@
+package api
+
+import (
+	"github.com/intelsdi-x/snap/core"
+	"github.com/intelsdi-x/snap/core/serror"
+	"github.com/intelsdi-x/snap/pkg/schedule"
+	"github.com/intelsdi-x/snap/scheduler/wmap"
+)
+
+type Tasks interface {
+	CreateTask(schedule.Schedule, *wmap.WorkflowMap, bool, ...core.TaskOption) (core.Task, core.TaskErrors)
+	GetTasks() map[string]core.Task
+	GetTask(string) (core.Task, error)
+	StartTask(string) []serror.SnapError
+	StopTask(string) []serror.SnapError
+	RemoveTask(string) error
+	WatchTask(string, core.TaskWatcherHandler) (core.TaskWatcherCloser, error)
+	EnableTask(string) (core.Task, error)
+}

mgmt/rest/api/tribe.go

@@ -0,0 +1,17 @@
+package api
+
+import (
+	"github.com/intelsdi-x/snap/core/serror"
+	"github.com/intelsdi-x/snap/mgmt/tribe/agreement"
+)
+
+type Tribe interface {
+	GetAgreement(name string) (*agreement.Agreement, serror.SnapError)
+	GetAgreements() map[string]*agreement.Agreement
+	AddAgreement(name string) serror.SnapError
+	RemoveAgreement(name string) serror.SnapError
+	JoinAgreement(agreementName, memberName string) serror.SnapError
+	LeaveAgreement(agreementName, memberName string) serror.SnapError
+	GetMembers() []string
+	GetMember(name string) *agreement.Member
+}

mgmt/rest/client/client.go

@@ -38,7 +38,7 @@ import (
 
 	"github.com/asaskevich/govalidator"
 
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 )
 
 var (

mgmt/rest/client/client_func_test.go

@@ -36,6 +36,7 @@ import (
 
 	"github.com/intelsdi-x/snap/control"
 	"github.com/intelsdi-x/snap/mgmt/rest"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1"
 	"github.com/intelsdi-x/snap/plugin/helper"
 	"github.com/intelsdi-x/snap/scheduler"
 	"github.com/intelsdi-x/snap/scheduler/wmap"
@@ -75,7 +76,7 @@ func getWMFromSample(sample string) *wmap.WorkflowMap {
 // When we eventually have a REST API Stop command this can be killed.
 func startAPI() string {
 	// Start a REST API to talk to
-	rest.StreamingBufferWindow = 0.01
+	v1.StreamingBufferWindow = 0.01
 	log.SetLevel(LOG_LEVEL)
 	r, _ := rest.New(rest.GetDefaultConfig())
 	c := control.New(control.GetDefaultConfig())
@@ -490,7 +491,7 @@ func TestSnapClient(t *testing.T) {
 				})
 				Convey("WatchTasks", func() {
 					Convey("invalid task ID", func() {
-						rest.StreamingBufferWindow = 0.01
+						v1.StreamingBufferWindow = 0.01
 
 						type ea struct {
 							events []string
@@ -521,7 +522,7 @@ func TestSnapClient(t *testing.T) {
 						So(r.Err.Error(), ShouldEqual, "Task not found: ID(1)")
 					})
 					Convey("event stream", func() {
-						rest.StreamingBufferWindow = 0.01
+						v1.StreamingBufferWindow = 0.01
 						sch := &Schedule{Type: "simple", Interval: "100ms"}
 						tf := c.CreateTask(sch, wf, "baron", "", false, 0)
 

mgmt/rest/client/client_tribe_func_test.go

@@ -37,7 +37,7 @@ import (
 	"github.com/intelsdi-x/snap/control"
 	"github.com/intelsdi-x/snap/mgmt/rest"
 	"github.com/intelsdi-x/snap/mgmt/rest/client"
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 	"github.com/intelsdi-x/snap/mgmt/tribe"
 	"github.com/intelsdi-x/snap/scheduler"
 )

mgmt/rest/client/config.go

@@ -25,7 +25,7 @@ import (
 	"net/url"
 
 	"github.com/intelsdi-x/snap/core/ctypes"
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 )
 
 // GetPluginConfig retrieves the merged plugin config given the type of plugin,

mgmt/rest/client/metric.go

@@ -23,7 +23,7 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 )
 
 var (

mgmt/rest/client/plugin.go

@@ -27,7 +27,7 @@ import (
 	"time"
 
 	"github.com/intelsdi-x/snap/core/serror"
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 )
 
 // LoadPlugin loads plugins for the given plugin names.

mgmt/rest/client/task.go

@@ -29,7 +29,7 @@ import (
 	"time"
 
 	"github.com/intelsdi-x/snap/core"
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 	"github.com/intelsdi-x/snap/scheduler/wmap"
 )
 

mgmt/rest/client/tribe.go

@@ -23,7 +23,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/intelsdi-x/snap/mgmt/rest/rbody"
+	"github.com/intelsdi-x/snap/mgmt/rest/v1/rbody"
 )
 
 // ListMembers retrieves a list of tribe members through an HTTP GET call.