Use go module as dependency tool instead of glide
[src/xds/xds-agent.git] / lib / agent / xdsserver.go
index 620bae9..40ee57b 100644 (file)
@@ -1,20 +1,36 @@
+/*
+ * Copyright (C) 2017-2018 "IoT.bzh"
+ * Author Sebastien Douheret <sebastien@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package agent
 
 import (
        "encoding/json"
        "fmt"
        "io"
-       "io/ioutil"
        "net/http"
        "strings"
        "sync"
        "time"
 
+       "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
+       "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xdsconfig"
+       common "gerrit.automotivelinux.org/gerrit/src/xds/xds-common.git"
+       "gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
        "github.com/gin-gonic/gin"
-       "github.com/iotbzh/xds-agent/lib/xaapiv1"
-       "github.com/iotbzh/xds-agent/lib/xdsconfig"
-       common "github.com/iotbzh/xds-common/golib"
-       "github.com/iotbzh/xds-server/lib/xsapiv1"
        uuid "github.com/satori/go.uuid"
        sio_client "github.com/sebd71/go-socket.io-client"
 )
@@ -23,6 +39,7 @@ import (
 type XdsServer struct {
        *Context
        ID           string
+       URLIndex     string
        BaseURL      string
        APIURL       string
        PartialURL   string
@@ -38,15 +55,20 @@ type XdsServer struct {
        sockEventsLock *sync.Mutex
 
        // Private fields
-       client    *common.HTTPClient
-       ioSock    *sio_client.Client
-       logOut    io.Writer
-       apiRouter *gin.RouterGroup
+       client      *common.HTTPClient
+       ioSock      *sio_client.Client
+       logOut      io.Writer
+       apiRouter   *gin.RouterGroup
+       cmdList     map[string]interface{}
+       cbOnConnect OnConnectedCB
 }
 
 // EventCB Event emitter callback
 type EventCB func(privData interface{}, evtData interface{}) error
 
+// OnConnectedCB connect callback
+type OnConnectedCB func(svr *XdsServer) error
+
 // caller Used to chain event listeners
 type caller struct {
        id          uuid.UUID
@@ -62,6 +84,7 @@ func NewXdsServer(ctx *Context, conf xdsconfig.XDSServerConf) *XdsServer {
        return &XdsServer{
                Context:    ctx,
                ID:         _IDTempoPrefix + uuid.NewV1().String(),
+               URLIndex:   conf.URLIndex,
                BaseURL:    conf.URL,
                APIURL:     conf.APIBaseURL + conf.APIPartialURL,
                PartialURL: conf.APIPartialURL,
@@ -72,16 +95,15 @@ func NewXdsServer(ctx *Context, conf xdsconfig.XDSServerConf) *XdsServer {
                sockEvents:     make(map[string][]*caller),
                sockEventsLock: &sync.Mutex{},
                logOut:         ctx.Log.Out,
+               cmdList:        make(map[string]interface{}),
        }
 }
 
 // Close Free and close XDS Server connection
 func (xs *XdsServer) Close() error {
-       xs.Connected = false
+       err := xs._Disconnected()
        xs.Disabled = true
-       xs.ioSock = nil
-       xs._NotifyState()
-       return nil
+       return err
 }
 
 // Connect Establish HTTP connection with XDS Server
@@ -106,7 +128,7 @@ func (xs *XdsServer) Connect() error {
                time.Sleep(time.Second)
        }
        if retry == 0 {
-               // FIXME: re-use _reconnect to wait longer in background
+               // FIXME: re-use _Reconnect to wait longer in background
                return fmt.Errorf("Connection to XDS Server failure")
        }
        if err != nil {
@@ -114,11 +136,17 @@ func (xs *XdsServer) Connect() error {
        }
 
        // Check HTTP connection and establish WS connection
-       err = xs._connect(false)
+       err = xs._Connect(false)
 
        return err
 }
 
+// ConnectOn Register a callback on events reception
+func (xs *XdsServer) ConnectOn(f OnConnectedCB) error {
+       xs.cbOnConnect = f
+       return nil
+}
+
 // IsTempoID returns true when server as a temporary id
 func (xs *XdsServer) IsTempoID() bool {
        return strings.HasPrefix(xs.ID, _IDTempoPrefix)
@@ -129,6 +157,19 @@ func (xs *XdsServer) SetLoggerOutput(out io.Writer) {
        xs.logOut = out
 }
 
+// GetConfig return the current server config
+func (xs *XdsServer) GetConfig() xaapiv1.ServerCfg {
+       return xaapiv1.ServerCfg{
+               ID:         xs.ID,
+               URL:        xs.BaseURL,
+               APIURL:     xs.APIURL,
+               PartialURL: xs.PartialURL,
+               ConnRetry:  xs.ConnRetry,
+               Connected:  xs.Connected,
+               Disabled:   xs.Disabled,
+       }
+}
+
 // SendCommand Send a command to XDS Server
 func (xs *XdsServer) SendCommand(cmd string, body []byte, res interface{}) error {
        url := cmd
@@ -172,6 +213,32 @@ func (xs *XdsServer) FolderUpdate(fld *xsapiv1.FolderConfig, resFld *xsapiv1.Fol
        return xs.client.Put("/folders/"+fld.ID, fld, resFld)
 }
 
+// CommandExec Send POST request to execute a command
+func (xs *XdsServer) CommandExec(args *xsapiv1.ExecArgs, res *xsapiv1.ExecResult) error {
+       return xs.client.Post("/exec", args, res)
+}
+
+// CommandSignal Send POST request to send a signal to a command
+func (xs *XdsServer) CommandSignal(args *xsapiv1.ExecSignalArgs, res *xsapiv1.ExecSigResult) error {
+       return xs.client.Post("/signal", args, res)
+}
+
+// CommandTgtTerminalGet Send GET request to retrieve info of a target terminals
+func (xs *XdsServer) CommandTgtTerminalGet(targetID, termID string, res *xsapiv1.TerminalConfig) error {
+       return xs.client.Get("/targets/"+targetID+"/terminals/"+termID, res)
+}
+
+// CommandTgtTerminalOpen Send POST request to open a target terminal
+func (xs *XdsServer) CommandTgtTerminalOpen(targetID string, termID string, res *xsapiv1.TerminalConfig) error {
+       var empty interface{}
+       return xs.client.Post("/targets/"+targetID+"/terminals/"+termID+"/open", &empty, res)
+}
+
+// CommandTgtTerminalSignal Send POST request to send a signal to a target terminal
+func (xs *XdsServer) CommandTgtTerminalSignal(args *xsapiv1.TerminalSignalArgs, res *xsapiv1.TerminalConfig) error {
+       return xs.client.Post("/signal", args, res)
+}
+
 // SetAPIRouterGroup .
 func (xs *XdsServer) SetAPIRouterGroup(r *gin.RouterGroup) {
        xs.apiRouter = r
@@ -194,8 +261,7 @@ func (xs *XdsServer) PassthroughGet(url string) {
                // Send Get request
                if err := xs.client.Get(nURL, &data); err != nil {
                        if strings.Contains(err.Error(), "connection refused") {
-                               xs.Connected = false
-                               xs._NotifyState()
+                               xs._Disconnected()
                        }
                        common.APIError(c, err.Error())
                        return
@@ -213,8 +279,11 @@ func (xs *XdsServer) PassthroughPost(url string) {
        }
 
        xs.apiRouter.POST(url, func(c *gin.Context) {
-               bodyReq := []byte{}
-               n, err := c.Request.Body.Read(bodyReq)
+               var err error
+               var data interface{}
+
+               // Get raw body
+               body, err := c.GetRawData()
                if err != nil {
                        common.APIError(c, err.Error())
                        return
@@ -227,38 +296,146 @@ func (xs *XdsServer) PassthroughPost(url string) {
                }
 
                // Send Post request
-               body, err := json.Marshal(bodyReq[:n])
+               response, err := xs.client.HTTPPostWithRes(nURL, string(body))
                if err != nil {
-                       common.APIError(c, err.Error())
+                       goto httpError
+               }
+               if response.StatusCode != 200 {
+                       err = fmt.Errorf(response.Status)
                        return
                }
+               err = json.Unmarshal(xs.client.ResponseToBArray(response), &data)
+               if err != nil {
+                       goto httpError
+               }
 
-               response, err := xs.client.HTTPPostWithRes(nURL, string(body))
+               c.JSON(http.StatusOK, data)
+               return
+
+               /* Handle error case */
+       httpError:
+               if strings.Contains(err.Error(), "connection refused") {
+                       xs._Disconnected()
+               }
+               common.APIError(c, err.Error())
+               return
+       })
+}
+
+// PassthroughPut Used to declare a route that sends directly a PUT request to XDS Server
+func (xs *XdsServer) PassthroughPut(url string) {
+       if xs.apiRouter == nil {
+               xs.Log.Errorf("apiRouter not set !")
+               return
+       }
+
+       xs.apiRouter.PUT(url, func(c *gin.Context) {
+               var err error
+               var data interface{}
+
+               // Get raw body
+               body, err := c.GetRawData()
                if err != nil {
                        common.APIError(c, err.Error())
                        return
                }
 
-               bodyRes, err := ioutil.ReadAll(response.Body)
+               // Take care of param (eg. id in /projects/:id)
+               nURL := url
+               if strings.Contains(url, ":") {
+                       nURL = strings.TrimPrefix(c.Request.URL.Path, xs.APIURL)
+               }
+
+               // Send Put request
+               response, err := xs.client.HTTPPutWithRes(nURL, string(body))
+               if err != nil {
+                       goto httpError
+               }
+               if response.StatusCode != 200 {
+                       err = fmt.Errorf(response.Status)
+                       return
+               }
+               err = json.Unmarshal(xs.client.ResponseToBArray(response), &data)
+               if err != nil {
+                       goto httpError
+               }
+
+               c.JSON(http.StatusOK, data)
+               return
+
+               /* Handle error case */
+       httpError:
+               if strings.Contains(err.Error(), "connection refused") {
+                       xs._Disconnected()
+               }
+               common.APIError(c, err.Error())
+               return
+       })
+}
+
+// PassthroughDelete Used to declare a route that sends directly a Delete request to XDS Server
+func (xs *XdsServer) PassthroughDelete(url string) {
+       if xs.apiRouter == nil {
+               xs.Log.Errorf("apiRouter not set !")
+               return
+       }
+
+       xs.apiRouter.DELETE(url, func(c *gin.Context) {
+               var err error
+               var data interface{}
+
+               // Take care of param (eg. id in /projects/:id)
+               nURL := url
+               if strings.Contains(url, ":") {
+                       nURL = strings.TrimPrefix(c.Request.URL.Path, xs.APIURL)
+               }
+
+               // Send Post request
+               response, err := xs.client.HTTPDeleteWithRes(nURL)
                if err != nil {
-                       common.APIError(c, "Cannot read response body")
+                       goto httpError
+               }
+               if response.StatusCode != 200 {
+                       err = fmt.Errorf(response.Status)
                        return
                }
-               c.JSON(http.StatusOK, string(bodyRes))
+               err = json.Unmarshal(xs.client.ResponseToBArray(response), &data)
+               if err != nil {
+                       goto httpError
+               }
+
+               c.JSON(http.StatusOK, data)
+               return
+
+               /* Handle error case */
+       httpError:
+               if strings.Contains(err.Error(), "connection refused") {
+                       xs._Disconnected()
+               }
+               common.APIError(c, err.Error())
+               return
        })
 }
 
 // EventRegister Post a request to register to an XdsServer event
-func (xs *XdsServer) EventRegister(evName string, id string) error {
-       return xs.client.Post(
-               "/events/register",
+func (xs *XdsServer) EventRegister(evName string, filter string) error {
+       return xs.client.Post("/events/register",
                xsapiv1.EventRegisterArgs{
-                       Name:      evName,
-                       ProjectID: id,
+                       Name:   evName,
+                       Filter: filter,
                },
                nil)
 }
 
+// EventEmit Emit a event to XDS Server through WS
+func (xs *XdsServer) EventEmit(message string, args ...interface{}) error {
+       if xs.ioSock == nil {
+               return fmt.Errorf("Io.Socket not initialized")
+       }
+
+       return xs.ioSock.Emit(message, args...)
+}
+
 // EventOn Register a callback on events reception
 func (xs *XdsServer) EventOn(evName string, privData interface{}, f EventCB) (uuid.UUID, error) {
        if xs.ioSock == nil {
@@ -272,31 +449,16 @@ func (xs *XdsServer) EventOn(evName string, privData interface{}, f EventCB) (uu
                // Register listener only the first time
                evn := evName
 
-               // FIXME: use generic type: data interface{} instead of data xsapiv1.EventMsg
-               var err error
-               if evName == "event:folder-state-change" {
-                       err = xs.ioSock.On(evn, func(data xsapiv1.EventMsg) error {
-                               xs.sockEventsLock.Lock()
-                               sEvts := make([]*caller, len(xs.sockEvents[evn]))
-                               copy(sEvts, xs.sockEvents[evn])
-                               xs.sockEventsLock.Unlock()
-                               for _, c := range sEvts {
-                                       c.Func(c.PrivateData, data)
-                               }
-                               return nil
-                       })
-               } else {
-                       err = xs.ioSock.On(evn, func(data interface{}) error {
-                               xs.sockEventsLock.Lock()
-                               sEvts := make([]*caller, len(xs.sockEvents[evn]))
-                               copy(sEvts, xs.sockEvents[evn])
-                               xs.sockEventsLock.Unlock()
-                               for _, c := range sEvts {
-                                       c.Func(c.PrivateData, data)
-                               }
-                               return nil
-                       })
-               }
+               err := xs.ioSock.On(evn, func(data interface{}) error {
+                       xs.sockEventsLock.Lock()
+                       sEvts := make([]*caller, len(xs.sockEvents[evn]))
+                       copy(sEvts, xs.sockEvents[evn])
+                       xs.sockEventsLock.Unlock()
+                       for _, c := range sEvts {
+                               c.Func(c.PrivateData, data)
+                       }
+                       return nil
+               })
                if err != nil {
                        return uuid.Nil, err
                }
@@ -310,6 +472,7 @@ func (xs *XdsServer) EventOn(evName string, privData interface{}, f EventCB) (uu
        }
 
        xs.sockEvents[evName] = append(xs.sockEvents[evName], c)
+       xs.LogSillyf("XS EventOn: sockEvents[\"%s\"]: len %d", evName, len(xs.sockEvents[evName]))
        return c.id, nil
 }
 
@@ -331,6 +494,7 @@ func (xs *XdsServer) EventOff(evName string, id uuid.UUID) error {
                        }
                }
        }
+       xs.LogSillyf("XS EventOff: sockEvents[\"%s\"]: len %d", evName, len(xs.sockEvents[evName]))
        return nil
 }
 
@@ -404,6 +568,33 @@ func (xs *XdsServer) FolderToProject(fPrj xsapiv1.FolderConfig) xaapiv1.ProjectC
        return pPrj
 }
 
+// CommandAdd Add a new command to the list of running commands
+func (xs *XdsServer) CommandAdd(cmdID string, data interface{}) error {
+       if xs.CommandGet(cmdID) != nil {
+               return fmt.Errorf("command id already exist")
+       }
+       xs.cmdList[cmdID] = data
+       return nil
+}
+
+// CommandDelete Delete a command from the command list
+func (xs *XdsServer) CommandDelete(cmdID string) error {
+       if xs.CommandGet(cmdID) == nil {
+               return fmt.Errorf("unknown command id")
+       }
+       delete(xs.cmdList, cmdID)
+       return nil
+}
+
+// CommandGet Retrieve a command data
+func (xs *XdsServer) CommandGet(cmdID string) interface{} {
+       d, exist := xs.cmdList[cmdID]
+       if exist {
+               return d
+       }
+       return nil
+}
+
 /***
 ** Private functions
 ***/
@@ -437,18 +628,17 @@ func (xs *XdsServer) _CreateConnectHTTP() error {
        return nil
 }
 
-//  Re-established connection
-func (xs *XdsServer) _reconnect() error {
-       err := xs._connect(true)
-       if err == nil {
-               // Reload projects list for this server
-               err = xs.projects.Init(xs)
-       }
+// _Reconnect Re-established connection
+func (xs *XdsServer) _Reconnect() error {
+
+       // Note that ConnectOn callback will be called (see apiv1.go file)
+       err := xs._Connect(true)
+
        return err
 }
 
-//  Established HTTP and WS connection and retrieve XDSServer config
-func (xs *XdsServer) _connect(reConn bool) error {
+// _Connect Established HTTP and WS connection and retrieve XDSServer config
+func (xs *XdsServer) _Connect(reConn bool) error {
 
        xdsCfg := xsapiv1.APIConfig{}
        if err := xs.client.Get("/config", &xdsCfg); err != nil {
@@ -469,17 +659,22 @@ func (xs *XdsServer) _connect(reConn bool) error {
 
        // Establish WS connection and register listen
        if err := xs._SocketConnect(); err != nil {
-               xs.Connected = false
-               xs._NotifyState()
+               xs._Disconnected()
                return err
        }
 
        xs.Connected = true
+
+       // Call OnConnect callback
+       if xs.cbOnConnect != nil {
+               xs.cbOnConnect(xs)
+       }
+
        xs._NotifyState()
        return nil
 }
 
-// Create WebSocket (io.socket) connection
+// _SocketConnect Create WebSocket (io.socket) connection
 func (xs *XdsServer) _SocketConnect() error {
 
        xs.Log.Infof("Connecting IO.socket for server %s (url %s)", xs.ID, xs.BaseURL)
@@ -506,12 +701,11 @@ func (xs *XdsServer) _SocketConnect() error {
        })
 
        iosk.On("disconnection", func(err error) {
-               xs.Log.Infof("IO.socket disconnection server %s", xs.ID)
+               xs.Log.Infof("IO.socket disconnection server %s (APIURL %s)", xs.ID, xs.APIURL)
                if xs.CBOnDisconnect != nil {
                        xs.CBOnDisconnect(err)
                }
-               xs.Connected = false
-               xs._NotifyState()
+               xs._Disconnected()
 
                // Try to reconnect during 15min (or at least while not disabled)
                go func() {
@@ -529,7 +723,12 @@ func (xs *XdsServer) _SocketConnect() error {
                                time.Sleep(time.Second * time.Duration(waitTime))
                                xs.Log.Infof("Try to reconnect to server %s (%d)", xs.BaseURL, count)
 
-                               xs._reconnect()
+                               err := xs._Reconnect()
+                               if err != nil &&
+                                       !(strings.Contains(err.Error(), "dial tcp") && strings.Contains(err.Error(), "connection refused")) {
+                                       xs.Log.Errorf("ERROR while reconnecting: %v", err.Error())
+                               }
+
                        }
                }()
        })
@@ -542,7 +741,22 @@ func (xs *XdsServer) _SocketConnect() error {
        return nil
 }
 
-// Send event to notify changes
+// _Disconnected Set XDS Server as disconnected
+func (xs *XdsServer) _Disconnected() error {
+       // Clear all register events as socket is closed
+       xs.sockEventsLock.Lock()
+       defer xs.sockEventsLock.Unlock()
+
+       for k := range xs.sockEvents {
+               delete(xs.sockEvents, k)
+       }
+       xs.Connected = false
+       xs.ioSock = nil
+       xs._NotifyState()
+       return nil
+}
+
+// _NotifyState Send event to notify changes
 func (xs *XdsServer) _NotifyState() {
 
        evSts := xaapiv1.ServerCfg{